Inherits BaseObject.
|
| PlotOptionsErrorbarAccessibility | Accessibility [get, set] |
| | Accessibility options for a series. More...
|
| |
| bool | AllowPointSelect [get, set] |
| | Allow this series' points to be selected by clicking on the graphic(columns, point markers, pie slices, map areas etc).The selected points can be handled by point select and unselectevents, or collectively by the getSelectedPoints function.And alternative way of selecting points is through dragging. More...
|
| |
| Animation | Animation [get, set] |
| | Enable or disable the initial animation when a series is displayed.The animation can also be set as a configuration object. Pleasenote that this option only applies to the initial animation of theseries itself. For other animations, see chart.animation and the animation parameter under the API methods.The following properties are supported:- defer: The animation delay time in milliseconds.- duration: The duration of the animation in milliseconds. (Defaults to 1000)- easing: Can be a string reference to an easing function set on the Math object or a function. See the Custom easing function demo below. (Defaults to easeInOutSine)Due to poor performance, animation is disabled in old IE browsersfor several chart types. More...
|
| |
| bool | AnimationBool [get, set] |
| | Enable or disable the initial animation when a series is displayed.The animation can also be set as a configuration object. Pleasenote that this option only applies to the initial animation of theseries itself. For other animations, see chart.animation and the animation parameter under the API methods.The following properties are supported:- defer: The animation delay time in milliseconds.- duration: The duration of the animation in milliseconds. (Defaults to 1000)- easing: Can be a string reference to an easing function set on the Math object or a function. See the Custom easing function demo below. (Defaults to easeInOutSine)Due to poor performance, animation is disabled in old IE browsersfor several chart types. More...
|
| |
| double | AnimationLimit [get, set] |
| | For some series, there is a limit that shuts down animationby default when the total number of points in the chart is too high.For example, for a column chart and its derivatives, animation doesnot run if there is more than 250 points totally. To disable thiscap, set animationLimit to Infinity. This option works if animationis fired on individual points, not on a group of points like e.g. duringthe initial animation. More...
|
| |
| Hashtable | BoxDashStyle [get, set] |
| | The dash style of the box. More...
|
| |
| bool | CenterInCategory [get, set] |
| | When true, the columns will center in the category, ignoring nullor missing points. When false, space will be reserved for null ormissing points. More...
|
| |
| string | ClassName [get, set] |
| | An additional class name to apply to the series' graphical elements.This option does not replace default class names of the graphicalelement. Changes to the series' color will also be reflected in achart's legend and tooltip. More...
|
| |
| bool | Clip [get, set] |
| | Disable this option to allow series rendering in the whole plottingarea.**Note:** Clipping should be always enabled whenchart.zoomType is set More...
|
| |
| string | Color [get, set] |
| | The main color of the bars. This can be overridden bystemColor andwhiskerColor individually. More...
|
| |
| string | ColorAxis [get, set] |
| | When using dual or multiple color axes, this number defines whichcolorAxis the particular series is connected to. It refers toeither theidor the index of the axis in the colorAxis array, with 0 being thefirst. Set this option to false to prevent a series from connectingto the default color axis.Since v7.2.0 the option can also be an axis id or an axis indexinstead of a boolean flag. More...
|
| |
| double | ColorAxisNumber [get, set] |
| | When using dual or multiple color axes, this number defines whichcolorAxis the particular series is connected to. It refers toeither theidor the index of the axis in the colorAxis array, with 0 being thefirst. Set this option to false to prevent a series from connectingto the default color axis.Since v7.2.0 the option can also be an axis id or an axis indexinstead of a boolean flag. More...
|
| |
| bool | ColorAxisBool [get, set] |
| | When using dual or multiple color axes, this number defines whichcolorAxis the particular series is connected to. It refers toeither theidor the index of the axis in the colorAxis array, with 0 being thefirst. Set this option to false to prevent a series from connectingto the default color axis.Since v7.2.0 the option can also be an axis id or an axis indexinstead of a boolean flag. More...
|
| |
| bool | ColorByPoint [get, set] |
| | When using automatic point colors pulled from the global[colors](colors) or series-specificplotOptions.column.colors collections, this optiondetermines whether the chart should receive one color per series orone color per point.In styled mode, the colors or series.colors arrays are notsupported, and instead this option gives the points individual colorclass names on the form highcharts-color-{n}. More...
|
| |
| double | ColorIndex [get, set] |
| | Styled mode only. A specific color index to use for the series, so itsgraphic representations are given the class name highcharts-color-{n}.Since v11, CSS variables on the form --highcharts-color-{n} makechanging the color scheme very convenient. More...
|
| |
| string | ColorKey [get, set] |
| | Determines what data value should be used to calculate point colorif colorAxis is used. Requires to set min and max if somecustom point property is used or if approximation for data groupingis set to ‘'sum’`. More...
|
| |
| List< string > | Colors [get, set] |
| | A series specific or series type specific color set to apply insteadof the global colors when colorByPoint is true. More...
|
| |
| bool | Crisp [get, set] |
| | When true, each point or column edge is rounded to its nearest pixelin order to render sharp on screen. In some cases, when there are alot of densely packed columns, this leads to visible differencein column widths or distance between columns. In these cases,setting crisp to false may look better, even though each columnis rendered blurry. More...
|
| |
| double | CropThreshold [get, set] |
| | When the series contains less points than the crop threshold, allpoints are drawn, even if the points fall outside the visible plotarea at the current zoom. The advantage of drawing all points(including markers and columns), is that animation is performed onupdates. On the other hand, when the series contains more points thanthe crop threshold, the series data is cropped to only contain pointsthat fall within the plot area. The advantage of cropping awayinvisible points is to increase performance on large series. More...
|
| |
| PlotOptionsErrorbarCursor | Cursor [get, set] |
| | You can set the cursor to "pointer" if you have click events attachedto the series, to signal to the user that the points and lines canbe clicked.In styled mode, the series cursor can be set with the same classesas listed under series.color. More...
|
| |
| Hashtable | Custom [get, set] |
| | A reserved subspace to store options and values for customizedfunctionality. Here you can add additional data for your own eventcallbacks and formatter callbacks. More...
|
| |
| PlotOptionsErrorbarDashStyle | DashStyle [get, set] |
| | Name of the dash style to use for the graph, or for some series typesthe outline of each shape.In styled mode, thestroke dash-arraycan be set with the same classes as listed underseries.color. More...
|
| |
| PlotOptionsErrorbarDataLabels | DataLabels [get, set] |
| | Options for the series data labels, appearing next to each datapoint.Since v6.2.0, multiple data labels can be applied to each singlepoint by defining them as an array of configs.In styled mode, the data labels can be styled with the<tt>.highcharts-data-label-box and .highcharts-data-label class names(see example). More...
|
| |
| PlotOptionsErrorbarDataSorting | DataSorting [get, set] |
| | Options for the series data sorting. More...
|
| |
| double | Depth [get, set] |
| | Depth of the columns in a 3D column chart. More...
|
| |
| string | Description [get, set] |
| | A description of the series to add to the screen reader informationabout the series. More...
|
| |
| PlotOptionsErrorbarDragDrop | DragDrop [get, set] |
| | The draggable-points module allows points to be moved around or modified inthe chart. In addition to the options mentioned under the dragDrop APIstructure, the module fires three events,point.dragStart,point.drag andpoint.drop. More...
|
| |
| string | EdgeColor [get, set] |
| | 3D columns only. The color of the edges. Similar to borderColor, except itdefaults to the same color as the column. More...
|
| |
| double | EdgeWidth [get, set] |
| | 3D columns only. The width of the colored edges. More...
|
| |
| bool | EnableMouseTracking [get, set] |
| | Enable or disable the mouse tracking for a specific series. Thisincludes point tooltips and click events on graphs and points. Forlarge datasets it improves performance. More...
|
| |
| PlotOptionsErrorbarEvents | Events [get, set] |
| | General event handlers for the series items. These event hooks canalso be attached to the series at run time using theHighcharts.addEvent function. More...
|
| |
| Object | FillColor [get, set] |
| | The fill color of the box.In styled mode, the fill color can be set with the<tt>.highcharts-boxplot-box class. More...
|
| |
| PlotOptionsErrorbarFindNearestPointBy | FindNearestPointBy [get, set] |
| | Determines whether the series should look for the nearest pointin both dimensions or just the x-dimension when hovering the series.Defaults to ‘'xy’for scatter series and'x'for most otherseries. If the data has duplicate x-values, it is recommended toset this to'xy'` to allow hovering over all points.Applies only to series types using nearest neighbor search (notdirect hover) for tooltip. More...
|
| |
| bool | GetExtremesFromAll [get, set] |
| | Whether to use the Y extremes of the total chart width or only thezoomed area when zooming in on parts of the X axis. By default, theY axis adjusts to the min and max of the visible data. Cartesianseries only. More...
|
| |
| bool | Grouping [get, set] |
| |
| double | GroupPadding [get, set] |
| | Padding between each value groups, in x axis units. More...
|
| |
| bool | InactiveOtherPoints [get, set] |
| | Highlight only the hovered point and fade the remaining points.Scatter-type series require enabling the 'inactive' marker state andadjusting opacity. Note that this approach could affect performancewith large datasets. More...
|
| |
| bool | IncludeInDataExport [get, set] |
| | When set to false will prevent the series data from being included inany form of data export.Since version 6.0.0 until 7.1.0 the option was existing undocumentedas includeInCSVExport. More...
|
| |
| List< string > | Keys [get, set] |
| | An array specifying which option maps to which key in the data pointarray. This makes it convenient to work with unstructured data arraysfrom different sources. More...
|
| |
| PlotOptionsErrorbarLabel | Label [get, set] |
| | Series labels are placed as close to the series as possible in anatural way, seeking to avoid other series. The goal of thisfeature is to make the chart more easily readable, like if ahuman designer placed the labels in the optimal position.The series labels currently work with series types having agraph or an area. More...
|
| |
| PlotOptionsErrorbarLegendSymbol | LegendSymbol [get, set] |
| | What type of legend symbol to render for this series. Can be one ofareaMarker, lineMarker or rectangle. More...
|
| |
| double | LineWidth [get, set] |
| | The width of the line surrounding the box. If any ofstemWidth,medianWidthor whiskerWidth are null,the lineWidth also applies to these lines. More...
|
| |
| string | LinkedTo [get, set] |
| | The parent series of the error bar. The default value links it tothe previous series. Otherwise, use the id of the parent series. More...
|
| |
| double | MaxPointWidth [get, set] |
| | The maximum allowed pixel width for a column, translated to theheight of a bar in a bar chart. This prevents the columns frombecoming too wide when there is a small number of points in thechart. More...
|
| |
| string | MedianColor [get, set] |
| | The color of the median line. If undefined, the general seriescolor applies.In styled mode, the median stroke width can be set with the<tt>.highcharts-boxplot-median class. More...
|
| |
| Hashtable | MedianDashStyle [get, set] |
| | The dash style of the median. More...
|
| |
| double | MedianWidth [get, set] |
| | The pixel width of the median line. If null, thelineWidth is used.In styled mode, the median stroke width can be set with the<tt>.highcharts-boxplot-median class. More...
|
| |
| double | MinPointLength [get, set] |
| | 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 stackedcolumn charts, minPointLength might not be respected for tightlypacked values. More...
|
| |
| string | NegativeColor [get, set] |
| | The color for the parts of the graph or points that are below thethreshold. Note that zones takesprecedence over the negative color. Using negativeColor isequivalent to applying a zone with value of 0. More...
|
| |
| PlotOptionsErrorbarOnPoint | OnPoint [get, set] |
| | Options for the Series on point feature. Only pie and sunburst seriesare supported at this moment. More...
|
| |
| double | Opacity [get, set] |
| | Opacity of a series parts: line, fill (e.g. area) and dataLabels. More...
|
| |
| PlotOptionsErrorbarPoint | Point [get, set] |
| | Properties for each single point. More...
|
| |
| string | PointDescriptionFormat [get, set] |
| | Same asaccessibility.point.descriptionFormat,but for an individual series. Overrides the chart wide configuration. More...
|
| |
| string | PointDescriptionFormatter [get, set] |
| | Same asaccessibility.series.descriptionFormatter,but for an individual series. Overrides the chart wide configuration. More...
|
| |
| double | PointInterval [get, set] |
| | If no x values are given for the points in a series, pointIntervaldefines the interval of the x values. For example, if a seriescontains one value every decade starting from year 0, setpointInterval to 10. In true datetime axes, the pointIntervalis set in milliseconds.It can be also be combined with pointIntervalUnit to draw irregulartime intervals.If combined with relativeXValue, an x value can be set on eachpoint, and the pointInterval is added x times to the pointStartsetting.Please note that this options applies to the series data, not theinterval of the axis ticks, which is independent. More...
|
| |
| PlotOptionsErrorbarPointIntervalUnit | PointIntervalUnit [get, set] |
| | On datetime series, this allows for setting thepointInterval to irregular timeunits, day, month and year. A day is usually the same as 24hours, but pointIntervalUnit also takes the DST crossover intoconsideration when dealing with local time. Combine this option withpointInterval to draw weeks, quarters, 6 months, 10 years etc.Please note that this options applies to the series data, not theinterval of the axis ticks, which is independent. More...
|
| |
| double | PointPadding [get, set] |
| | Padding between each column or bar, in x axis units. More...
|
| |
| PointPlacement | PointPlacement [get, set] |
| | Possible values: "on", "between", number.In a column chart, when pointPlacement is "on", the point will notcreate any padding of the X axis. In a polar column chart this meansthat the first column points directly north. If the pointPlacement is"between", the columns will be laid out between ticks. This isuseful for example for visualising an amount between two points intime 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 theprevious, and 0.5 is between this value and the next. Unlike thetextual options, numeric point placement options won't affect axispadding.Note that pointPlacement needs a pointRange to work. For column series this iscomputed, but for line-type series it needs to be set.For the xrange series type and gantt charts, if the Y axis is acategory axis, the pointPlacement applies to the Y axis rather thanthe (typically datetime) X axis.Defaults to undefined in cartesian charts, "between" in polarcharts. More...
|
| |
| double | PointRange [get, set] |
| | The X axis range that each point is valid for. This determines thewidth of the column. On a categorized axis, the range will be 1by default (one category unit). On linear and datetime axes, therange will be computed as the distance between the two closest datapoints.The default null means it is computed automatically, but thisoption can be used to override the automatic value.This option is set by default to 1 if data sorting is enabled. More...
|
| |
| double | PointStart [get, set] |
| | If no x values are given for the points in a series, pointStartdefines on what value to start. For example, if a series contains oneyearly value starting from 1945, set pointStart to 1945.If combined with relativeXValue, an x value can be set on eachpoint. The x value from the point options is multiplied bypointInterval and added to pointStart to produce a modified xvalue. More...
|
| |
| double | PointWidth [get, set] |
| | A pixel value specifying a fixed width for each column or bar point.When set to undefined, the width is calculated from thepointPadding and groupPadding. The width effects the dimensionthat is not based on the point value. For column series it is thehoizontal length and for bar series it is the vertical length. More...
|
| |
| bool | RelativeXValue [get, set] |
| | When true, X values in the data set are relative to the currentpointStart, pointInterval and pointIntervalUnit settings. Thisallows compression of the data for datasets with irregular X values.The real X values are computed on the formula f(x) = ax + b, wherea is the pointInterval (optionally with a time unit given bypointIntervalUnit), and b is the pointStart. More...
|
| |
| bool | Selected [get, set] |
| | Whether to select the series initially. If showCheckbox is true,the checkbox next to the series name in the legend will be checkedfor a selected series. More...
|
| |
| Shadow | Shadow [get, set] |
| | Whether to apply a drop shadow to the graph line. Since 2.3 theshadow can be an object configuration containing color, offsetX,offsetY, opacity and width.Note that in some cases, like stacked columns or other dense layouts, theseries may cast shadows on each other. In that case, thechart.seriesGroupShadow allows applying a common drop shadow to thewhole series group. More...
|
| |
| bool | ShadowBool [get, set] |
| | Whether to apply a drop shadow to the graph line. Since 2.3 theshadow can be an object configuration containing color, offsetX,offsetY, opacity and width.Note that in some cases, like stacked columns or other dense layouts, theseries may cast shadows on each other. In that case, thechart.seriesGroupShadow allows applying a common drop shadow to thewhole series group. More...
|
| |
| bool | ShowCheckbox [get, set] |
| | If true, a checkbox is displayed next to the legend item to allowselecting the series. The state of the checkbox is determined bythe selected option. More...
|
| |
| bool | ShowInLegend [get, set] |
| | Whether to display this particular series or series type in thelegend. Standalone series are shown in legend by default, and linkedseries are not. Since v7.2.0 it is possible to show series that usecolorAxis by setting this option to true. More...
|
| |
| bool | SkipKeyboardNavigation [get, set] |
| | If set to true, the accessibility module will skip past the pointsin this series for keyboard navigation. More...
|
| |
| bool | SoftThreshold [get, set] |
| | When this is true, the series will not cause the Y axis to crossthe 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 theminPadding option. If softThreshold is true, the Y axis startsat 0. More...
|
| |
| PlotOptionsErrorbarSonification | Sonification [get, set] |
| | Sonification/audio chart options for a series. More...
|
| |
| PlotOptionsErrorbarStacking | Stacking [get, set] |
| | Whether to stack the values of each series on top of each other.Possible values are undefined to disable, "normal" to stack byvalue or "percent".When stacking is enabled, data must be sortedin ascending X order.Some stacking options are related to specific series types. In thestreamgraph series type, the stacking option is set to "stream".The second one is "overlap", which only applies to waterfallseries. More...
|
| |
| PlotOptionsErrorbarStates | States [get, set] |
| |
| string | StemColor [get, set] |
| | The color of the stem, the vertical line extending from the box tothe whiskers. If undefined, the series color is used.In styled mode, the stem stroke can be set with the<tt>.highcharts-boxplot-stem class. More...
|
| |
| Hashtable | StemDashStyle [get, set] |
| | The dash style of the stem, the vertical line extending from thebox to the whiskers. More...
|
| |
| double | StemWidth [get, set] |
| | The width of the stem, the vertical line extending from the box tothe whiskers. If undefined, the width is inherited from thelineWidth option.In styled mode, the stem stroke width can be set with the<tt>.highcharts-boxplot-stem class. More...
|
| |
| bool | StickyTracking [get, set] |
| | Sticky tracking of mouse events. When true, the mouseOut event on aseries isn't triggered until the mouse moves over another series, orout of the plot area. When false, the mouseOut event on a series istriggered when the mouse leaves the area around the series' graph ormarkers. This also implies the tooltip when not shared. WhenstickyTracking is false and tooltip.shared is false, the tooltipwill be hidden when moving the mouse between series. Defaults to truefor line and area type series, but to false for columns, pies etc.**Note:** The boost module will force this option because oftechnical limitations. More...
|
| |
| double | Threshold [get, set] |
| | The threshold, also called zero level or base level. For line typeseries this is only used in conjunction withnegativeColor. More...
|
| |
| PlotOptionsErrorbarTooltip | Tooltip [get, set] |
| |
| double | TurboThreshold [get, set] |
| | When a series contains a data array that is longer than this, onlyone dimensional arrays of numbers, or two dimensional arrays withx and y values are allowed. Also, only the first point is tested,and the rest are assumed to be the same format. This saves expensivedata checking and indexing in long series. Set it to 0 disable.Note:In boost mode turbo threshold is forced. Only array of numbers ortwo dimensional arrays are allowed. More...
|
| |
| bool | Visible [get, set] |
| | Set the initial visibility of the series. More...
|
| |
| string | WhiskerColor [get, set] |
| | The color of the whiskers, the horizontal lines marking low and highvalues. When undefined, the general series color is used.In styled mode, the whisker stroke can be set with the<tt>.highcharts-boxplot-whisker class . More...
|
| |
| Hashtable | WhiskerDashStyle [get, set] |
| | The dash style of the whiskers. More...
|
| |
| string | WhiskerLength [get, set] |
| | The length of the whiskers, the horizontal lines marking low andhigh values. It can be a numerical pixel value, or a percentagevalue of the box width. Set 0 to disable whiskers. More...
|
| |
| double | WhiskerLengthNumber [get, set] |
| | The length of the whiskers, the horizontal lines marking low andhigh values. It can be a numerical pixel value, or a percentagevalue of the box width. Set 0 to disable whiskers. More...
|
| |
| double | WhiskerWidth [get, set] |
| | The line width of the whiskers, the horizontal lines markinglow and high values. When null, the generallineWidth applies. More...
|
| |
| string | ZoneAxis [get, set] |
| | Defines the Axis on which the zones are applied. More...
|
| |
| List< PlotOptionsErrorbarZone > | Zones [get, set] |
| | An array defining zones within a series. Zones can be applied to theX axis, Y axis or Z axis for bubbles, according to the zoneAxisoption. The zone definitions have to be in ascending order regardingto the value.In styled mode, the color zones are styled with the<tt>.highcharts-zone-{n} class, or custom classed from the classNameoption(view live demo). More...
|
| |
|
Hashtable | CustomFields [get, set] |
| |
1.8.14