Type Members

1.  final case class Axis(type: AxisType, position: Opt[Int] = Blank, title: Opt[String] = Blank, side: Opt[Side] = Blank, overlaying: Opt[Axis] = Blank, domain: Opt[(Double, Double)] = Blank, range: Opt[(Double, Double)] = Blank, tickformat: Opt[String] = Blank, logarithmic: Boolean = false, reversed: Boolean = false, showgrid: Boolean = true, zeroline: Boolean = false, showline: Boolean = false, start_tick: Opt[Double] = Blank, tick_gap: Opt[Double] = Blank) extends Component with Product with Serializable

   A case class representing an axis.

2.  sealed trait AxisType extends AnyRef

   Specifies the axis direction.

3.  final case class Canvas(rows: Int = 1, columns: Int = 1, grid: Opt[Array[Chart]] = Blank) extends Product with Serializable

   This is the top level object which renders and plots the charts.

   This is the top level object which renders and plots the charts. All other Components sit inside it.

   rows

   : Number of rows in the Canvas subplot grid.

   columns

   : Number of columns in the Canvas subplot grid.

   grid

   : The actual grid containing the chart data.

4.  final case class Chart(series: List[Series] = Nil, layout: ChartLayout = ChartLayout(), config: Config = Config(), animated: Boolean = false, transition_duration: Int = 100, animate_multiple_series: Boolean = false, id: String = generateRandomText()) extends Component with Product with Serializable

   This is a single chart that renders in a slot in the Canvas grid.

   This is a single chart that renders in a slot in the Canvas grid.

   series

   : A list of series we wish to plot on the page.

   layout

   : This specifies how the chart will be laid out.

   config

   : This configures the chart.

   animated

   : This specifies whether the chart is animated.

   transition_duration

   : If the chart is animated, this specifies the duration between the frames.

   id

   : This is used by the Picta library internally for book-keeping purposes.

5.  final case class ChartLayout(title: Opt[String] = Blank, axes: Opt[List[Axis]] = Empty, legend: Opt[Legend] = Blank, auto_size: Opt[Boolean] = Blank, margin: Opt[Margin] = Blank, map_options: Opt[MapOption] = Blank, multi_chart: Opt[MultiChart] = Blank, hover_distance: Opt[Int] = Blank, show_legend: Boolean = true, hover_mode: HoverMode = CLOSEST, height: Int = 550, width: Int = 600, XYZ: Boolean = false) extends Component with Product with Serializable

   Specifies the layout for the chart.

6.  final case class Config(responsive: Boolean = true, scrollZoom: Boolean = true) extends Component with Product with Serializable

   A class that allows the user to specify chart configuration options.

   A class that allows the user to specify chart configuration options.

   responsive

   : specify whether the chart should be responsive to window size

   scrollZoom

   : specify whether mousewheel or two-finger scroll zooms the plot

7.  trait HoverMode extends AnyRef

   Determines how the hover mode interactions behave.

8.  final case class LatAxis(range: List[Double], showgrid: Boolean = true, dtick: Int = 10) extends MapAxis with Product with Serializable
9.  final case class LongAxis(range: List[Double], showgrid: Boolean = true, dtick: Int = 10) extends MapAxis with Product with Serializable
10.  final case class Map[T](lat: List[Double] = Nil, lon: List[Double] = Nil, name: String = generateRandomText, style: Opt[Style] = Blank, line: Opt[Line[T]] = Blank)(implicit evidence$1: Color[T]) extends Series with Product with Serializable

    This sets the Series for a Map chart specifically.

    This sets the Series for a Map chart specifically.

    lat

    : This is the list of latitudes.

    lon

    : This is the list of longitudes.

    name

    : This sets the series name.

    style

    : This sets the series mode.

    line

    : This configures the line for the Map.

