org.moxieapps.gwt.highcharts.client.plotOptions
Class WaterfallPlotOptions

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

public class WaterfallPlotOptions
extends PlotOptions<WaterfallPlotOptions>

Represents the general plot options available for all waterfall type series, which can be set either generically on the chart via the WaterfallPlotOptions 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 waterfall 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 waterfall 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 waterfall 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

WaterfallPlotOptions()

Method Summary

WaterfallPlotOptions	setUpColor(Color upColor) Convenience method for setting the 'upColor' plot option to a gradient or color with an alpha value.
WaterfallPlotOptions	setUpColor(String upColor) Convenience method for setting the 'upColor' option of 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

WaterfallPlotOptions

public WaterfallPlotOptions()

Method Detail

setUpColor

public WaterfallPlotOptions setUpColor(String upColor)

Convenience method for setting the 'upColor' option of the chart. Equivalent to:

     chart.setOption("upColor", "#8BBC21");
 

The chart's upColor is the the color which represents any area on the chart which has a positive value.

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 setUpColor(Color) version instead.

Parameters:

upColor - The color to use for this series.

Returns:

A reference to this PlotOptions instance for convenient method chaining.

setUpColor

public WaterfallPlotOptions setUpColor(Color upColor)

Convenience method for setting the 'upColor' plot option to a gradient or color with an alpha value. Equivalent to:

     chart.setOption("upColor", new Color()
        .setLinearGradient(0.0, 0.0, 1.0, 1.0)
        .addStop(new Color(255, 255, 255))
        .addStop(new Color(200, 200, 255))
     );
 

The chart's upColor is the the color which represents any area on the chart which has a positive value.

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 setUpColor(String) version instead.

Parameters:

upColor - The color to use for the series.

Returns:

A reference to this PlotOptions instance for convenient method chaining