org.moxieapps.gwt.highcharts.client.plotOptions
Class BaseAreaPlotOptions<T extends BaseAreaPlotOptions>

java.lang.Object
  org.moxieapps.gwt.highcharts.client.Configurable<T>
      org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions<T>
          org.moxieapps.gwt.highcharts.client.plotOptions.BaseAreaPlotOptions<T>

Direct Known Subclasses:

AreaPlotOptions, AreaRangePlotOptions

public abstract class BaseAreaPlotOptions<T extends BaseAreaPlotOptions>
extends PlotOptions<T>

A common base class for both AreaPlotOptions and AreaRangePlotOptions to prevent code duplication while still maintaining a cleaner way for the user to utilize the method chaining with the generics in place. You should not use this class directly, but instead use one of the base classes.

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

BaseAreaPlotOptions()

Method Summary

T	setConnectNulls(boolean connectNulls) Convenience method for setting the 'connectNulls' option of the area plot options.
T	setFillColor(Color fillColor) Convenience method for setting the 'fillColor' option of the area plot options, allowing for colors with opacity or gradients.
T	setFillColor(String fillColor) Convenience method for setting the 'fillColor' option of the area plot options to a RGB hex value.
T	setFillOpacity(Number fillOpacity) Convenience method for setting the 'fillOpacity' option of the area plot options.
T	setGapSize(Number gapSize) Convenience Method for setting the "gapSize" option of the plot options.
T	setLineColor(Color lineColor) Convenience method for setting the 'lineColor' option of the area plot options, allowing for colors with opacity or gradients.
T	setLineColor(String lineColor) Convenience method for setting the 'lineColor' option of the area plot options to a RGB hex value.
T	setNegativeFillColor(Color negativeFillColor) areaPlotOptions.setOption("negativeFillColor", new Color() .setLinearGradient(0.0, 0.0, 1.0, 1.0) .addStop(new Color(255, 255, 255)) .addStop(new Color(200, 200, 255)) );
T	setNegativeFillColor(String negativeFillColor) Convenience method for setting the "negativeFillColor" option for area charts.
T	setTrackByArea(boolean trackByArea) Convenience method for setting the 'trackByArea' option for area charts.

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

BaseAreaPlotOptions

public BaseAreaPlotOptions()

Method Detail

setConnectNulls

public T setConnectNulls(boolean connectNulls)

Convenience method for setting the 'connectNulls' option of the area plot options. Equivalent to:

     areaPlotOptions.setOption("connectNulls", true);
 

Whether to connect a graph line across null points. Defaults to false.

Parameters:

connectNulls - 'true' to connect the graph across null points.

Returns:

A reference to this AreaPlotOptions instance for convenient method chaining.

Since:

1.6.0

setFillColor

public T setFillColor(String fillColor)

Convenience method for setting the 'fillColor' option of the area plot options to a RGB hex value. Equivalent to:

     areaPlotOptions.setOption("fillColor", "#CCCCCC");
 

Fill color or gradient for the area. When null, the series' color is used with the series' fillOpacity. Defaults to null.

Note that this method is intended for setting the color to a simple RBG hex value. If you instead want to set a color to include an alpha channel or a gradient, use the setFillColor(Color) version instead.

Parameters:

fillColor - The value to set as the 'fillColor' option of the area plots.

Returns:

A reference to this AreaPlotOptions instance for convenient method chaining.

setFillColor

public T setFillColor(Color fillColor)

Convenience method for setting the 'fillColor' option of the area plot options, allowing for colors with opacity or gradients. Equivalent to:

     areaPlotOptions.setOption("fillColor", new Color()
        .setLinearGradient(0.0, 0.0, 1.0, 1.0)
        .addStop(new Color(255, 255, 255))
        .addStop(new Color(200, 200, 255))
     );
 

Fill color or gradient for the area. When null, the series' color is used with the series' fillOpacity. Defaults to null.

Note that this method is intended for setting the color to a gradient or color that includes an alpha channel. If you instead just want to set the color to a normal RGB hex value you can use the setFillColor(String) version instead.

Parameters:

fillColor - The color gradient or color with an alpha channel to set as the 'fillColor' option of the area plot.

Returns:

A reference to this AreaPlotOptions instance for convenient method chaining.

setFillOpacity

public T setFillOpacity(Number fillOpacity)

Convenience method for setting the 'fillOpacity' option of the area plot options. Equivalent to:

     areaPlotOptions.setOption("fillOpacity", 0.5);
 

