PlotOptionsScatter (Vaadin Charts 19.0.0 API)

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

All Implemented Interfaces:: Serializable

@Generated(value="This class is generated and shouldn\'t be modified",
           comments="Incorrect and missing API should be reported to https://github.com/vaadin/vaadin-charts-flow/issues/new")
public class PlotOptionsScatter
extends PointOptions

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

PlotOptionsScatter()

Constructors
Constructor and Description
`PlotOptionsScatter()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated 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()`
`Boolean`	`getAnimation()`
`Number`	`getAnimationLimit()`
`ChartType`	`getChartType()`
`String`	`getClassName()`
`Boolean`	`getClip()`
`Color`	`getColor()`
`Number`	`getColorIndex()`
`String`	`getColorKey()`
`Compare`	`getCompare()`
`Number`	`getCompareBase()`
`Boolean`	`getCrisp()`
`Number`	`getCropThreshold()`
`Cursor`	`getCursor()`
`DashStyle`	`getDashStyle()`
`DataGrouping`	`getDataGrouping()`
`DataLabels`	`getDataLabels()`
`String`	`getDescription()`
`Boolean`	`getEnableMouseTracking()`
`Boolean`	`getExposeElementToA11y()`
`Dimension`	`getFindNearestPointBy()`
`String`	`getGapUnit()`
`Boolean`	`getGetExtremesFromAll()`
`String[]`	`getKeys()`
`Number`	`getLegendIndex()`
`Number`	`getLineWidth()`
`String`	`getLinkedTo()`
`Marker`	`getMarker()`
`PlotOptionsSeries`	`getNavigatorOptions()`
`Color`	`getNegativeColor()`
`Number`	`getOpacity()`
`String`	`getPointDescriptionFormatter()`
`Number`	`getPointInterval()`
`IntervalUnit`	`getPointIntervalUnit()`
`PointPlacement`	`getPointPlacement()`
`Number`	`getPointRange()`
`Number`	`getPointStart()`
`Boolean`	`getSelected()`
`Boolean`	`getShadow()`
`Boolean`	`getShowCheckbox()`
`Boolean`	`getShowInLegend()`
`Boolean`	`getShowInNavigator()`
`Boolean`	`getSkipKeyboardNavigation()`
`Boolean`	`getSoftThreshold()`
`Stacking`	`getStacking()`
`States`	`getStates()`
`Boolean`	`getStickyTracking()`
`Number`	`getThreshold()`
`SeriesTooltip`	`getTooltip()`
`Number`	`getTurboThreshold()`
`Boolean`	`getVisible()`
`ZoneAxis`	`getZoneAxis()`
`Zones[]`	`getZones()`
`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`	`setAnimation(Boolean animation)` Enable or disable the initial animation when a series is displayed.
`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`	`setClip(Boolean clip)` Disable this option to allow series rendering in the whole plotting area.
`void`	`setColor(Color color)` The main color or the series.
`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`	`setCompare(Compare compare)` Compare the values of the series against the first non-null, non-zero value in the visible range.
`void`	`setCompareBase(Number compareBase)` When compare is `percent`, this option dictates whether to use 0 or 100 as the base of comparison.
`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`	`setCropThreshold(Number cropThreshold)` When the series contains less points than the crop threshold, all points are drawn, even 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`	`setDashStyle(DashStyle dashStyle)` A name for the dash style to use for the graph.
`void`	`setDataGrouping(DataGrouping dataGrouping)` Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts.
`void`	`setDataLabels(DataLabels dataLabels)` Options for the series data labels, appearing next to each data point.
`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`	`setLineWidth(Number lineWidth)` The width of the line connecting the data points.
`void`	`setLinkedTo(String linkedTo)` The id of another series to link to.
`void`	`setMarker(Marker marker)` Options for the point markers of line-like series.
`void`	`setNavigatorOptions(PlotOptionsSeries navigatorOptions)` Options for the corresponding navigator series if `showInNavigator` is `true` for this series.
`void`	`setNegativeColor(Color negativeColor)` The color for the parts of the graph or points that are below the threshold.
`void`	`setOpacity(Number opacity)` Opacity of a series parts: line, fill (e.g.
`void`	`setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)`
`void`	`setPointInterval(Number pointInterval)` If no x values are given for the points in a series, pointInterval defines the interval of the x values.
`void`	`setPointIntervalUnit(IntervalUnit pointIntervalUnit)` On datetime series, this allows for setting the pointInterval to irregular time units, `day`, `month` and `year`.
`void`	`setPointPlacement(PointPlacement pointPlacement)` Possible values: `null`, `"on"`, `"between"`.
`void`	`setPointRange(Number pointRange)` The width of each point on the x axis.
`void`	`setPointStart(Date date)` Deprecated. as of 4.0. Use `setPointStart(Instant)`
`void`	`setPointStart(Instant instant)`
`void`	`setPointStart(Number pointStart)` If no x values are given for the points in a series, pointStart defines on what value to start.
`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`	`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`	`setStacking(Stacking stacking)` Whether to stack the values of each series on top of each other.
`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`	`setThreshold(Number threshold)` The threshold, also called zero level or base level.
`void`	`setTooltip(SeriesTooltip tooltip)` A configuration object for the tooltip rendering of each single series.
`void`	`setTurboThreshold(Number turboThreshold)` When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed.
`void`	`setVisible(Boolean visible)` Set the initial visibility of the series.
`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
  - PlotOptionsScatter
