public class PlotOptionsColumnrange extends ColumnOptions
highcharts-more.js. To display
horizontal bars, set chart.inverted to
true.| Constructor and Description |
|---|
PlotOptionsColumnrange() |
| Modifier and Type | Method and Description |
|---|---|
void |
addKey(String key)
Adds key to the keys array
|
void |
addZone(Zones zone)
Adds zone to the zones array
|
Boolean |
getAllowPointSelect() |
Boolean |
getAnimation() |
Number |
getAnimationLimit() |
Number |
getBorderRadius() |
ChartType |
getChartType() |
String |
getClassName() |
Boolean |
getColorByPoint() |
Number |
getColorIndex() |
Compare |
getCompare() |
Number |
getCompareBase() |
Boolean |
getCrisp() |
Number |
getCropThreshold() |
Cursor |
getCursor() |
DataGrouping |
getDataGrouping() |
DataLabelsRange |
getDataLabels() |
Number |
getDepth() |
String |
getDescription() |
Number |
getEdgeWidth() |
Boolean |
getEnableMouseTracking() |
Boolean |
getExposeElementToA11y() |
Dimension |
getFindNearestPointBy() |
String |
getGapUnit() |
Boolean |
getGetExtremesFromAll() |
Boolean |
getGrouping() |
Number |
getGroupPadding() |
Number |
getGroupZPadding() |
String[] |
getKeys() |
Number |
getLegendIndex() |
String |
getLinkedTo() |
Number |
getMaxPointWidth() |
Number |
getMinPointLength() |
PlotOptionsSeries |
getNavigatorOptions() |
String |
getPointDescriptionFormatter() |
Number |
getPointInterval() |
IntervalUnit |
getPointIntervalUnit() |
Number |
getPointPadding() |
PointPlacement |
getPointPlacement() |
Number |
getPointRange() |
Number |
getPointStart() |
Number |
getPointWidth() |
Boolean |
getSelected() |
Boolean |
getShadow() |
Boolean |
getShowCheckbox() |
Boolean |
getShowInLegend() |
Boolean |
getShowInNavigator() |
Boolean |
getSkipKeyboardNavigation() |
States |
getStates() |
Boolean |
getStickyTracking() |
SeriesTooltip |
getTooltip() |
Number |
getTurboThreshold() |
Boolean |
getVisible() |
ZoneAxis |
getZoneAxis() |
Zones[] |
getZones() |
void |
removeKey(String key)
Removes first occurrence of key in keys array
|
void |
removeZone(Zones zone)
Removes first occurrence of zone in zones array
|
void |
setAllowPointSelect(Boolean allowPointSelect)
Allow this series' points to be selected by clicking on the markers, bars
or pie slices.
|
void |
setAnimation(Boolean animation)
Enable or disable the initial animation when a series is displayed.
|
void |
setAnimationLimit(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.
|
void |
setBorderRadius(Number borderRadius)
The corner radius of the border surrounding each column or bar.
|
void |
setClassName(String className)
A class name to apply to the series' graphical elements.
|
void |
setColorByPoint(Boolean colorByPoint)
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. |
void |
setColorIndex(Number colorIndex)
Styled mode only.
|
void |
setCompare(Compare compare)
Compare the values of the series against the first non-null, non-zero
value in the visible range.
|
void |
setCompareBase(Number compareBase)
When compare is
percent, this option dictates whether to use 0 or 100 as the
base of comparison. |
void |
setCrisp(Boolean crisp)
When true, each column edge is rounded to its nearest pixel in order to
render sharp on screen.
|
void |
setCropThreshold(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.
|
void |
setCursor(Cursor cursor)
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.
|
void |
setDataGrouping(DataGrouping dataGrouping) |
void |
setDataLabels(DataLabelsRange dataLabels)
Extended data labels for range series types.
|
void |
setDepth(Number depth)
Depth of the columns in a 3D column chart.
|
void |
setDescription(String description)
Requires Accessibility module
|
void |
setEdgeWidth(Number edgeWidth)
3D columns only.
|
void |
setEnableMouseTracking(Boolean enableMouseTracking)
Enable or disable the mouse tracking for a specific series.
|
void |
setExposeElementToA11y(Boolean exposeElementToA11y)
By default, series are exposed to screen readers as regions.
|
void |
setFindNearestPointBy(Dimension findNearestPointBy)
Determines whether the series should look for the nearest point in both
dimensions or just the x-dimension when hovering the series.
|
void |
setGapUnit(String gapUnit)
Together with
gapSize, this option defines where to draw
gaps in the graph. |
void |
setGetExtremesFromAll(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.
|
void |
setGrouping(Boolean grouping)
Whether to group non-stacked columns or to let them render independent of
each other.
|
void |
setGroupPadding(Number groupPadding)
Padding between each value groups, in x axis units.
|
void |
setGroupZPadding(Number groupZPadding)
The spacing between columns on the Z Axis in a 3D chart.
|
void |
setKeys(String... keys)
An array specifying which option maps to which key in the data point
array.
|
void |
setLegendIndex(Number legendIndex)
The sequential index of the series within the legend.
|
void |
setLinkedTo(String linkedTo)
The id of another series to link to.
|
void |
setMaxPointWidth(Number maxPointWidth)
The maximum allowed pixel width for a column, translated to the height of
a bar in a bar chart.
|
void |
setMinPointLength(Number minPointLength)
The minimal height for a column or width for a bar.
|
void |
setNavigatorOptions(PlotOptionsSeries navigatorOptions)
Options for the corresponding navigator series if
showInNavigator is true for this series. |
void |
setPointDescriptionFormatter(String _fn_pointDescriptionFormatter) |
void |
setPointInterval(Number pointInterval)
If no x values are given for the points in a series, pointInterval
defines the interval of the x values.
|
void |
setPointIntervalUnit(IntervalUnit pointIntervalUnit)
On datetime series, this allows for setting the
pointInterval to
irregular time units,
day, month and
year. |
void |
setPointPadding(Number pointPadding)
Padding between each column or bar, in x axis units.
|
void |
setPointPlacement(PointPlacement pointPlacement)
Possible values:
null, "on",
"between". |
void |
setPointRange(Number pointRange)
The X axis range that each point is valid for.
|
void |
setPointStart(Date date)
Deprecated.
as of 4.0. Use
setPointStart(Instant) |
void |
setPointStart(Instant instant) |
void |
setPointStart(Number pointStart)
If no x values are given for the points in a series, pointStart defines
on what value to start.
|
void |
setPointWidth(Number pointWidth)
A pixel value specifying a fixed width for each column or bar.
|
void |
setSelected(Boolean selected)
Whether to select the series initially.
|
void |
setShadow(Boolean shadow)
Whether to apply a drop shadow to the graph line.
|
void |
setShowCheckbox(Boolean showCheckbox)
If true, a checkbox is displayed next to the legend item to allow
selecting the series.
|
void |
setShowInLegend(Boolean showInLegend)
Whether to display this particular series or series type in the legend.
|
void |
setShowInNavigator(Boolean showInNavigator)
Whether or not to show the series in the navigator.
|
void |
setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)
If set to
True, the accessibility module will skip past the
points in this series for keyboard navigation. |
void |
setStates(States states)
A wrapper object for all the series options in specific states.
|
void |
setStickyTracking(Boolean stickyTracking)
Sticky tracking of mouse events.
|
void |
setTooltip(SeriesTooltip tooltip)
A configuration object for the tooltip rendering of each single series.
|
void |
setTurboThreshold(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.
|
void |
setVisible(Boolean visible)
Set the initial visibility of the series.
|
void |
setZoneAxis(ZoneAxis zoneAxis)
Defines the Axis on which the zones are applied.
|
void |
setZones(Zones... zones)
An array defining zones within a series.
|
public ChartType getChartType()
getChartType in class AbstractPlotOptionspublic Boolean getAllowPointSelect()
getAllowPointSelect in class ColumnOptionssetAllowPointSelect(Boolean)public void setAllowPointSelect(Boolean allowPointSelect)
Defaults to: false
setAllowPointSelect in class ColumnOptionspublic Boolean getAnimation()
getAnimation in class ColumnOptionssetAnimation(Boolean)public void setAnimation(Boolean animation)
ChartModel.setAnimation(Boolean)setAnimation in class ColumnOptionspublic Number getAnimationLimit()
setAnimationLimit(Number)public void setAnimationLimit(Number animationLimit)
animationLimit to Infinity.public Number getBorderRadius()
getBorderRadius in class ColumnOptionssetBorderRadius(Number)public void setBorderRadius(Number borderRadius)
Defaults to: 0
setBorderRadius in class ColumnOptionspublic String getClassName()
setClassName(String)public void setClassName(String className)
public Boolean getColorByPoint()
getColorByPoint in class ColumnOptionssetColorByPoint(Boolean)public void setColorByPoint(Boolean colorByPoint)
options.colors collection, this option determines whether
the chart should receive one color per series or one color per point.
Defaults to: false
setColorByPoint in class ColumnOptionspublic Number getColorIndex()
setColorIndex(Number)public void setColorIndex(Number colorIndex)
highcharts-color-{n}.public Boolean getCrisp()
setCrisp(Boolean)public void setCrisp(Boolean crisp)
crisp to
false may look better, even though each column is rendered
blurry.
Defaults to: true
public Number getCropThreshold()
setCropThreshold(Number)public void setCropThreshold(Number cropThreshold)
Defaults to: 50
public Cursor getCursor()
getCursor in class ColumnOptionssetCursor(Cursor)public void setCursor(Cursor cursor)
setCursor in class ColumnOptionspublic DataLabelsRange getDataLabels()
setDataLabels(DataLabelsRange)public void setDataLabels(DataLabelsRange dataLabels)
x and y options. Instead, they have
xLow, xHigh, yLow and
yHigh options to allow the higher and lower data label sets
individually.public Number getDepth()
getDepth in class ColumnOptionssetDepth(Number)public void setDepth(Number depth)
highcharts-3d.js.
Defaults to: 25
setDepth in class ColumnOptionspublic String getDescription()
setDescription(String)public void setDescription(String description)
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
Defaults to: undefined
public Number getEdgeWidth()
getEdgeWidth in class ColumnOptionssetEdgeWidth(Number)public void setEdgeWidth(Number edgeWidth)
Defaults to: 1
setEdgeWidth in class ColumnOptionspublic Boolean getEnableMouseTracking()
getEnableMouseTracking in class ColumnOptionssetEnableMouseTracking(Boolean)public void setEnableMouseTracking(Boolean enableMouseTracking)
Defaults to: true
setEnableMouseTracking in class ColumnOptionspublic Boolean getExposeElementToA11y()
setExposeElementToA11y(Boolean)public void setExposeElementToA11y(Boolean exposeElementToA11y)
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
public Dimension getFindNearestPointBy()
setFindNearestPointBy(Dimension)public void setFindNearestPointBy(Dimension findNearestPointBy)
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.
public Boolean getGetExtremesFromAll()
getGetExtremesFromAll in class ColumnOptionssetGetExtremesFromAll(Boolean)public void setGetExtremesFromAll(Boolean getExtremesFromAll)
Defaults to: false
setGetExtremesFromAll in class ColumnOptionspublic Number getGroupPadding()
getGroupPadding in class ColumnOptionssetGroupPadding(Number)public void setGroupPadding(Number groupPadding)
Defaults to: 0.2
setGroupPadding in class ColumnOptionspublic Number getGroupZPadding()
getGroupZPadding in class ColumnOptionssetGroupZPadding(Number)public void setGroupZPadding(Number groupZPadding)
highcharts-3d.js.
Defaults to: 1
setGroupZPadding in class ColumnOptionspublic Boolean getGrouping()
getGrouping in class ColumnOptionssetGrouping(Boolean)public void setGrouping(Boolean grouping)
Defaults to: true
setGrouping in class ColumnOptionspublic String[] getKeys()
getKeys in class ColumnOptionssetKeys(String...)public void setKeys(String... keys)
setKeys in class ColumnOptionspublic void addKey(String key)
addKey in class ColumnOptionskey - to addsetKeys(String...)public void removeKey(String key)
removeKey in class ColumnOptionskey - to removesetKeys(String...)public String getLinkedTo()
getLinkedTo in class ColumnOptionssetLinkedTo(String)public void setLinkedTo(String linkedTo)
setLinkedTo in class ColumnOptionspublic Number getMaxPointWidth()
getMaxPointWidth in class ColumnOptionssetMaxPointWidth(Number)public void setMaxPointWidth(Number maxPointWidth)
Defaults to: null
setMaxPointWidth in class ColumnOptionspublic Number getMinPointLength()
getMinPointLength in class ColumnOptionssetMinPointLength(Number)public void setMinPointLength(Number minPointLength)
Defaults to: 0
setMinPointLength in class ColumnOptionspublic String getPointDescriptionFormatter()
public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)
public Number getPointInterval()
getPointInterval in class ColumnOptionssetPointInterval(Number)public void setPointInterval(Number pointInterval)
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.
Defaults to: 1
setPointInterval in class ColumnOptionspublic IntervalUnit getPointIntervalUnit()
getPointIntervalUnit in class ColumnOptionssetPointIntervalUnit(IntervalUnit)public void setPointIntervalUnit(IntervalUnit pointIntervalUnit)
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.setPointIntervalUnit in class ColumnOptionspublic Number getPointPadding()
getPointPadding in class ColumnOptionssetPointPadding(Number)public void setPointPadding(Number pointPadding)
Defaults to: 0.1
setPointPadding in class ColumnOptionspublic PointPlacement getPointPlacement()
getPointPlacement in class ColumnOptionssetPointPlacement(PointPlacement)public void setPointPlacement(PointPlacement pointPlacement)
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.
setPointPlacement in class ColumnOptionspublic Number getPointRange()
getPointRange in class ColumnOptionssetPointRange(Number)public void setPointRange(Number pointRange)
setPointRange in class ColumnOptionspublic Number getPointStart()
getPointStart in class ColumnOptionssetPointStart(Number)public void setPointStart(Number pointStart)
Defaults to: 0
setPointStart in class ColumnOptionspublic Number getPointWidth()
getPointWidth in class ColumnOptionssetPointWidth(Number)public void setPointWidth(Number pointWidth)
null, the width is calculated from the
pointPadding and groupPadding.setPointWidth in class ColumnOptionspublic Boolean getSelected()
getSelected in class ColumnOptionssetSelected(Boolean)public void setSelected(Boolean selected)
showCheckbox is
true, the checkbox next to the series name will be checked for a selected
series.
Defaults to: false
setSelected in class ColumnOptionspublic Boolean getShadow()
getShadow in class ColumnOptionssetShadow(Boolean)public void setShadow(Boolean shadow)
color,
offsetX, offsetY, opacity and
width.
Defaults to: false
setShadow in class ColumnOptionspublic Boolean getShowCheckbox()
getShowCheckbox in class ColumnOptionssetShowCheckbox(Boolean)public void setShowCheckbox(Boolean showCheckbox)
selected option.
Defaults to: false
setShowCheckbox in class ColumnOptionspublic Boolean getShowInLegend()
getShowInLegend in class ColumnOptionssetShowInLegend(Boolean)public void setShowInLegend(Boolean showInLegend)
true for standalone series,
false for linked series.
Defaults to: true
setShowInLegend in class ColumnOptionspublic Boolean getSkipKeyboardNavigation()
setSkipKeyboardNavigation(Boolean)public void setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)
True, the accessibility module will skip past the
points in this series for keyboard navigation.public States getStates()
getStates in class ColumnOptionssetStates(States)public void setStates(States states)
setStates in class ColumnOptionspublic Boolean getStickyTracking()
getStickyTracking in class ColumnOptionssetStickyTracking(Boolean)public void setStickyTracking(Boolean stickyTracking)
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.
Defaults to: true
setStickyTracking in class ColumnOptionspublic SeriesTooltip getTooltip()
getTooltip in class ColumnOptionssetTooltip(SeriesTooltip)public void setTooltip(SeriesTooltip tooltip)
setTooltip in class ColumnOptionspublic Number getTurboThreshold()
setTurboThreshold(Number)public void setTurboThreshold(Number turboThreshold)
0 disable.
Defaults to: 1000
public Boolean getVisible()
getVisible in class ColumnOptionssetVisible(Boolean)public void setVisible(Boolean visible)
Defaults to: true
setVisible in class ColumnOptionspublic ZoneAxis getZoneAxis()
getZoneAxis in class ColumnOptionssetZoneAxis(ZoneAxis)public void setZoneAxis(ZoneAxis zoneAxis)
Defaults to: y
setZoneAxis in class ColumnOptionspublic Zones[] getZones()
getZones in class ColumnOptionssetZones(Zones...)public void setZones(Zones... zones)
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).
setZones in class ColumnOptionspublic void addZone(Zones zone)
addZone in class ColumnOptionszone - to addsetZones(Zones...)public void removeZone(Zones zone)
removeZone in class ColumnOptionszone - to removesetZones(Zones...)public Compare getCompare()
setCompare(Compare)public void setCompare(Compare compare)
compare is 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
public Number getCompareBase()
setCompareBase(Number)public void setCompareBase(Number compareBase)
percent, this option dictates whether to use 0 or 100 as the
base of comparison.
Defaults to: 0
public DataGrouping getDataGrouping()
setDataGrouping(DataGrouping)public void setDataGrouping(DataGrouping dataGrouping)
public String getGapUnit()
setGapUnit(String)public void setGapUnit(String gapUnit)
gapSize, this option defines where to draw
gaps in the graph.
Defaults to: relative
public Number getLegendIndex()
setLegendIndex(Number)public void setLegendIndex(Number legendIndex)
Defaults to: 0
public PlotOptionsSeries getNavigatorOptions()
setNavigatorOptions(PlotOptionsSeries)public void setNavigatorOptions(PlotOptionsSeries navigatorOptions)
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.
Defaults to: undefined
public Boolean getShowInNavigator()
setShowInNavigator(Boolean)public void setShowInNavigator(Boolean showInNavigator)
Defaults to: undefined
@Deprecated public void setPointStart(Date date)
setPointStart(Instant)setPointStart in class ColumnOptionsColumnOptions.setPointStart(Number)public void setPointStart(Instant instant)
setPointStart(Number)Copyright © 2025. All rights reserved.