PyramidOptions (Vaadin Platform (vaadin-platform-javadoc) 14.9.5 API)

java.lang.Object
- com.vaadin.flow.component.charts.model.AbstractConfigurationObject
- - com.vaadin.flow.component.charts.model.AbstractPlotOptions
  - - com.vaadin.flow.component.charts.model.PyramidOptions

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PlotOptionsFunnel, PlotOptionsPyramid
```
public abstract class PyramidOptions
extends AbstractPlotOptions
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PyramidOptions()

Constructors
Constructor and Description
`PyramidOptions()`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`abstract void`	`addKey(String key)` Adds key to the keys array
`abstract void`	`addZone(Zones zone)` Adds zone to the zones array
`abstract Boolean`	`getAllowPointSelect()`
`abstract Number`	`getAnimationLimit()`
`abstract String[]`	`getCenter()`
`abstract ChartType`	`getChartType()`
`abstract String`	`getClassName()`
`abstract Number`	`getColorIndex()`
`abstract Cursor`	`getCursor()`
`abstract DataLabelsFunnel`	`getDataLabels()`
`abstract Number`	`getDepth()`
`abstract String`	`getDescription()`
`abstract Boolean`	`getEnableMouseTracking()`
`abstract Boolean`	`getExposeElementToA11y()`
`abstract Dimension`	`getFindNearestPointBy()`
`abstract Boolean`	`getGetExtremesFromAll()`
`abstract String`	`getHeight()`
`abstract String[]`	`getKeys()`
`abstract String`	`getLinkedTo()`
`abstract Number`	`getMinSize()`
`abstract String`	`getPointDescriptionFormatter()`
`abstract Boolean`	`getReversed()`
`abstract Boolean`	`getSelected()`
`abstract Boolean`	`getShadow()`
`abstract Boolean`	`getShowInLegend()`
`abstract Boolean`	`getSkipKeyboardNavigation()`
`abstract Number`	`getSlicedOffset()`
`abstract States`	`getStates()`
`abstract Boolean`	`getStickyTracking()`
`abstract SeriesTooltip`	`getTooltip()`
`abstract Boolean`	`getVisible()`
`abstract String`	`getWidth()`
`abstract ZoneAxis`	`getZoneAxis()`
`abstract Zones[]`	`getZones()`
`abstract void`	`removeKey(String key)` Removes first occurrence of key in keys array
`abstract void`	`removeZone(Zones zone)` Removes first occurrence of zone in zones array
`abstract void`	`setAllowPointSelect(Boolean allowPointSelect)` Allow this series' points to be selected by clicking on the markers, bars or pie slices.
`abstract 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.
`abstract void`	`setCenter(String[] center)` The center of the series.
`abstract void`	`setCenter(String x, String y)`
`abstract void`	`setClassName(String className)` A class name to apply to the series' graphical elements.
`abstract void`	`setColorIndex(Number colorIndex)` A specific color index to use for the series, so its graphic representations are given the class name `highcharts-color-{n}`.
`abstract 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.
`abstract void`	`setDataLabels(DataLabelsFunnel dataLabels)` Specific data labels configuration for a series type
`abstract void`	`setDepth(Number depth)` The thickness of a 3D pie.
`abstract void`	`setDescription(String description)` A description of the series to add to the screen reader information about the series.
`abstract void`	`setEnableMouseTracking(Boolean enableMouseTracking)` Enable or disable the mouse tracking for a specific series.
`abstract void`	`setExposeElementToA11y(Boolean exposeElementToA11y)` By default, series are exposed to screen readers as regions.
`abstract 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.
`abstract 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.
`abstract void`	`setHeight(String height)` Sets the height using String presentation.
`abstract void`	`setKeys(String... keys)` An array specifying which option maps to which key in the data point array.
`abstract void`	`setLinkedTo(String linkedTo)` The ID of another series to link to.
`abstract void`	`setMinSize(Number minSize)` The minimum size for a pie in response to auto margins.
`abstract void`	`setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)`
`abstract void`	`setReversed(Boolean reversed)` The pyramid is reversed by default, as opposed to the funnel, which shares the layout engine, and is not reversed.
`abstract void`	`setSelected(Boolean selected)` Whether to select the series initially.
`abstract void`	`setShadow(Boolean shadow)` Whether to apply a drop shadow to the graph line.
`abstract void`	`setShowInLegend(Boolean showInLegend)` Whether to display this particular series or series type in the legend.
`abstract void`	`setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)` Whether or not to skip past the points in this series for keyboard navigation.
`abstract void`	`setSlicedOffset(Number slicedOffset)` If a point is sliced, moved out from the center, how many pixels should it be moved?.
`abstract void`	`setStates(States states)` A wrapper object for all the series options in specific states.
`abstract void`	`setStickyTracking(Boolean stickyTracking)` Sticky tracking of mouse events.
`abstract void`	`setTooltip(SeriesTooltip tooltip)` A configuration object for the tooltip rendering of each single series.
`abstract void`	`setVisible(Boolean visible)` Set the initial visibility of the series.
`abstract void`	`setWidth(String width)` Sets the width using String presentation.
`abstract void`	`setZoneAxis(ZoneAxis zoneAxis)` Defines the Axis on which the zones are applied.
`abstract 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 Detail
  - PyramidOptions
```
public PyramidOptions()
```
- Method Detail
  - getChartType
```
public abstract ChartType getChartType()
```
    Overrides:
    
    getChartType in class AbstractPlotOptions
  - getAllowPointSelect
```
public abstract Boolean getAllowPointSelect()
```
    See Also:
    
    setAllowPointSelect(Boolean)
  - setAllowPointSelect
```
public abstract void setAllowPointSelect(Boolean allowPointSelect)
```
    Allow this series' points to be selected by clicking on the markers, bars or pie slices.
  - getAnimationLimit
```
public abstract Number getAnimationLimit()
```
    See Also:
    
    setAnimationLimit(Number)
  - setAnimationLimit
```
public abstract 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.
  - setCenter
```
public abstract 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.
  - getClassName
```
public abstract String getClassName()
```
    See Also:
    
    setClassName(String)
  - setClassName
```
public abstract void setClassName(String className)
```
    A class name to apply to the series' graphical elements.
  - getColorIndex
```
public abstract Number getColorIndex()
```
    See Also:
    
    setColorIndex(Number)
  - setColorIndex
```
public abstract void setColorIndex(Number colorIndex)
```
    A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
  - getCursor
```
public abstract Cursor getCursor()
```
    See Also:
    
    setCursor(Cursor)
  - setCursor
```
public abstract 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.
  - getDataLabels
```
public abstract DataLabelsFunnel getDataLabels()
```
    See Also:
    
    setDataLabels(DataLabelsFunnel)
  - setDataLabels
```
public abstract void setDataLabels(DataLabelsFunnel dataLabels)
```
    Specific data labels configuration for a series type
    
    Parameters:
    
    dataLabels -
  - getDepth
```
public abstract Number getDepth()
```
    See Also:
    
    setDepth(Number)
  - setDepth
```
public abstract void setDepth(Number depth)
```
    The thickness of a 3D pie.
  - getDescription
```
public abstract String getDescription()
```
    See Also:
    
    setDescription(String)
  - setDescription
```
public abstract void setDescription(String description)
```
    A description of the series to add to the screen reader information about the series.
  - getEnableMouseTracking
```
public abstract Boolean getEnableMouseTracking()
```
    See Also:
    
    setEnableMouseTracking(Boolean)
  - setEnableMouseTracking
```
public abstract 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.
  - getExposeElementToA11y
```
public abstract Boolean getExposeElementToA11y()
```
    See Also:
    
    setExposeElementToA11y(Boolean)
  - setExposeElementToA11y
```
public abstract 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.
  - getFindNearestPointBy
```
public abstract Dimension getFindNearestPointBy()
```
    See Also:
    
    setFindNearestPointBy(Dimension)
  - setFindNearestPointBy
```
public abstract 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.
  - getGetExtremesFromAll
```
public abstract Boolean getGetExtremesFromAll()
```
    See Also:
    
    setGetExtremesFromAll(Boolean)
  - setGetExtremesFromAll
```
public abstract 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.
  - getHeight
```
public abstract String getHeight()
```
    See Also:
    
    setHeight(String)
  - setHeight
```
public abstract void setHeight(String height)
```
    Sets the height using String presentation. String presentation is similar to what is used in Cascading Style Sheets. Size can be pixels or percentage, otherwise IllegalArgumentException is thrown. The empty string ("") or null will unset the height and set the units to pixels.
    
    Parameters:
    
    height - CSS style string representation
  - getKeys
```
public abstract String[] getKeys()
```
    See Also:
    
    setKeys(String...)
  - setKeys
```
public abstract 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.
  - addKey
```
public abstract void addKey(String key)
```
    Adds key to the keys array
    
    Parameters:
    
    key - to add
    
    See Also:
    
    setKeys(String...)
  - removeKey
```
public abstract void removeKey(String key)
```
    Removes first occurrence of key in keys array
    
    Parameters:
    
    key - to remove
    
    See Also:
    
    setKeys(String...)
  - getLinkedTo
```
public abstract String getLinkedTo()
```
    See Also:
    
    setLinkedTo(String)
  - setLinkedTo
```
public abstract 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.
  - getMinSize
```
public abstract Number getMinSize()
```
    See Also:
    
    setMinSize(Number)
  - setMinSize
```
public abstract 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.
  - getPointDescriptionFormatter
```
public abstract String getPointDescriptionFormatter()
```
  - setPointDescriptionFormatter
```
public abstract void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)
```
  - getReversed
```
public abstract Boolean getReversed()
```
    See Also:
    
    setReversed(Boolean)
  - setReversed