```
public PlotOptionsScatter()
```
- Method Detail
  - getChartType
```
public ChartType getChartType()
```
    Specified by:
    
    getChartType in class PointOptions
  - getAllowPointSelect
```
public Boolean getAllowPointSelect()
```
    Specified by:
    
    getAllowPointSelect in class PointOptions
    
    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 PointOptions
  - getAnimation
```
public Boolean getAnimation()
```
    Specified by:
    
    getAnimation in class PointOptions
    
    See Also:
    
    setAnimation(Boolean)
  - setAnimation
```
public void setAnimation(Boolean animation)
```
    Enable or disable the initial animation when a series is displayed. Please note that this option only applies to the initial animation of the series itself. For other animations, see ChartModel.setAnimation(Boolean)
    
    Specified by:
    
    setAnimation in class PointOptions
  - getAnimationLimit
```
public Number getAnimationLimit()
```
    Specified by:
    
    getAnimationLimit in class PointOptions
    
    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 PointOptions
  - getClassName
```
public String getClassName()
```
    Specified by:
    
    getClassName in class PointOptions
    
    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 PointOptions
  - getClip
```
public Boolean getClip()
```
    Specified by:
    
    getClip in class PointOptions
    
    See Also:
    
    setClip(Boolean)
  - setClip
```
public void setClip(Boolean clip)
```
    Disable this option to allow series rendering in the whole plotting area. Note that lipping should be always enabled when chart.zoomType is set
    Defaults to true.
    
    Specified by:
    
    setClip in class PointOptions
  - getColor
```
public Color getColor()
```
    Specified by:
    
    getColor in class PointOptions
    
    See Also:
    
    setColor(Color)
  - setColor
```
public void setColor(Color color)
```
    The main color or the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the options.colors array.
    
    In styled mode, the color can be defined by the colorIndex option. Also, the series color can be set with the .highcharts-series, .highcharts-color-{n}, .highcharts-{type}-series or .highcharts-series-{n} class, or individual classes given by the className option.
    
    Specified by:
    
    setColor in class PointOptions
  - getColorIndex
```
public Number getColorIndex()
```
    Specified by:
    
    getColorIndex in class PointOptions
    
    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 PointOptions
  - getColorKey
```
public String getColorKey()
```
    Specified by:
    
    getColorKey in class PointOptions
    
    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 PointOptions
    
    Parameters:
    
    colorKey -
  - getCrisp
