PlotOptionsWaterfall

Instance Constructors

new PlotOptionsWaterfall()

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
val allowPointSelect: Boolean

Allow this series' points to be selected by clicking on the markers, bars or pie slices.
Allow this series' points to be selected by clicking on the markers, bars or pie slices.
Example:
1. Line, column, pie
Since
1.2.0
val animation: Boolean

Enable or disable the initial animation when a series is displayed.
Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation of the series itself. For other animations, see chart.animation and the animation parameter under the API methods. The following properties are supported: <dl> <dt>duration</dt>
The duration of the animation in milliseconds.
<dt>easing</dt>
A string reference to an easing function set on the Math object. See the easing demo.
</dl>
Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
Example:
1. Animation disabled, slower animation, easing "easeOutBounce" through jQuery UI.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val borderColor: String

The color of the border of each waterfall column.
The color of the border of each waterfall column.

Since
3.0
val borderRadius: Double

The corner radius of the border surrounding each column or bar.
The corner radius of the border surrounding each column or bar.
Example:
1. Rounded columns
val borderWidth: Double

The width of the border surrounding each column or bar.
The width of the border surrounding each column or bar.
Example:
1. 2px black border
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val color: String

The main color or the series.
The main color or the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the options.colors array.
Example:
1. General plot option, one specific series, area color
val colorByPoint: Boolean

When using automatic point colors pulled from the options.colors collection, this option determines whether the chart should receive one color per series or one color per point.
When using automatic point colors pulled from the options.colors collection, this option determines whether the chart should receive one color per series or one color per point.
Example:
1. False by default, true
Since
2.0
val colors: Array[String]

A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.

Since
3.0
val cursor: String

You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
Example:
1. Pointer cursor on line graph, on columns, on scatter markers
val dashStyle: String

A name for the dash style to use for the line connecting the columns of the waterfall series.
A name for the dash style to use for the line connecting the columns of the waterfall series. Possible values:
- Solid
- ShortDash
- ShortDot
- ShortDashDot
- ShortDashDotDot
- Dot
- Dash
- LongDash
- DashDot
- LongDashDot
- LongDashDotDot .
Since
3.0
val dataLabels: PlotOptionsWaterfallDataLabels
val depth: Double

Depth of the columns in a 3D column chart.
Depth of the columns in a 3D column chart. Requires highcharts-3d.js.
Example:
1. Basic 3D column chart
Since
4.0
val edgeColor: String

3D columns only.
3D columns only. The color of the edges. Similar to borderColor, except it defaults to the same color as the column.
val edgeWidth: Double

3D columns only.
3D columns only. The width of the colored edges.
val enableMouseTracking: Boolean

Enable or disable the mouse tracking for a specific series.
Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.
Example:
1. No mouse tracking
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val events: PlotOptionsWaterfallEvents
def finalize(): Unit

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

Definition Classes
AnyRef → Any
val getExtremesFromAll: Boolean

Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis.
Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.

Since
4.1.6
val groupPadding: Double

Padding between each value groups, in x axis units.
Padding between each value groups, in x axis units.
Example:
1. 0.2 by default, no group padding - all columns are evenly spaced
val groupZPadding: Double

The spacing between columns on the Z Axis in a 3D chart.
The spacing between columns on the Z Axis in a 3D chart. Requires highcharts-3d.js.

Since
4.0
val grouping: Boolean

Whether to group non-stacked columns or to let them render independent of each other.
Whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other.
Example:
1. Grouping disabled
Since
2.3.0
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

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

Definition Classes
Any
def isPrototypeOf(v: Object): Boolean

Definition Classes
Object
val keys: Array[String]

An array specifying which option maps to which key in the data point array.
An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.
Example:
1. An extended data array with keys
Since
4.1.6
val lineColor: String

The color of the line that connects columns in a waterfall series.
The color of the line that connects columns in a waterfall series.

Since
3.0
val linkedTo: String

The id of another series to link to.
The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.
Example:
1. Linked series
Since
3.0
val maxPointWidth: Double

The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.
The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart.
Example:
1. Limited to 50
Since
4.1.8
val minPointLength: Double

The minimal height for a column or width for a bar.
The minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed values.
Example:
1. Set to three with zero base value, positive and negative close to zero values
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val point: PlotOptionsWaterfallPoint

Properties for each single point
val pointInterval: Double

If no x values are given for the points in a series, pointInterval defines the interval of the x values.
If no x values are given for the points in a series, pointInterval defines the interval of the x values. For example, if a series contains one value every decade starting from year 0, set pointInterval to 10.
Since Highcharts 4.1, it can be combined with pointIntervalUnit to draw irregular intervals.
Example:
1. Datetime X axis
val pointIntervalUnit: String

On datetime series, this allows for setting the pointInterval to the two irregular time units, month and year.
On datetime series, this allows for setting the pointInterval to the two irregular time units, month and year. Combine it with pointInterval to draw quarters, 6 months, 10 years etc.
Example:
1. One point a month
Since
4.1.0
val pointPadding: Double

