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

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

public class BarPlotOptions
extends PlotOptions<BarPlotOptions>

Represents the general plot options available for all bar type series, which can be set either generically on the chart via the BaseChart.setBarPlotOptions(BarPlotOptions) )} 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 bar 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 bar 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 bar type series in the chart), use 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

BarPlotOptions()

Method Summary

BarPlotOptions	setBorderColor(Color borderColor) Convenience method for setting the 'borderColor' option of the bar plot options, allowing for colors with opacity or gradients.
BarPlotOptions	setBorderColor(String borderColor) Convenience method for setting the 'borderColor' option of the bar plot options to a RGB hex value.
BarPlotOptions	setBorderRadius(Number borderRadius) Convenience method for setting the 'borderRadius' option of the bar plot options.
BarPlotOptions	setBorderWidth(Number borderWidth) Convenience method for setting the 'borderWidth' option of the bar plot options.
BarPlotOptions	setColorByPoint(boolean colorByPoint) Convenience method for setting the 'colorByPoint' option of the bar plot options.
BarPlotOptions	setGroupPadding(Number groupPadding) Convenience method for setting the 'groupPadding' option of the bar plot options.
BarPlotOptions	setMinPointLength(Number minPointLength) Convenience method for setting the 'minPointLength' option of the bar plot options.
BarPlotOptions	setPointPadding(Number pointPadding) Convenience method for setting the 'pointPadding' option of the bar plot options.
BarPlotOptions	setPointWidth(Number pointWidth) Convenience method for setting the 'pointWidth' option of the bar 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

BarPlotOptions

public BarPlotOptions()

Method Detail

setBorderColor

public BarPlotOptions setBorderColor(String borderColor)

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

     barPlotOptions.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 bar plots.

Returns:

A reference to this BarPlotOptions instance for convenient method chaining.

Since:

1.1.3

setBorderColor

public BarPlotOptions setBorderColor(Color borderColor)

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

     barPlotOptions.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 BarPlotOptions instance for convenient method chaining.

Since:

1.1.3

setBorderRadius

public BarPlotOptions setBorderRadius(Number borderRadius)

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

     barPlotOptions.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 BarPlotOptions instance for convenient method chaining.

Since:

1.1.3

setBorderWidth

public BarPlotOptions setBorderWidth(Number borderWidth)

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

     barPlotOptions.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 BarPlotOptions instance for convenient method chaining.

Since:

1.1.3

setColorByPoint

public BarPlotOptions setColorByPoint(boolean colorByPoint)

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

     barPlotOptions.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 BarPlotOptions instance for convenient method chaining.

Since:

1.1.3

setGroupPadding

public BarPlotOptions setGroupPadding(Number groupPadding)

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

     barPlotOptions.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 BarPlotOptions instance for convenient method chaining.

Since:

1.1.3

setMinPointLength

public BarPlotOptions setMinPointLength(Number minPointLength)

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

     barPlotOptions.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 BarPlotOptions instance for convenient method chaining.

Since:

1.1.3

setPointPadding

public BarPlotOptions setPointPadding(Number pointPadding)

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

     barPlotOptions.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 BarPlotOptions instance for convenient method chaining.

Since:

1.1.3

setPointWidth

public BarPlotOptions setPointWidth(Number pointWidth)

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

     barPlotOptions.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 BarPlotOptions instance for convenient method chaining.

Since:

1.1.3