class PlotOptionsWaterfall extends Object
- Annotations
- @RawJSType() @ScalaJSDefined()
- Note
JavaScript name:
plotOptions-waterfall
- Alphabetic
- By Inheritance
- PlotOptionsWaterfall
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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: UndefOr[Boolean]
Allow this series' points to be selected by clicking on the markers, bars or pie slices.
-
val
animation: UndefOr[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
</dl>Mathobject. See the easing demo.Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
Example: -
val
animationLimit: UndefOr[Double]
For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high.
For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation doesn't run if there is more than 250 points totally. To disable this cap, set
animationLimittoInfinity. -
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
val
borderColor: UndefOr[|[String, Object]]
The color of the border of each waterfall column.
The color of the border of each waterfall column.
In styled mode, the border stroke can be set with the
.highcharts-pointclass.- Since
3.0
-
val
borderRadius: UndefOr[Double]
The corner radius of the border surrounding each column or bar.
The corner radius of the border surrounding each column or bar.
Example: -
val
borderWidth: UndefOr[Double]
The width of the border surrounding each column or bar.
The width of the border surrounding each column or bar.
In styled mode, the stroke width can be set with the
.highcharts-pointrule.Example: -
val
className: UndefOr[String]
A class name to apply to the series' graphical elements.
A class name to apply to the series' graphical elements.
- Since
5.0.0
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
val
color: UndefOr[|[String, Object]]
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.colorsarray.In styled mode, the series color can be set with the
.highcharts-series,.highcharts-color-{n},.highcharts-{type}-seriesor.highcharts-series-{n}class, or individual classes given by theclassNameoption.Example: -
val
colorByPoint: UndefOr[Boolean]
When using automatic point colors pulled from the
options.colorscollection, 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.colorscollection, this option determines whether the chart should receive one color per series or one color per point.- Since
2.0
Example: -
val
colors: UndefOr[Array[|[String, Object]]]
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: UndefOr[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.
Pointer cursor on line graph, on columns, on scatter markers
Example: -
val
dashStyle: UndefOr[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
In styled mode, the stroke dash-array can be set with the
.highcharts-graphclass.- Since
3.0
-
val
dataLabels: UndefOr[CleanJsObject[PlotOptionsWaterfallDataLabels]]
Options for the series data labels, appearing next to each data point.
Options for the series data labels, appearing next to each data point.
In styled mode, the data labels can be styled wtih the
.highcharts-data-label-boxand.highcharts-data-labelclass names (see example). -
val
depth: UndefOr[Double]
Depth of the columns in a 3D column chart.
Depth of the columns in a 3D column chart. Requires
highcharts-3d.js.- Since
4.0
Example: -
val
description: UndefOr[String]
Requires Accessibility module
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
- Since
5.0.0
Example: -
val
edgeColor: UndefOr[|[String, Object]]
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: UndefOr[Double]
3D columns only.
3D columns only. The width of the colored edges.
-
val
enableMouseTracking: UndefOr[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: -
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val events: UndefOr[CleanJsObject[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: UndefOr[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: UndefOr[Double]
Padding between each value groups, in x axis units.
Padding between each value groups, in x axis units.
-
val
groupZPadding: UndefOr[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: UndefOr[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.
- Since
2.3.0
Example: -
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: UndefOr[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.
- Since
4.1.6
Example: -
val
lineColor: UndefOr[|[String, Object]]
The color of the line that connects columns in a waterfall series.
The color of the line that connects columns in a waterfall series.
In styled mode, the stroke can be set with the
.highcharts-graphclass.- Since
3.0
-
val
lineWidth: UndefOr[Double]
The width of the line connecting waterfall columns.
-
val
linkedTo: UndefOr[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.
- Since
3.0
Example: -
val
maxPointWidth: UndefOr[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.
- Since
4.1.8
Example: -
val
minPointLength: UndefOr[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.
Set to three with zero base value, positive and negative close to zero values
Example: -
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: UndefOr[CleanJsObject[PlotOptionsWaterfallPoint]]
Properties for each single point
-
val
pointInterval: UndefOr[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
pointIntervalUnitto draw irregular intervals.Example: -
val
pointIntervalUnit: UndefOr[String]
On datetime series, this allows for setting the pointInterval to irregular time units,
day,monthandyear.On datetime series, this allows for setting the pointInterval to irregular time units,
day,monthandyear. A day is usually the same as 24 hours, but pointIntervalUnit also takes the DST crossover into consideration when dealing with local time. Combine this option withpointIntervalto draw weeks, quarters, 6 months, 10 years etc.- Since
4.1.0
Example: -
val
pointPadding: UndefOr[Double]
Padding between each column or bar, in x axis units.
Padding between each column or bar, in x axis units.
Example: -
val
pointPlacement: UndefOr[|[String, Double]]
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
nullin cartesian charts,"between"in polar charts.- Since
2.3.0
-
val
pointRange: UndefOr[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.
- Since
2.3
-
val
pointStart: UndefOr[Double]
If no x values are given for the points in a series, pointStart defines on what value to start.
-
val
pointWidth: UndefOr[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 thepointPaddingandgroupPadding.- Since
1.2.5
-
def
propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
-
val
selected: UndefOr[Boolean]
Whether to select the series initially.
Whether to select the series initially. If
showCheckboxis true, the checkbox next to the series name will be checked for a selected series.- Since
1.2.0
Example: -
val
shadow: UndefOr[|[Boolean, Object]]
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,opacityandwidth.Example: -
val
showCheckbox: UndefOr[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
selectedoption.- Since
1.2.0
Example: -
val
showInLegend: UndefOr[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
truefor standalone series,falsefor linked series.Example: -
val
softThreshold: UndefOr[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
softThresholdisfalse, a series of 0, 1, 2, 3 will make the Y axis show negative values according to theminPaddingoption. IfsoftThresholdistrue, the Y axis starts at 0.- Since
4.1.9
-
val
states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]]
A wrapper object for all the series options in specific states.
-
val
stickyTracking: UndefOr[Boolean]
Sticky tracking of mouse events.
Sticky tracking of mouse events. When true, the
mouseOutevent on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, themouseOutevent on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. WhenstickyTrackingis false andtooltip.sharedis 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.- Since
2.0
Example: -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
val
threshold: UndefOr[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: UndefOr[CleanJsObject[PlotOptionsWaterfallTooltip]]
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: UndefOr[|[String, Object]]
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.
In styled mode, the waterfall colors can be set with the
.highcharts-point-negative,.highcharts-sumand.highcharts-intermediate-sumclasses.Example: -
def
valueOf(): Any
- Definition Classes
- Object
-
val
visible: UndefOr[Boolean]
Set the initial visibility of the series.
Set the initial visibility of the series.
-
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: UndefOr[String]
Defines the Axis on which the zones are applied.
Defines the Axis on which the zones are applied.
- Since
4.1.0
Example: -
val
zones: UndefOr[Array[CleanJsObject[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
zoneAxisoption.In styled mode, the color zones are styled with the
.highcharts-zone-{n}class, or custom classed from theclassNameoption (view live demo).- Since
4.1.0
Example: