Class/Object

co.theasi.plotly

ScatterOptions

Related Docs: object ScatterOptions | package plotly

Permalink

case class ScatterOptions(name: Option[String], mode: Seq[ScatterMode.Value], text: Option[TextValue], marker: MarkerOptions) extends SeriesOptions with Product with Serializable

Options controlling how scatter and line plots are plotted.

Linear Supertypes
Serializable, Serializable, Product, Equals, SeriesOptions, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScatterOptions
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. SeriesOptions
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScatterOptions(name: Option[String], mode: Seq[ScatterMode.Value], text: Option[TextValue], marker: MarkerOptions)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  8. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  9. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  10. def marker(newMarker: MarkerOptions): ScatterOptions

    Permalink

    Set new MarkerOptions for this series.

    Set new MarkerOptions for this series.

    See also

    ScatterOptions.updatedMarker to update an existing set of marker options.

  11. val marker: MarkerOptions

    Permalink
  12. def mode(newModes: Iterable[ScatterMode.Value]): ScatterOptions

    Permalink

    Set the line mode.

    Set the line mode.

    Possible arguments are ScatterMode.Marker, ScatterMode.Line and ScatterMode.Text. These are additive: .mode(List(ScatterMode.Marker, ScatterMode.Line)) will show both markers and a line between them.

    ScatterMode.Text indicates that the text corresponding to a particular point should always be shown (by default, it is shown when the user hovers over the point).

  13. def mode(newMode: ScatterMode.Value, rest: ScatterMode.Value*): ScatterOptions

    Permalink

    Set the line mode.

    Set the line mode.

    Possible arguments are ScatterMode.Marker, ScatterMode.Line and ScatterMode.Text. These are additive: .mode(ScatterMode.Marker, ScatterMode.Line) will show both markers and a line between them.

    ScatterMode.Text indicates that the text corresponding to a particular point should always be shown (by default, it is shown when the user hovers over the point).

  14. val mode: Seq[ScatterMode.Value]

    Permalink
  15. def name(newName: String): ScatterOptions

    Permalink

    Set the name of the series

  16. val name: Option[String]

    Permalink
    Definition Classes
    ScatterOptionsSeriesOptions
  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  21. def text[T](newText: Iterable[T])(implicit arg0: Writable[T]): ScatterOptions

    Permalink

    Set the text labels for points in this series.

    Set the text labels for points in this series.

    This sets a different label for each point. The iterator newText must be the same length as the data series.

  22. def text(newText: String): ScatterOptions

    Permalink

    Set the text labels for points in this series.

    Set the text labels for points in this series.

    This sets the same label for every point.

  23. val text: Option[TextValue]

    Permalink
  24. def textSrc(src: String): ScatterOptions

    Permalink

    Set the text labels for points in this series.

    Set the text labels for points in this series.

    This sets the labels from data that is already in Plotly.

    src

    String of format fileId:columnUid, where fileId is the id of a grid in Plotly and column uid is the id of a column in that grid.

    Example:
    1. import co.theasi.plotly._
      val gridFile = writer.GridFile.fromFileName("lowest-oecd-votes-cast-grid")
      val fileId = gridFile.fileId
      val columnUid = gridFile.columnUids("y-0")
      val textSrc = s"$fileId:$columnUid"
      val xs = (1 to 10)
      val ys = (1 to 10)
      val p = CartesianPlot()
        .withScatter(xs, ys, ScatterOptions().textSrc(textSrc))
      draw(p, "text-src-example")
  25. def updatedMarker(updater: (MarkerOptions) ⇒ MarkerOptions): ScatterOptions

    Permalink

    Update the MarkerOptions for this series.

    Update the MarkerOptions for this series.

    updater

    Function mapping the existing MarkerOptions to new MarkerOptions.

    Example:
    1. val xs = (1 to 10)
      val ys = (1 to 10)
      val p = CartesianPlot()
        .withScatter(xs, ys, ScatterOptions()
          .updatedMarker(_.size(10).symbol("x")))
  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SeriesOptions

Inherited from AnyRef

Inherited from Any

Ungrouped