11.  trait MapOption extends Component
12.  final case class MapOptions[T0, T1](region: Opt[Region] = Blank, landcolor: Opt[T0] = Blank, lakecolor: Opt[T1] = Blank, projection: Opt[Projection] = Blank, lataxis: Opt[LatAxis] = Blank, longaxis: Opt[LongAxis] = Blank, showland: Boolean = true, showlakes: Boolean = true, resolution: Int = 50, coastlinewidth: Int = 2)(implicit evidence$1: Color[T0], evidence$2: Color[T1]) extends MapOption with Product with Serializable

    This is configures the Chart for a Map.

    This is configures the Chart for a Map.

    region

    : This determines the geographic scope for the map.

    landcolor

    : Specifcies the landcolor.

    lakecolor

    : Specifies the lakecolor.

    projection

    : TODO

    lataxis

    : This is the component that configures the lataxis.

    longaxis

    : This is the component that configures the longaxis.

    showland

    : Specifies whether the land is shown on the map.

    showlakes

    : Specifies whether lakes are shown on the map.

    resolution

    : This sets the resolution.

    coastlinewidth

    : Specifies the coast line width on the map.

13.  sealed trait Orientation extends AnyRef

    Specifies the direction of orientation.

    Specifies the direction of orientation. An example use case is specifying whether a histogram is displayed vertically or horizontally.

14.  final case class PieElement(value: Double, name: String) extends Component with Product with Serializable

    Represents a slice of a pie chart, with a value and name pair.

    Represents a slice of a pie chart, with a value and name pair. Can be composed into a Pie chart.

    value

    : Value for the slice.

    name

    : Name for the particular slice.

15.  sealed trait Projection extends AnyRef

    Sets how the projection is calculated on a map.

16.  case class RGB(r: Double, g: Double, b: Double) extends Product with Serializable

    This case class represents an RGB color.

17.  case class RGBA(r: Double, g: Double, b: Double, a: Double) extends Product with Serializable

    This case class represents and RGBA color

18.  sealed trait Region extends AnyRef

    Sets the region for a map chart.

19.  sealed trait Side extends AnyRef

    Enum type for specifying a side.

20.  sealed trait Style extends AnyRef

    ENUM for series markers

21.  final case class XY[T0, T1, T2, T3](x: List[T0], y: Opt[List[T1]] = Empty, name: String = generateRandomText, type: XYType = SCATTER, style: Opt[Style] = Blank, xaxis: Opt[Axis] = Blank, yaxis: Opt[Axis] = Blank, marker: Opt[Marker[T2, T3]] = Blank, hist_options: Opt[HistOptions] = Blank, hist2d_options: Opt[Hist2dOptions] = Blank, xerror: Opt[XError] = Blank, yerror: Opt[YError] = Blank, text: Opt[List[String]] = Empty)(implicit evidence$1: Serializer[T0], evidence$2: Serializer[T1], evidence$3: Color[T2], evidence$4: Color[T3]) extends Series with Product with Serializable
    x

    : The data series for the first dimension.

    y

    : The data series for the second dimension.

    name

    : The name for the series.

    style

    : This specifies the style for the marker.

    xaxis

    : This specifies the xaxis that the series maps to.

    yaxis

    : This specifies the yaxis that the series maps to.

    marker

    : This is a Marker component that sets a range of marker-specific options.

    hist_options

    : This is a HistOptions component that sets a range of histogram specific options

    hist2d_options

    : This is a Hist2dOptions component that sets 2D histogram specific options.

    xerror

    : This specifies the behaviour of the x error bar.

    yerror

    : This specifies the behaviour of the y error bar.

22.  final case class XYZ[T0, T1, T2](x: Opt[List[T0]] = Empty, y: Opt[List[T1]] = Empty, z: List[T2], name: String = generateRandomText, type: XYZType = SCATTER3D, style: Opt[Style] = Blank, n: Opt[Int] = Blank, colorbar_options: Opt[ColorBar] = Blank)(implicit evidence$1: Serializer[T0], evidence$2: Serializer[T1], evidence$3: Serializer[T2]) extends Series with Product with Serializable

    * A Series for a 3d chart.

23.  sealed trait XYZType extends AnyRef

    ENUM for the XYZ chart series types