PlotOptionsFlags (Vaadin Platform (vaadin-platform-javadoc) 14.12.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.PlotOptionsFlags

All Implemented Interfaces:

Serializable
```
public class PlotOptionsFlags
extends AbstractPlotOptions
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

PlotOptionsFlags()

Constructors
Constructor and Description
`PlotOptionsFlags()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addKey(String key)` Adds key to the keys array
`void`	`addZone(Zones zone)` Adds zone to the zones array
`Boolean`	`getAllowPointSelect()`
`Number`	`getAnimationLimit()`
`ChartType`	`getChartType()`
`String`	`getClassName()`
`Number`	`getColorIndex()`
`Number`	`getCompareBase()`
`Number`	`getCropThreshold()`
`Cursor`	`getCursor()`
`String`	`getDescription()`
`Boolean`	`getEnableMouseTracking()`
`Boolean`	`getExposeElementToA11y()`
`Dimension`	`getFindNearestPointBy()`
`String`	`getGapUnit()`
`Boolean`	`getGetExtremesFromAll()`
`String[]`	`getKeys()`
`Number`	`getLegendIndex()`
`String`	`getLinkedTo()`
`Number`	`getMaxPointWidth()`
`PlotOptionsSeries`	`getNavigatorOptions()`
`String`	`getOnKey()`
`String`	`getOnSeries()`
`String`	`getPointDescriptionFormatter()`
`IntervalUnit`	`getPointIntervalUnit()`
`Boolean`	`getSelected()`
`Boolean`	`getShadow()`
`FlagShape`	`getShape()`
`Boolean`	`getShowCheckbox()`
`Boolean`	`getShowInLegend()`
`Boolean`	`getShowInNavigator()`
`Boolean`	`getSkipKeyboardNavigation()`
`Boolean`	`getSoftThreshold()`
`Number`	`getStackDistance()`
`States`	`getStates()`
`Boolean`	`getStickyTracking()`
`String`	`getTextAlign()`
`Number`	`getThreshold()`
`SeriesTooltip`	`getTooltip()`
`Boolean`	`getUseHTML()`
`Boolean`	`getVisible()`
`Number`	`getY()`
`ZoneAxis`	`getZoneAxis()`
`Zones[]`	`getZones()`
`boolean`	`isNegativeColor()`
`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 or bars.
`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`	`setClassName(String className)` A class name to apply to the series' graphical elements.
`void`	`setColorIndex(Number colorIndex)` Styled mode only.
`void`	`setCompareBase(Number compareBase)` When compare is `percent`, this option dictates whether to use 0 or 100 as the base of comparison.
`void`	`setCropThreshold(Number cropThreshold)` When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom.
`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`	`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`	`setGapUnit(String gapUnit)` Together with `gapSize`, this option defines where to draw gaps in the graph.
`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`	`setKeys(String... keys)` An array specifying which option maps to which key in the data point array.
`void`	`setLegendIndex(Number legendIndex)` The sequential index of the series within the legend.
`void`	`setLinkedTo(String linkedTo)` The id of another series to link to.
`void`	`setMaxPointWidth(Number maxPointWidth)` The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.
`void`	`setNavigatorOptions(PlotOptionsSeries navigatorOptions)` Options for the corresponding navigator series if `showInNavigator` is `true` for this series.
`void`	`setNegativeColor(boolean negativeColor)` Enable or disable the color for parts of the graph that are bellow `getThreshold()`.
`void`	`setOnKey(String onKey)` In case the flag is placed on a series, on what point key to place it.
`void`	`setOnSeries(String onSeries)` The id of the series that the flags should be drawn on.
`void`	`setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)`
`void`	`setPointIntervalUnit(IntervalUnit pointIntervalUnit)` On datetime series, this allows for setting the pointInterval to irregular time units, `day`, `month` and `year`.
`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`	`setShape(FlagShape shape)` The shape of the marker.
`void`	`setShowCheckbox(Boolean showCheckbox)` If true, a checkbox is displayed next to the legend item to allow selecting the series.
`void`	`setShowInLegend(Boolean showInLegend)` Whether to display this particular series or series type in the legend.
`void`	`setShowInNavigator(Boolean showInNavigator)` Whether or not to show the series in the navigator.
`void`	`setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)` If set to `True`, the accessibility module will skip past the points in this series for keyboard navigation.
`void`	`setSoftThreshold(Boolean softThreshold)` When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.
`void`	`setStackDistance(Number stackDistance)` When multiple flags in the same series fall on the same value, this number determines the vertical offset between them.
`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`	`setTextAlign(String textAlign)` Text alignment for the text inside the flag.
`void`	`setThreshold(Number threshold)` The threshold, also called zero level or base level.
`void`	`setTooltip(SeriesTooltip tooltip)` Specific tooltip options for flag series.
`void`	`setUseHTML(Boolean useHTML)` Whether to use HTML to render the flag texts.
`void`	`setVisible(Boolean visible)` Set the initial visibility of the series.
`void`	`setY(Number y)` The y position of the top left corner of the flag relative to either the series (if onSeries is defined), or the x axis.
`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 Detail
  - PlotOptionsFlags
```
public PlotOptionsFlags()
```
- Method Detail
  - getChartType
```
public ChartType getChartType()
```
    Overrides:
    
    getChartType in class AbstractPlotOptions
  - getAllowPointSelect
```
public Boolean getAllowPointSelect()
```
    See Also:
    
    setAllowPointSelect(Boolean)
  - setAllowPointSelect
```
public void setAllowPointSelect(Boolean allowPointSelect)
```
    Allow this series' points to be selected by clicking on the markers or bars.
    Defaults to: false
  - getAnimationLimit
```
public Number getAnimationLimit()
```
    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.
  - getClassName
```
public String getClassName()
```
    See Also:
    
    setClassName(String)
  - setClassName
```
public void setClassName(String className)
```
    A class name to apply to the series' graphical elements.
  - getColorIndex
```
public Number getColorIndex()
```
    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}.
  - getCompareBase
```
public Number getCompareBase()
```
    See Also:
    
    setCompareBase(Number)
  - setCompareBase
```
public void setCompareBase(Number compareBase)
```
    When compare is percent, this option dictates whether to use 0 or 100 as the base of comparison.
    Defaults to: 0
  - getCropThreshold
```
public Number getCropThreshold()
```
    See Also:
    
    setCropThreshold(Number)
  - setCropThreshold
```
public void setCropThreshold(Number cropThreshold)
```
    When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series. .
    Defaults to: 50
  - getCursor
```
public Cursor getCursor()
```
    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.
  - getDescription
```
public String getDescription()
```
    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
  - getEnableMouseTracking
```
public Boolean getEnableMouseTracking()
```
    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. When using shared tooltips (default in stock charts), mouse tracking is not required. For large datasets it improves performance.
    Defaults to: true
  - getExposeElementToA11y
```
public Boolean getExposeElementToA11y()
```
    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
  - getFindNearestPointBy
```
public Dimension getFindNearestPointBy()
```
    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.
  - getGapUnit
```
public String getGapUnit()
```
    See Also:
    
    setGapUnit(String)
  - setGapUnit
```
public void setGapUnit(String gapUnit)
```
    Together with gapSize, this option defines where to draw gaps in the graph.
    Defaults to: relative
  - getGetExtremesFromAll
```
public Boolean getGetExtremesFromAll()
```
    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
  - getKeys
```
public String[] getKeys()
```
    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.
  - addKey
```
public void addKey(String key)
```
    Adds key to the keys array
    
    Parameters:
    
    key - to add
    
    See Also:
    
    setKeys(String...)
  - removeKey
```
public void removeKey(String key)
```
    Removes first occurrence of key in keys array
    
    Parameters:
    
    key - to remove
    
    See Also:
    
    setKeys(String...)
  - getLegendIndex
```
public Number getLegendIndex()
```
    See Also:
    
    setLegendIndex(Number)
  - setLegendIndex
```
public void setLegendIndex(Number legendIndex)
```
    The sequential index of the series within the legend.
    Defaults to: 0
  - getLinkedTo
```
public String getLinkedTo()
```
    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.
  - getMaxPointWidth
```
public Number getMaxPointWidth()
```
    See Also:
    
    setMaxPointWidth(Number)
  - setMaxPointWidth
```
public void setMaxPointWidth(Number maxPointWidth)
```
    The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart.
    Defaults to: null
  - getNavigatorOptions
```
public PlotOptionsSeries getNavigatorOptions()
```
    See Also:
    
    setNavigatorOptions(PlotOptionsSeries)
  - setNavigatorOptions
```
public void setNavigatorOptions(PlotOptionsSeries navigatorOptions)
```
    Options for the corresponding navigator series if showInNavigator is true for this series. Available options are the same as any series, documented at plotOptions and series.
    
    These options are merged with options in navigator.series, and will take precedence if the same option is defined both places.
    
    Defaults to: undefined
  - isNegativeColor
```
public boolean isNegativeColor()
```
    See Also:
    
    setNegativeColor(boolean)
  - setNegativeColor
```
public void setNegativeColor(boolean negativeColor)
```
    Enable or disable the color for parts of the graph that are bellow getThreshold(). A negative color is applied by setting this option to true combined with the .highcharts-negative class name.
  - getOnKey
```
public String getOnKey()
```
    See Also:
    
    setOnKey(String)
  - setOnKey
```
public void setOnKey(String onKey)
```
    In case the flag is placed on a series, on what point key to place it. Line and columns have one key, y. In range or OHLC-type series, however, the flag can optionally be placed on the open, high, low or close key.
    Defaults to: y
  - getOnSeries
```
public String getOnSeries()
```
    See Also:
    
    setOnSeries(String)
  - setOnSeries
```
public void setOnSeries(String onSeries)
```
    The id of the series that the flags should be drawn on. If no id is given, the flags are drawn on the x axis.
    Defaults to: undefined
  - getPointDescriptionFormatter
```
public String getPointDescriptionFormatter()
```
  - setPointDescriptionFormatter
```
public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)
```
  - getPointIntervalUnit
```
public IntervalUnit getPointIntervalUnit()
```
    See Also:
    
    setPointIntervalUnit(IntervalUnit)
  - setPointIntervalUnit
```
public void setPointIntervalUnit(IntervalUnit pointIntervalUnit)
```
    On datetime series, this allows for setting the pointInterval to irregular time units, day, month and year. A day is usually the same as 24 hours, but pointIntervalUnit also takes the DST crossover into consideration when dealing with local time. Combine this option with pointInterval to draw weeks, quarters, 6 months, 10 years etc.
  - getSelected
```
public Boolean getSelected()
```
    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 in the legend will be checked for a selected series.
    Defaults to: false
  - getShadow
```
public Boolean getShadow()
```
    See Also:
    
    setShadow(Boolean)
  - setShadow
```
public void setShadow(Boolean shadow)
```
    Whether to apply a drop shadow to the graph line. Since 1.1.7 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.
    Defaults to: false
  - getShape
```
public FlagShape getShape()
```
    See Also:
    
    setShape(FlagShape)
  - setShape
```
public void setShape(FlagShape shape)
```
    The shape of the marker. Can be one of "flag", "circlepin", "squarepin", or an image on the format url(/path-to-image.jpg). Individual shapes can also be set for each point.
    Defaults to: flag
  - getShowCheckbox
```
public Boolean getShowCheckbox()
```
    See Also:
    
    setShowCheckbox(Boolean)
  - setShowCheckbox
```
public void setShowCheckbox(Boolean showCheckbox)
```
    If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.
    Defaults to: false
  - getShowInLegend
```
public Boolean getShowInLegend()
```
    See Also:
    
    setShowInLegend(Boolean)
  - setShowInLegend
```
public void setShowInLegend(Boolean showInLegend)
```
    Whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.
    Defaults to: true
  - getShowInNavigator
```
public Boolean getShowInNavigator()
```
    See Also:
    
    setShowInNavigator(Boolean)
  - setShowInNavigator
```
public void setShowInNavigator(Boolean showInNavigator)
```
    Whether or not to show the series in the navigator. Takes precedence over navigator.baseSeries if defined.
    Defaults to: undefined
  - getSkipKeyboardNavigation
```
public Boolean getSkipKeyboardNavigation()
```
    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.
  - getSoftThreshold
```
public Boolean getSoftThreshold()
```
    See Also:
    
    setSoftThreshold(Boolean)
  - setSoftThreshold
```
public void setSoftThreshold(Boolean softThreshold)
```
    When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.
    
    For example, if softThreshold is false, a series of 0, 1, 2, 3 will make the Y axis show negative values according to the minPadding option. If softThreshold is true, the Y axis starts at 0.
    
    Defaults to: false
  - getStackDistance
```
public Number getStackDistance()
```
    See Also:
    
    setStackDistance(Number)
  - setStackDistance
```
public void setStackDistance(Number stackDistance)
```
    When multiple flags in the same series fall on the same value, this number determines the vertical offset between them.
    Defaults to: 12
  - getStates
```
public States getStates()
```
    See Also:
    
    setStates(States)
  - setStates
```
public void setStates(States states)
```
    A wrapper object for all the series options in specific states.
  - getStickyTracking
```
public Boolean getStickyTracking()
```
    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 not shared. When stickyTracking is false, the tooltip will be hidden when moving the mouse between series. Defaults to true for line and area type series, but to false for columns, candlesticks etc.
    Defaults to: true
  - getTextAlign
```
public String getTextAlign()
```
    See Also:
    
    setTextAlign(String)
  - setTextAlign
```
public void setTextAlign(String textAlign)
```
    Text alignment for the text inside the flag.
    Defaults to: center
  - getThreshold
```
public Number getThreshold()
```
    See Also:
    
    setThreshold(Number)
  - setThreshold
```
public void setThreshold(Number threshold)
```
    The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.
    Defaults to: 0
  - getTooltip
```
public SeriesTooltip getTooltip()
```
    See Also:
    
    setTooltip(SeriesTooltip)
  - setTooltip
```
public void setTooltip(SeriesTooltip tooltip)
```
    Specific tooltip options for flag series. Flag series tooltips are different from most other types in that a flag doesn't have a data value, so the tooltip rather displays the text option for each point.
  - getUseHTML
```
public Boolean getUseHTML()
```
    See Also:
    
    setUseHTML(Boolean)
  - setUseHTML
```
public void setUseHTML(Boolean useHTML)
```
    Whether to use HTML to render the flag texts. Using HTML allows for advanced formatting, images and reliable bi-directional text rendering. Note that exported images won't respect the HTML, and that HTML won't respect Z-index settings.
    Defaults to: false
  - getVisible
```
public Boolean getVisible()
```
    See Also:
    
    setVisible(Boolean)
  - setVisible
```
public void setVisible(Boolean visible)
```
    Set the initial visibility of the series.
    Defaults to: true
  - getY
```
public Number getY()
```
    See Also:
    
    setY(Number)
  - setY
```
public void setY(Number y)
```
    The y position of the top left corner of the flag relative to either the series (if onSeries is defined), or the x axis. Defaults to -30.
    Defaults to: -30
  - getZoneAxis
```
public ZoneAxis getZoneAxis()
```
    See Also:
    
    setZoneAxis(ZoneAxis)
  - setZoneAxis
```
public void setZoneAxis(ZoneAxis zoneAxis)
```
    Defines the Axis on which the zones are applied.
    Defaults to: y
  - getZones
```
public Zones[] getZones()
```
    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).
  - addZone
```
public void addZone(Zones zone)
```
    Adds zone to the zones array
    
    Parameters:
    
    zone - to add
    
    See Also:
    
    setZones(Zones...)
  - removeZone
```
public void removeZone(Zones zone)
```
    Removes first occurrence of zone in zones array
    
    Parameters:
    
    zone - to remove
    
    See Also:
    
    setZones(Zones...)

Class PlotOptionsFlags

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PlotOptionsFlags

Method Detail

getChartType

getAllowPointSelect

setAllowPointSelect

getAnimationLimit

setAnimationLimit

getClassName

setClassName

getColorIndex

setColorIndex

getCompareBase

setCompareBase

getCropThreshold

setCropThreshold

getCursor

setCursor

getDescription

setDescription

getEnableMouseTracking

setEnableMouseTracking

getExposeElementToA11y

setExposeElementToA11y

getFindNearestPointBy

setFindNearestPointBy

getGapUnit

setGapUnit

getGetExtremesFromAll

setGetExtremesFromAll

getKeys

setKeys

addKey

removeKey

getLegendIndex

setLegendIndex

getLinkedTo

setLinkedTo

getMaxPointWidth

setMaxPointWidth

getNavigatorOptions

setNavigatorOptions

isNegativeColor

setNegativeColor

getOnKey

setOnKey

getOnSeries

setOnSeries

getPointDescriptionFormatter

setPointDescriptionFormatter

getPointIntervalUnit

setPointIntervalUnit

getSelected

setSelected

getShadow

setShadow

getShape

setShape

getShowCheckbox

setShowCheckbox

getShowInLegend

setShowInLegend

getShowInNavigator

setShowInNavigator

getSkipKeyboardNavigation

setSkipKeyboardNavigation

getSoftThreshold

setSoftThreshold

getStackDistance

setStackDistance

getStates

setStates

getStickyTracking

setStickyTracking

getTextAlign

setTextAlign