org.moxieapps.gwt.highcharts.client.plotOptions
Class BaseStatisticalPlotOptions<T extends BaseStatisticalPlotOptions>

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>
              org.moxieapps.gwt.highcharts.client.plotOptions.BaseStatisticalPlotOptions<T>

Direct Known Subclasses:

BoxPlotOptions, ErrorBarPlotOptions

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

A common base class for both BoxPlotOptions and ErrorBarPlotOptions 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.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

BaseStatisticalPlotOptions()

Method Summary

T	setFillColor(Color fillColor) Convenience method for setting the 'fillColor' option of the box plot options, allowing for colors with opacity or gradients.
T	setFillColor(String fillColor) Convenience method for setting the 'fillColor' option of the box plot options to a RGB hex value.
T	setMedianColor(Color medianColor) Convenience method for setting the 'medianColor' option of the box plot options, allowing for colors with opacity or gradients.
T	setMedianColor(String medianColor) Convenience method for setting the 'medianColor' option of the box plot options to a RGB hex value.
T	setMedianWidth(Number medianWidth) Convenience method for setting the 'medianWidth' option of the box plot options.
T	setStemColor(Color stemColor) Convenience method for setting the 'stemColor' option of the box plot options.
T	setStemColor(String stemColor) Convenience method for setting the 'stemColor' option of the box plot options.
T	setStemDashStyle(PlotLine.DashStyle stemDashStyle) Convenience method for setting the 'dashStyle' option of the box plot options.
T	setStemWidth(Number stemWidth) Convenience method for setting the 'dashStyle' option of the box plot options.
T	setWhiskerColor(Color whiskerColor) Convenience method for setting the 'whiskerColor' option of the box plot options.
T	setWhiskerColor(String whiskerColor) Convenience method for setting the 'whiskerColor' option of the box plot options.
T	setWhiskerLength(Number whiskerLength) Convenience method for setting the 'whiskerLength' option of the box plot options.
T	setWhiskerLength(String whiskerLength) Convenience method for setting the 'whiskerColor' option of the box plot options.
T	setWhiskerWidth(Number whiskerWidth) Convenience method for setting the 'whiskerWidth' option of the box plot options.

Methods inherited from class org.moxieapps.gwt.highcharts.client.plotOptions.BaseColumnPlotOptions

setBorderColor, setBorderColor, setBorderRadius, setBorderWidth, setColorByPoint, setDepth, setGroupPadding, setMinPointLength, setPointPadding, setPointWidth

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

BaseStatisticalPlotOptions

public BaseStatisticalPlotOptions()

Method Detail

setFillColor

public T setFillColor(String fillColor)

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

     boxPlotOptions.setOption("fillColor", "#CCCCCC");
 

Fill color or gradient for the area. When null, the series' color is used with the series' fillOpacity. Defaults to null.

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

Parameters:

fillColor - The value to set as the 'fillColor' option of the box plots.

Returns:

A reference to this BoxPlotOptions instance for convenient method chaining.

setFillColor

public T setFillColor(Color fillColor)

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

     boxPlotOptions.setOption("fillColor", new Color()
        .setLinearGradient(0.0, 0.0, 1.0, 1.0)
        .addStop(new Color(255, 255, 255))
        .addStop(new Color(200, 200, 255))
     );
 

Fill color or gradient for the area. When null, the series' color is used with the series' fillOpacity. Defaults to null.

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

Parameters:

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

Returns:

A reference to this BoxPlotOptions instance for convenient method chaining.

setMedianColor

public T setMedianColor(String medianColor)

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

     boxPlotOptions.setOption("medianColor", "#CCCCCC");
 

The color of the median line. If null, the general series color applies. Defaults to null.

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

Parameters:

medianColor - The value to set as the 'medianColor' option of the box plots.

Returns:

A reference to this BoxPlotOptions instance for convenient method chaining.

setMedianColor

