org.moxieapps.gwt.highcharts.client.plotOptions

Class SeriesPlotOptions

java.lang.Object

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

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

org.moxieapps.gwt.highcharts.client.plotOptions.SeriesPlotOptions

public class SeriesPlotOptions
extends PlotOptions<SeriesPlotOptions>

Represents the general plot options available for all series types, which can be set either generically on the chart via the BaseChart.setSeriesPlotOptions(SeriesPlotOptions) method or directly on a series via 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
SeriesPlotOptions()

Method Summary

Methods

Modifier and Type	Method and Description
PointClickEventHandler	getPointClickEventHandler() Returns the custom event handler that has been set on the plot options, or null if no event handler has been set.
PointMouseOutEventHandler	getPointMouseOutEventHandler() Returns the custom event handler that has been set on the plot options, or null if no event handler has been set.
PointMouseOverEventHandler	getPointMouseOverEventHandler() Returns the custom event handler that has been set on the plot options, or null if no event handler has been set.
PointRemoveEventHandler	getPointRemoveEventHandler() Returns the custom event handler that has been set on the plot options, or null if no event handler has been set.
PointSelectEventHandler	getPointSelectEventHandler() Returns the custom event handler that has been set on the plot options, or null if no event handler has been set.
PointUnselectEventHandler	getPointUnselectEventHandler() Returns the custom event handler that has been set on the plot options, or null if no event handler has been set.
PointUpdateEventHandler	getPointUpdateEventHandler() Returns the custom event handler that has been set on the plot options, or null if no event handler has been set.
SeriesCheckboxClickEventHandler	getSeriesCheckboxClickEventHandler() Returns the custom event handler that has been set on the plot options, or null if no event handler has been set.
SeriesClickEventHandler	getSeriesClickEventHandler() Returns the custom event handler that has been set on the plot options, or null if no event handler has been set.
SeriesHideEventHandler	getSeriesHideEventHandler() Returns the custom event handler that has been set on the plot options, or null if no event handler has been set.
SeriesLegendItemClickEventHandler	getSeriesLegendItemClickEventHandler() Returns the custom event handler that has been set on the plot options, or null if no event handler has been set.
SeriesMouseOutEventHandler	getSeriesMouseOutEventHandler() Returns the custom event handler that has been set on the plot options, or null if no event handler has been set.
SeriesMouseOverEventHandler	getSeriesMouseOverEventHandler() Returns the custom event handler that has been set on the plot options, or null if no event handler has been set.
SeriesShowEventHandler	getSeriesShowEventHandler() Returns the custom event handler that has been set on the plot options, or null if no event handler has been set.
SeriesPlotOptions	setPointClickEventHandler(PointClickEventHandler pointClickEventHandler) Set a callback handler that will be invoked whenever the user clicks on a point in a series.
SeriesPlotOptions	setPointMouseOutEventHandler(PointMouseOutEventHandler pointMouseOutEventHandler) Set a callback handler that will be invoked whenever the user mouses out of a point in a series.
SeriesPlotOptions	setPointMouseOverEventHandler(PointMouseOverEventHandler pointMouseOverEventHandler) Set a callback handler that will be invoked whenever the user mouses over a point in a series.
SeriesPlotOptions	setPointRemoveEventHandler(PointRemoveEventHandler pointRemoveEventHandler) Set a callback handler that will be invoked whenever the user removes on a point in a series.
SeriesPlotOptions	setPointSelectEventHandler(PointSelectEventHandler pointSelectEventHandler) Set a callback handler that will be invoked whenever the user selects a point in a series.
SeriesPlotOptions	setPointUnselectEventHandler(PointUnselectEventHandler pointUnselectEventHandler) Set a callback handler that will be invoked whenever the user unselects a point in a series.
SeriesPlotOptions	setPointUpdateEventHandler(PointUpdateEventHandler pointUpdateEventHandler) Set a callback handler that will be invoked whenever the a point in a series is updated programatically.
SeriesPlotOptions	setSeriesCheckboxClickEventHandler(SeriesCheckboxClickEventHandler seriesCheckboxClickEventHandler) Set a callback handler that will be invoked whenever the user clicks on the checkbox next to a series' name in the legend.
SeriesPlotOptions	setSeriesClickEventHandler(SeriesClickEventHandler seriesClickEventHandler) Set a callback handler that will be invoked whenever the user clicks on the series.
SeriesPlotOptions	setSeriesHideEventHandler(SeriesHideEventHandler seriesHideEventHandler) Set a callback handler that will be invoked whenever a series is hidden on the chart.
SeriesPlotOptions	setSeriesLegendItemClickEventHandler(SeriesLegendItemClickEventHandler seriesLegendItemClickEventHandler) Set a callback handler that will be invoked whenever the legend item belonging to a series is clicked.
SeriesPlotOptions	setSeriesMouseOutEventHandler(SeriesMouseOutEventHandler seriesMouseOutEventHandler) Set a callback handler that will be invoked whenever a mouse out event occurs on a series.
SeriesPlotOptions	setSeriesMouseOverEventHandler(SeriesMouseOverEventHandler seriesMouseOverEventHandler) Set a callback handler that will be invoked whenever a mouse over event occurs on a series.
SeriesPlotOptions	setSeriesShowEventHandler(SeriesShowEventHandler seriesShowEventHandler) Set a callback handler that will be invoked whenever a series is shown on the chart.

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