Fill opacity for the area. Defaults to .75.

Parameters:

fillOpacity - Fill opacity for the area.

Returns:

A reference to this AreaPlotOptions instance for convenient method chaining.

setGapSize

public T setGapSize(Number gapSize)

Convenience Method for setting the "gapSize" option of the plot options. Equivalent to:

     areaPlotOptions.setOption("gapSize", 5);
 

Defines when to display a gap in the graph. A gap size of 5 means that if the distance between two points is greater than five times that of the two closest points, the graph will be broken.In practice, this option is most often used to visualize gaps in time series. In a stock chart, intraday data is available for daytime hours, while gaps will appear in nights and weekends.. Defaults to 0.

Parameters:

gapSize - The distance between points needed to display a gap in the series.

Returns:

A reference to this AreaPlotOptions instance for convenient method chaining.

Since:

1.6.0

setLineColor

public T setLineColor(String lineColor)

Convenience method for setting the 'lineColor' option of the area plot options to a RGB hex value. Equivalent to:

     areaPlotOptions.setOption("lineColor", "#CCCCCC");
 

A separate color for the graph line. By default the line takes the color of the series, but the lineColor setting allows setting a separate color for the line without altering the fillColor. Defaults to null.

Note that this method is intended for setting the color to a simple RBG hex value. If you instead want to set a color to include an alpha channel or a gradient, use the setLineColor(Color) version instead.

Parameters:

lineColor - The value to set as the 'lineColor' option of the area plots.

Returns:

A reference to this AreaPlotOptions instance for convenient method chaining.

setLineColor

public T setLineColor(Color lineColor)

Convenience method for setting the 'lineColor' option of the area plot options, allowing for colors with opacity or gradients. Equivalent to:

     areaPlotOptions.setOption("lineColor", new Color()
        .setLinearGradient(0.0, 0.0, 1.0, 1.0)
        .addStop(new Color(255, 255, 255))
        .addStop(new Color(200, 200, 255))
     );
 

A separate color for the graph line. By default the line takes the color of the series, but the lineColor setting allows setting a separate color for the line without altering the fillColor. Defaults to null.

Note that this method is intended for setting the color to a gradient or color that includes an alpha channel. If you instead just want to set the color to a normal RGB hex value you can use the setLineColor(String) version instead.

Parameters:

lineColor - The color gradient or color with an alpha channel to set as the 'lineColor' option of the area plots.

Returns:

A reference to this AreaPlotOptions instance for convenient method chaining.

setNegativeFillColor

public T setNegativeFillColor(String negativeFillColor)

Convenience method for setting the "negativeFillColor" option for area charts. Equivalent to:

     areaPlotOptions.setOption("negativeFillColor", "#CCCCCC");
 

A separate color for the negative part of the area.

Note that this method is intended for setting the color to a simple RBG hex value. If you instead want to set a color to include an alpha channel or a gradient, use the setNegativeFillColor(Color) version instead.

Parameters:

negativeFillColor - The value to set as the 'negativeFillColor' option of the area plots.

Returns:

A reference to this AreaPlotOptions instance for convenient method chaining.

Since:

1.6.0

setNegativeFillColor

public T setNegativeFillColor(Color negativeFillColor)

     areaPlotOptions.setOption("negativeFillColor", new Color()
        .setLinearGradient(0.0, 0.0, 1.0, 1.0)
        .addStop(new Color(255, 255, 255))
        .addStop(new Color(200, 200, 255))
     );
 

A separate color for the negative part of the area.

Note that this method is intended for setting the color to a gradient or color that includes an alpha channel. If you instead just want to set the color to a normal RGB hex value you can use the setNegativeFillColor(String) version instead.

Parameters:

negativeFillColor - The color gradient or color with an alpha channel to set as the 'negativeFillColor' option of the area plot.

Returns:

A reference to this AreaPlotOptions instance for convenient method chaining.

Since:

1.6.0

setTrackByArea

public T setTrackByArea(boolean trackByArea)

Convenience method for setting the 'trackByArea' option for area charts. Equivalent to:

     areaPlotOptions.setOption("trackByArea", true);
 

If true, the whole area will respond to mouseover events. If false, just the line will respond. Defaults to false.

Parameters:

trackByArea - Whether the whole area or just the line should respond to mouseover tooltips and other mouse or touch events.

Returns:

A reference to this AreaPlotOptions instance for convenient method chaining.

Since:

1.6.0