|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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>
public abstract class BaseColumnPlotOptions<T extends BaseColumnPlotOptions>
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.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.moxieapps.gwt.highcharts.client.plotOptions.PlotOptions |
---|
PlotOptions.Cursor, PlotOptions.PointPlacement, PlotOptions.Stacking |
Constructor Summary | |
---|---|
BaseColumnPlotOptions()
|
Method Summary | |
---|---|
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 |
---|
public BaseColumnPlotOptions()
Method Detail |
---|
public T setBorderColor(String borderColor)
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.
borderColor
- The value to set as the 'borderColor' option of the column plots.
ColumnPlotOptions
instance for convenient method chaining.public T setBorderColor(Color borderColor)
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.
borderColor
- The color gradient or color with an alpha channel to set as the 'borderColor' option of the area plot.
ColumnPlotOptions
instance for convenient method chaining.public T setBorderRadius(Number borderRadius)
columnPlotOptions.setOption("borderRadius", 4);
The corner radius of the border surrounding each column or bar. Defaults to 0.
borderRadius
- The corner radius of the border surrounding each column or bar.
ColumnPlotOptions
instance for convenient method chaining.public T setBorderWidth(Number borderWidth)
columnPlotOptions.setOption("borderWidth", 4);
The width of the border surrounding each column or bar. Defaults to 1.
borderWidth
- The width of the border surrounding each column or bar.
ColumnPlotOptions
instance for convenient method chaining.public T setColorByPoint(boolean colorByPoint)
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".
colorByPoint
- Whether the chart should receive one color per series or one color per point.
ColumnPlotOptions
instance for convenient method chaining.public T setDepth(Number depth)
columnPlotOptions.setOption("depth", 40);
Depth of the columns in a 3D column chart. Requires highcharts-3d.js. Defaults to 25.
depth
- A number representing the depth of the columns in the 3D chart.
ColumnPlotOptions
instance for convenient method chaining.public T setGroupPadding(Number groupPadding)
columnPlotOptions.setOption("groupPadding", 4);
Padding between each value groups, in x axis units. Defaults to 0.2.
groupPadding
- Padding between each value groups, in x axis units.
ColumnPlotOptions
instance for convenient method chaining.public T setMinPointLength(Number minPointLength)
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.
minPointLength
- The minimal height for a column or width for a bar.
ColumnPlotOptions
instance for convenient method chaining.public T setPointPadding(Number pointPadding)
columnPlotOptions.setOption("pointPadding", 0.5);
Padding between each column or bar, in x axis units. Defaults to 0.1.
pointPadding
- Padding between each column or bar, in x axis units.
ColumnPlotOptions
instance for convenient method chaining.public T setPointWidth(Number pointWidth)
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.
pointWidth
- A pixel value specifying a fixed width for each column or bar.
ColumnPlotOptions
instance for convenient method chaining.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |