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

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

public class CandlestickPlotOptions
extends PlotOptions<CandlestickPlotOptions>

Represents the general plot options available for all Candlestick type series, which can be set either generically on the chart via the StockChart.setCandlestickPlotOptions(org.moxieapps.gwt.highcharts.client.plotOptions.CandlestickPlotOptions) )} method or directly on a series via the Series.setPlotOptions(org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions) method.

Note that Candlestick series types are only available when using the StockChart widget.

Note that these options are only needed if you want to specifically control the general options for all Candlestick type series in the entire chart. If you instead want to control the options for all series in the chart (not just those of an Candlestick 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 Candlestick type series in the chart), use the Series.setPlotOptions(org.moxieapps.gwt.highcharts.client.plotOptions.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

CandlestickPlotOptions()

Method Summary

CandlestickPlotOptions

setGrouping(boolean grouping) Convenience method for setting the 'grouping' option for 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

CandlestickPlotOptions

public CandlestickPlotOptions()

Method Detail

setGrouping

public CandlestickPlotOptions setGrouping(boolean grouping)

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

     candlestickPlotOptions.setOption("grouping", false);
 

Whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other. Defaults to true.

Parameters:

grouping - False to disable grouping of columns

Returns:

A reference to this CandlestickPlotOptions for convenient method chaining.