```
public Boolean getCrisp()
```
    Specified by:
    
    getCrisp in class PointOptions
    
    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 PointOptions
  - getCropThreshold
```
public Number getCropThreshold()
```
    Specified by:
    
    getCropThreshold in class PointOptions
    
    See Also:
    
    setCropThreshold(Number)
  - setCropThreshold
```
public void setCropThreshold(Number cropThreshold)
```
    When the series contains less points than the crop threshold, all points are drawn, even 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: 300
    
    Specified by:
    
    setCropThreshold in class PointOptions
  - getCursor
```
public Cursor getCursor()
```
    Specified by:
    
    getCursor in class PointOptions
    
    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 PointOptions
  - getDashStyle
```
public DashStyle getDashStyle()
```
    Specified by:
    
    getDashStyle in class PointOptions
    
    See Also:
    
    setDashStyle(DashStyle)
  - setDashStyle
```
public void setDashStyle(DashStyle dashStyle)
```
    A name for the dash style to use for the graph. Applies only to series type having a graph, like line, spline, area and scatter in case it has a lineWidth. The value for the dashStyle include:
    - Solid
    - ShortDash
    - ShortDot
    - ShortDashDot
    - ShortDashDotDot
    - Dot
    - Dash
    - LongDash
    - DashDot
    - LongDashDot
    - LongDashDotDot
    Defaults to: Solid
    Specified by:
    
    setDashStyle in class PointOptions
  - getDataLabels
```
public DataLabels getDataLabels()
```
    Specified by:
    
    getDataLabels in class PointOptions
    
    See Also:
    
    setDataLabels(DataLabels)
  - setDataLabels
```
public void setDataLabels(DataLabels dataLabels)
```
    Options for the series data labels, appearing next to each data point.
    
    In styled mode, the data labels can be styled wtih the .highcharts-data-label-box and .highcharts-data-label class names (see example).
    
    Specified by:
    
    setDataLabels in class PointOptions
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in class PointOptions
    
    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 PointOptions
  - getEnableMouseTracking
```
public Boolean getEnableMouseTracking()
```
    Specified by:
    
    getEnableMouseTracking in class PointOptions
    
    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 PointOptions
  - getExposeElementToA11y
```
public Boolean getExposeElementToA11y()
```
    Specified by:
    
    getExposeElementToA11y in class PointOptions
    
    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 PointOptions
  - getFindNearestPointBy
```
public Dimension getFindNearestPointBy()
```
    Specified by:
    
    getFindNearestPointBy in class PointOptions
    
    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 PointOptions
  - getGetExtremesFromAll
```
public Boolean getGetExtremesFromAll()
```
    Specified by:
    
    getGetExtremesFromAll in class PointOptions
    
    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 PointOptions
  - getKeys
```
public String[] getKeys()
```
    Specified by:
    
    getKeys in class PointOptions
    
    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 PointOptions
  - addKey
```
public void addKey(String key)
```
    Adds key to the keys array
    
    Specified by:
    
    addKey in class PointOptions
    
    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 PointOptions
    
    Parameters:
    
    key - to remove
    
    See Also:
    
    setKeys(String...)
  - getLineWidth
```
public Number getLineWidth()
```
    Specified by:
    
    getLineWidth in class PointOptions
    
    See Also:
    
    setLineWidth(Number)
  - setLineWidth
```
public void setLineWidth(Number lineWidth)
```
    The width of the line connecting the data points.
    Defaults to: 0
    
    Specified by:
    
    setLineWidth in class PointOptions
  - getLinkedTo
```
public String getLinkedTo()
```
    Specified by:
    
    getLinkedTo in class PointOptions
    
    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 PointOptions
  - getMarker
```
public Marker getMarker()
```
    Specified by:
    
    getMarker in class PointOptions
    
    See Also:
    
    setMarker(Marker)
  - setMarker
