GridFigure

Figure containing plots arranged on a grid.

This Figure subclass is designed for equally spaced subplots on a grid. Use the companion object's apply method to construct a new instance, specifying the number of rows and columns. For instance, val figure = GridFigure(2, 3) will build a new figure with 6 subplots, arranged in a grid with two rows and three columns. You can then use the plot method to set the content of specific sub-plots.

import util.Random
val xs = (0 to 100).map { i => Random.nextGaussian }
val ys = (0 to 100).map { i => Random.nextGaussian }
val ys2 = (0 to 100).map { i => Random.nextGaussian }
val ys3 = (0 to 100).map { i => Random.nextGaussian }

val figure = GridFigure(2, 3) // 2 rows, 3 columns
  .plot(0, 0) { CartesianPlot().withScatter(xs, ys) } // top left
  .plot(0, 1) { CartesianPlot().withScatter(xs, ys2) } // top middle
  .plot(1, 2) { CartesianPlot().withScatter(xs, ys3) } // bottom right
  .title("My grid figure")

draw(figure, "grid-figure")

Linear Supertypes

Serializable, Serializable, Product, Equals, Figure, AnyRef, Any

Instance Constructors

new GridFigure(plots: Vector[Plot], viewPorts: Vector[ViewPort], numberRows: Int, numberColumns: Int, options: FigureOptions)

Type Members

type Self = GridFigure

Definition Classes
GridFigure → Figure

Value Members

final def !=(arg0: Any): Boolean

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

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

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

Definition Classes
Any
def bottomMargin(newBottomMargin: Int): Self

Set bottom margin (in px)
Set bottom margin (in px)

Definition Classes
Figure
def clone(): AnyRef

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

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def height(newHeight: Int): Self

Set the plot height (in px)
Set the plot height (in px)

Definition Classes
Figure
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def leftMargin(newLeftMargin: Int): Self

Set left margin (in px)
Set left margin (in px)

Definition Classes
Figure
def legend(newLegend: LegendOptions): Self

Set legend options
Set legend options
```
val legend = LegendOptions().fontSize(20)
val figure = Figure().legend(legend)
```
Definition Classes
Figure
def margins(top: Int, right: Int, bottom: Int, left: Int): Self

Set layout margins
Set layout margins

Definition Classes
Figure
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val numberColumns: Int
val numberRows: Int
val options: FigureOptions

Definition Classes
GridFigure → Figure
def paperBackgroundColor(r: Int, g: Int, b: Int): Self

Set the paper's background color.
Set the paper's background color.

Definition Classes
Figure
def paperBackgroundColor(r: Int, g: Int, b: Int, a: Double): Self

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
def paperBackgroundColor(newColor: Color): Self

Set the paper's background color
Set the paper's background color
```
val figure = Figure().paperBackgroundColor(Color.rgb(0, 255, 0))
```
Definition Classes
Figure
def plot(rowIndex: Int, columnIndex: Int)(newPlot: Plot): GridFigure

Set the content of a sub-plot.
Set the content of a sub-plot.
This returns a copy of the current figure with the new plot.
def plotAt(rowIndex: Int, columnIndex: Int): Plot

Get the plot at a specific row, column.
def plotBackgroundColor(r: Int, g: Int, b: Int): Self

Set the plot's background color
Set the plot's background color

Definition Classes
Figure
def plotBackgroundColor(r: Int, g: Int, b: Int, a: Double): Self

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
def plotBackgroundColor(newColor: Color): Self

Set the plot's background color
Set the plot's background color
```
val figure = Figure().plotBackgroundColor(Color.rgb(0, 255, 0))
```
Definition Classes
Figure
val plots: Vector[Plot]

Definition Classes
GridFigure → Figure
def rightMargin(newRightMargin: Int): Self

Set right margin (in px)
Set right margin (in px)

Definition Classes
Figure
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def title(newTitle: String): Self

Set figure title
Set figure title

Definition Classes
Figure
def topMargin(newTopMargin: Int): Self

Set top margin (in px)
Set top margin (in px)

Definition Classes
Figure
def viewPortAt(rowIndex: Int, columnIndex: Int): ViewPort

Get the view-port at a specific row, column.
val viewPorts: Vector[ViewPort]

Definition Classes
GridFigure → Figure
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def width(newWidth: Int): Self

Set the plot width (in px)
Set the plot width (in px)

Definition Classes
Figure
def withNewOptions(newOptions: FigureOptions): Self

Definition Classes
GridFigure → Figure

Related Docs: object GridFigure | package plotly

case class GridFigure(plots: Vector[Plot], viewPorts: Vector[ViewPort], numberRows: Int, numberColumns: Int, options: FigureOptions) extends Figure with Product with Serializable

Instance Constructors

new GridFigure(plots: Vector[Plot], viewPorts: Vector[ViewPort], numberRows: Int, numberColumns: Int, options: FigureOptions)

Type Members

type Self = GridFigure

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def bottomMargin(newBottomMargin: Int): Self

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def height(newHeight: Int): Self

final def isInstanceOf[T0]: Boolean

def leftMargin(newLeftMargin: Int): Self

def legend(newLegend: LegendOptions): Self

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val numberColumns: Int

val numberRows: Int

val options: FigureOptions

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

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

def paperBackgroundColor(newColor: Color): Self

def plot(rowIndex: Int, columnIndex: Int)(newPlot: Plot): GridFigure

def plotAt(rowIndex: Int, columnIndex: Int): Plot

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

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

def plotBackgroundColor(newColor: Color): Self

val plots: Vector[Plot]

def rightMargin(newRightMargin: Int): Self

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

def title(newTitle: String): Self

def topMargin(newTopMargin: Int): Self

def viewPortAt(rowIndex: Int, columnIndex: Int): ViewPort

val viewPorts: Vector[ViewPort]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def width(newWidth: Int): Self

def withNewOptions(newOptions: FigureOptions): Self

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Figure

Inherited from AnyRef

Inherited from Any

Ungrouped