org.moxieapps.gwt.highcharts.client.plotOptions

Class PiePlotOptions

java.lang.Object

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

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

org.moxieapps.gwt.highcharts.client.plotOptions.BaseProportionalPlotOptions<PiePlotOptions>

org.moxieapps.gwt.highcharts.client.plotOptions.PiePlotOptions

public class PiePlotOptions
extends BaseProportionalPlotOptions<PiePlotOptions>

Represents the general plot options available for all pie type series, which can be set either generically on the chart via the BaseChart.setPiePlotOptions(PiePlotOptions) )} 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 pie 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 pie 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 pie type series in the chart), use the Series.setPlotOptions(PlotOptions) method.

Since:

1.0.0

Author:

squinn@moxiegroup.com (Shawn Quinn)

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
PiePlotOptions()

Method Summary

Methods

Modifier and Type	Method and Description
PointLegendItemClickEventHandler	getPointLegendItemClickEventHandler() Returns the custom event handler that has been set on the plot options, or null if no event handler has been set.
PiePlotOptions	setPieDataLabels(PieDataLabels pieDataLabels) Convenience method for setting the 'dataLabels' plot option to a configuration object that is more specific to pie charts.
PiePlotOptions	setPointLegendItemClickEventHandler(PointLegendItemClickEventHandler pointLegendItemClickEventHandler) Set a callback handler that will be invoked whenever the user clicks on the legend item points in a pie series.

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

setBorderColor, setBorderColor, setBorderWidth, setCenter, setCenter, setDepth, setIgnoreHiddenPoint, setInnerSize, setInnerSize, setMinSize, setSize, setSize, setSlicedOffset, setStartAngle

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

PiePlotOptions

public PiePlotOptions()

Method Detail

setPieDataLabels

public PiePlotOptions setPieDataLabels(PieDataLabels pieDataLabels)

Convenience method for setting the 'dataLabels' plot option to a configuration object that is more specific to pie charts. Equivalent to:

 piePlotOptions.setOption("/dataLabels/connectorWidth", 2.0);
 piePlotOptions.setOption("/dataLabels/connectorPadding", 5.0);
 etc...
 

Defines the appearance of the data labels of the pie, which are the static labels for each point.

Parameters:

pieDataLabels - The configuration of how the pie's data labels should appear.

Returns:

A reference to this PiePlotOptions instance for convenient method chaining.

setPointLegendItemClickEventHandler

public PiePlotOptions setPointLegendItemClickEventHandler(PointLegendItemClickEventHandler pointLegendItemClickEventHandler)

Set a callback handler that will be invoked whenever the user clicks on the legend item points in a pie series. Additional information about the click (such as the values of the point clicked) can be found via the PointLegendItemClickEventHandler instance that is passed to the handler's PointLegendItemClickEventHandler.onClick(org.moxieapps.gwt.highcharts.client.events.PointLegendItemClickEvent) method.

Overrides:

setPointLegendItemClickEventHandler in class BaseProportionalPlotOptions<PiePlotOptions>

Parameters:

pointLegendItemClickEventHandler - The handler that should be invoked whenever a legend item click event occurs.

Returns:

A reference to this BaseChart instance for convenient method chaining.

Since:

1.1.2

getPointLegendItemClickEventHandler

public PointLegendItemClickEventHandler getPointLegendItemClickEventHandler()

Returns the custom event handler that has been set on the plot options, or null if no event handler has been set.

Overrides:

getPointLegendItemClickEventHandler in class BaseProportionalPlotOptions<PiePlotOptions>

Returns:

The custom event handler that has been applied, or null if it has not been set.

Since:

1.1.2