```
public void setMarker(Marker marker)
```
    Options for the point markers of line-like series. Properties like fillColor, lineColor and lineWidth define the visual appearance of the markers. Other series types, like column series, don't have markers, but have visual options on the series level instead.
    
    In styled mode, the markers can be styled with the .highcharts-point, .highcharts-point-hover and .highcharts-point-select class names.
    
    Specified by:
    
    setMarker in class PointOptions
  - getNegativeColor
```
public Color getNegativeColor()
```
    Specified by:
    
    getNegativeColor in class PointOptions
    
    See Also:
    
    setNegativeColor(Color)
  - setNegativeColor
```
public void setNegativeColor(Color negativeColor)
```
    The color for the parts of the graph or points that are below the threshold.
    Defaults to: null
    
    Specified by:
    
    setNegativeColor in class PointOptions
  - getOpacity
```
public Number getOpacity()
```
    Specified by:
    
    getOpacity in class PointOptions
    
    See Also:
    
    setOpacity(Number)
  - setOpacity
```
public void setOpacity(Number opacity)
```
    Opacity of a series parts: line, fill (e.g. area) and dataLabels.
    
    Specified by:
    
    setOpacity in class PointOptions
  - getPointDescriptionFormatter
```
public String getPointDescriptionFormatter()
```
    Specified by:
    
    getPointDescriptionFormatter in class PointOptions
  - setPointDescriptionFormatter
```
public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)
```
    Specified by:
    
    setPointDescriptionFormatter in class PointOptions
  - getPointInterval
```
public Number getPointInterval()
```
    Specified by:
    
    getPointInterval in class PointOptions
    
    See Also:
    
    setPointInterval(Number)
  - setPointInterval
```
public void setPointInterval(Number pointInterval)
```
    If no x values are given for the points in a series, pointInterval defines the interval of the x values. For example, if a series contains one value every decade starting from year 0, set pointInterval to 10.
    
    Since Highcharts 4.1, it can be combined with pointIntervalUnit to draw irregular intervals.
    
    Defaults to: 1
    
    Specified by:
    
    setPointInterval in class PointOptions
  - getPointIntervalUnit
```
public IntervalUnit getPointIntervalUnit()
```
    Specified by:
    
    getPointIntervalUnit in class PointOptions
    
    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.
    
    Specified by:
    
    setPointIntervalUnit in class PointOptions
  - getPointStart
```
public Number getPointStart()
```
    Specified by:
    
    getPointStart in class PointOptions
    
    See Also:
    
    setPointStart(Number)
  - setPointStart
```
public void setPointStart(Number pointStart)
```
    If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945.
    Defaults to: 0
    
    Specified by:
    
    setPointStart in class PointOptions
  - getSelected
```
public Boolean getSelected()
```
    Specified by:
    
    getSelected in class PointOptions
    
    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 PointOptions
  - getShadow
```
public Boolean getShadow()
```
    Specified by:
    
    getShadow in class PointOptions
    
    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 PointOptions
  - getShowCheckbox
```
public Boolean getShowCheckbox()
```
    Specified by:
    
    getShowCheckbox in class PointOptions
    
    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
    
    Specified by:
    
    setShowCheckbox in class PointOptions
  - getShowInLegend
```
public Boolean getShowInLegend()
```
    Specified by:
    
    getShowInLegend in class PointOptions
    
    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
    
    Specified by:
    
    setShowInLegend in class PointOptions
  - getSkipKeyboardNavigation
```
public Boolean getSkipKeyboardNavigation()
```
    Specified by:
    
    getSkipKeyboardNavigation in class PointOptions
    
    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 PointOptions
  - getSoftThreshold
```
public Boolean getSoftThreshold()
```
    Specified by:
    
    getSoftThreshold in class PointOptions
    
    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: true
    
    Specified by:
    
    setSoftThreshold in class PointOptions
  - getStates
