Package com.vaadin.flow.component.charts.model

Class PlotOptionsFunnel

java.lang.Object

com.vaadin.flow.component.charts.model.AbstractConfigurationObject

com.vaadin.flow.component.charts.model.AbstractPlotOptions

com.vaadin.flow.component.charts.model.PyramidOptions

com.vaadin.flow.component.charts.model.PlotOptionsFunnel

All Implemented Interfaces:

Serializable

public class PlotOptionsFunnel
extends PyramidOptions

Funnel charts are a type of chart often used to visualize stages in a sales project, where the top are the initial stages with the most clients. It requires that the modules/funnel.js file is loaded.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PlotOptionsFunnel()

Method Summary

Modifier and Type	Method	Description
void	addColor(Color color)	Adds color to the colors array
void	addKey(String key)	Adds key to the keys array
void	addZone(Zones zone)	Adds zone to the zones array
Boolean	getAllowPointSelect()
Number	getAnimationLimit()
Color	getBorderColor()
Number	getBorderWidth()
String[]	getCenter()
ChartType	getChartType()
String	getClassName()
Boolean	getClip()
Number	getColorIndex()
String	getColorKey()
Color[]	getColors()
Boolean	getCrisp()
Cursor	getCursor()
DataLabelsFunnel	getDataLabels()
Number	getDepth()
String	getDescription()
Boolean	getEnableMouseTracking()
Boolean	getExposeElementToA11y()
Dimension	getFindNearestPointBy()
Boolean	getGetExtremesFromAll()
String	getHeight()
Boolean	getIgnoreHiddenPoint()
String[]	getKeys()
String	getLinkedTo()
Number	getMinSize()
String	getNeckHeight()
String	getNeckWidth()
Number	getOpacity()
String	getPointDescriptionFormatter()
Boolean	getReversed()
Boolean	getSelected()
Boolean	getShadow()
Boolean	getShowInLegend()
Boolean	getSkipKeyboardNavigation()
Number	getSlicedOffset()
States	getStates()
Boolean	getStickyTracking()
SeriesTooltip	getTooltip()
Boolean	getVisible()
String	getWidth()
ZoneAxis	getZoneAxis()
Zones[]	getZones()
void	removeColor(Color color)	Removes first occurrence of color in colors array
void	removeKey(String key)	Removes first occurrence of key in keys array
void	removeZone(Zones zone)	Removes first occurrence of zone in zones array
void	setAllowPointSelect(Boolean allowPointSelect)	Allow this series' points to be selected by clicking on the markers, bars or pie slices.
void	setAnimationLimit(Number animationLimit)	For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high.
void	setBorderColor(Color borderColor)	The color of the border surrounding each slice.
void	setBorderWidth(Number borderWidth)	The width of the border surrounding each slice.
void	setCenter(String[] center)	The center of the series.
void	setCenter(String x, String y)
void	setClassName(String className)	A class name to apply to the series' graphical elements.
void	setClip(Boolean clip)	Disable this option to allow series rendering in the whole plotting area.
void	setColorIndex(Number colorIndex)	Styled mode only.
void	setColorKey(String colorKey)	Determines what data value should be used to calculate point color if colorAxis is used.
void	setColors(Color... colors)	A series specific or series type specific color set to use instead of the global colors.
void	setCrisp(Boolean crisp)	When true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen.
void	setCursor(Cursor cursor)	You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
void	setDataLabels(DataLabelsFunnel dataLabels)	Specific data labels configuration for a series type
void	setDepth(Number depth)	The thickness of a 3D pie.
void	setDescription(String description)	Requires Accessibility module
void	setEnableMouseTracking(Boolean enableMouseTracking)	Enable or disable the mouse tracking for a specific series.
void	setExposeElementToA11y(Boolean exposeElementToA11y)	By default, series are exposed to screen readers as regions.
void	setFindNearestPointBy(Dimension findNearestPointBy)	Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.
void	setGetExtremesFromAll(Boolean getExtremesFromAll)	Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis.
void	setHeight(String height)	The height of the funnel or pyramid.
void	setIgnoreHiddenPoint(Boolean ignoreHiddenPoint)	This option tells whether the series shall be redrawn as if the hidden point were null.
void	setKeys(String... keys)	An array specifying which option maps to which key in the data point array.
void	setLinkedTo(String linkedTo)	The id of another series to link to.
void	setMinSize(Number minSize)	The minimum size for a pie in response to auto margins.
void	setNeckHeight(String neckHeight)	The height of the neck, the lower part of the funnel.
void	setNeckWidth(String neckWidth)	The width of the neck, the lower part of the funnel.
void	setOpacity(Number opacity)	Opacity of a series parts: line, fill (e.g.
void	setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)
void	setReversed(Boolean reversed)	A reversed funnel has the widest area down.
void	setSelected(Boolean selected)	Whether to select the series initially.
void	setShadow(Boolean shadow)	Whether to apply a drop shadow to the graph line.
void	setShowInLegend(Boolean showInLegend)	Whether to display this particular series or series type in the legend.
void	setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)	If set to True, the accessibility module will skip past the points in this series for keyboard navigation.
void	setSlicedOffset(Number slicedOffset)	If a point is sliced, moved out from the center, how many pixels should it be moved?.
void	setStates(States states)	A wrapper object for all the series options in specific states.
void	setStickyTracking(Boolean stickyTracking)	Sticky tracking of mouse events.
void	setTooltip(SeriesTooltip tooltip)	A configuration object for the tooltip rendering of each single series.
void	setVisible(Boolean visible)	Set the initial visibility of the series.
void	setWidth(String width)	The width of the funnel compared to the width of the plot area, or the pixel width if it is a number.
void	setZoneAxis(ZoneAxis zoneAxis)	Defines the Axis on which the zones are applied.
void	setZones(Zones... zones)	An array defining zones within a series.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PlotOptionsFunnel

public PlotOptionsFunnel()

Method Details

getChartType

public ChartType getChartType()

Specified by:

getChartType in class PyramidOptions

getAllowPointSelect

public Boolean getAllowPointSelect()

Specified by:

getAllowPointSelect in class PyramidOptions

See Also:

• setAllowPointSelect(Boolean)

setAllowPointSelect

public void setAllowPointSelect(Boolean allowPointSelect)

Allow this series' points to be selected by clicking on the markers, bars or pie slices.

Defaults to: false

Specified by:

setAllowPointSelect in class PyramidOptions

getAnimationLimit

public Number getAnimationLimit()

Specified by:

getAnimationLimit in class PyramidOptions

See Also:

• setAnimationLimit(Number)

setAnimationLimit

public void setAnimationLimit(Number animationLimit)

For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation doesn't run if there is more than 250 points totally. To disable this cap, set animationLimit to Infinity.

Specified by:

setAnimationLimit in class PyramidOptions

getBorderColor

public Color getBorderColor()

See Also:

• setBorderColor(Color)

setBorderColor

public void setBorderColor(Color borderColor)

The color of the border surrounding each slice. When null, the border takes the same color as the slice fill. This can be used together with a borderWidth to fill drawing gaps created by antialiazing artefacts in borderless pies.

In styled mode, the border stroke is given in the .highcharts-point class.

Defaults to: #ffffff

getBorderWidth

public Number getBorderWidth()

See Also:

• setBorderWidth(Number)

setBorderWidth

public void setBorderWidth(Number borderWidth)

The width of the border surrounding each slice.

When setting the border width to 0, there may be small gaps between the slices due to SVG antialiasing artefacts. To work around this, keep the border width at 0.5 or 1, but set the borderColor to null instead.

In styled mode, the border stroke width is given in the .highcharts-point class.

Defaults to: 1

setCenter

public void setCenter(String[] center)

The center of the series. By default, it is centered in the middle of the plot area, so it fills the plot area height.

Defaults to: ["50%", "50%"]

Specified by:

setCenter in class PyramidOptions

getClassName

public String getClassName()

Specified by:

getClassName in class PyramidOptions

See Also:

• setClassName(String)

setClassName

public void setClassName(String className)

A class name to apply to the series' graphical elements.

Specified by:

setClassName in class PyramidOptions

getClip

public Boolean getClip()

Specified by:

getClip in class PyramidOptions

See Also:

• setClip(Boolean)

setClip

public void setClip(Boolean clip)

Disable this option to allow series rendering in the whole plotting area. Note that clipping should be always enabled when chart.zoomType is set.

Defaults to false.

Specified by:

setClip in class PyramidOptions

getColorIndex

public Number getColorIndex()

Specified by:

getColorIndex in class PyramidOptions

See Also:

• setColorIndex(Number)

setColorIndex

public void setColorIndex(Number colorIndex)

Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.

Specified by:

setColorIndex in class PyramidOptions

getColorKey

public String getColorKey()

Specified by:

getColorKey in class PyramidOptions

See Also:

• setColorKey(String)

setColorKey

public void setColorKey(String colorKey)

Determines what data value should be used to calculate point color if colorAxis is used. Requires to set min and max if some custom point property is used or if approximation for data grouping is set to 'sum'.

Defaults to y.

Specified by:

setColorKey in class PyramidOptions

getColors

public Color[] getColors()

Specified by:

getColors in class PyramidOptions

See Also:

• setColors(Color...)

setColors

public void setColors(Color... colors)

A series specific or series type specific color set to use instead of the global colors.

Specified by:

setColors in class PyramidOptions

addColor

public void addColor(Color color)

Adds color to the colors array

Specified by:

addColor in class PyramidOptions

Parameters:

color - to add

See Also:

• setColors(Color...)

removeColor

public void removeColor(Color color)

Removes first occurrence of color in colors array

Specified by:

removeColor in class PyramidOptions

Parameters:

color - to remove

See Also:

• setColors(Color...)

getCrisp

public Boolean getCrisp()

Specified by:

getCrisp in class PyramidOptions

See Also:

• setCrisp(Boolean)

setCrisp

public void setCrisp(Boolean crisp)

When true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen. In some cases, when there are a lot of densely packed columns, this leads to visible difference in column widths or distance between columns. In these cases, setting crisp to false may look better, even though each column is rendered blurry.

Defaults to true.

Specified by:

setCrisp in class PyramidOptions

getCursor

public Cursor getCursor()

Specified by:

getCursor in class PyramidOptions

See Also:

• setCursor(Cursor)

setCursor

public void setCursor(Cursor cursor)

You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.

Specified by:

setCursor in class PyramidOptions

getDataLabels

public DataLabelsFunnel getDataLabels()

Specified by:

getDataLabels in class PyramidOptions

See Also:

• setDataLabels(DataLabelsFunnel)

setDataLabels

public void setDataLabels(DataLabelsFunnel dataLabels)

Description copied from class: PyramidOptions

Specific data labels configuration for a series type

Specified by:

setDataLabels in class PyramidOptions

Parameters:

dataLabels -

getDepth

public Number getDepth()

Specified by:

getDepth in class PyramidOptions

See Also:

• setDepth(Number)

setDepth

public void setDepth(Number depth)

The thickness of a 3D pie. Requires highcharts-3d.js

Defaults to: 0

Specified by:

setDepth in class PyramidOptions

getDescription

public String getDescription()

Specified by:

getDescription in class PyramidOptions

See Also:

• setDescription(String)

setDescription

public void setDescription(String description)

Requires Accessibility module

A description of the series to add to the screen reader information about the series.

Defaults to: undefined

Specified by:

setDescription in class PyramidOptions

getEnableMouseTracking

public Boolean getEnableMouseTracking()

Specified by:

getEnableMouseTracking in class PyramidOptions

See Also:

• setEnableMouseTracking(Boolean)

setEnableMouseTracking

public void setEnableMouseTracking(Boolean enableMouseTracking)

Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.

Defaults to: true

Specified by:

setEnableMouseTracking in class PyramidOptions

getExposeElementToA11y

public Boolean getExposeElementToA11y()

Specified by:

getExposeElementToA11y in class PyramidOptions

See Also:

• setExposeElementToA11y(Boolean)

setExposeElementToA11y

public void setExposeElementToA11y(Boolean exposeElementToA11y)

By default, series are exposed to screen readers as regions. By enabling this option, the series element itself will be exposed in the same way as the data points. This is useful if the series is not used as a grouping entity in the chart, but you still want to attach a description to the series.

Requires the Accessibility module.

Defaults to: undefined

Specified by:

setExposeElementToA11y in class PyramidOptions

getFindNearestPointBy

public Dimension getFindNearestPointBy()

Specified by:

getFindNearestPointBy in class PyramidOptions

See Also:

• setFindNearestPointBy(Dimension)

setFindNearestPointBy

public void setFindNearestPointBy(Dimension findNearestPointBy)

Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to 'xy' for scatter series and 'x' for most other series. If the data has duplicate x-values, it is recommended to set this to 'xy' to allow hovering over all points.

Applies only to series types using nearest neighbor search (not direct hover) for tooltip.

Specified by:

setFindNearestPointBy in class PyramidOptions

getGetExtremesFromAll

public Boolean getGetExtremesFromAll()

Specified by:

getGetExtremesFromAll in class PyramidOptions

See Also:

• setGetExtremesFromAll(Boolean)

setGetExtremesFromAll

public void setGetExtremesFromAll(Boolean getExtremesFromAll)

Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.

Defaults to: false

Specified by:

setGetExtremesFromAll in class PyramidOptions

getHeight

public String getHeight()

Specified by:

getHeight in class PyramidOptions

See Also:

• setHeight(String)

setHeight

public void setHeight(String height)

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.

Specified by:

setHeight in class PyramidOptions

Parameters:

height - CSS style string representation

getIgnoreHiddenPoint

public Boolean getIgnoreHiddenPoint()

Specified by:

getIgnoreHiddenPoint in class PyramidOptions

See Also:

• setIgnoreHiddenPoint(Boolean)

setIgnoreHiddenPoint

public void setIgnoreHiddenPoint(Boolean ignoreHiddenPoint)

This option tells whether the series shall be redrawn as if the hidden point were null.

Defaults to true.

Specified by:

setIgnoreHiddenPoint in class PyramidOptions

getKeys

public String[] getKeys()

Specified by:

getKeys in class PyramidOptions

See Also:

• setKeys(String...)

setKeys

public void setKeys(String... keys)

An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.

Specified by:

setKeys in class PyramidOptions

addKey

public void addKey(String key)

Adds key to the keys array

Specified by:

addKey in class PyramidOptions

Parameters:

key - to add

See Also:

• setKeys(String...)

removeKey

public void removeKey(String key)

Removes first occurrence of key in keys array

Specified by:

removeKey in class PyramidOptions

Parameters:

key - to remove

See Also:

• setKeys(String...)

getLinkedTo

public String getLinkedTo()

Specified by:

getLinkedTo in class PyramidOptions

See Also:

• setLinkedTo(String)

setLinkedTo

public void setLinkedTo(String linkedTo)

The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.

Specified by:

setLinkedTo in class PyramidOptions

getMinSize

public Number getMinSize()

Specified by:

getMinSize in class PyramidOptions

See Also:

• setMinSize(Number)

setMinSize

public void setMinSize(Number minSize)

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

Specified by:

setMinSize in class PyramidOptions

getOpacity

public Number getOpacity()

Specified by:

getOpacity in class PyramidOptions

See Also:

• setOpacity(Number)

setOpacity

public void setOpacity(Number opacity)

Opacity of a series parts: line, fill (e.g. area) and dataLabels.

Defaults to 1.

Specified by:

setOpacity in class PyramidOptions

getNeckHeight

public String getNeckHeight()

See Also:

• setNeckHeight(String)

setNeckHeight

public void setNeckHeight(String neckHeight)

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

Defaults to: 25%

getNeckWidth

public String getNeckWidth()

See Also:

• setNeckWidth(String)

setNeckWidth

public void setNeckWidth(String neckWidth)

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.

Defaults to: 30%

getPointDescriptionFormatter

public String getPointDescriptionFormatter()

Specified by:

getPointDescriptionFormatter in class PyramidOptions

setPointDescriptionFormatter

public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)

Specified by:

setPointDescriptionFormatter in class PyramidOptions

getReversed

public Boolean getReversed()

Specified by:

getReversed in class PyramidOptions

See Also:

• setReversed(Boolean)

setReversed

public void setReversed(Boolean reversed)

A reversed funnel has the widest area down. A reversed funnel with no neck width and neck height is a pyramid.

Defaults to: false

Specified by:

setReversed in class PyramidOptions

getSelected

public Boolean getSelected()

Specified by:

getSelected in class PyramidOptions

See Also:

• setSelected(Boolean)

setSelected

public void setSelected(Boolean selected)

Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.

Defaults to: false

Specified by:

setSelected in class PyramidOptions

getShadow

public Boolean getShadow()

Specified by:

