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

Class PyramidOptions

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:

  • Constructor Details

    • PyramidOptions

      public PyramidOptions()

  • Method Details

    • getChartType

      public abstract ChartType getChartType()
      Overrides:
      getChartType in class AbstractPlotOptions

    • getAllowPointSelect

      public abstract Boolean getAllowPointSelect()
      See Also:

    • 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

      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

      public abstract void setClassName(String className)
      A class name to apply to the series' graphical elements.

    • getClip

      public abstract Boolean getClip()
      See Also:

    • setClip

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

    • getColorIndex

      public abstract Number getColorIndex()
      See Also:

    • 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}.

    • getColorKey

      public abstract String getColorKey()
      See Also:

    • setColorKey

      public abstract 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'.

    • getColors

      public abstract Color[] getColors()
      See Also:

    • setColors

      public abstract void setColors(Color... colors)
      A series specific or series type specific color set to use instead of the theme colors.

    • addColor

      public abstract void addColor(Color color)
      Adds color to the colors array
      Parameters:
      color - to add
      See Also:

    • removeColor

      public abstract void removeColor(Color color)
      Removes first occurrence of color in colors array
      Parameters:
      color - to remove
      See Also:

    • getCrisp

      public abstract Boolean getCrisp()
      See Also:

    • setCrisp

      public abstract 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 falase may look better, even though each column is rendered blurry.

    • getCursor

      public abstract Cursor getCursor()
      See Also:

    • 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

      public abstract void setDataLabels(DataLabelsFunnel dataLabels)
      Specific data labels configuration for a series type
      Parameters:
      dataLabels -

    • getDepth

      public abstract Number getDepth()
      See Also:

    • setDepth

      public abstract void setDepth(Number depth)
      The thickness of a 3D pie.

    • getDescription

      public abstract String getDescription()
      See Also:

    • 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

      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

      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

      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

      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

      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

    • getIgnoreHiddenPoint

      public abstract Boolean getIgnoreHiddenPoint()
      See Also:

    • setIgnoreHiddenPoint

      public abstract void setIgnoreHiddenPoint(Boolean ignoreHiddenPoint)
      This option tells whether the series shall be redrawn as if the hidden point were null.

    • getKeys

      public abstract String[] getKeys()
      See Also:

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

    • removeKey

      public abstract void removeKey(String key)
      Removes first occurrence of key in keys array
      Parameters:
      key - to remove
      See Also:

    • getLinkedTo

      public abstract String getLinkedTo()
      See Also:

    • 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

      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.

    • getOpacity

      public abstract Number getOpacity()
      See Also:

    • setOpacity

      public abstract void setOpacity(Number opacity)
      Opacity of a series parts: line, fill (e.g. area) and dataLabels.

    • getPointDescriptionFormatter

      public abstract String getPointDescriptionFormatter()

    • setPointDescriptionFormatter

      public abstract void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)

    • getReversed

      public abstract Boolean getReversed()
      See Also:

    • 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

      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

      public abstract void setShadow(Boolean shadow)
      Whether to apply a drop shadow to the graph line.

    • getShowInLegend

      public abstract Boolean getShowInLegend()
      See Also:

    • 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

      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

      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

      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

      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

      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

      public abstract void setVisible(Boolean visible)
      Set the initial visibility of the series.

    • getWidth

      public abstract String getWidth()
      See Also:

    • 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

      public abstract void setZoneAxis(ZoneAxis zoneAxis)
      Defines the Axis on which the zones are applied.

    • getZones

      public abstract Zones[] getZones()
      See Also:

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

    • removeZone

      public abstract void removeZone(Zones zone)
      Removes first occurrence of zone in zones array
      Parameters:
      zone - to remove
      See Also:

    • setCenter

      public abstract void setCenter(String x, String y)

    • getCenter

      public abstract String[] getCenter()