io.udash.wrappers.highcharts.config.series
CandleLikeSeries
Related Doc:
package series
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.
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>
Math object. See the easing demo.Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
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.
A class name to apply to the series' graphical elements.
A class name to apply to the series' graphical elements.
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.
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.
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.
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. Defaults to true.
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
An array of data points for the series.
An array of data points for the series. For the area series type, points can be given in the following ways:
y options. The x values will be automatically calculated,
either starting at 0 and incremented by 1, or from pointStart
and pointInterval given in the series options. If the axis
has categories, these will be used. Example:
data: [0, 5, 3, 5]
-
An array of arrays with 2 values. In this case, the values correspond to x,y. If the first value is a string, it is
applied as the name of the point, and the x value is inferred.
data: [ [0, 9], [1, 7], [2, 6] ]
-
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,
y: 9,
name: "Point2",
color: "#00FF00"
}, {
x: 1,
y: 6,
name: "Point1",
color: "#FF00FF"
}]
The demos use a line series, but the principle is the same for all types.
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).
Depth of the columns in a 3D column chart.
Depth of the columns in a 3D column chart. Requires highcharts-3d.js.
Requires Accessibility module
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
3D columns only.
3D columns only. The color of the edges. Similar to borderColor, except it defaults to the same color as the column.
3D columns only.
3D columns only. The width of the colored edges.
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.
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.
Padding between each value groups, in x axis units.
Padding between each value groups, in x axis units.
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.
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().
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.
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.
The sequential index of the series in the legend.
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.
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.
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.
The name of the series as shown in the legend, tooltip etc.
The name of the series as shown in the legend, tooltip etc.
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.
Properties for each single point
Properties for each single point
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.
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.
Padding between each column or bar, in x axis units.
Padding between each column or bar, in x axis units.
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.
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.
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.
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.
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.
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.
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.
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.
A wrapper object for all the series options in specific states.
A wrapper object for all the series options in specific states.
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.
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.
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.
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.
A configuration object for the tooltip rendering of each single series.
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.
Set the initial visibility of the series.
Set the initial visibility of the series.
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.
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.
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.
When using dual or multiple x axes, this number defines which xAxis the particular series is connected to.
When using dual or multiple y axes, this number defines which yAxis the particular series is connected to.
Define the visual z index of the series.
Define the visual z index of the series.
Defines the Axis on which the zones are applied.
Defines the Axis on which the zones are applied.
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.