com.highsoft.highcharts.common.hichartsclasses

Class HIPackedbubble

java.lang.Object

java.util.Observable

com.highsoft.highcharts.core.HIFoundation

com.highsoft.highcharts.common.hichartsclasses.HISeries

com.highsoft.highcharts.common.hichartsclasses.HIPackedbubble

public class HIPackedbubble
extends HISeries

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

Constructor Summary

Constructors

Constructor and Description
HIPackedbubble()

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getDisplayNegative()
java.lang.Boolean	getDraggable()
HILayoutAlgorithm	getLayoutAlgorithm()
java.lang.Object	getMaxSize()
java.lang.Object	getMinSize()
java.util.HashMap<java.lang.String,java.lang.Object>	getParams()
HIParentNode	getParentNode()
java.lang.String	getSizeBy()
java.lang.Boolean	getUseSimulation()
java.lang.Number	getZThreshold()
void	setDisplayNegative(java.lang.Boolean displayNegative) Whether to display negative sized bubbles.
void	setDraggable(java.lang.Boolean draggable) Flag to determine if nodes are draggable or not.
void	setLayoutAlgorithm(HILayoutAlgorithm layoutAlgorithm) Options for layout algorithm when simulation is enabled.
void	setMaxSize(java.lang.Object maxSize) /** * description: Maximum bubble size.
void	setMinSize(java.lang.Object minSize) /** * description: Minimum bubble size.
void	setParentNode(HIParentNode parentNode) Series options for parent nodes.
void	setSizeBy(java.lang.String sizeBy) /** * description: Whether the bubble's value should be represented by the area or the width of the bubble.
void	setUseSimulation(java.lang.Boolean useSimulation) An option is giving a possibility to choose between using simulation for calculating bubble positions.
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

HIPackedbubble

public HIPackedbubble()

Method Detail

getDisplayNegative

public java.lang.Boolean getDisplayNegative()

getDraggable

public java.lang.Boolean getDraggable()

getLayoutAlgorithm

public HILayoutAlgorithm getLayoutAlgorithm()

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

getParentNode

public HIParentNode getParentNode()

getSizeBy

public java.lang.String getSizeBy()

getUseSimulation

public java.lang.Boolean getUseSimulation()

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

setDraggable

public void setDraggable(java.lang.Boolean draggable)

Flag to determine if nodes are draggable or not. Available for graph with useSimulation set to true only.

defaults:

 True

setLayoutAlgorithm

public void setLayoutAlgorithm(HILayoutAlgorithm layoutAlgorithm)

Options for layout algorithm when simulation is enabled. Inside there are options to change the speed, padding, initial bubbles positions and more.

setMaxSize

public void setMaxSize(java.lang.Object maxSize)

/** * description: Maximum bubble size. Bubbles will automatically size between the `minSize` and `maxSize` to reflect the 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, divided by the square root of total number of points. * demo: * [Bubble size](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/bubble-size/) defaults: 50%

setMinSize

public void setMinSize(java.lang.Object minSize)

/** * description: Minimum bubble size. Bubbles will automatically size between the `minSize` and `maxSize` to reflect the 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, divided by the square root of total number of points. * demo: * [Bubble size](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/bubble-size/) defaults: 10%

setParentNode

public void setParentNode(HIParentNode parentNode)

Series options for parent nodes.

setSizeBy

public void setSizeBy(java.lang.String sizeBy)

/** * description: 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. * demo: * [Comparison of area and size](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/bubble-sizeby/) defaults: area

setUseSimulation

public void setUseSimulation(java.lang.Boolean useSimulation)

An option is giving a possibility to choose between using simulation for calculating bubble positions. These reflects in both animation and final position of bubbles. Simulation is also adding options to the series graph based on used layout. In case of big data sets, with any performance issues, it is possible to disable animation and pack bubble in a simple circular way.

defaults:

 True

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.