|
||||||||||
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.BaseProportionalPlotOptions<T>
public abstract class BaseProportionalPlotOptions<T extends BaseProportionalPlotOptions>
A common base class for both FunnelPlotOptions
and PiePlotOptions
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 | |
---|---|
BaseProportionalPlotOptions()
|
Method Summary | |
---|---|
PointLegendItemClickEventHandler |
getPointLegendItemClickEventHandler()
Returns the custom event handler that has been set on the plot options, or null if no event handler has been set. |
T |
setBorderColor(Color borderColor)
Convenience method for setting the 'borderColor' option of the pie plot options, allowing for colors with opacity or gradients. |
T |
setBorderColor(String borderColor)
Convenience method for setting the "borderColor" option for the pie plot options to a RGB hex value. |
T |
setBorderWidth(Number borderWidth)
Convenience method for setting the "borderWidth" option for the pie plot options. |
T |
setCenter(double xPercent,
double yPercent)
Convenience method for setting the 'center' option of the pie plot options to percentage values. |
T |
setCenter(int x,
int y)
Convenience method for setting the 'center' option of the pie plot options to pixel values. |
T |
setDepth(Number depth)
Convenience method for setting the 'depth option of the plot. |
T |
setIgnoreHiddenPoint(boolean ignoreHiddenPoint)
Convenience method for setting the "ignoreHiddenPoint" option for the pie plot options. |
T |
setInnerSize(double innerSize)
Convenience method for setting the 'innerSize' option of the pie plot options to a percentage value. |
T |
setInnerSize(int innerSize)
Convenience method for setting the 'innerSize' option of the pie plot options to pixel values. |
T |
setMinSize(Number minSize)
Convenience method for setting the "minSize" option for the pie plot options. |
BaseProportionalPlotOptions |
setPointLegendItemClickEventHandler(PointLegendItemClickEventHandler pointLegendItemClickEventHandler)
Set a callback handler that will be invoked whenever the user clicks on the legend item points in a pie or funnel series. |
T |
setSize(double size)
Convenience method for setting the 'size' option of the pie plot options to a percentage value. |
T |
setSize(int size)
Convenience method for setting the 'size' option of the pie plot options to pixel values. |
T |
setSlicedOffset(Number slicedOffset)
Convenience method for setting the "slicedOffset" option for the pie plot options. |
T |
setStartAngle(Number startAngle)
Convenience method for setting the "startAngle" option for the pie 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 BaseProportionalPlotOptions()
Method Detail |
---|
public T setBorderColor(String borderColor)
piePlotOptions.setOption("borderColor", "#CCCCCC");
The color of the border surrounding each slice. 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(Color)
version instead.
borderColor
- The value to set as the 'borderColor' option of the box plots.
BaseProportionalPlotOptions
instance for convenient method chaining.setBorderColor(Color)
public T setBorderColor(Color borderColor)
piePlotOptions.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 slice. 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 box plot.
BaseProportionalPlotOptions
instance for convenient method chaining.setBorderColor(String)
public T setBorderWidth(Number borderWidth)
piePlotOptions.setOptions("borderWidth", 2);
The width of the border surrounding each slice. Defaults to 1.
borderWidth
- The width of the border
BaseProportionalPlotOptions
instance for convenient method chaining.public T setCenter(int x, int y)
piePlotOptions.setOption("center", new Number[] { 100, 120 });
The center of the pie chart relative to the plot area (in pixels). See the
setCenter(double, double)
method to set the center using percentages instead.
Defaults to 50%, 50%.
x
- The horizontal center of the pie chart relative to the plot area (in pixels)y
- The vertical center of the pie chart relative to the plot area (in pixels)
BaseProportionalPlotOptions
instance for convenient method chaining.public T setCenter(double xPercent, double yPercent)
piePlotOptions.setOption("center", new String[] { "50%", "40%" });
The center of the pie chart relative to the plot area (as a percentage). See the
setCenter(int, int)
method to set the center using pixels instead.
Defaults to 50%, 50%.
Note that the percentage is specified by providing a floating point number in the
range of 0.0 to 1.0, where 0.0 is equivalent to "0%" and 1.0 is equivalent to "100%".
xPercent
- The horizontal percent center of the pie chart relative to the plot area (0.0 to 1.0)yPercent
- The vertical percent center of the pie chart relative to the plot area (0.0 to 1.0)
BaseProportionalPlotOptions
instance for convenient method chaining.public T setDepth(Number depth)
piePlotOptions.setOption("depth", 25);
The thickness of a 3D pie. Defaults to 0.
Note: This option requires highcharts-3d.js
depth
- The thickness of a 3D pie.
BaseProportionalPlotOptions
instance for convenient method chaining.public T setIgnoreHiddenPoint(boolean ignoreHiddenPoint)
piePlotOptions.setOptions("ignoreHiddenPoint", false);
Equivalent to BaseChart.setIgnoreHiddenSeries(boolean)
, this option tells whether the series shall be redrawn as if the hidden point were null.
The default value changed from false to true with Highcharts 3.0.
Defaults to true.
ignoreHiddenPoint
- Whether to redraw the chart if a hidden point is null.
BaseProportionalPlotOptions
instance for convenient method chaining.public T setInnerSize(int innerSize)
piePlotOptions.setOption("innerSize", 100);
The size of the inner diameter for the pie. A size greater than 0 renders a donut chart.
setInnerSize(double)
method to set the innerSize using percentages instead.
Defaults to 0.
innerSize
- The size of the inner diameter for the pie.
BaseProportionalPlotOptions
instance for convenient method chaining.public T setInnerSize(double innerSize)
piePlotOptions.setOption("innerSize", "50%");
The size of the inner diameter for the pie. A size greater than 0 renders a donut chart.
See the setInnerSize(int)
method to set the innerSize using pixels instead.
Defaults to 0.
Note that the percentage is specified by providing a floating point number in the
range of 0.0 to 1.0, where 0.0 is equivalent to "0%" and 1.0 is equivalent to "100%".
innerSize
- The percentage size of the inner diameter for the pie. (0.0 to 1.0)
BaseProportionalPlotOptions
instance for convenient method chaining.public T setMinSize(Number minSize)
piePlotOptions.setOptions("minSize", true);
The minimum size for a pie in response to auto margins. The pie will try to shrink to make room
for data labels in side the plot area, but only to this size. Defaults to 80.
minSize
- The minimum size for a pie in response to auto margins
BaseProportionalPlotOptions
instance for convenient method chaining.public T setSize(int size)
piePlotOptions.setOption("size", 100);
The diameter of the pie relative to the plot area (in pixels). See the
setSize(double)
method to set the size using percentages instead.
Defaults to 75%.
size
- The diameter of the pie relative to the plot area.
BaseProportionalPlotOptions
instance for convenient method chaining.public T setSize(double size)
piePlotOptions.setOption("size", "50%");
The diameter of the pie relative to the plot area (as a percentage). See the
setSize(int)
method to set the size using pixels instead.
Defaults to 75%.
Note that the percentage is specified by providing a floating point number in the
range of 0.0 to 1.0, where 0.0 is equivalent to "0%" and 1.0 is equivalent to "100%".
size
- The percent diameter of the pie relative to the plot area. (0.0 to 1.0)
BaseProportionalPlotOptions
instance for convenient method chaining.public T setSlicedOffset(Number slicedOffset)
piePlotOptions.setOptions("slicedOffset", 25);
If a point is sliced, moved out from the center, how many pixels should it be moved?. Defaults to 10.
slicedOffset
- The number of pixels the point should be moved if it is sliced.
BaseProportionalPlotOptions
instance for convenient method chaining.public T setStartAngle(Number startAngle)
piePlotOptions.setOptions("startAngle", 45);
The start angle of the pie slices in degrees where 0 is top and 90 right. Defaults to 0.
startAngle
- The start angle of the pie slices in degrees where 0 is top and 90 right
BaseProportionalPlotOptions
instance for convenient method chaining.public BaseProportionalPlotOptions setPointLegendItemClickEventHandler(PointLegendItemClickEventHandler pointLegendItemClickEventHandler)
PointLegendItemClickEventHandler
instance
that is passed to the handler's PointLegendItemClickEventHandler.onClick(org.moxieapps.gwt.highcharts.client.events.PointLegendItemClickEvent)
method.
pointLegendItemClickEventHandler
- The handler that should be invoked whenever a legend item click event occurs.
BaseChart
instance for convenient method chaining.public PointLegendItemClickEventHandler getPointLegendItemClickEventHandler()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |