PlotOptionsCandlestick
Related Docs:
class PlotOptionsCandlestick
| package config
Allow this series' points to be selected by clicking on the markers or bars.
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>.
Math object. See the easing demo.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.
A class name to apply to the series' graphical elements.
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 color can be defined by the colorIndex option. Also, 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.
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
When compare is percent, this option dictates whether to use 0 or 100 as the base of comparison.
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. .
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.
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).
Requires Accessibility module. A description of the series to add to the screen reader information about the 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.
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.
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.
Together with gapSize, this option defines where to draw gaps in the graph.
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.
Padding between each value groups, in x axis units.
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.
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.
The sequential index of the series within the legend.
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.
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.
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.
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.
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.
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.
The color for the parts of the graph or points that are below the threshold.
Properties for each single point
Same as accessibility.pointDescriptionFormatter, but for an individual series. Overrides the chart wide configuration.
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.
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.
Padding between each column or bar, in x axis units.
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.
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.
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).
A pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the pointPadding and groupPadding.
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.
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.
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.
Whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.
Whether or not to show the series in the navigator. Takes precedence over navigator.baseSeries if defined.
If set to True, the accessibility module will skip past the points in this series for keyboard navigation.
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.
A wrapper object for all the series options in specific states.
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.
The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.
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.
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.
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.
The specific line color for up candle sticks. The default is to inherit the general lineColor setting.
Set the initial visibility of the series.
Defines the Axis on which the zones are applied.
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).