ThreeDPlot

Plot with 3D axes

Example usage

This class represents plots with 3D Cartesian axes. This can be used to draw 3D surface plots.

ThreeDPlot instances can be sent directly to Plotly:

val zs = Vector(
  Vector(1.0, 2.0, 1.0),
  Vector(5.0, 4.0, 5.0),
  Vector(1.0, 2.0, 1.0)
)

val plot = ThreeDPlot().withSurface(zs)
draw(plot, "my-3d-plot")

They can also be embedded in Figure instances for more complex plot layouts:

val zs1 = Vector(
  Vector(1.0, 2.0, 1.0),
  Vector(5.0, 4.0, 5.0),
  Vector(1.0, 2.0, 1.0)
)

val zs2 = zs1.map { row => row.map { _ - 2.0 } }

val figure = RowFigure(2) // 2 sub-plots next to each other
  .plot(0) { ThreeDPlot().withSurface(zs1) } // left sub-plot
  .plot(1) { ThreeDPlot().withSurface(zs2) } // right sub-plot

draw(figure, "3d-subplots")

Surface plots

Add a surface plot with the withSurface method:

val xs = Vector(-1.0, 0.0, 1.0)
val ys = Vector(0.0, 10.0)

val zs = Vector(
  Vector(1.0, 2.0, 1.0),
  Vector(5,0, 4.0, 5.0)
)

val p = ThreeDPlot().withSurface(xs, ys, zs)

The z-values are assumed to be nested iterables, oriented such that zs(0)(1) is the value of z at xs(1) and ys(0).

You can also pass in options to control how the surface is represented:

val p = ThreeDPlot().withSurface(xs, ys, zs, SurfaceOptions().opacity(0.4))

See the documentation for SurfaceOptions for a list of available options.

.withSurface also supports passing a zs iterable without xs and ys. This is equivalent to having xs = (0 to zs(0).size) and ys = (0 to zs.size).

Multiple surfaces

ThreeDPlot instances support multiple surfaces:

val zs1 = Vector(
  Vector(1.0, 2.0, 1.0),
  Vector(5.0, 4.0, 5.0),
  Vector(1.0, 2.0, 1.0)
)

val zs2 = zs1.map { row => row.map { _ - 2.0 } }

val p = ThreeDPlot()
  .withSurface(zs1, SurfaceOptions().name("top"))
  .withSurface(zs2, SurfaceOptions().name("bottom"))

The immutable builder pattern

When you call the .withSurface method on a ThreeDPlot object, it returns a new plot with the series added. ThreeDPlot instances are immutable. Thus, the following does not work as expected:

// Not what you want!
val plot = ThreeDPlot().withSurface(zs)
plot.withSurface(zs2) // No: this does not modify 'plot' in place!

You should chain calls to withSurface instead:

val plot = ThreeDPlot()
  .withSurface(zs1)
  .withSurface(zs2)

All methods in this class work in the same way: they return a new instance of ThreeDPlot. This pattern is called the immutable builder pattern: it is a variant of the common builder pattern adapted for immutable objects.

Linear Supertypes

Serializable, Serializable, Product, Equals, Plot, AnyRef, Any

Instance Constructors

new ThreeDPlot(series: Vector[Series], options: ThreeDPlotOptions)

Type Members

type OptionType = ThreeDPlotOptions

Definition Classes
ThreeDPlot → Plot

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 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
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val options: ThreeDPlotOptions

Definition Classes
ThreeDPlot → Plot
val series: Vector[Series]

Definition Classes
ThreeDPlot → Plot
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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 withSurface[X, Y, Z](xs: Iterable[X], ys: Iterable[Y], zs: Iterable[Iterable[Z]]): ThreeDPlot

[use case] Add a surface plot to this plot.
[use case]
Add a surface plot to this plot.
zs
The values of z. This is an iterable of iterables of any type T, provided an instance of the typeclass Writable[T] exists. The values of zs are oriented such that zs(0)(1) corresponds to the value of z at xs(1) and ys(0).
returns
Copy of this plot with the surface added.

Full Signature
def withSurface[X, Y, Z](xs: Iterable[X], ys: Iterable[Y], zs: Iterable[Iterable[Z]])(implicit arg0: Writable[X], arg1: Writable[Y], arg2: Writable[Z]): ThreeDPlot
def withSurface[X, Y, Z](xs: Iterable[X], ys: Iterable[Y], zs: Iterable[Iterable[Z]], options: SurfaceOptions): ThreeDPlot

[use case] Add a surface plot to this plot.
[use case]
Add a surface plot to this plot.
zs
The values of z. This is an iterable of iterables of any type T, provided an instance of the typeclass Writable[T] exists. The values of zs are oriented such that zs(0)(1) corresponds to the value of z at xs(1) and ys(0).
options
Options controlling the style in which the surface is drawn.
returns
Copy of this plot with the surface added.

Full Signature
def withSurface[X, Y, Z](xs: Iterable[X], ys: Iterable[Y], zs: Iterable[Iterable[Z]], options: SurfaceOptions)(implicit arg0: Writable[X], arg1: Writable[Y], arg2: Writable[Z]): ThreeDPlot
def withSurface[Z](zs: Iterable[Iterable[Z]]): ThreeDPlot