```
public States getStates()
```
    Specified by:
    
    getStates in class PointOptions
    
    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 PointOptions
  - getStickyTracking
```
public Boolean getStickyTracking()
```
    Specified by:
    
    getStickyTracking in class PointOptions
    
    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 PointOptions
  - getThreshold
```
public Number getThreshold()
```
    Specified by:
    
    getThreshold in class PointOptions
    
    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
    
    Specified by:
    
    setThreshold in class PointOptions
  - getTooltip
```
public SeriesTooltip getTooltip()
```
    Specified by:
    
    getTooltip in class PointOptions
    
    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 PointOptions
  - getTurboThreshold
```
public Number getTurboThreshold()
```
    Specified by:
    
    getTurboThreshold in class PointOptions
    
    See Also:
    
    setTurboThreshold(Number)
  - setTurboThreshold
```
public void setTurboThreshold(Number turboThreshold)
```
    When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed. Also, only the first point is tested, and the rest are assumed to be the same format. This saves expensive data checking and indexing in long series. Set it to 0 disable.
    Defaults to: 1000
    
    Specified by:
    
    setTurboThreshold in class PointOptions
  - getVisible
```
public Boolean getVisible()
```
    Specified by:
    
    getVisible in class PointOptions
    
    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 PointOptions
  - getZoneAxis
```
public ZoneAxis getZoneAxis()
```
    Specified by:
    
    getZoneAxis in class PointOptions
    
    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 PointOptions
  - getZones
```
public Zones[] getZones()
```
    Specified by:
    
    getZones in class PointOptions
    
    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 PointOptions
  - addZone
```
public void addZone(Zones zone)
```
    Adds zone to the zones array
    
    Specified by:
    
    addZone in class PointOptions
    
    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 PointOptions
    
    Parameters:
    
    zone - to remove
    
    See Also:
    
    setZones(Zones...)
  - getCompare
```
public Compare getCompare()
```
    Specified by:
    
    getCompare in class PointOptions
    
    See Also:
    
    setCompare(Compare)
  - setCompare
```
public void setCompare(Compare compare)
```
    Compare the values of the series against the first non-null, non-zero value in the visible range. The y axis will show percentage or absolute change depending on whether compare is set to "percent" or "value". When this is applied to multiple series, it allows comparing the development of the series against each other.
    Defaults to: undefined
    
    Specified by:
    
    setCompare in class PointOptions
  - getCompareBase
```
public Number getCompareBase()
```
    Specified by:
    
    getCompareBase in class PointOptions
    
    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
    
    Specified by:
    
    setCompareBase in class PointOptions
  - getDataGrouping
```
public DataGrouping getDataGrouping()
```
    Specified by:
    
    getDataGrouping in class PointOptions
    
    See Also:
    
    setDataGrouping(DataGrouping)
  - setDataGrouping
```
public void setDataGrouping(DataGrouping dataGrouping)
```
    Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts. Highstock by default applies data grouping when the points become closer than a certain pixel value, determined by the groupPixelWidth option.
    
    If data grouping is applied, the grouping information of grouped points can be read from the Point.dataGroup.
    
    Specified by:
    
    setDataGrouping in class PointOptions
  - getGapUnit
```
public String getGapUnit()
```
    Specified by:
    
    getGapUnit in class PointOptions
    
    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
    
    Specified by:
    
    setGapUnit in class PointOptions
  - getLegendIndex
```
public Number getLegendIndex()
```
    Specified by:
    
    getLegendIndex in class PointOptions
    
    See Also:
    
    setLegendIndex(Number)
  - setLegendIndex
```
public void setLegendIndex(Number legendIndex)
```
    The sequential index of the series within the legend.
    Defaults to: 0
    
    Specified by:
    
    setLegendIndex in class PointOptions
  - getNavigatorOptions
```
public PlotOptionsSeries getNavigatorOptions()
```
    Specified by:
    
    getNavigatorOptions in class PointOptions
    
    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
    
    Specified by:
    
    setNavigatorOptions in class PointOptions
  - getPointPlacement
```
public PointPlacement getPointPlacement()
```
    Specified by:
    
    getPointPlacement in class PointOptions
    
    See Also:
    
    setPointPlacement(PointPlacement)
  - setPointPlacement
```
public void setPointPlacement(PointPlacement pointPlacement)
```
    Possible values: null, "on", "between".
    
    In a column chart, when pointPlacement is "on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is "between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.
    
    Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
    
    Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series it needs to be set.
    
    Defaults to null in cartesian charts, "between" in polar charts.
    Defaults to: null
    
    Specified by:
    
    setPointPlacement in class PointOptions
  - getPointRange
```
public Number getPointRange()
```
    Specified by:
    
    getPointRange in class PointOptions
    
    See Also:
    
    setPointRange(Number)
  - setPointRange
```
public void setPointRange(Number pointRange)
```
    The width of each point on the x axis. For example in a column chart with one value each day, the pointRange would be 1 day (= 24 * 3600 * 1000 milliseconds). This is normally computed automatically, but this option can be used to override the automatic value.
    Defaults to: 0
    
    Specified by:
    
    setPointRange in class PointOptions
  - getShowInNavigator
```
public Boolean getShowInNavigator()
```
    Specified by:
    
    getShowInNavigator in class PointOptions
    
    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
    
    Specified by:
    
    setShowInNavigator in class PointOptions
  - getStacking
```
public Stacking getStacking()
```
    Specified by:
    
    getStacking in class PointOptions
    
    See Also:
    
    setStacking(Stacking)
  - setStacking
```
public void setStacking(Stacking stacking)
```
    Whether to stack the values of each series on top of each other. Possible values are null to disable, "normal" to stack by value or "percent". When stacking is enabled, data must be sorted in ascending X order.
    Defaults to: null
    
    Specified by:
    
    setStacking in class PointOptions
  - setPointStart
```
@Deprecated
public void setPointStart(Date date)
```
    Deprecated. as of 4.0. Use setPointStart(Instant)
    
    Specified by:
    
    setPointStart in class PointOptions
    
    See Also:
    
    PointOptions.setPointStart(Number)
  - setPointStart
```
public void setPointStart(Instant instant)
```
    Specified by:
    
    setPointStart in class PointOptions
    
    See Also:
    
    setPointStart(Number)

Class PlotOptionsScatter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PlotOptionsScatter

Method Detail

getChartType

getAllowPointSelect

setAllowPointSelect

getAnimation

setAnimation

getAnimationLimit

setAnimationLimit

getClassName

setClassName

getClip

setClip

getColor

setColor

getColorIndex

setColorIndex

getColorKey

setColorKey

getCrisp

setCrisp

getCropThreshold

setCropThreshold

getCursor

setCursor

getDashStyle

setDashStyle

getDataLabels

setDataLabels

getDescription

setDescription

getEnableMouseTracking

setEnableMouseTracking

getExposeElementToA11y

setExposeElementToA11y

getFindNearestPointBy

setFindNearestPointBy

getGetExtremesFromAll

setGetExtremesFromAll

getKeys

setKeys

addKey

removeKey

getLineWidth

setLineWidth

getLinkedTo

setLinkedTo

getMarker

setMarker

getNegativeColor

setNegativeColor

getOpacity

setOpacity

getPointDescriptionFormatter

setPointDescriptionFormatter

getPointInterval

setPointInterval

getPointIntervalUnit

setPointIntervalUnit

getPointStart

setPointStart

getSelected

setSelected

getShadow

setShadow

getShowCheckbox

setShowCheckbox

getShowInLegend

setShowInLegend

getSkipKeyboardNavigation

setSkipKeyboardNavigation

getSoftThreshold

setSoftThreshold

getStates

setStates