org.moxieapps.gwt.highcharts.client.plotOptions

Class FunnelPlotOptions

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<FunnelPlotOptions>

org.moxieapps.gwt.highcharts.client.plotOptions.FunnelPlotOptions

public class FunnelPlotOptions
extends BaseProportionalPlotOptions<FunnelPlotOptions>

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

Constructors

Constructor and Description
FunnelPlotOptions()

Method Summary

Methods

Modifier and Type	Method and Description
FunnelPlotOptions	setFunnelDataLabels(FunnelDataLabels funnelDataLabels) Convenience method for setting the 'dataLabels' plot option to a configuration object that is more specific to funnel charts.
FunnelPlotOptions	setHeight(Number height) Convenience method for setting the 'height' option of a funnel chart.
FunnelPlotOptions	setHeight(String height) Convenience method for setting the 'height' option of a funnel chart.
FunnelPlotOptions	setNeckHeight(Number height) Convenience method for setting the "height" option for the funnel plot options.
FunnelPlotOptions	setNeckHeight(String neckHeight) Convenience method for setting the "height" option for the funnel plot options.
FunnelPlotOptions	setNeckWidth(Number neckWidth) Convenience method for setting the "neckWidth" option for the funnel plot options.
FunnelPlotOptions	setNeckWidth(String neckWidth) Convenience method for setting the "neckWidth" option for the funnel plot options.
FunnelPlotOptions	setWidth(Number width) Convenience method for setting the "width" option for the funnel plot options.
FunnelPlotOptions	setWidth(String width) Convenience method for setting the "width" option for the funnel plot options.

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 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

FunnelPlotOptions

public FunnelPlotOptions()

Method Detail

setFunnelDataLabels

public FunnelPlotOptions setFunnelDataLabels(FunnelDataLabels funnelDataLabels)

Convenience method for setting the 'dataLabels' plot option to a configuration object that is more specific to funnel charts. Equivalent to:

 funnelPlotOptions.setOption("/dataLabels/connectorWidth", 2.0);
 funnelPlotOptions.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:

funnelDataLabels - The configuration of how the pie's data labels should appear.

Returns:

A reference to this PiePlotOptions instance for convenient method chaining.

setHeight

public FunnelPlotOptions setHeight(Number height)

Convenience method for setting the 'height' option of a funnel chart. Equivalent to:

     funnelPlotOptions.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 PiePlotOptions instance for convenient method chaining.

Since:

1.7.0

See Also:

setHeight(String)

setHeight

public FunnelPlotOptions setHeight(String height)

Convenience method for setting the 'height' option of a funnel chart. Equivalent to:

     funnelPlotOptions.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 PiePlotOptions instance for convenient method chaining.

Since:

1.7.0

See Also:

setHeight(Number)

setNeckHeight

public FunnelPlotOptions setNeckHeight(Number height)

Convenience method for setting the "height" option for the funnel plot options. Equivalent to:

     funnelPlotOptions.setOptions("height", 4.0);
 

The height of the neck, the lower part of a funnel. 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.

Parameters:

height - The height, in pixels, of the neck.

Returns:

A reference to this FunnelPlotOptions instance for convenient method chaining.

setNeckHeight

public FunnelPlotOptions setNeckHeight(String neckHeight)

Convenience method for setting the "height" option for the funnel plot options. Equivalent to:

     funnelPlotOptions.setOptions("height", "5%");
 

The height of the neck, the lower part of a funnel. 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.

Parameters:

neckHeight - The height of the neck, as a percentage of the plot area height.

Returns:

A reference to this FunnelPlotOptions instance for convenient method chaining.

setNeckWidth

public FunnelPlotOptions setNeckWidth(Number neckWidth)

Convenience method for setting the "neckWidth" option for the funnel plot options. Equivalent to:

     funnelPlotOptions.setOptions("neckWidth", 3.0);
 

The width of the neck, the lower part of the funnel. A number defines pixel width, a percentage string defines a percentage of the plot area width.

Parameters:

neckWidth - The width, in pixels, of the neck.

Returns:

A reference to this FunnelPlotOptions instance for convenient method chaining.

setNeckWidth

public FunnelPlotOptions setNeckWidth(String neckWidth)

Convenience method for setting the "neckWidth" option for the funnel plot options. Equivalent to:

     funnelPlotOptions.setOptions("neckWidth", "10%");
 

The width of the neck, the lower part of the funnel. A number defines pixel width, a percentage string defines a percentage of the plot area width.

Parameters:

neckWidth - The width of the neck as a percentage of the plot width.

Returns:

A reference to this FunnelPlotOptions instance for convenient method chaining.

setWidth

public FunnelPlotOptions setWidth(Number width)

Convenience method for setting the "width" option for the funnel plot options. Equivalent to:

     funnelPlotOptions.setOptions("width", 50);
 

The width of the funnel compared to the width of the plot area, or the pixel width if it is a number. Defaults to 90%.

Parameters:

width - The width, in pixels, of the funnel.

Returns:

A reference to this FunnelPlotOptions instance for convenient method chaining.

setWidth

public FunnelPlotOptions setWidth(String width)

Convenience method for setting the "width" option for the funnel plot options. Equivalent to:

     funnelPlotOptions.setOptions("width", "50%");
 

The width of the funnel compared to the width of the plot area, or the pixel width if it is a number. Defaults to 90%.

Parameters:

width - The width of the funnel as a percentage of the plot width.

Returns:

A reference to this FunnelPlotOptions instance for convenient method chaining.