com.highsoft.highcharts.common.hichartsclasses

Class HIXrange

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HISeries

com.highsoft.highcharts.common.hichartsclasses.HIXrange

public class HIXrange
extends HISeries

An `xrange` series. If the `type` option is not specified, it is inherited from `chart.type`. In TypeScript the `type` option must always be set. Configuration options for the series are given in three levels: 1. Options for all series in a chart are defined in the `plotOptions.series` object. 2. Options for all `xrange` series are defined in `plotOptions.xrange`. 3. Options for one single series are given in `the series instance array`. ``` Highcharts.chart('container', { plotOptions: { series: { // general options for all series }, xrange: { // shared options for all xrange series } }, series: [{ // specific options for this series instance type: 'xrange' }] }); ```

Constructor Summary

Constructors

Constructor and Description
HIXrange()

Method Summary

Modifier and Type	Method and Description
HIColor	getBorderColor()
java.lang.Number	getBorderRadius()
java.lang.Number	getBorderWidth()
java.lang.Boolean	getCenterInCategory()
java.lang.Boolean	getColorByPoint()
java.util.ArrayList<java.lang.String>	getColors()
java.lang.Boolean	getGrouping()
java.lang.Number	getGroupPadding()
java.lang.Number	getGroupZPadding()
java.lang.Number	getMaxPointWidth()
java.lang.Number	getMinPointLength()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
HIPartialFill	getPartialFill()
java.lang.Number	getPointPadding()
java.lang.Number	getPointWidth()
void	setBorderColor(HIColor borderColor) The color of the border surrounding each column or bar.
void	setBorderRadius(java.lang.Number borderRadius) /** * description: The corner radius of the border surrounding each column or bar.
void	setBorderWidth(java.lang.Number borderWidth) The width of the border surrounding each column or bar.
void	setCenterInCategory(java.lang.Boolean centerInCategory) When `true`, the columns will center in the category, ignoring null or missing points.
void	setColorByPoint(java.lang.Boolean colorByPoint) /** * description: In an X-range series, this option makes all points of the same Y-axis category the same color. * demo: * [False by defaults](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/column-colorbypoint-false/) * [True](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/column-colorbypoint-true/) defaults: True
void	setColors(java.util.ArrayList<java.lang.String> colors) A series specific or series type specific color set to apply instead of the global `colors` when `colorByPoint` is true.
void	setGrouping(java.lang.Boolean grouping) Whether to group non-stacked columns or to let them render independent of each other.
void	setGroupPadding(java.lang.Number groupPadding) Padding between each value groups, in x axis units.
void	setGroupZPadding(java.lang.Number groupZPadding) The spacing between columns on the Z Axis in a 3D chart.
void	setMaxPointWidth(java.lang.Number maxPointWidth) The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.
void	setMinPointLength(java.lang.Number minPointLength) The minimal height for a column or width for a bar.
void	setPartialFill(HIPartialFill partialFill) A partial fill for each point, typically used to visualize how much of a task is performed.
void	setPointPadding(java.lang.Number pointPadding) Padding between each column or bar, in x axis units.
void	setPointWidth(java.lang.Number pointWidth) A pixel value specifying a fixed width for each column or bar point.

Methods inherited from class com.highsoft.highcharts.common.hichartsclasses.HISeries

addPoint, addPoint, addPoint, addPoint, animate, drawGraph, drawPoints, getAccessibility, getAllowPointSelect, getAnimation, getAnimationLimit, getBoostBlending, getBoostThreshold, getClassName, getClip, getColor, getColorAxis, getColorIndex, getColorKey, getConnectEnds, getConnectNulls, getCrisp, getCropThreshold, getCursor, getCustom, getDashStyle, getData, getDataLabels, getDataSorting, getDefinition, getDescribeSingleSeries, getDescriptionFormat, getDescriptionFormatter, getDragDrop, getEnableMouseTracking, getEvents, getFindNearestPointBy, getGetExtremesFromAll, getId, getInactiveOtherPoints, getIncludeInDataExport, getIndex, getKeys, getLabel, getLegendIndex, getLegendSymbol, getLinecap, getLineWidth, getLinkedTo, getMarker, getName, getNegativeColor, getNullPointValue, getOnPoint, getOpacity, getPoint, getPointAnnotationsDescription, getPointDescriptionEnabledThreshold, getPointDescriptionFormat, getPointDescriptionFormatter, getPointInterval, getPointIntervalUnit, getPointPlacement, getPointStart, getRelativeXValue, getSelected, getShadow, getShowCheckbox, getShowInLegend, getSkipKeyboardNavigation, getSoftThreshold, getSonification, getStack, getStacking, getStates, getStep, getStickyTracking, getSummary, getThreshold, getTooltip, getTurboThreshold, getType, getVisible, getXAxis, getXAxisDescription, getYAxis, getYAxisDescription, getZIndex, getZoneAxis, getZones, hide, onMouseOut, onMouseOver, remove, remove, remove, remove, removePoint, removePoint, removePoint, render, select, select, setAccessibility, setAllowPointSelect, setAnimation, setAnimationLimit, setBoostBlending, setBoostThreshold, setClassName, setClip, setColor, setColorAxis, setColorIndex, setColorKey, setConnectEnds, setConnectNulls, setCrisp, setCropThreshold, setCursor, setCustom, setDashStyle, setData, setDataLabels, setDataSorting, setDefinition, setDescribeSingleSeries, setDescriptionFormat, setDescriptionFormatter, setDragDrop, setEnableMouseTracking, setEvents, setFindNearestPointBy, setGetExtremesFromAll, setId, setInactiveOtherPoints, setIncludeInDataExport, setIndex, setKeys, setLabel, setLegendIndex, setLegendSymbol, setLinecap, setLineWidth, setLinkedTo, setMarker, setName, setNegativeColor, setNullPointValue, setOnPoint, setOpacity, setOptions, setPoint, setPointAnnotationsDescription, setPointDescriptionEnabledThreshold, setPointDescriptionFormat, setPointDescriptionFormatter, setPointInterval, setPointIntervalUnit, setPointPlacement, setPointStart, setProperty, setRelativeXValue, setSelected, setSeriesData, setSeriesData, setSeriesData, setSeriesData, setSeriesVisible, setSeriesVisible, setSeriesVisible, setShadow, setShowCheckbox, setShowInLegend, setSkipKeyboardNavigation, setSoftThreshold, setSonification, setStack, setStacking, setState, setState, setStates, setStep, setStickyTracking, setSummary, setThreshold, setTooltip, setTurboThreshold, setType, setVisible, setXAxis, setXAxisDescription, setYAxis, setYAxisDescription, setZIndex, setZoneAxis, setZones, show, sonify, translate, update, update

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HIXrange

public HIXrange()

Method Detail

getBorderColor

public HIColor getBorderColor()

getBorderRadius

public java.lang.Number getBorderRadius()

getBorderWidth

public java.lang.Number getBorderWidth()

getCenterInCategory

public java.lang.Boolean getCenterInCategory()

getColorByPoint

public java.lang.Boolean getColorByPoint()

getColors

public java.util.ArrayList<java.lang.String> getColors()

getGrouping

public java.lang.Boolean getGrouping()

getGroupPadding

public java.lang.Number getGroupPadding()

getGroupZPadding

public java.lang.Number getGroupZPadding()

getMaxPointWidth

public java.lang.Number getMaxPointWidth()

getMinPointLength

public java.lang.Number getMinPointLength()

getParams

public java.util.HashMap<java.lang.String,java.lang.Object> getParams()

Overrides:

getParams in class HISeries

getPartialFill

public HIPartialFill getPartialFill()

getPointPadding

public java.lang.Number getPointPadding()

getPointWidth

public java.lang.Number getPointWidth()

setBorderColor

public void setBorderColor(HIColor borderColor)

The color of the border surrounding each column or bar. In styled mode, the border stroke can be set with the `.highcharts-point` rule.

defaults:

 #ffffff

setBorderRadius

public void setBorderRadius(java.lang.Number borderRadius)

/** * description: The corner radius of the border surrounding each column or bar. A number signifies pixels. A percentage string, like for example `50%`, signifies a relative size. For columns this is relative to the column width, for pies it is relative to the radius and the inner radius. * demo: * [Rounded columns](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/column-borderradius/) * [Column and pie with rounded border](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/series-border-radius) defaults: 3

setBorderWidth

public void setBorderWidth(java.lang.Number borderWidth)

The width of the border surrounding each column or bar. Defaults to `1` when there is room for a border, but to `0` when the columns are so dense that a border would cover the next column. In styled mode, the stroke width can be set with the `.highcharts-point` rule.

defaults:

 undefined

setCenterInCategory

public void setCenterInCategory(java.lang.Boolean centerInCategory)

When `true`, the columns will center in the category, ignoring null or missing points. When `false`, space will be reserved for null or missing points.

setColorByPoint

public void setColorByPoint(java.lang.Boolean colorByPoint)

/** * description: In an X-range series, this option makes all points of the same Y-axis category the same color. * demo: * [False by defaults](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/column-colorbypoint-false/) * [True](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/column-colorbypoint-true/) defaults: True

setColors

public void setColors(java.util.ArrayList<java.lang.String> colors)

A series specific or series type specific color set to apply instead of the global `colors` when `colorByPoint` is true.

setGrouping

public void setGrouping(java.lang.Boolean grouping)

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:

 true

setGroupPadding

public void setGroupPadding(java.lang.Number groupPadding)

Padding between each value groups, in x axis units.

defaults:

 0.2

setGroupZPadding

public void setGroupZPadding(java.lang.Number groupZPadding)

The spacing between columns on the Z Axis in a 3D chart.

defaults:

 1

setMaxPointWidth

public void setMaxPointWidth(java.lang.Number maxPointWidth)

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.

setMinPointLength

public void setMinPointLength(java.lang.Number minPointLength)

The minimal height for a column or width for a bar. By defaults, 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.

setPartialFill

public void setPartialFill(HIPartialFill partialFill)

A partial fill for each point, typically used to visualize how much of a task is performed. The partial fill object can be set either on series or point level.

setPointPadding

public void setPointPadding(java.lang.Number pointPadding)

Padding between each column or bar, in x axis units.

defaults:

 0.1

setPointWidth

public void setPointWidth(java.lang.Number pointWidth)

A pixel value specifying a fixed width for each column or bar point. When set to `undefined`, the width is calculated from the `pointPadding` and `groupPadding`. The width effects the dimension that is not based on the point value. For column series it is the horizontal length and for bar series it is the vertical length.