SeriesCandlestick

Companion object SeriesCandlestick

class SeriesCandlestick extends Object

Annotations: @RawJSType() @ScalaJSDefined()
Note: JavaScript name: series<candlestick>

Linear Supertypes

Object, Any, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

SeriesCandlestick
Object
Any
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new SeriesCandlestick()

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 or bars.
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 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. Slower animation, custom easing function.
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 series.
The main color of 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.
In styled mode, the series color can be set with the .highcharts-series, .highcharts-color-{n}, .highcharts-{type}-series or .highcharts-series-{n} class, or individual classes given by the className option.
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
1.3
val compareBase: UndefOr[Double]
When compare is percent, this option dictates whether to use 0 or 100 as the base of comparison.
When compare is percent, this option dictates whether to use 0 or 100 as the base of comparison.
Example:
1. Compare base is 100
Since
5.0.6
val cropThreshold: UndefOr[Double]
When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom.
When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series. .
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 on a line graph
val data: UndefOr[Array[|[CleanJsObject[SeriesCandlestickData], Array[Any]]]]
An array of data points for the series.
An array of data points for the series. For the candlestick series type, points can be given in the following ways:
-
An array of arrays with 5 or 4 values. In this case, the values correspond to x,open,high,low,close. 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 4. 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, 7, 2, 0, 4],
    [1, 1, 4, 2, 8],
    [2, 3, 3, 9, 3]
]
```
-
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,
    open: 9,
    high: 2,
    low: 4,
    close: 6,
    name: "Point2",
    color: "#00FF00"
}, {
    x: 1,
    open: 1,
    high: 4,
    low: 7,
    close: 7,
    name: "Point1",
    color: "#FF00FF"
}]
```
val dataGrouping: UndefOr[CleanJsObject[SeriesCandlestickDataGrouping]]
val dataLabels: UndefOr[CleanJsObject[SeriesCandlestickDataLabels]]
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-box and .highcharts-data-label class names (see 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.
Example:
1. Accessible stock chart
Since
5.0.0
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. When using shared tooltips (default in stock charts), mouse tracking is not required. For large datasets it improves performance.
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
val events: UndefOr[CleanJsObject[SeriesCandlestickEvents]]
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
2.1.6
val groupPadding: UndefOr[Double]
Padding between each value groups, in x axis units.
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.
Example:
1. Grouping disabled
Since
1.2.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().
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
1.2.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
2.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 lineColor: UndefOr[|[String, Object]]
The color of the line/border of the candlestick.
The color of the line/border of the candlestick.
In styled mode, the line stroke can be set with the .highcharts-candlestick-series .highcahrts-point rule.
Example:
1. Candlestick line colors
val lineWidth: UndefOr[Double]
The pixel width of the candlestick line/border.
The pixel width of the candlestick line/border. Defaults to 1.
In styled mode, the line stroke width can be set with the .highcharts-candlestick-series .highcahrts-point rule.
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.
Example:
1. Linked series
Since
1.3
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
2.1.8
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.
val name: UndefOr[String]
The name of the series as shown in the legend, tooltip etc.
val navigatorOptions: UndefOr[Object]
Options for the corresponding navigator series if showInNavigator is true for this series.
Options for the corresponding navigator series if showInNavigator is true for this series. Available options are the same as any series, documented at plotOptions and series.
These options are merged with options in navigator.series, and will take precedence if the same option is defined both places.

Since
5.0.0
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[SeriesCandlestickPoint]]
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 in milliseconds.
If no x values are given for the points in a series, pointInterval defines the interval of the x values in milliseconds. For example, if a series contains one value each day, set pointInterval to 24 * 3600 * 1000.
Since Highstock 2.1, it can be combined with pointIntervalUnit to draw irregular intervals.
Example:
1. Using pointStart and pointInterval
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
2.1.0
val pointPadding: UndefOr[Double]
Padding between each column or bar, in x axis units.
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
1.2.0
val pointRange: UndefOr[Double]
The width of each point on the x axis.
The width of each point on the x axis. For example in a column chart with one value each day, the pointRange would be 1 day (= 24 * 3600 * 1000 milliseconds). This is normally computed automatically, but this option can be used to override the automatic value. In a series on a categorized axis the pointRange is 1 by default.

Since
1.2
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. On a datetime X axis, the number will be given as milliseconds since 1970-01-01, for example Date.UTC(2011, 0, 1).
Example:
1. Using pointStart and pointInterval
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.
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 in the legend will be checked for a selected series.
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 1.1.7 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
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 selected option.
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 true for standalone series, false for linked series.
val showInNavigator: UndefOr[Boolean]
Whether or not to show the series in the navigator.
Whether or not to show the series in the navigator. Takes precedence over navigator.baseSeries if defined.
Example:
1. Multiple navigator series
Since
5.0.0
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 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
2.1.9
val stack: UndefOr[String]
This option allows grouping series in a stacked chart.
This option allows grouping series in a stacked chart. The stack option can be a string or a number or anything else, as long as the grouped series' stack options match each other.
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 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 not shared. When stickyTracking 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, candlesticks etc.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val threshold: UndefOr[Double]
The threshold, also called zero level or base level.
The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.
def toLocaleString(): String

Definition Classes
Object
def toString(): String

Definition Classes
AnyRef → Any
val tooltip: UndefOr[CleanJsObject[SeriesCandlestickTooltip]]
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.
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.
val type: String
The type of series.
The type of series. Can be one of area, areaspline, bar, column, line, pie, scatter, spline, candlestick or ohlc. From version 1.1.7, arearange, areasplinerange and columnrange are supported with the highcharts-more.js component.
val upColor: UndefOr[|[String, Object]]
The fill color of the candlestick when values are rising.
The fill color of the candlestick when values are rising.
In styled mode, the up color can be set with the .highcharts-candlestick-series .highcharts-point-up rule.
Example:
1. Custom colors, colors in styled mode.
val upLineColor: UndefOr[|[String, Object]]
The specific line color for up candle sticks.
The specific line color for up candle sticks. The default is to inherit the general lineColor setting.
Example:
1. Candlestick line colors
Since
1.3.6
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. Hidden 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 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.
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
2.1.0
val zones: UndefOr[Array[CleanJsObject[SeriesCandlestickZones]]]
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
2.1.0

Packages

SeriesCandlestick

Companion object SeriesCandlestick

class SeriesCandlestick extends Object

Instance Constructors

Value Members

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

SeriesCandlestick 

Companion object SeriesCandlestick

class SeriesCandlestick extends Object

Instance Constructors

Value Members

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped

SeriesCandlestick