Class PlotOptionsColumnrange
- All Implemented Interfaces:
Serializable
highcharts-more.js. To display
horizontal bars, set chart.inverted to
true.- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds color to the colors arrayvoidAdds key to the keys arrayvoidAdds zone to the zones arraygetClip()getColor()Color[]getCrisp()getDepth()String[]getKeys()Zones[]getZones()voidremoveColor(Color color) Removes first occurrence of color in colors arrayvoidRemoves first occurrence of key in keys arrayvoidremoveZone(Zones zone) Removes first occurrence of zone in zones arrayvoidsetAllowPointSelect(Boolean allowPointSelect) Allow this series' points to be selected by clicking on the markers, bars or pie slices.voidsetAnimation(Boolean animation) Enable or disable the initial animation when a series is displayed.voidsetAnimationLimit(Number animationLimit) 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.voidsetBorderColor(Color borderColor) The color of the border surrounding each column or bar.voidsetBorderRadius(Number borderRadius) The corner radius of the border surrounding each column or bar.voidsetBorderWidth(Number borderWidth) The width of the border surrounding each column or bar.voidsetClassName(String className) A class name to apply to the series' graphical elements.voidDisable this option to allow series rendering in the whole plotting area.voidThe main color or the series.voidsetColorByPoint(Boolean colorByPoint) When using automatic point colors pulled from theoptions.colorscollection, this option determines whether the chart should receive one color per series or one color per point.voidsetColorIndex(Number colorIndex) Styled mode only.voidsetColorKey(String colorKey) Determines what data value should be used to calculate point color ifcolorAxisis used.voidA series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.voidsetCompare(Compare compare) Compare the values of the series against the first non-null, non-zero value in the visible range.voidsetCompareBase(Number compareBase) When compare ispercent, this option dictates whether to use 0 or 100 as the base of comparison.voidWhen true, each column edge is rounded to its nearest pixel in order to render sharp on screen.voidsetCropThreshold(Number cropThreshold) 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.voidYou 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.voidsetDataGrouping(DataGrouping dataGrouping) voidsetDataLabels(DataLabelsRange dataLabels) Extended data labels for range series types.voidDepth of the columns in a 3D column chart.voidsetDescription(String description) Requires Accessibility modulevoidsetEdgeColor(Color edgeColor) 3D columns only.voidsetEdgeWidth(Number edgeWidth) 3D columns only.voidsetEnableMouseTracking(Boolean enableMouseTracking) Enable or disable the mouse tracking for a specific series.voidsetExposeElementToA11y(Boolean exposeElementToA11y) By default, series are exposed to screen readers as regions.voidsetFindNearestPointBy(Dimension findNearestPointBy) Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.voidsetGapUnit(String gapUnit) Together withgapSize, this option defines where to draw gaps in the graph.voidsetGetExtremesFromAll(Boolean getExtremesFromAll) 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.voidsetGrouping(Boolean grouping) Whether to group non-stacked columns or to let them render independent of each other.voidsetGroupPadding(Number groupPadding) Padding between each value groups, in x axis units.voidsetGroupZPadding(Number groupZPadding) The spacing between columns on the Z Axis in a 3D chart.voidAn array specifying which option maps to which key in the data point array.voidsetLegendIndex(Number legendIndex) The sequential index of the series within the legend.voidsetLinkedTo(String linkedTo) The id of another series to link to.voidsetMaxPointWidth(Number maxPointWidth) The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.voidsetMinPointLength(Number minPointLength) The minimal height for a column or width for a bar.voidsetNavigatorOptions(PlotOptionsSeries navigatorOptions) Options for the corresponding navigator series ifshowInNavigatoristruefor this series.voidsetOpacity(Number opacity) Opacity of a series parts: line, fill (e.g.voidsetPointDescriptionFormatter(String _fn_pointDescriptionFormatter) voidsetPointInterval(Number pointInterval) If no x values are given for the points in a series, pointInterval defines the interval of the x values.voidsetPointIntervalUnit(IntervalUnit pointIntervalUnit) On datetime series, this allows for setting the pointInterval to irregular time units,day,monthandyear.voidsetPointPadding(Number pointPadding) Padding between each column or bar, in x axis units.voidsetPointPlacement(PointPlacement pointPlacement) Possible values:null,"on","between".voidsetPointRange(Number pointRange) The X axis range that each point is valid for.voidsetPointStart(Number pointStart) If no x values are given for the points in a series, pointStart defines on what value to start.voidsetPointStart(Instant instant) voidsetPointWidth(Number pointWidth) A pixel value specifying a fixed width for each column or bar.voidsetSelected(Boolean selected) Whether to select the series initially.voidWhether to apply a drop shadow to the graph line.voidsetShowCheckbox(Boolean showCheckbox) If true, a checkbox is displayed next to the legend item to allow selecting the series.voidsetShowInLegend(Boolean showInLegend) Whether to display this particular series or series type in the legend.voidsetShowInNavigator(Boolean showInNavigator) Whether or not to show the series in the navigator.voidsetSkipKeyboardNavigation(Boolean skipKeyboardNavigation) If set toTrue, the accessibility module will skip past the points in this series for keyboard navigation.voidA wrapper object for all the series options in specific states.voidsetStickyTracking(Boolean stickyTracking) Sticky tracking of mouse events.voidsetTooltip(SeriesTooltip tooltip) A configuration object for the tooltip rendering of each single series.voidsetTurboThreshold(Number turboThreshold) 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.voidsetVisible(Boolean visible) Set the initial visibility of the series.voidsetZoneAxis(ZoneAxis zoneAxis) Defines the Axis on which the zones are applied.voidAn array defining zones within a series.
-
Constructor Details
-
PlotOptionsColumnrange
public PlotOptionsColumnrange()
-
-
Method Details
-
getChartType
- Overrides:
getChartTypein classAbstractPlotOptions
-
getAllowPointSelect
- Specified by:
getAllowPointSelectin classColumnOptions- See Also:
-
setAllowPointSelect
Allow this series' points to be selected by clicking on the markers, bars or pie slices.Defaults to: false
- Specified by:
setAllowPointSelectin classColumnOptions
-
getAnimation
- Specified by:
getAnimationin classColumnOptions- See Also:
-
setAnimation
Enable or disable the initial animation when a series is displayed. Please note that this option only applies to the initial animation of the series itself. For other animations, seeChartModel.setAnimation(Boolean)- Specified by:
setAnimationin classColumnOptions
-
getAnimationLimit
- See Also:
-
setAnimationLimit
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, setanimationLimittoInfinity. -
getBorderColor
- Specified by:
getBorderColorin classColumnOptions- See Also:
-
setBorderColor
The color of the border surrounding each column or bar.
In styled mode, the border stroke can be set with the
.highcharts-pointrule.Defaults to: #ffffff
- Specified by:
setBorderColorin classColumnOptions
-
getBorderRadius
- Specified by:
getBorderRadiusin classColumnOptions- See Also:
-
setBorderRadius
The corner radius of the border surrounding each column or bar.Defaults to: 0
- Specified by:
setBorderRadiusin classColumnOptions
-
getBorderWidth
- Specified by:
getBorderWidthin classColumnOptions- See Also:
-
setBorderWidth
The width of the border surrounding each column or bar.
In styled mode, the stroke width can be set with the
.highcharts-pointrule.Defaults to: 1
- Specified by:
setBorderWidthin classColumnOptions
-
getClip
- Specified by:
getClipin classColumnOptions- See Also:
-
setClip
Disable this option to allow series rendering in the whole plotting area. Note that clipping should be always enabled when chart.zoomType is setDefaults to
true.- Specified by:
setClipin classColumnOptions
-
getClassName
- See Also:
-
setClassName
A class name to apply to the series' graphical elements. -
getColor
- See Also:
-
setColor
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.colorsarray.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}-seriesor.highcharts-series-{n}class, or individual classes given by theclassNameoption. -
getColorByPoint
- Specified by:
getColorByPointin classColumnOptions- See Also:
-
setColorByPoint
When using automatic point colors pulled from theoptions.colorscollection, this option determines whether the chart should receive one color per series or one color per point.Defaults to: false
- Specified by:
setColorByPointin classColumnOptions
-
getColorKey
- Specified by:
getColorKeyin classColumnOptions- See Also:
-
setColorKey
Determines what data value should be used to calculate point color ifcolorAxisis used. Requires to setminandmaxif some custom point property is used or if approximation for data grouping is set to'sum'.Defaults to
y.- Specified by:
setColorKeyin classColumnOptions
-
getColorIndex
- See Also:
-
setColorIndex
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class namehighcharts-color-{n}. -
getColors
- Specified by:
getColorsin classColumnOptions- See Also:
-
setColors
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.- Specified by:
setColorsin classColumnOptions
-
addColor
Adds color to the colors array- Specified by:
addColorin classColumnOptions- Parameters:
color- to add- See Also:
-
removeColor
Removes first occurrence of color in colors array- Specified by:
removeColorin classColumnOptions- Parameters:
color- to remove- See Also:
-
getCrisp
- Specified by:
getCrispin classColumnOptions- See Also:
-
setCrisp
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, settingcrisptofalsemay look better, even though each column is rendered blurry.Defaults to: true
- Specified by:
setCrispin classColumnOptions
-
getCropThreshold
- See Also:
-
setCropThreshold
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. .Defaults to: 50
-
getCursor
- Specified by:
getCursorin classColumnOptions- See Also:
-
setCursor
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.- Specified by:
setCursorin classColumnOptions
-
getDataLabels
- See Also:
-
setDataLabels
Extended data labels for range series types. Range series data labels have noxandyoptions. Instead, they havexLow,xHigh,yLowandyHighoptions to allow the higher and lower data label sets individually. -
getDepth
- Specified by:
getDepthin classColumnOptions- See Also:
-
setDepth
Depth of the columns in a 3D column chart. Requireshighcharts-3d.js.Defaults to: 25
- Specified by:
setDepthin classColumnOptions
-
getDescription
- See Also:
-
setDescription
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
Defaults to: undefined
-
getEdgeColor
- Specified by:
getEdgeColorin classColumnOptions- See Also:
-
setEdgeColor
3D columns only. The color of the edges. Similar toborderColor, except it defaults to the same color as the column.- Specified by:
setEdgeColorin classColumnOptions
-
getEdgeWidth
- Specified by:
getEdgeWidthin classColumnOptions- See Also:
-
setEdgeWidth
3D columns only. The width of the colored edges.Defaults to: 1
- Specified by:
setEdgeWidthin classColumnOptions
-
getEnableMouseTracking
- Specified by:
getEnableMouseTrackingin classColumnOptions- See Also:
-
setEnableMouseTracking
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.Defaults to: true
- Specified by:
setEnableMouseTrackingin classColumnOptions
-
getExposeElementToA11y
- See Also:
-
setExposeElementToA11y
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.
Defaults to: undefined
-
getFindNearestPointBy
- See Also:
-
setFindNearestPointBy
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.
-
getGetExtremesFromAll
- Specified by:
getGetExtremesFromAllin classColumnOptions- See Also:
-
setGetExtremesFromAll
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.Defaults to: false
- Specified by:
setGetExtremesFromAllin classColumnOptions
-
getGroupPadding
- Specified by:
getGroupPaddingin classColumnOptions- See Also:
-
setGroupPadding
Padding between each value groups, in x axis units.Defaults to: 0.2
- Specified by:
setGroupPaddingin classColumnOptions
-
getGroupZPadding
- Specified by:
getGroupZPaddingin classColumnOptions- See Also:
-
setGroupZPadding
The spacing between columns on the Z Axis in a 3D chart. Requireshighcharts-3d.js.Defaults to: 1
- Specified by:
setGroupZPaddingin classColumnOptions
-
getGrouping
- Specified by:
getGroupingin classColumnOptions- See Also:
-
setGrouping
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.Defaults to: true
- Specified by:
setGroupingin classColumnOptions
-
getKeys
- Specified by:
getKeysin classColumnOptions- See Also:
-
setKeys
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.- Specified by:
setKeysin classColumnOptions
-
addKey
Adds key to the keys array- Specified by:
addKeyin classColumnOptions- Parameters:
key- to add- See Also:
-
removeKey
Removes first occurrence of key in keys array- Specified by:
removeKeyin classColumnOptions- Parameters:
key- to remove- See Also:
-
getLinkedTo
- Specified by:
getLinkedToin classColumnOptions- See Also:
-
setLinkedTo
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.- Specified by:
setLinkedToin classColumnOptions
-
getOpacity
- Specified by:
getOpacityin classColumnOptions- See Also:
-
setOpacity
Opacity of a series parts: line, fill (e.g. area) and dataLabels.Defaults to
1.- Specified by:
setOpacityin classColumnOptions
-
getMaxPointWidth
- Specified by:
getMaxPointWidthin classColumnOptions- See Also:
-
setMaxPointWidth
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.Defaults to: null
- Specified by:
setMaxPointWidthin classColumnOptions
-
getMinPointLength
- Specified by:
getMinPointLengthin classColumnOptions- See Also:
-
setMinPointLength
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.Defaults to: 0
- Specified by:
setMinPointLengthin classColumnOptions
-
getPointDescriptionFormatter
-
setPointDescriptionFormatter
-
getPointInterval
- Specified by:
getPointIntervalin classColumnOptions- See Also:
-
setPointInterval
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
pointIntervalUnitto draw irregular intervals.Defaults to: 1
- Specified by:
setPointIntervalin classColumnOptions
-
getPointIntervalUnit
- Specified by:
getPointIntervalUnitin classColumnOptions- See Also:
-
setPointIntervalUnit
On datetime series, this allows for setting the pointInterval to irregular time units,day,monthandyear. 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 withpointIntervalto draw weeks, quarters, 6 months, 10 years etc.- Specified by:
setPointIntervalUnitin classColumnOptions
-
getPointPadding
- Specified by:
getPointPaddingin classColumnOptions- See Also:
-
setPointPadding
Padding between each column or bar, in x axis units.Defaults to: 0.1
- Specified by:
setPointPaddingin classColumnOptions
-
getPointPlacement
- Specified by:
getPointPlacementin classColumnOptions- See Also:
-
setPointPlacement
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
nullin cartesian charts,"between"in polar charts.- Specified by:
setPointPlacementin classColumnOptions
-
getPointRange
- Specified by:
getPointRangein classColumnOptions- See Also:
-
setPointRange
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.- Specified by:
setPointRangein classColumnOptions
-
getPointStart
- Specified by:
getPointStartin classColumnOptions- See Also:
-
setPointStart
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.Defaults to: 0
- Specified by:
setPointStartin classColumnOptions
-
getPointWidth
- Specified by:
getPointWidthin classColumnOptions- See Also:
-
setPointWidth
A pixel value specifying a fixed width for each column or bar. Whennull, the width is calculated from thepointPaddingandgroupPadding.- Specified by:
setPointWidthin classColumnOptions
-
getSelected
- Specified by:
getSelectedin classColumnOptions- See Also:
-
setSelected
Whether to select the series initially. IfshowCheckboxis true, the checkbox next to the series name will be checked for a selected series.Defaults to: false
- Specified by:
setSelectedin classColumnOptions
-
getShadow
- Specified by:
getShadowin classColumnOptions- See Also:
-
setShadow
Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containingcolor,offsetX,offsetY,opacityandwidth.Defaults to: false
- Specified by:
setShadowin classColumnOptions
-
getShowCheckbox
- Specified by:
getShowCheckboxin classColumnOptions- See Also:
-
setShowCheckbox
If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by theselectedoption.Defaults to: false
- Specified by:
setShowCheckboxin classColumnOptions
-
getShowInLegend
- Specified by:
getShowInLegendin classColumnOptions- See Also:
-
setShowInLegend
Whether to display this particular series or series type in the legend. The default value istruefor standalone series,falsefor linked series.Defaults to: true
- Specified by:
setShowInLegendin classColumnOptions
-
getStates
- Specified by:
getStatesin classColumnOptions- See Also:
-
setStates
A wrapper object for all the series options in specific states.- Specified by:
setStatesin classColumnOptions
-
getStickyTracking
- Specified by:
getStickyTrackingin classColumnOptions- See Also:
-
setStickyTracking
Sticky tracking of mouse events. When true, themouseOutevent on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, themouseOutevent on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. WhenstickyTrackingis false andtooltip.sharedis 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.Defaults to: true
- Specified by:
setStickyTrackingin classColumnOptions
-
getTooltip
- Specified by:
getTooltipin classColumnOptions- See Also:
-
setTooltip
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.- Specified by:
setTooltipin classColumnOptions
-
getTurboThreshold
- See Also:
-
setTurboThreshold
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 to0disable.Defaults to: 1000
-
getVisible
- Specified by:
getVisiblein classColumnOptions- See Also:
-
setVisible
Set the initial visibility of the series.Defaults to: true
- Specified by:
setVisiblein classColumnOptions
-
getZoneAxis
- Specified by:
getZoneAxisin classColumnOptions- See Also:
-
setZoneAxis
Defines the Axis on which the zones are applied.Defaults to: y
- Specified by:
setZoneAxisin classColumnOptions
-
getZones
- Specified by:
getZonesin classColumnOptions- See Also:
-
setZones
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
zoneAxisoption.In styled mode, the color zones are styled with the
.highcharts-zone-{n}class, or custom classed from theclassNameoption (view live demo).- Specified by:
setZonesin classColumnOptions
-
addZone
Adds zone to the zones array- Specified by:
addZonein classColumnOptions- Parameters:
zone- to add- See Also:
-
removeZone
Removes first occurrence of zone in zones array- Specified by:
removeZonein classColumnOptions- Parameters:
zone- to remove- See Also:
-
getCompare
- See Also:
-
setCompare
Compare the values of the series against the first non-null, non-zero value in the visible range. The y axis will show percentage or absolute change depending on whethercompareis set to"percent"or"value". When this is applied to multiple series, it allows comparing the development of the series against each other.Defaults to: undefined
-
getCompareBase
- See Also:
-
setCompareBase
When compare ispercent, this option dictates whether to use 0 or 100 as the base of comparison.Defaults to: 0
-
getDataGrouping
- See Also:
-
setDataGrouping
-
getGapUnit
- See Also:
-
setGapUnit
Together withgapSize, this option defines where to draw gaps in the graph.Defaults to: relative
-
getLegendIndex
- See Also:
-
setLegendIndex
The sequential index of the series within the legend.Defaults to: 0
-
setPointStart
- Specified by:
setPointStartin classColumnOptions- See Also:
-