getShadow in class PyramidOptions

See Also:

• setShadow(Boolean)

setShadow

public void setShadow(Boolean shadow)

Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.

Defaults to: false

Specified by:

setShadow in class PyramidOptions

getShowInLegend

public Boolean getShowInLegend()

Specified by:

getShowInLegend in class PyramidOptions

See Also:

• setShowInLegend(Boolean)

setShowInLegend

public void setShowInLegend(Boolean showInLegend)

Whether to display this particular series or series type in the legend. Since 2.1, pies are not shown in the legend by default.

Defaults to: false

Specified by:

setShowInLegend in class PyramidOptions

getSkipKeyboardNavigation

public Boolean getSkipKeyboardNavigation()

Specified by:

getSkipKeyboardNavigation in class PyramidOptions

See Also:

• setSkipKeyboardNavigation(Boolean)

setSkipKeyboardNavigation

public void setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)

If set to True, the accessibility module will skip past the points in this series for keyboard navigation.

Specified by:

setSkipKeyboardNavigation in class PyramidOptions

getSlicedOffset

public Number getSlicedOffset()

Specified by:

getSlicedOffset in class PyramidOptions

See Also:

• setSlicedOffset(Number)

setSlicedOffset

public void setSlicedOffset(Number slicedOffset)

If a point is sliced, moved out from the center, how many pixels should it be moved?.

Defaults to: 10

Specified by:

setSlicedOffset in class PyramidOptions

getStates

public States getStates()

Specified by:

getStates in class PyramidOptions

See Also:

• setStates(States)

setStates

public void setStates(States states)

A wrapper object for all the series options in specific states.

Specified by:

setStates in class PyramidOptions

getStickyTracking

public Boolean getStickyTracking()

Specified by:

getStickyTracking in class PyramidOptions

See Also:

• setStickyTracking(Boolean)

setStickyTracking

public void setStickyTracking(Boolean stickyTracking)

Sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. When stickyTracking is false and tooltip.shared is false, the tooltip will be hidden when moving the mouse between series.

Defaults to: false

Specified by:

setStickyTracking in class PyramidOptions

getTooltip

public SeriesTooltip getTooltip()

Specified by:

getTooltip in class PyramidOptions

See Also:

• setTooltip(SeriesTooltip)

setTooltip

public void setTooltip(SeriesTooltip tooltip)

A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.

Specified by:

setTooltip in class PyramidOptions

getVisible

public Boolean getVisible()

Specified by:

getVisible in class PyramidOptions

See Also:

• setVisible(Boolean)

setVisible

public void setVisible(Boolean visible)

Set the initial visibility of the series.

Defaults to: true

Specified by:

setVisible in class PyramidOptions

getWidth

public String getWidth()

Specified by:

getWidth in class PyramidOptions

See Also:

• setWidth(String)

setWidth

public void setWidth(String width)

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%

Specified by:

setWidth in class PyramidOptions

Parameters:

width - CSS style string representation

getZoneAxis

public ZoneAxis getZoneAxis()

Specified by:

getZoneAxis in class PyramidOptions

See Also:

• setZoneAxis(ZoneAxis)

setZoneAxis

public void setZoneAxis(ZoneAxis zoneAxis)

Defines the Axis on which the zones are applied.

Defaults to: y

Specified by:

setZoneAxis in class PyramidOptions

getZones

public Zones[] getZones()

Specified by:

getZones in class PyramidOptions

See Also:

• setZones(Zones...)

setZones

public void setZones(Zones... zones)

An array defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles, according to the zoneAxis option.

In styled mode, the color zones are styled with the .highcharts-zone-{n} class, or custom classed from the className option (view live demo).

Specified by:

setZones in class PyramidOptions

addZone

public void addZone(Zones zone)

Adds zone to the zones array

Specified by:

addZone in class PyramidOptions

Parameters:

zone - to add

See Also:

• setZones(Zones...)

removeZone

public void removeZone(Zones zone)

Removes first occurrence of zone in zones array

Specified by:

removeZone in class PyramidOptions

Parameters:

zone - to remove

See Also:

• setZones(Zones...)

setCenter

public void setCenter(String x,
 String y)

Specified by:

setCenter in class PyramidOptions

getCenter

public String[] getCenter()

Specified by:

getCenter in class PyramidOptions