Padding between each column or bar, in x axis units.
Padding between each column or bar, in x axis units.
Example:
1. 0.1 by default, 0.25, 0 for tightly packed columns,
val pointPlacement: Any

Possible values: null, "on", "between".
Possible values: null, "on", "between".
In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.
Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series it needs to be set.
Defaults to null in cartesian charts, "between" in polar charts.
Example:
1. Between in a column chart, numeric placement for custom layout.
Since
2.3.0
val pointRange: Double

The X axis range that each point is valid for.
The X axis range that each point is valid for. This determines the width of the column. On a categorized axis, the range will be 1 by default (one category unit). On linear and datetime axes, the range will be computed as the distance between the two closest data points.
Example:
1. Set the point range to one day on a data set with one week between the points
Since
2.3
val pointStart: Double

If no x values are given for the points in a series, pointStart defines on what value to start.
If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945.
Example:
1. Linear, datetime X axis
val pointWidth: Double

A pixel value specifying a fixed width for each column or bar.
A pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the pointPadding and groupPadding.
Example:
1. 20px wide columns regardless of chart width or the amount of data points
Since
1.2.5
def propertyIsEnumerable(v: String): Boolean

Definition Classes
Object
val selected: Boolean

Whether to select the series initially.
Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.
Example:
1. One out of two series selected
Since
1.2.0
val shadow: Any

Whether to apply a drop shadow to the graph line.
Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
Example:
1. Shadow enabled
val showCheckbox: Boolean

If true, a checkbox is displayed next to the legend item to allow selecting the series.
If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.
Example:
1. Show select box
Since
1.2.0
val showInLegend: Boolean

Whether to display this particular series or series type in the legend.
Whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.
Example:
1. One series in the legend, one hidden
val softThreshold: Boolean

When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.
When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.
For example, if softThreshold is false, a series of 0, 1, 2, 3 will make the Y axis show negative values according to the minPadding option. If softThreshold is true, the Y axis starts at 0.

Since
4.1.9
val states: PlotOptionsSeriesStates

A wrapper object for all the series options in specific states.
val stickyTracking: Boolean

Sticky tracking of mouse events.
Sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. When stickyTracking is false and tooltip.shared is false, the tooltip will be hidden when moving the mouse between series. Defaults to true for line and area type series, but to false for columns, pies etc.
Example:
1. True by default, false
Since
2.0
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val threshold: Double

The Y axis value to serve as the base for the columns, for distinguishing between values above and below a threshold.
The Y axis value to serve as the base for the columns, for distinguishing between values above and below a threshold. If null, the columns extend from the padding Y axis minimum.

Since
2.0
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
val tooltip: Object

A configuration object for the tooltip rendering of each single series.
A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.

Since
2.3
val upColor: String

The color used specifically for positive point columns.
The color used specifically for positive point columns. When not specified, the general series color is used.
Example:
1. Waterfall
def valueOf(): Any

Definition Classes
Object
val visible: Boolean

Set the initial visibility of the series.
Set the initial visibility of the series.
Example:
1. Two series, one hidden and one visible
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( ... )
val zoneAxis: String

Defines the Axis on which the zones are applied.
Defines the Axis on which the zones are applied.
Example:
1. Zones on the X-Axis
Since
4.1.0
val zones: Array[PlotOptionsWaterfallZones]

An array defining zones within a series.
An array defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles, according to the zoneAxis option.
Example:
1. Color zones
Since
4.1.0

Related Doc: package config

class PlotOptionsWaterfall extends Object

Instance Constructors

new PlotOptionsWaterfall()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val allowPointSelect: Boolean

val animation: Boolean

final def asInstanceOf[T0]: T0

val borderColor: String

val borderRadius: Double

val borderWidth: Double

def clone(): AnyRef

val color: String

val colorByPoint: Boolean

val colors: Array[String]

val cursor: String

val dashStyle: String

val dataLabels: PlotOptionsWaterfallDataLabels

val depth: Double

val edgeColor: String

val edgeWidth: Double

val enableMouseTracking: Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val events: PlotOptionsWaterfallEvents

def finalize(): Unit

final def getClass(): Class[_]

val getExtremesFromAll: Boolean

val groupPadding: Double

val groupZPadding: Double

val grouping: Boolean

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

val keys: Array[String]

val lineColor: String

val linkedTo: String

val maxPointWidth: Double

val minPointLength: Double

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val point: PlotOptionsWaterfallPoint

val pointInterval: Double

val pointIntervalUnit: String

val pointPadding: Double

val pointPlacement: Any

val pointRange: Double

val pointStart: Double

val pointWidth: Double

def propertyIsEnumerable(v: String): Boolean

val selected: Boolean

val shadow: Any

val showCheckbox: Boolean

val showInLegend: Boolean

val softThreshold: Boolean

val states: PlotOptionsSeriesStates

val stickyTracking: Boolean

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

val threshold: Double

def toLocaleString(): String

def toString(): String

val tooltip: Object

val upColor: String

def valueOf(): Any

val visible: Boolean

final def wait(): Unit

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

final def wait(arg0: Long): Unit

val zoneAxis: String

val zones: Array[PlotOptionsWaterfallZones]

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any