[use case] Add a surface plot to this plot with default x and y.
[use case]
Add a surface plot to this plot with default x and y.
This adds a surface plot where x and y values are assumed to range from 0 to zs(0).size and 0 to zs.size respectively.
zs
The values of z. This is an iterable of iterables of any type T, provided an instance of the typeclass Writable[T] exists. The values of zs are oriented such that zs(0)(1) corresponds to the value of z at x = 1 and y = 0.
returns
Copy of this plot with the surface added.

Full Signature
def withSurface[Z](zs: Iterable[Iterable[Z]])(implicit arg0: Writable[Z]): ThreeDPlot
def withSurface[Z](zs: Iterable[Iterable[Z]], options: SurfaceOptions): ThreeDPlot

[use case] Add a surface plot to this plot with default x and y.
[use case]
Add a surface plot to this plot with default x and y.
This adds a surface plot where x and y values are assumed to range from 0 to zs(0).size and 0 to zs.size respectively.
zs
The values of z. This is an iterable of iterables of any type T, provided an instance of the typeclass Writable[T] exists. The values of zs are oriented such that zs(0)(1) corresponds to the value of z at x = 1 and y = 0.
options
Options controlling the style in which the surface is drawn.
returns
Copy of this plot with the surface added.

Full Signature
def withSurface[Z](zs: Iterable[Iterable[Z]], options: SurfaceOptions)(implicit arg0: Writable[Z]): ThreeDPlot

def xAxisOptions(newAxisOptions: AxisOptions): ThreeDPlot

Set options for the x-axis

newAxisOptions: The new option values.
returns: Copy of this plot with the new axis options set.

Example:

val zs = Vector.tabulate(3, 4) { (i, j) => util.Random.nextDouble }
val p = ThreeDPlot()
  .withSurface(zs)
  .xAxisOptions(AxisOptions().title("x-axis").noZeroLine)
  .yAxisOptions(AxisOptions().title("y-axis").titleColor(255, 0, 0))
  .zAxisOptions(AxisOptions().title("z-axis").noGrid)

def yAxisOptions(newAxisOptions: AxisOptions): ThreeDPlot

Set options for the y-axis

newAxisOptions: The new option values.
returns: Copy of this plot with the new axis options set.

Example:

val zs = Vector.tabulate(3, 4) { (i, j) => util.Random.nextDouble }
val p = ThreeDPlot()
  .withSurface(zs)
  .xAxisOptions(AxisOptions().title("x-axis").noZeroLine)
  .yAxisOptions(AxisOptions().title("y-axis").titleColor(255, 0, 0))
  .zAxisOptions(AxisOptions().title("z-axis").noGrid)

def zAxisOptions(newAxisOptions: AxisOptions): ThreeDPlot

Set options for the z-axis

newAxisOptions: The new option values.
returns: Copy of this plot with the new axis options set.

Example:

val zs = Vector.tabulate(3, 4) { (i, j) => util.Random.nextDouble }
val p = ThreeDPlot()
  .withSurface(zs)
  .xAxisOptions(AxisOptions().title("x-axis").noZeroLine)
  .yAxisOptions(AxisOptions().title("y-axis").titleColor(255, 0, 0))
  .zAxisOptions(AxisOptions().title("z-axis").noGrid)

Related Docs: object ThreeDPlot | package plotly

case class ThreeDPlot(series: Vector[Series], options: ThreeDPlotOptions) extends Plot with Product with Serializable

Example usage

Surface plots

Multiple surfaces

The immutable builder pattern

Instance Constructors

new ThreeDPlot(series: Vector[Series], options: ThreeDPlotOptions)

Type Members

type OptionType = ThreeDPlotOptions

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val options: ThreeDPlotOptions

val series: Vector[Series]

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def withSurface[X, Y, Z](xs: Iterable[X], ys: Iterable[Y], zs: Iterable[Iterable[Z]]): ThreeDPlot

def withSurface[X, Y, Z](xs: Iterable[X], ys: Iterable[Y], zs: Iterable[Iterable[Z]])(implicit arg0: Writable[X], arg1: Writable[Y], arg2: Writable[Z]): ThreeDPlot

def withSurface[X, Y, Z](xs: Iterable[X], ys: Iterable[Y], zs: Iterable[Iterable[Z]], options: SurfaceOptions): ThreeDPlot

def withSurface[X, Y, Z](xs: Iterable[X], ys: Iterable[Y], zs: Iterable[Iterable[Z]], options: SurfaceOptions)(implicit arg0: Writable[X], arg1: Writable[Y], arg2: Writable[Z]): ThreeDPlot

def withSurface[Z](zs: Iterable[Iterable[Z]]): ThreeDPlot

def withSurface[Z](zs: Iterable[Iterable[Z]])(implicit arg0: Writable[Z]): ThreeDPlot

def withSurface[Z](zs: Iterable[Iterable[Z]], options: SurfaceOptions): ThreeDPlot

def withSurface[Z](zs: Iterable[Iterable[Z]], options: SurfaceOptions)(implicit arg0: Writable[Z]): ThreeDPlot

def xAxisOptions(newAxisOptions: AxisOptions): ThreeDPlot

def yAxisOptions(newAxisOptions: AxisOptions): ThreeDPlot

def zAxisOptions(newAxisOptions: AxisOptions): ThreeDPlot

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Plot

Inherited from AnyRef

Inherited from Any

Ungrouped