com.highsoft.highcharts.common.hichartsclasses

Class HIBubble

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HISeries

com.highsoft.highcharts.common.hichartsclasses.HIBubble

public class HIBubble
extends HISeries

A `bubble` 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 `bubble` series are defined in `plotOptions.bubble`. 3. Options for one single series are given in `the series instance array`. ``` Highcharts.chart('container', { plotOptions: { series: { // general options for all series }, bubble: { // shared options for all bubble series } }, series: [{ // specific options for this series instance type: 'bubble' }] }); ```

Constructor Summary

Constructors

Constructor and Description
HIBubble()

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getDisplayNegative()
HIJitter	getJitter()
java.lang.Object	getMaxSize()
java.lang.Object	getMinSize()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
java.lang.String	getSizeBy()
java.lang.Boolean	getSizeByAbsoluteValue()
java.lang.Number	getZMax()
java.lang.Number	getZMin()
java.lang.Number	getZThreshold()
void	setDisplayNegative(java.lang.Boolean displayNegative) Whether to display negative sized bubbles.
void	setJitter(HIJitter jitter) Apply a jitter effect for the rendered markers.
void	setMaxSize(java.lang.Object maxSize) Maximum bubble size.
void	setMinSize(java.lang.Object minSize) Minimum bubble size.
void	setSizeBy(java.lang.String sizeBy) Whether the bubble's value should be represented by the area or the width of the bubble.
void	setSizeByAbsoluteValue(java.lang.Boolean sizeByAbsoluteValue) When this is true, the absolute value of z determines the size of the bubble.
void	setZMax(java.lang.Number zMax) The minimum for the Z value range.
void	setZMin(java.lang.Number zMin) The minimum for the Z value range.
void	setZThreshold(java.lang.Number zThreshold) When `displayNegative` is `false`, bubbles with lower Z values are skipped.

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

HIBubble

public HIBubble()

Method Detail

getDisplayNegative

public java.lang.Boolean getDisplayNegative()

getJitter

public HIJitter getJitter()

getMaxSize

public java.lang.Object getMaxSize()

getMinSize

public java.lang.Object getMinSize()

getParams

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

Overrides:

getParams in class HISeries

getSizeBy

public java.lang.String getSizeBy()

getSizeByAbsoluteValue

public java.lang.Boolean getSizeByAbsoluteValue()

getZMax

public java.lang.Number getZMax()

getZMin

public java.lang.Number getZMin()

getZThreshold

public java.lang.Number getZThreshold()

setDisplayNegative

public void setDisplayNegative(java.lang.Boolean displayNegative)

Whether to display negative sized bubbles. The threshold is given by the `zThreshold` option, and negative bubbles can be visualized by setting `negativeColor`.

defaults:

 true

setJitter

public void setJitter(HIJitter jitter)

Apply a jitter effect for the rendered markers. When plotting discrete values, a little random noise may help telling the points apart. The jitter setting applies a random displacement of up to `n` axis units in either direction. So for example on a horizontal X axis, setting the `jitter.x` to 0.24 will render the point in a random position between 0.24 units to the left and 0.24 units to the right of the true axis position. On a category axis, setting it to 0.5 will fill up the bin and make the data appear continuous. When rendered on top of a box plot or a column series, a jitter value of 0.24 will correspond to the underlying series' defaults [groupPadding](https://api.highcharts.com/highcharts/plotOptions.column.groupPadding) and [pointPadding](https://api.highcharts.com/highcharts/plotOptions.column.pointPadding) settings. **Note:** With boost mode enabled, the jitter effect is not supported.

setMaxSize

public void setMaxSize(java.lang.Object maxSize)

Maximum bubble size. Bubbles will automatically size between the `minSize` and `maxSize` to reflect the `z` value of each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width and height.

defaults:

 20%

setMinSize

public void setMinSize(java.lang.Object minSize)

Minimum bubble size. Bubbles will automatically size between the `minSize` and `maxSize` to reflect the `z` value of each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width and height.

defaults:

 8

setSizeBy

public void setSizeBy(java.lang.String sizeBy)

Whether the bubble's value should be represented by the area or the width of the bubble. The defaults, `area`, corresponds best to the human perception of the size of each bubble.

defaults:

 area

setSizeByAbsoluteValue

public void setSizeByAbsoluteValue(java.lang.Boolean sizeByAbsoluteValue)

When this is true, the absolute value of z determines the size of the bubble. This means that with the defaults `zThreshold` of 0, a bubble of value -1 will have the same size as a bubble of value 1, while a bubble of value 0 will have a smaller size according to `minSize`.

defaults:

 false

setZMax

public void setZMax(java.lang.Number zMax)

The minimum for the Z value range. Defaults to the highest Z value in the data.

setZMin

public void setZMin(java.lang.Number zMin)

The minimum for the Z value range. Defaults to the lowest Z value in the data.

setZThreshold

public void setZThreshold(java.lang.Number zThreshold)

When `displayNegative` is `false`, bubbles with lower Z values are skipped. When `displayNegative` is `true` and a `negativeColor` is given, points with lower Z is colored.