public T setMedianColor(Color medianColor)

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

     boxPlotOptions.setOption("medianColor", 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 median line. If null, the general series color applies. Defaults to null.

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

Parameters:

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

Returns:

A reference to this BoxPlotOptions instance for convenient method chaining.

setMedianWidth

public T setMedianWidth(Number medianWidth)

Convenience method for setting the 'medianWidth' option of the box plot options. Equivalent to:

     boxPlotOptions.setOption("medianWidth", 4);
 

The pixel width of the median line. If null, the lineWidth is used. Defaults to 2.

Parameters:

medianWidth - The width in pixels of the median line.

Returns:

A reference to this BoxPlotOptions instance for convenient method chaining.

setStemColor

public T setStemColor(String stemColor)

Convenience method for setting the 'stemColor' option of the box plot options. Equivalent to:

     boxPlotOptions.setOption("stemColor", "#CCCCCC");
 

The color of the stem, the vertical line extending from the box to the whiskers. If null, the series color is used. Defaults to null.

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

Parameters:

stemColor - The value to set as the 'stemColor' option of the box plots.

Returns:

A reference to this BoxPlotOptions instance for convenient method chaining.

setStemColor

public T setStemColor(Color stemColor)

Convenience method for setting the 'stemColor' option of the box plot options. Equivalent to:

     boxPlotOptions.setOption("stemColor", 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 stem, the vertical line extending from the box to the whiskers. If null, the series color is used. Defaults to null.

Parameters:

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

Returns:

A reference to this BoxPlotOptions instance for convenient method chaining.

setStemDashStyle

public T setStemDashStyle(PlotLine.DashStyle stemDashStyle)

Convenience method for setting the 'dashStyle' option of the box plot options. Equivalent to:

     boxPlotOptions.setOption("stemDashStyle", PlotOptions.DashStyle.DOT);
 

The dash style of the stem, the vertical line extending from the box to the whiskers. Defaults to Solid.

Parameters:

stemDashStyle - The dash style to use for this series, or null to use the default.

Returns:

A reference to this BoxPlotOptions instance for convenient method chaining.

setStemWidth

public T setStemWidth(Number stemWidth)

Convenience method for setting the 'dashStyle' option of the box plot options. Equivalent to:

     boxPlotOptions.setOption("stemDashWidth", 5);
 

The width of the stem, the vertical line extending from the box to the whiskers. If null, the width is inherited from the lineWidth option. Defaults to null.

Parameters:

stemWidth - The width in pixels to use for the stem width

Returns:

A reference to this BoxPlotOptions instance for convenient method chaining.

setWhiskerColor

public T setWhiskerColor(String whiskerColor)

Convenience method for setting the 'whiskerColor' option of the box plot options. Equivalent to:

     boxPlotOptions.setOption("whiskerColor", "#CCCCCC");
 

The color of the whiskers, the horizontal lines marking low and high values. When null, the general series color is used. Defaults to null.

Parameters:

whiskerColor - The value to set as the 'whiskerColor' option of the box plots.

Returns:

A reference to this BoxPlotOptions instance for convenient method chaining.

setWhiskerColor

public T setWhiskerColor(Color whiskerColor)

Convenience method for setting the 'whiskerColor' option of the box plot options. Equivalent to:

     boxPlotOptions.setOption("whiskerColor", 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 whiskers, the horizontal lines marking low and high values. When null, the general series color is used. Defaults to null.

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

Parameters:

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

Returns:

A reference to this BoxPlotOptions instance for convenient method chaining.

setWhiskerLength

public T setWhiskerLength(Number whiskerLength)

Convenience method for setting the 'whiskerLength' option of the box plot options. Equivalent to:

     boxPlotOptions.setOption("whiskerLength", "25");
 

The length of the whiskers, the horizontal lines marking low and high values. It can be a numerical pixel value, or a percentage value of the box width. Set 0 to disable whiskers. Defaults to 50%.

Note: This method is for denoting the whisker length as a number of pixels. If you wish to set its length as a percentage of the box width, use this setWhiskerLength(String).

Parameters:

whiskerLength - The length, in pixels, of the whisker.

Returns:

A reference to this BoxPlotOptions instance for convenient method chaining.

setWhiskerLength

public T setWhiskerLength(String whiskerLength)

Convenience method for setting the 'whiskerColor' option of the box plot options. Equivalent to:

     boxPlotOptions.setOption("whiskerLength", "25%);
 

The length of the whiskers, the horizontal lines marking low and high values. It can be a numerical pixel value, or a percentage value of the box width. Set 0 to disable whiskers. Defaults to 50%.

Note: This method is for denoting the whisker length as a percentage of box width. If you wish to set its length as a number of pixels, use this setWhiskerLength(Number).

Parameters:

whiskerLength - The length, as a percentage, of the whisker.

Returns:

A reference to this BoxPlotOptions instance for convenient method chaining.

setWhiskerWidth

public T setWhiskerWidth(Number whiskerWidth)

Convenience method for setting the 'whiskerWidth' option of the box plot options. Equivalent to:

     boxPlotOptions.setOption("whiskerWidth", 25);
 

The line width of the whiskers, the horizontal lines marking low and high values. When null, the general lineWidth applies. Defaults to null.

Parameters:

whiskerWidth -

Returns:

A reference to this BoxPlotOptions instance for convenient method chaining.