SeriesErrorbar

Instance Constructors

new SeriesErrorbar()

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.
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 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 animationLimit to Infinity.
final def asInstanceOf[T0]: T0

Definition Classes
Any
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 of the bars.
The main color of the bars. This can be overridden by stemColor and whiskerColor individually.
Example:
1. Error bar styling
Since
3.0
val colorByPoint: UndefOr[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 colorIndex: UndefOr[Double]

Styled mode only.
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.

Since
5.0.0
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 crisp: UndefOr[Boolean]

When true, each column edge is rounded to its nearest pixel in order to render sharp on screen.
When true, each column edge is rounded to its nearest pixel in order to render sharp on screen. In some cases, when there are a lot of densely packed columns, this leads to visible difference in column widths or distance between columns. In these cases, setting crisp to false may look better, even though each column is rendered blurry.
Example:
1. Crisp is false.
Since
5.0.10
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.
Example:
1. Pointer cursor on line graph, on columns, on scatter markers
val data: UndefOr[Array[|[CleanJsObject[SeriesErrorbarData], Array[Any]]]]

An array of data points for the series.
An array of data points for the series. For the errorbar series type, points can be given in the following ways:
-
An array of arrays with 3 or 2 values. In this case, the values correspond to x,low,high. If the first value is a string, it is applied as the name of the point, and the x value is inferred. The x value can also be omitted, in which case the inner arrays should be of length 2. Then the x value is automatically calculated, either starting at 0 and incremented by 1, or from pointStart and pointInterval given in the series options.
```
data: [
    [0, 10, 2],
    [1, 1, 8],
    [2, 4, 5]
]
```
-
An array of objects with named values. The objects are point configuration objects as seen below. If the total number of data points exceeds the series' turboThreshold, this option is not available.
```
data: [{
    x: 1,
    low: 0,
    high: 0,
    name: "Point2",
    color: "#00FF00"
}, {
    x: 1,
    low: 5,
    high: 5,
    name: "Point1",
    color: "#FF00FF"
}]
```
Example:
1. The demos use a line series, but the principle is the same for all types.
  Numerical values
  Arrays of numeric x and y
  Arrays of datetime x and y
  Arrays of point.name and y
  Config objects
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.
Example:
1. Basic 3D column chart
Since
4.0
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.
Example:
1. Accessible stock chart
Since
5.0.0
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:
1. No mouse tracking
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
val events: UndefOr[CleanJsObject[SeriesErrorbarEvents]]
val exposeElementToA11y: UndefOr[Boolean]

By default, series are exposed to screen readers as regions.
By default, series are exposed to screen readers as regions. By enabling this option, the series element itself will be exposed in the same way as the data points. This is useful if the series is not used as a grouping entity in the chart, but you still want to attach a description to the series.
Requires the Accessibility module.
Example:
1. Accessible data visualization
Since
5.0.12
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val findNearestPointBy: UndefOr[String]

Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.
Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to 'xy' for scatter series and 'x' for most other series. If the data has duplicate x-values, it is recommended to set this to 'xy' to allow hovering over all points.
Applies only to series types using nearest neighbor search (not direct hover) for tooltip.
Example:
1. Different hover behaviors
Since
5.0.10
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 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
def hasOwnProperty(v: String): Boolean

Definition Classes
Object
def hashCode(): Int

Definition Classes
AnyRef → Any
val id: UndefOr[String]

An id for the series.
An id for the series. This can be used after render time to get a pointer to the series object through chart.get().
Example:
1. Get series by id
Since
1.2.0
val index: UndefOr[Double]

The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.
The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.

Since
2.3.0
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.
Example:
1. An extended data array with keys
Since
4.1.6
val legendIndex: UndefOr[Double]

The sequential index of the series in the legend.
The sequential index of the series in the legend.
Try it: Legend in opposite order .
val lineWidth: UndefOr[Double]

The width of the line surrounding the box.
The width of the line surrounding the box. If any of stemWidth, medianWidth or whiskerWidth are null, the lineWidth also applies to these lines.
Example:
1. Box plot styling, error bar styling
Since
3.0
val linkedTo: UndefOr[String]

The parent series of the error bar.
The parent series of the error bar. The default value links it to the previous series. Otherwise, use the id of the parent series.

Since
3.0
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.
Example:
1. Limited to 50
Since
4.1.8
val name: UndefOr[String]

The name of the series as shown in the legend, tooltip etc.
The name of the series as shown in the legend, tooltip etc.
Example:
1. Series name
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val negativeColor: UndefOr[|[String, Object]]

The color for the parts of the graph or points that are below the threshold.
The color for the parts of the graph or points that are below the threshold.
Example:
1. Spline, area and column - arearange.
Since
3.0
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val point: UndefOr[CleanJsObject[SeriesErrorbarPoint]]

Properties for each single point
val pointDescriptionFormatter: UndefOr[Function]

Same as accessibility.pointDescriptionFormatter, but for an individual series.
Same as accessibility.pointDescriptionFormatter, but for an individual series. Overrides the chart wide configuration.

Since
5.0.12
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 pointIntervalUnit to draw irregular intervals.
Example:
1. Datetime X axis
val pointIntervalUnit: UndefOr[String]

On datetime series, this allows for setting the pointInterval to irregular time units, day, month and year.
On datetime series, this allows for setting the pointInterval to irregular time units, day, month and year. 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 with pointInterval to draw weeks, quarters, 6 months, 10 years etc.
Example:
1. One point a month
Since
4.1.0
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:
1. 0.1 by default, 0.25, 0 for tightly packed columns,
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 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: 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.
Example:
1. Set the point range to one day on a data set with one week between the 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.
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: 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 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: UndefOr[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 skipKeyboardNavigation: UndefOr[Boolean]

If set to True, the accessibility module will skip past the points in this series for keyboard navigation.
If set to True, the accessibility module will skip past the points in this series for keyboard navigation.

Since
5.0.12
val states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]]

A wrapper object for all the series options in specific states.
val stemColor: UndefOr[|[String, Object]]

The color of the stem, the vertical line extending from the box to the whiskers.
The color of the stem, the vertical line extending from the box to the whiskers. If null, the series color is used.
Example:
1. Box plot styling, error bar styling
Since
3.0
val stemDashStyle: UndefOr[String]

The dash style of the stem, the vertical line extending from the box to the whiskers.
The dash style of the stem, the vertical line extending from the box to the whiskers.
Example:
1. Box plot styling, error bar styling
Since
3.0
val stemWidth: UndefOr[Double]

The width of the stem, the vertical line extending from the box to the whiskers.
The width of the stem, the vertical line extending from the box to the whiskers. If null, the width is inherited from the lineWidth option.
Example:
1. Box plot styling, error bar styling
Since
3.0
val stickyTracking: UndefOr[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
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
val tooltip: UndefOr[CleanJsObject[SeriesErrorbarTooltip]]

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 turboThreshold: UndefOr[Double]

When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed.
When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed. Also, only the first point is tested, and the rest are assumed to be the same format. This saves expensive data checking and indexing in long series. Set it to 0 disable.

Since
2.2
val type: String

The type of series.
The type of series. Can be one of area, areaspline, bar, column, line, pie, scatter or spline. From version 2.3, arearange, areasplinerange and columnrange are supported with the highcharts-more.js component.
Example:
1. Line and column in the same chart
def valueOf(): Any

Definition Classes
Object
val visible: UndefOr[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 whiskerColor: UndefOr[|[String, Object]]

The color of the whiskers, the horizontal lines marking low and high values.
The color of the whiskers, the horizontal lines marking low and high values. When null, the general series color is used.
Example:
1. Box plot styling
Since
3.0
val whiskerLength: UndefOr[|[Double, String]]

The length of the whiskers, the horizontal lines marking low and high values.
The length of the whiskers, the horizontal lines marking low and high values. It can be a numerical pixel value, or a percentage value of the box width. Set 0 to disable whiskers.
Example:
1. True by default
Since
3.0
val whiskerWidth: UndefOr[Double]

The line width of the whiskers, the horizontal lines marking low and high values.
The line width of the whiskers, the horizontal lines marking low and high values. When null, the general lineWidth applies.
Example:
1. Error bar styling
Since
3.0
val xAxis: UndefOr[|[Double, String]]

When using dual or multiple x axes, this number defines which xAxis the particular series is connected to.
When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first.
val yAxis: UndefOr[|[Double, String]]

When using dual or multiple y axes, this number defines which yAxis the particular series is connected to.
When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first.
Example:
1. Apply the column series to the secondary Y axis
val zIndex: UndefOr[Double]

Define the visual z index of the series.
Define the visual z index of the series.
Example:
1. With no z index, the series defined last are on top, with a z index, the series with the highest z index is on top.
val zoneAxis: UndefOr[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: UndefOr[Array[CleanJsObject[SeriesErrorbarZones]]]

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.
In styled mode, the color zones are styled with the .highcharts-zone-{n} class, or custom classed from the className option (view live demo).
Example:
1. Color zones
Since
4.1.0

Related Docs: object SeriesErrorbar | package config

class SeriesErrorbar extends Object

Instance Constructors

new SeriesErrorbar()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val allowPointSelect: UndefOr[Boolean]

val animationLimit: UndefOr[Double]

final def asInstanceOf[T0]: T0

val className: UndefOr[String]

def clone(): AnyRef

val color: UndefOr[|[String, Object]]

val colorByPoint: UndefOr[Boolean]

val colorIndex: UndefOr[Double]

val colors: UndefOr[Array[|[String, Object]]]

val crisp: UndefOr[Boolean]

val cursor: UndefOr[String]

val data: UndefOr[Array[|[CleanJsObject[SeriesErrorbarData], Array[Any]]]]

val depth: UndefOr[Double]

val description: UndefOr[String]

val edgeColor: UndefOr[|[String, Object]]

val edgeWidth: UndefOr[Double]

val enableMouseTracking: UndefOr[Boolean]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

val events: UndefOr[CleanJsObject[SeriesErrorbarEvents]]

val exposeElementToA11y: UndefOr[Boolean]

def finalize(): Unit

val findNearestPointBy: UndefOr[String]

final def getClass(): Class[_]

val getExtremesFromAll: UndefOr[Boolean]

val groupZPadding: UndefOr[Double]

def hasOwnProperty(v: String): Boolean

def hashCode(): Int

val id: UndefOr[String]

val index: UndefOr[Double]

final def isInstanceOf[T0]: Boolean

def isPrototypeOf(v: Object): Boolean

val keys: UndefOr[Array[String]]

val legendIndex: UndefOr[Double]

val lineWidth: UndefOr[Double]

val linkedTo: UndefOr[String]

val maxPointWidth: UndefOr[Double]

val name: UndefOr[String]

final def ne(arg0: AnyRef): Boolean

val negativeColor: UndefOr[|[String, Object]]

final def notify(): Unit

final def notifyAll(): Unit

val point: UndefOr[CleanJsObject[SeriesErrorbarPoint]]

val pointDescriptionFormatter: UndefOr[Function]

val pointInterval: UndefOr[Double]

val pointIntervalUnit: UndefOr[String]

val pointPadding: UndefOr[Double]

val pointPlacement: UndefOr[|[String, Double]]

val pointRange: UndefOr[Double]

val pointStart: UndefOr[Double]

val pointWidth: UndefOr[Double]

def propertyIsEnumerable(v: String): Boolean

val selected: UndefOr[Boolean]

val skipKeyboardNavigation: UndefOr[Boolean]

val states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]]

val stemColor: UndefOr[|[String, Object]]

val stemDashStyle: UndefOr[String]

val stemWidth: UndefOr[Double]

val stickyTracking: UndefOr[Boolean]

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

def toLocaleString(): String

def toString(): String

val tooltip: UndefOr[CleanJsObject[SeriesErrorbarTooltip]]

val turboThreshold: UndefOr[Double]

val type: String

def valueOf(): Any

val visible: UndefOr[Boolean]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

val whiskerColor: UndefOr[|[String, Object]]