org.moxieapps.gwt.highcharts.client.plotOptions

Class BubblePlotOptions

java.lang.Object

org.moxieapps.gwt.highcharts.client.Configurable<T>

org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions<BubblePlotOptions>

org.moxieapps.gwt.highcharts.client.plotOptions.BubblePlotOptions

public class BubblePlotOptions
extends PlotOptions<BubblePlotOptions>

Represents the general plot options available for all bubble type series, which can be set either generically on the chart via the BaseChart.setBubblePlotOptions(BubblePlotOptions) )} method or directly on a series via the Series.setPlotOptions(PlotOptions) method.

Note that these options are only needed if you want to specifically control the general options for all bar type series in the entire chart. If you instead want to control the options for all series in the chart (not just those of a bar type), then you can use the SeriesPlotOptions class instead. Or, if you want to control the plot options for just one series (and not all bar type series in the chart), use the Series.setPlotOptions(PlotOptions) method.

Since:

1.6.0

Author:

cskowron@moxiegroup.com (Cory Skowronek)

Nested Class Summary

Nested classes/interfaces inherited from class org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions

PlotOptions.Cursor, PlotOptions.PointPlacement, PlotOptions.Stacking

Constructor Summary

Constructors

Constructor and Description
BubblePlotOptions()

Method Summary

Methods

Modifier and Type	Method and Description
BubblePlotOptions	setDisplayNegative(boolean displayNegative) Convenience method for setting the "displayNegative" option for the bubble plot options.
BubblePlotOptions	setZThreshold(Number zThreshold) Convenience method for setting the "zThreshold" option for the bubble plot options.

Methods inherited from class org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions

getDataLabels, setAllowPointSelect, setAnimation, setAnimation, setBaseDataLabels, setColor, setColor, setCropThreshold, setCursor, setDashStyle, setDataGrouping, setDataLabels, setEnableMouseTracking, setHoverStateEnabled, setHoverStateLineWidth, setHoverStateMarker, setId, setLegendIndex, setLineWidth, setLinkedTo, setLinkedTo, setMarker, setNegativeColor, setNegativeColor, setPointInterval, setPointPlacement, setPointStart, setSelected, setShadow, setShowCheckbox, setShowInLegend, setStacking, setStickyTracking, setThreshold, setTurboThreshold, setVisible, setZIndex, setZoneAxis, setZones

Methods inherited from class org.moxieapps.gwt.highcharts.client.Configurable

getOptions, setOption

Methods inherited from class java.lang.Object

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

Constructor Detail

BubblePlotOptions

public BubblePlotOptions()

Method Detail

setDisplayNegative

public BubblePlotOptions setDisplayNegative(boolean displayNegative)

Convenience method for setting the "displayNegative" option for the bubble plot options. Equivalent to:

     bubblePlotOptions.setOptions("displayNegative", true);
 

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

Parameters:

displayNegative - 'true' to display negative-sized bubbles

Returns:

A reference to this BubblePlotOptions instance for convenient method chaining.

setZThreshold

public BubblePlotOptions setZThreshold(Number zThreshold)

Convenience method for setting the "zThreshold" option for the bubble plot options. Equivalent to:

     bubblePlotOptions.setOptions("zThreshold", 0);
 

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. Defaults to 0.

Parameters:

zThreshold - The minimum z-value for a point to be shown in a bubble plot

Returns:

A reference to this BubblePlotOptions instance for convenient method chaining.