```
public abstract void setReversed(Boolean reversed)
```
    The pyramid is reversed by default, as opposed to the funnel, which shares the layout engine, and is not reversed.
  - getSelected
```
public abstract Boolean getSelected()
```
    See Also:
    
    setSelected(Boolean)
  - setSelected
```
public abstract 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.
  - getShadow
```
public abstract Boolean getShadow()
```
    See Also:
    
    setShadow(Boolean)
  - setShadow
```
public abstract void setShadow(Boolean shadow)
```
    Whether to apply a drop shadow to the graph line.
  - getShowInLegend
```
public abstract Boolean getShowInLegend()
```
    See Also:
    
    setShowInLegend(Boolean)
  - setShowInLegend
```
public abstract void setShowInLegend(Boolean showInLegend)
```
    Whether to display this particular series or series type in the legend.
  - getSkipKeyboardNavigation
```
public abstract Boolean getSkipKeyboardNavigation()
```
    See Also:
    
    setSkipKeyboardNavigation(Boolean)
  - setSkipKeyboardNavigation
```
public abstract void setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)
```
    Whether or not to skip past the points in this series for keyboard navigation.
  - getSlicedOffset
```
public abstract Number getSlicedOffset()
```
    See Also:
    
    setSlicedOffset(Number)
  - setSlicedOffset
```
public abstract void setSlicedOffset(Number slicedOffset)
```
    If a point is sliced, moved out from the center, how many pixels should it be moved?.
  - getStates
```
public abstract States getStates()
```
    See Also:
    
    setStates(States)
  - setStates
```
public abstract void setStates(States states)
```
    A wrapper object for all the series options in specific states.
  - getStickyTracking
```
public abstract Boolean getStickyTracking()
```
    See Also:
    
    setStickyTracking(Boolean)
  - setStickyTracking
```
public abstract 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.
  - getTooltip
```
public abstract SeriesTooltip getTooltip()
```
    See Also:
    
    setTooltip(SeriesTooltip)
  - setTooltip
```
public abstract void setTooltip(SeriesTooltip tooltip)
```
    A configuration object for the tooltip rendering of each single series.
  - getVisible
```
public abstract Boolean getVisible()
```
    See Also:
    
    setVisible(Boolean)
  - setVisible
```
public abstract void setVisible(Boolean visible)
```
    Set the initial visibility of the series.
  - getWidth
```
public abstract String getWidth()
```
    See Also:
    
    setWidth(String)
  - setWidth
```
public abstract void setWidth(String width)
```
    Sets the width using String presentation. String presentation is similar to what is used in Cascading Style Sheets. Size can be pixels or percentage, otherwise IllegalArgumentException is thrown. The empty string ("") or null will unset the height and set the units to pixels.
    
    Parameters:
    
    width - CSS style string representation
  - getZoneAxis
```
public abstract ZoneAxis getZoneAxis()
```
    See Also:
    
    setZoneAxis(ZoneAxis)
  - setZoneAxis
```
public abstract void setZoneAxis(ZoneAxis zoneAxis)
```
    Defines the Axis on which the zones are applied.
  - getZones
```
public abstract Zones[] getZones()
```
    See Also:
    
    setZones(Zones...)
  - setZones
```
public abstract 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.
  - addZone
```
public abstract void addZone(Zones zone)
```
    Adds zone to the zones array
    
    Parameters:
    
    zone - to add
    
    See Also:
    
    setZones(Zones...)
  - removeZone
```
public abstract void removeZone(Zones zone)
```
    Removes first occurrence of zone in zones array
    
    Parameters:
    
    zone - to remove
    
    See Also:
    
    setZones(Zones...)
  - setCenter
```
public abstract void setCenter(String x,
                               String y)
```
  - getCenter
```
public abstract String[] getCenter()
```

Class PyramidOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PyramidOptions

Method Detail

getChartType

getAllowPointSelect

setAllowPointSelect

getAnimationLimit

setAnimationLimit

setCenter

getClassName

setClassName

getColorIndex

setColorIndex

getCursor

setCursor

getDataLabels

setDataLabels

getDepth

setDepth

getDescription

setDescription

getEnableMouseTracking

setEnableMouseTracking

getExposeElementToA11y

setExposeElementToA11y

getFindNearestPointBy

setFindNearestPointBy

getGetExtremesFromAll

setGetExtremesFromAll

getHeight

setHeight

getKeys

setKeys

addKey

removeKey

getLinkedTo

setLinkedTo

getMinSize

setMinSize

getPointDescriptionFormatter

setPointDescriptionFormatter

getReversed

setReversed

getSelected

setSelected

getShadow

setShadow

getShowInLegend

setShowInLegend

getSkipKeyboardNavigation

setSkipKeyboardNavigation

getSlicedOffset

setSlicedOffset

getStates

setStates

getStickyTracking

setStickyTracking

getTooltip

setTooltip

getVisible

setVisible

getWidth

setWidth

getZoneAxis

setZoneAxis

getZones

setZones

addZone

removeZone

setCenter

getCenter