org.moxieapps.gwt.highcharts.client.plotOptions
Class PyramidPlotOptions
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<PyramidPlotOptions>
org.moxieapps.gwt.highcharts.client.plotOptions.PyramidPlotOptions
public class PyramidPlotOptions
- extends BaseProportionalPlotOptions<PyramidPlotOptions>
Represents the general plot options available for all pyramid type series, which can be set either generically
on the chart via the BaseChart.setPyramidPlotOptions(PyramidPlotOptions)
)} 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 pyramid 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 pyramid 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 column type
series in the chart), use the Series.setPlotOptions(PlotOptions)
method.
- Since:
- 1.7.0
- Author:
- cskowron@moxiegroup.com (Cory Skowronek)
Methods inherited from class org.moxieapps.gwt.highcharts.client.plotOptions.BaseProportionalPlotOptions |
getPointLegendItemClickEventHandler, setBorderColor, setBorderColor, setBorderWidth, setCenter, setCenter, setDepth, setIgnoreHiddenPoint, setInnerSize, setInnerSize, setMinSize, setPointLegendItemClickEventHandler, setSize, setSize, setSlicedOffset, setStartAngle |
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PyramidPlotOptions
public PyramidPlotOptions()
setHeight
public PyramidPlotOptions setHeight(Number height)
- Convenience method for setting the 'height' option of a funnel chart. Equivalent to:
pyramidPlotOptions.setOption("height", 12);
The height of the funnel or pyramid. If it is a number it defines the pixel height,
if it is a percentage string it is the percentage of the plot area height.
Note that this method is intended for setting the height to a fixed pixel amount. If instead you want to
set the height as percentage of the plot siz you can use the setHeight(String)
instead.
- Parameters:
height
- The height of a funnel in pixels
- Returns:
- A reference to this
PyramidPlotOptions
instance for convenient method chaining. - Since:
- 1.7.0
- See Also:
setHeight(String)
setHeight
public PyramidPlotOptions setHeight(String height)
- Convenience method for setting the 'height' option of a funnel chart. Equivalent to:
pyramidPlotOptions.setOption("height", "12%");
The height of the funnel or pyramid. If it is a number it defines the pixel height,
if it is a percentage string it is the percentage of the plot area height.
Note that this method is intended for setting the height to a percentage of the plot size.
If instead you want to set the height as a set number of pixels you can use the setHeight(Number)
instead.
- Parameters:
height
- The height of a funnel as a percentage of the plot size
- Returns:
- A reference to this
PyramidPlotOptions
instance for convenient method chaining. - Since:
- 1.7.0
- See Also:
setHeight(Number)
setPyramidDataLabels
public PyramidPlotOptions setPyramidDataLabels(PyramidDataLabels pyramidDataLabels)
- Convenience method for setting the 'dataLabels' plot option to a configuration object
that is more specific to funnel charts. Equivalent to:
pyramidPlotOptions.setOption("/dataLabels/connectorWidth", 2.0);
pyramidPlotOptions.setOption("/dataLabels/connectorPadding", 5.0);
etc...
Defines the appearance of the data labels of the pie, which are the static labels for each point.
- Parameters:
pyramidDataLabels
- The configuration of how the pie's data labels should appear.
- Returns:
- A reference to this
PiePlotOptions
instance for convenient method chaining.
Copyright © 2015. All Rights Reserved.