org.moxieapps.gwt.highcharts.client.plotOptions

Class BaseColumnPlotOptions<T extends BaseColumnPlotOptions>

java.lang.Object

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

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

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

Direct Known Subclasses:

BaseStatisticalPlotOptions, ColumnPlotOptions, ColumnRangePlotOptions

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

A common base class for BoxPlotOptions, ColumnPlotOptions and ColumnRangePlotOptions 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

Constructors

Constructor and Description
BaseColumnPlotOptions()

Method Summary

Methods

Modifier and Type	Method and Description
T	setBorderColor(Color borderColor) Convenience method for setting the 'borderColor' option of the column plot options, allowing for colors with opacity or gradients.
T	setBorderColor(String borderColor) Convenience method for setting the 'borderColor' option of the column plot options to a RGB hex value.
T	setBorderRadius(Number borderRadius) Convenience method for setting the 'borderRadius' option of the column plot options.
T	setBorderWidth(Number borderWidth) Convenience method for setting the 'borderWidth' option of the column plot options.
T	setColorByPoint(boolean colorByPoint) Convenience method for setting the 'colorByPoint' option of the column plot options.
T	setDepth(Number depth) Convenience method for setting the 'depth' option of the column plot options.
T	setGroupPadding(Number groupPadding) Convenience method for setting the 'groupPadding' option of the column plot options.
T	setMinPointLength(Number minPointLength) Convenience method for setting the 'minPointLength' option of the column plot options.
T	setPointPadding(Number pointPadding) Convenience method for setting the 'pointPadding' option of the column plot options.
T	setPointWidth(Number pointWidth) Convenience method for setting the 'pointWidth' option of the column plot options.

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

BaseColumnPlotOptions

public BaseColumnPlotOptions()

Method Detail

setBorderColor

public T setBorderColor(String borderColor)

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

     columnPlotOptions.setOption("borderColor", "#CCCCCC");
 

The color of the border surrounding each column or bar. Defaults to "#FFFFFF".

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 setBorderColor(org.moxieapps.gwt.highcharts.client.Color) version instead.

Parameters:

borderColor - The value to set as the 'borderColor' option of the column plots.

Returns:

A reference to this ColumnPlotOptions instance for convenient method chaining.

setBorderColor

public T setBorderColor(Color borderColor)

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

     columnPlotOptions.setOption("borderColor", new Color()
        .setLinearGradient(0.0, 0.0, 1.0, 1.0)
        .addStop(new Color(255, 255, 255))
        .addStop(new Color(200, 200, 255))
     );
 

The color of the border surrounding each column or bar. Defaults to "#FFFFFF".

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

Parameters:

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

Returns:

A reference to this ColumnPlotOptions instance for convenient method chaining.

setBorderRadius

public T setBorderRadius(Number borderRadius)

Convenience method for setting the 'borderRadius' option of the column plot options. Equivalent to:

     columnPlotOptions.setOption("borderRadius", 4);
 

The corner radius of the border surrounding each column or bar. Defaults to 0.

Parameters:

borderRadius - The corner radius of the border surrounding each column or bar.

Returns:

A reference to this ColumnPlotOptions instance for convenient method chaining.

setBorderWidth

public T setBorderWidth(Number borderWidth)

Convenience method for setting the 'borderWidth' option of the column plot options. Equivalent to:

     columnPlotOptions.setOption("borderWidth", 4);
 

The width of the border surrounding each column or bar. Defaults to 1.

Parameters:

borderWidth - The width of the border surrounding each column or bar.

Returns:

A reference to this ColumnPlotOptions instance for convenient method chaining.

setColorByPoint

public T setColorByPoint(boolean colorByPoint)

Convenience method for setting the 'colorByPoint' option of the column plot options. Equivalent to:

     columnPlotOptions.setOption("colorByPoint", true);
 

When using automatic point colors pulled from the options.colors collection, this option determines whether the chart should receive one color per series or one color per point. Defaults to false. TODO: Fix javadoc reference to "options.colors".

Parameters:

colorByPoint - Whether the chart should receive one color per series or one color per point.

Returns:

A reference to this ColumnPlotOptions instance for convenient method chaining.

setDepth

public T setDepth(Number depth)

Convenience method for setting the 'depth' option of the column plot options. Equivalent to:

     columnPlotOptions.setOption("depth", 40);
 

Depth of the columns in a 3D column chart. Requires highcharts-3d.js. Defaults to 25.

Parameters:

depth - A number representing the depth of the columns in the 3D chart.

Returns:

A reference to this ColumnPlotOptions instance for convenient method chaining.

setGroupPadding

public T setGroupPadding(Number groupPadding)

Convenience method for setting the 'groupPadding' option of the column plot options. Equivalent to:

     columnPlotOptions.setOption("groupPadding", 4);
 

Padding between each value groups, in x axis units. Defaults to 0.2.

Parameters:

groupPadding - Padding between each value groups, in x axis units.

Returns:

A reference to this ColumnPlotOptions instance for convenient method chaining.

setMinPointLength

public T setMinPointLength(Number minPointLength)

Convenience method for setting the 'minPointLength' option of the column plot options. Equivalent to:

     columnPlotOptions.setOption("minPointLength", 4);
 

The minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed values. Defaults to 0.

Parameters:

minPointLength - The minimal height for a column or width for a bar.

Returns:

A reference to this ColumnPlotOptions instance for convenient method chaining.

setPointPadding

public T setPointPadding(Number pointPadding)

Convenience method for setting the 'pointPadding' option of the column plot options. Equivalent to:

     columnPlotOptions.setOption("pointPadding", 0.5);
 

Padding between each column or bar, in x axis units. Defaults to 0.1.

Parameters:

pointPadding - Padding between each column or bar, in x axis units.

Returns:

A reference to this ColumnPlotOptions instance for convenient method chaining.

setPointWidth

public T setPointWidth(Number pointWidth)

Convenience method for setting the 'pointWidth' option of the column plot options. Equivalent to:

     columnPlotOptions.setOption("pointWidth", 2.0);
 

A pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the setPointPadding(Number) and setGroupPadding(Number). Defaults to null.

Parameters:

pointWidth - A pixel value specifying a fixed width for each column or bar.

Returns:

A reference to this ColumnPlotOptions instance for convenient method chaining.