Class/Object

co.theasi.plotly

SinglePlotFigure

Related Docs: object SinglePlotFigure | package plotly

Permalink

case class SinglePlotFigure(plot: Plot, options: FigureOptions) extends Figure with Product with Serializable

Figure containing a single plot

val xs = Vector(1, 2, 5)
val ys = Vector(5, 9, 11)

val figure = SinglePlotFigure()
  .plot { CartesianPlot().withScatter(xs, ys) }
  .title("My awesome plot")

draw(figure, "test-plot")

Use the companion object's apply method to construct a new figure. Set the content of the plot on the figure with the plot method.

Note that all the methods on this class return a copy of the current instance. They do not modify the instance in place. Instances of SinglePlotFigure are immutable.

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

Instance Constructors

  1. new SinglePlotFigure(plot: Plot, options: FigureOptions)

    Permalink

Type Members

  1. type Self = SinglePlotFigure

    Permalink
    Definition Classes
    SinglePlotFigure → Figure

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 bottomMargin(newBottomMargin: Int): Self

    Permalink

    Set bottom margin (in px)

    Set bottom margin (in px)

    Definition Classes
    Figure

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def height(newHeight: Int): Self

    Permalink

    Set the plot height (in px)

    Set the plot height (in px)

    Definition Classes
    Figure

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. def leftMargin(newLeftMargin: Int): Self

    Permalink

    Set left margin (in px)

    Set left margin (in px)

    Definition Classes
    Figure

  13. def legend(newLegend: LegendOptions): Self

    Permalink

    Set legend options

    Set legend options

    val legend = LegendOptions().fontSize(20)
val figure = Figure().legend(legend)
    Definition Classes
    Figure

  14. def margins(top: Int, right: Int, bottom: Int, left: Int): Self

    Permalink

    Set layout margins

    Set layout margins

    Definition Classes
    Figure

  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. val options: FigureOptions

    Permalink
    Definition Classes
    SinglePlotFigure → Figure

  19. def paperBackgroundColor(r: Int, g: Int, b: Int): Self

    Permalink

    Set the paper's background color.

    Set the paper's background color.

    Definition Classes
    Figure

  20. def paperBackgroundColor(r: Int, g: Int, b: Int, a: Double): Self

    Permalink

    Set the paper's background color with (red, green, blue, alpha)

    Set the paper's background color with (red, green, blue, alpha)

    Definition Classes
    Figure

  21. def paperBackgroundColor(newColor: Color): Self

    Permalink

    Set the paper's background color

    Set the paper's background color

    val figure = Figure().paperBackgroundColor(Color.rgb(0, 255, 0))
    Definition Classes
    Figure

  22. def plot(newPlot: Plot): SinglePlotFigure

    Permalink

    Set the content of the figure.

    Set the content of the figure.

    This returns a new figure containing the plot instance.

  23. val plot: Plot

    Permalink

  24. def plotBackgroundColor(r: Int, g: Int, b: Int): Self

    Permalink

    Set the plot's background color

    Set the plot's background color

    Definition Classes
    Figure

  25. def plotBackgroundColor(r: Int, g: Int, b: Int, a: Double): Self

    Permalink

    Set the plot's background color with (red, green, blue, alpha)

    Set the plot's background color with (red, green, blue, alpha)

    Definition Classes
    Figure

  26. def plotBackgroundColor(newColor: Color): Self

    Permalink

    Set the plot's background color

    Set the plot's background color

    val figure = Figure().plotBackgroundColor(Color.rgb(0, 255, 0))
    Definition Classes
    Figure

  27. def plots: Vector[Plot]

    Permalink
    Definition Classes
    SinglePlotFigure → Figure

  28. def rightMargin(newRightMargin: Int): Self

    Permalink

    Set right margin (in px)

    Set right margin (in px)

    Definition Classes
    Figure

  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  30. def title(newTitle: String): Self

    Permalink

    Set figure title

    Set figure title

    Definition Classes
    Figure

  31. def topMargin(newTopMargin: Int): Self

    Permalink

    Set top margin (in px)

    Set top margin (in px)

    Definition Classes
    Figure

  32. def viewPorts: Vector[ViewPort]

    Permalink
    Definition Classes
    SinglePlotFigure → Figure

  33. final def wait(): Unit

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

  34. final def wait(arg0: Long, arg1: Int): Unit

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

  35. final def wait(arg0: Long): Unit

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

  36. def width(newWidth: Int): Self

    Permalink

    Set the plot width (in px)

    Set the plot width (in px)

    Definition Classes
    Figure

  37. def withNewOptions(newOptions: FigureOptions): Self

    Permalink
    Definition Classes
    SinglePlotFigure → Figure

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Figure

Inherited from AnyRef

Inherited from Any

Ungrouped