SeriesPlotOptions

public SeriesPlotOptions()

Method Detail

setSeriesClickEventHandler

public SeriesPlotOptions setSeriesClickEventHandler(SeriesClickEventHandler seriesClickEventHandler)

Set a callback handler that will be invoked whenever the user clicks on the series. Additional information about the click (such as the point closest to the click) can be found via the SeriesClickEvent instance that is passed to the handler's SeriesClickEventHandler.onClick(org.moxieapps.gwt.highcharts.client.events.SeriesClickEvent) method.

Parameters:

seriesClickEventHandler - The handler that should be invoked whenever a series click event occurs.

Returns:

A reference to this BaseChart instance for convenient method chaining.

Since:

1.1.0

getSeriesClickEventHandler

public SeriesClickEventHandler getSeriesClickEventHandler()

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

Returns:

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

Since:

1.1.0

setSeriesCheckboxClickEventHandler

public SeriesPlotOptions setSeriesCheckboxClickEventHandler(SeriesCheckboxClickEventHandler seriesCheckboxClickEventHandler)

Set a callback handler that will be invoked whenever the user clicks on the checkbox next to a series' name in the legend. Additional information about the click (such as whether or not the box was checked or unchecked) can be found via the SeriesCheckboxClickEvent instance that is passed to the handler's SeriesCheckboxClickEventHandler.onClick(org.moxieapps.gwt.highcharts.client.events.SeriesCheckboxClickEvent) method.

Parameters:

seriesCheckboxClickEventHandler - The handler that should be invoked whenever a series checkbox click event occurs.

Returns:

A reference to this BaseChart instance for convenient method chaining.

Since:

1.1.0

getSeriesCheckboxClickEventHandler

public SeriesCheckboxClickEventHandler getSeriesCheckboxClickEventHandler()

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

Returns:

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

Since:

1.1.0

setSeriesHideEventHandler

public SeriesPlotOptions setSeriesHideEventHandler(SeriesHideEventHandler seriesHideEventHandler)

Set a callback handler that will be invoked whenever a series is hidden on the chart.

Parameters:

seriesHideEventHandler - The handler that should be invoked whenever a series hide event occurs.

Returns:

A reference to this BaseChart instance for convenient method chaining.

Since:

1.1.0

getSeriesHideEventHandler

public SeriesHideEventHandler getSeriesHideEventHandler()

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

Returns:

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

Since:

1.1.0

setSeriesLegendItemClickEventHandler

public SeriesPlotOptions setSeriesLegendItemClickEventHandler(SeriesLegendItemClickEventHandler seriesLegendItemClickEventHandler)

Set a callback handler that will be invoked whenever the legend item belonging to a series is clicked.

Parameters:

seriesLegendItemClickEventHandler - The handler that should be invoked whenever a series' legend item click event occurs.

Returns:

A reference to this BaseChart instance for convenient method chaining.

Since:

1.1.0

getSeriesLegendItemClickEventHandler

public SeriesLegendItemClickEventHandler getSeriesLegendItemClickEventHandler()

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

Returns:

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

Since:

1.1.0

setSeriesMouseOverEventHandler

public SeriesPlotOptions setSeriesMouseOverEventHandler(SeriesMouseOverEventHandler seriesMouseOverEventHandler)

Set a callback handler that will be invoked whenever a mouse over event occurs on a series.

Parameters:

seriesMouseOverEventHandler - The handler that should be invoked whenever a series' legend item click event occurs.

Returns:

A reference to this BaseChart instance for convenient method chaining.

Since:

1.1.0

getSeriesMouseOverEventHandler

public SeriesMouseOverEventHandler getSeriesMouseOverEventHandler()

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

Returns:

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

Since:

1.1.0

setSeriesMouseOutEventHandler

public SeriesPlotOptions setSeriesMouseOutEventHandler(SeriesMouseOutEventHandler seriesMouseOutEventHandler)

Set a callback handler that will be invoked whenever a mouse out event occurs on a series.

Parameters:

seriesMouseOutEventHandler - The handler that should be invoked whenever a series' legend item click event occurs.

Returns:

A reference to this BaseChart instance for convenient method chaining.

Since:

1.1.0

getSeriesMouseOutEventHandler

public SeriesMouseOutEventHandler getSeriesMouseOutEventHandler()

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

Returns:

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

Since:

1.1.0

setSeriesShowEventHandler

public SeriesPlotOptions setSeriesShowEventHandler(SeriesShowEventHandler seriesShowEventHandler)

Set a callback handler that will be invoked whenever a series is shown on the chart.

Parameters:

seriesShowEventHandler - The handler that should be invoked whenever a series show event occurs.

Returns:

A reference to this BaseChart instance for convenient method chaining.

Since:

1.1.0

getSeriesShowEventHandler

public SeriesShowEventHandler getSeriesShowEventHandler()

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

Returns:

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

Since:

1.1.0

setPointClickEventHandler

public SeriesPlotOptions setPointClickEventHandler(PointClickEventHandler pointClickEventHandler)

Set a callback handler that will be invoked whenever the user clicks on a point in a series.

Parameters:

pointClickEventHandler - The handler that should be invoked whenever a point click event occurs.

Returns:

A reference to this BaseChart instance for convenient method chaining.

Since:

1.1.0

getPointClickEventHandler

public PointClickEventHandler getPointClickEventHandler()

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

Returns:

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

Since:

1.1.0

setPointMouseOverEventHandler

public SeriesPlotOptions setPointMouseOverEventHandler(PointMouseOverEventHandler pointMouseOverEventHandler)

Set a callback handler that will be invoked whenever the user mouses over a point in a series.

Parameters:

pointMouseOverEventHandler - The handler that should be invoked whenever a point mouse over event occurs.

Returns:

A reference to this BaseChart instance for convenient method chaining.

Since:

1.1.0

getPointMouseOverEventHandler

public PointMouseOverEventHandler getPointMouseOverEventHandler()

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

Returns:

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

Since:

1.1.0

setPointMouseOutEventHandler

public SeriesPlotOptions setPointMouseOutEventHandler(PointMouseOutEventHandler pointMouseOutEventHandler)

Set a callback handler that will be invoked whenever the user mouses out of a point in a series.

Parameters:

pointMouseOutEventHandler - The handler that should be invoked whenever a point mouse out event occurs.

Returns:

A reference to this BaseChart instance for convenient method chaining.

Since:

1.1.0

getPointMouseOutEventHandler

public PointMouseOutEventHandler getPointMouseOutEventHandler()

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

Returns:

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

Since:

1.1.0

setPointRemoveEventHandler

public SeriesPlotOptions setPointRemoveEventHandler(PointRemoveEventHandler pointRemoveEventHandler)

Set a callback handler that will be invoked whenever the user removes on a point in a series.

Parameters:

pointRemoveEventHandler - The handler that should be invoked whenever a point remove event occurs.

Returns:

A reference to this BaseChart instance for convenient method chaining.

Since:

1.1.0

getPointRemoveEventHandler

public PointRemoveEventHandler getPointRemoveEventHandler()

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

Returns:

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

Since:

1.1.0

setPointSelectEventHandler

public SeriesPlotOptions setPointSelectEventHandler(PointSelectEventHandler pointSelectEventHandler)

Set a callback handler that will be invoked whenever the user selects a point in a series.

Parameters:

pointSelectEventHandler - The handler that should be invoked whenever a point select event occurs.

Returns:

A reference to this BaseChart instance for convenient method chaining.

Since:

1.1.0

getPointSelectEventHandler

public PointSelectEventHandler getPointSelectEventHandler()

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

Returns:

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

Since:

1.1.0

setPointUnselectEventHandler

public SeriesPlotOptions setPointUnselectEventHandler(PointUnselectEventHandler pointUnselectEventHandler)

Set a callback handler that will be invoked whenever the user unselects a point in a series.

Parameters:

pointUnselectEventHandler - The handler that should be invoked whenever a point unselect event occurs.

Returns:

A reference to this BaseChart instance for convenient method chaining.

Since:

1.1.0

getPointUnselectEventHandler

public PointUnselectEventHandler getPointUnselectEventHandler()

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

Returns:

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

Since:

1.1.0

setPointUpdateEventHandler

public SeriesPlotOptions setPointUpdateEventHandler(PointUpdateEventHandler pointUpdateEventHandler)

Set a callback handler that will be invoked whenever the a point in a series is updated programatically.

Parameters:

pointUpdateEventHandler - The handler that should be invoked whenever a point update event occurs.

Returns:

A reference to this BaseChart instance for convenient method chaining.

Since:

1.1.0

getPointUpdateEventHandler

public PointUpdateEventHandler getPointUpdateEventHandler()

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

Returns:

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

Since:

1.1.0