SeriesPlotOptions (The ZK Charts library 7.2.1.0 API)

java.lang.Object
- org.zkoss.chart.Optionable
- - org.zkoss.chart.plotOptions.SeriesPlotOptions

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

Direct Known Subclasses:

AreaPlotOptions, BellCurvePlotOptions, ColumnPlotOptions, ColumnPyramidPlotOptions, ColumnRangePlotOptions, GaugePlotOptions, HeatmapPlotOptions, HistogramPlotOptions, ItemPlotOptions, LinePlotOptions, NetworkGraphPlotOptions, ParetoPlotOptions, PiePlotOptions, PolygonPlotOptions, SankeyPlotOptions, ScatterPlotOptions, SplinePlotOptions, StreamGraphPlotOptions, TimelinePlotOptions, TreemapPlotOptions, VectorPlotOptions, VennPlotOptions
```
public class SeriesPlotOptions
extends Optionable
implements OptionDataListener
```
The plotOptions is a wrapper object for config series. The config objects for each series can also be overridden for each series item as given in the Series.
All the options in this class support DynamicalAttribute.

Author:

jumperchen, RaymondChao

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.zkoss.chart.Optionable
  NOT_NULL_VALUE, options

Constructor Summary

Constructors
Constructor and Description

SeriesPlotOptions()

Constructors
Constructor and Description
`SeriesPlotOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Animation`	`getAnimation()` Returns whether to enable or disable the initial animation when a series is displayed.
`Number`	`getBorderWidth()` Returns the border width of the series.
`Color`	`getColor()` Returns the main color of the series.
`Object`	`getColorAxis()` When using dual or multiple color axes, this defines which colorAxis the particular series is connected to.
`String`	`getColorKey()` Returns what data value should be used to calculate point color if colorAxis is used.
`Number`	`getCropThreshold()` Returns 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.
`String`	`getCursor()` Returns 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.
`String`	`getDashStyle()` Returns a name for the dash style to use for the graph.
`DataLabels`	`getDataLabels()` Returns the option of data labels.
`Number`	`getDepth()` Returns the depth of the series in a 3D chart.
`String`	`getDescription()` Returns a description of the series to add to the screen reader information about the series.
`DragDrop`	`getDragDrop()` Returns the options of the draggable-points module allows points to be moved around or modified in the chart, if any.
`String`	`getFindNearestPointBy()` Returns whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.
`Number`	`getGroupPadding()` Returns padding between each value groups, in x axis units.
`String`	`getId()` Returns an id for the series.
`SeriesLabel`	`getLabel()` Returns series label options, if any.
`String`	`getLinecap()` Returns the line cap used for line ends and line joins on the graph.
`Number`	`getLineWidth()` Returns pixel with of the graph line.
`String`	`getLinkedTo()` Returns the `setId(String)` of another series to link to.
`Marker`	`getMarker()` Returns the series marker
`String`	`getNeckHeight()` Returns the neck height for funnel chart only.
`String`	`getNeckWidth()` Returns the neck width for funnel chart only.
`Color`	`getNegativeColor()` Returns the color for the parts of the graph or points that are below the `setThreshold(Number)`.
`Number`	`getOpacity()` Returns opacity of a series parts: line, fill (e.g.
`Number`	`getPointInterval()` Returns if no x values are given for the points in a series, pointInterval defines the interval of the x values.
`String`	`getPointIntervalUnit()` On datetime series, this allows for setting the pointInterval to the two irregular time units, month and year.
`Object`	`getPointPlacement()` Returns the point placement.
`Number`	`getPointStart()` Returns if no x values are given for the points in a series, pointStart defines on what value to start.
`String`	`getStacking()` Returns whether to stack the values of each series on top of each other.
`States`	`getStates()` Returns a wrapper object for all the series options in specific states.
`String`	`getStep()` Returns whether to apply steps to the line.
`Number`	`getThreshold()` Returns the threshold, also called zero level or base level.
`TooltipPlotOptions`	`getTooltip()` Returns a configuration object for the tooltip rendering of each single series.
`Number`	`getTurboThreshold()` Returns 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.
`String`	`getZoneAxis()` Defines the Axis on which the zones are applied.
`List<Zone>`	`getZones()` An list defining zones within a series.
`boolean`	`isAllowPointSelect()` Returns to allow this series' points to be selected by clicking on the markers, bars or pie slices.
`boolean`	`isAnimation()` Returns whether to enable or disable the initial animation when a series is displayed.
`boolean`	`isClip()` Disable this option to allow series rendering in the whole plotting area.
`boolean`	`isColorByPoint()` Returns when using automatic point colors pulled from the `Charts.getColors()` collection, this option determines whether the chart should receive one color per series or one color per point.
`boolean`	`isConnectEnds()` Returns polar charts only.
`boolean`	`isConnectNulls()` Returns whether to connect a graph line across null points.
`boolean`	`isEnableMouseTracking()` Returns enable or disable the mouse tracking for a specific series.
`boolean`	`isGetExtremesFromAll()` Returns 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.
`boolean`	`isIncludeInDataExport()` When set to false will prevent the series data from being included in any form of data export.
`boolean`	`isSelected()` Returns whether to select the series initially.
`boolean`	`isShadow()` Returns whether to apply a drop shadow to the graph line.
`boolean`	`isShowCheckbox()` Returns if true, a checkbox is displayed next to the legend item to allow selecting the series.
`boolean`	`isShowInLegend()` Returns whether to display this particular series or series type in the legend.
`boolean`	`isSkipKeyboardNavigation()` If set to true, the accessibility module will skip past the points in this series for keyboard navigation.
`boolean`	`isSoftThreshold()` 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.
`boolean`	`isStacking()` Returns whether to stack the values of each series on top of each other or not.
`boolean`	`isStickyTracking()` Returns sticky tracking of mouse events.
`boolean`	`isVisible()` Returns set the initial visibility of the series.
`void`	`setAllowPointSelect(boolean allowPointSelect)` Sets to allow this series' points to be selected by clicking on the markers, bars or pie slices.
`void`	`setAnimation(Animation animation)` Sets whether to enable or disable the initial animation when a series is displayed.
`void`	`setAnimation(boolean animation)` Sets whether to enable or disable the initial animation when a series is displayed.
`void`	`setBorderWidth(Number borderWidth)` Sets the border width of the series.
`void`	`setClip(boolean clip)` Disable this option to allow series rendering in the whole plotting area.
`void`	`setColor(Color color)` Sets the main color of the series.
`void`	`setColor(LinearGradient color)` Sets the main color of the series.
`void`	`setColor(RadialGradient color)` Sets the main color of the series.
`void`	`setColor(String color)` Sets the main color of the series.
`void`	`setColorAxis(boolean colorAxis)` When using dual or multiple color axes, this defines which colorAxis the particular series is connected to.
`void`	`setColorAxis(Number colorAxis)` When using dual or multiple color axes, this defines which colorAxis the particular series is connected to.
`void`	`setColorAxis(String colorAxis)` When using dual or multiple color axes, this defines which colorAxis the particular series is connected to.
`void`	`setColorByPoint(boolean colorByPoint)` Sets when using automatic point colors pulled from the `Charts.getColors()` collection, this option determines whether the chart should receive one color per series or one color per point.
`void`	`setColorKey(String colorKey)` Sets what data value should be used to calculate point color if colorAxis is used.
`void`	`setConnectEnds(boolean connectEnds)` Sets polar charts only.
`void`	`setConnectNulls(boolean connectNulls)` Sets whether to connect a graph line across null points.
`void`	`setCropThreshold(Number cropThreshold)` Sets 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(String cursor)` Sets 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(String dashStyle)` Sets a name for the dash style to use for the graph.
`void`	`setDataLabels(DataLabels dataLabels)` Sets the option of data labels.
`void`	`setDepth(Number depth)` Sets the depth of the series in a 3D chart.
`void`	`setDescription(String description)` Sets a description of the series to add to the screen reader information about the series.
`void`	`setDragDrop(DragDrop dragDrop)` Sets the options of the draggable-points module allows points to be moved around or modified in the chart.
`void`	`setEnableMouseTracking(boolean enableMouseTracking)` Sets enable or disable the mouse tracking for a specific series.
`void`	`setFindNearestPointBy(String findNearestPointBy)` Sets whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.
`void`	`setGetExtremesFromAll(boolean getExtremesFromAll)` Sets 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`	`setGroupPadding(Number groupPadding)` Sets padding between each value groups, in x axis units.
`void`	`setId(String id)` Sets an id for the series.
`void`	`setIncludeInDataExport(boolean includeInDataExport)` When set to false will prevent the series data from being included in any form of data export.
`void`	`setLabel(SeriesLabel label)` Sets series label options.
`void`	`setLinecap(String linecap)` Sets the line cap used for line ends and line joins on the graph.
`void`	`setLineWidth(Number lineWidth)` Sets pixel with of the graph line.
`void`	`setLinkedTo(String linkedTo)` Sets the `setId(String)` of another series to link to.
`void`	`setMarker(Marker marker)` Sets the series marker
`void`	`setNeckHeight(String neckHeight)` Sets the neck height for funnel chart only.
`void`	`setNeckWidth(String neckWidth)` Sets the neck width for funnel chart only.
`void`	`setNegativeColor(Color color)` Sets the color for the parts of the graph or points that are below the `setThreshold(Number)`.
`void`	`setNegativeColor(LinearGradient color)` Sets the color for the parts of the graph or points that are below the `setThreshold(Number)`.
`void`	`setNegativeColor(RadialGradient color)` Sets the color for the parts of the graph or points that are below the `setThreshold(Number)`.
`void`	`setNegativeColor(String color)` Sets the color for the parts of the graph or points that are below the `setThreshold(Number)`.
`void`	`setOpacity(Number opacity)` Sets opacity of a series parts: line, fill (e.g.
`void`	`setPointInterval(Number pointInterval)` Sets if no x values are given for the points in a series, pointInterval defines the interval of the x values.
`void`	`setPointIntervalUnit(String pointIntervalUnit)` Set the irregular time unit for point interval, only "month" or "year" is allowed.
`void`	`setPointPlacement(Number pointPlacement)` Sets the point placement with a number
`void`	`setPointPlacement(String pointPlacement)` Sets the point placement.
`void`	`setPointStart(Number pointStart)` Sets if no x values are given for the points in a series, pointStart defines on what value to start.
`void`	`setSelected(boolean selected)` Sets whether to select the series initially.
`void`	`setShadow(boolean shadow)` Sets whether to apply a drop shadow to the graph line.
`void`	`setShowCheckbox(boolean showCheckbox)` Sets if true, a checkbox is displayed next to the legend item to allow selecting the series.
`void`	`setShowInLegend(boolean showInLegend)` Sets whether to display this particular series or series type in the legend.
`void`	`setSkipKeyboardNavigation(boolean skipKeyboardNavigation)` If set to true, the accessibility module will skip past the points in this series for keyboard navigation.
`void`	`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(Boolean stacking)`
`void`	`setStacking(String stacking)` Sets whether to stack the values of each series on top of each other.
`void`	`setStates(States states)` Sets a wrapper object for all the series options in specific states.
`void`	`setStep(String step)` Sets whether to apply steps to the line.
`void`	`setStickyTracking(boolean stickyTracking)` Sets sticky tracking of mouse events.
`void`	`setThreshold(Number threshold)` Sets the threshold, also called zero level or base level.
`void`	`setTooltip(TooltipPlotOptions tooltip)` Sets a configuration object for the tooltip rendering of each single series.
`void`	`setTurboThreshold(Number turboThreshold)` Sets 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)` Sets set the initial visibility of the series.
`void`	`setZoneAxis(String zoneAxis)` Set the axis on which the zones are applied.
`void`	`setZones(List<Zone> zones)` Set the zones within a series.

Methods inherited from class org.zkoss.chart.Optionable
addExtraAttr, addOptionDataListener, clearOptonDataListener, clone, containsKey, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, getAttr, getAttr, getClientState, getExtraAttr, merge, onChange, removeExtraAttr, removeKey, removeOptionDataListener, setAttr, setAttr, setAttr, toJSONString, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.zkoss.chart.OptionDataListener
onChange

- Constructor Detail
  - SeriesPlotOptions
```
public SeriesPlotOptions()
```
- Method Detail
  - isAllowPointSelect
```
public boolean isAllowPointSelect()
```
    Returns to allow this series' points to be selected by clicking on the markers, bars or pie slices.
    Default: false
  - setAllowPointSelect
```
public void setAllowPointSelect(boolean allowPointSelect)
```
    Sets to allow this series' points to be selected by clicking on the markers, bars or pie slices.
    Default: false
  - isAnimation
```
public boolean isAnimation()
```
    Returns whether to enable or disable the initial animation when a series is displayed. The animation can also be set as a Animation object. Please note that this option only applies to the initial animation of the series itself. For other animations, see Chart.setAnimation(Animation) and the animation parameter under the API methods. The following properties are supported:
    
    duration
    
    The duration of the animation in milliseconds.
    
    easing
    
    When using jQuery as the general framework, the easing can be set to linear or swing. More easing functions are available with the use of jQuery plug-ins, most notably the jQuery UI suite. See the jQuery docs. When using MooTools as the general framework, use the property name transition instead of easing.
    
    due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
  - getAnimation
```
public Animation getAnimation()
```
    Returns whether to enable or disable the initial animation when a series is displayed. The animation can also be set as a Animation object.
    Default: an instance of Animation
  - setAnimation
```
public void setAnimation(boolean animation)
```
    Sets whether to enable or disable the initial animation when a series is displayed. The animation can also be set as a Animation object. Please note that this option only applies to the initial animation of the series itself. For other animations, see Chart.setAnimation(Animation) and the animation parameter under the API methods. The following properties are supported:
    
    duration
    
    The duration of the animation in milliseconds.
    
    easing
    
    When using jQuery as the general framework, the easing can be set to linear or swing. More easing functions are available with the use of jQuery plug-ins, most notably the jQuery UI suite. See the jQuery docs. When using MooTools as the general framework, use the property name transition instead of easing.
    
    due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
    
    See Also:
    
    setAnimation(Animation), Animation
  - setAnimation
```
public void setAnimation(Animation animation)
```
    Sets whether to enable or disable the initial animation when a series is displayed. The animation can also be set as a Animation object. Please note that this option only applies to the initial animation of the series itself. For other animations, see Chart.setAnimation(Animation) and the animation parameter under the API methods. The following properties are supported:
    
    duration
    
    The duration of the animation in milliseconds.
    
    easing
    
    When using jQuery as the general framework, the easing can be set to linear or swing. More easing functions are available with the use of jQuery plug-ins, most notably the jQuery UI suite. See the jQuery docs. When using MooTools as the general framework, use the property name transition instead of easing.
    
    due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
    
    See Also:
    
    setAnimation(boolean), Animation
  - getBorderWidth
```
public Number getBorderWidth()
```
    Returns the border width of the series.
    Default: null
  - setBorderWidth
```
public void setBorderWidth(Number borderWidth)
```
    Sets the border width of the series.
  - isClip
```
public boolean isClip()
```
    Disable this option to allow series rendering in the whole plotting area. Note: Clipping should be always enabled when chart.zoomType is set
    Default: true
    
    Since:
    
    7.2.1.0
  - setClip
```
public void setClip(boolean clip)
```
    Disable this option to allow series rendering in the whole plotting area. Note: Clipping should be always enabled when chart.zoomType is set
    
    Since:
    
    7.2.1.0
  - getColor
```
public Color getColor()
```
    Returns the main color of 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 Charts.getColors() array.
  - setColor
```
public void setColor(Color color)
```
    Sets the main color of 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 Charts.getColors() array.
  - setColor
```
public void setColor(String color)
```
    Sets the main color of 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 Charts.getColors() array.
  - setColor
```
public void setColor(LinearGradient color)
```
    Sets the main color of 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 Charts.getColors() array.
  - setColor
```
public void setColor(RadialGradient color)
```
    Sets the main color of 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 Charts.getColors() array.
  - getColorAxis
```
public Object getColorAxis()
```
    When using dual or multiple color axes, this defines which colorAxis the particular series is connected to. It refers to either the Axis.getId() or the index of the axis in the colorAxis array, with 0 being the first. Set this option to false to prevent a series from connecting to the default color axis.
    Default: 0
    
    Since:
    
    7.2.1.0
  - setColorAxis
```
public void setColorAxis(Number colorAxis)
```
    When using dual or multiple color axes, this defines which colorAxis the particular series is connected to. It refers to the index of the axis in the colorAxis array, with 0 being the first.
    
    Since:
    
    7.2.1.0
  - isColorByPoint
```
public boolean isColorByPoint()
```
    Returns when using automatic point colors pulled from the Charts.getColors() collection, this option determines whether the chart should receive one color per series or one color per point.
    Default: false.
    
    Since:
    
    7.2.1.0
  - setColorByPoint
```
public void setColorByPoint(boolean colorByPoint)
```
    Sets when using automatic point colors pulled from the Charts.getColors() collection, this option determines whether the chart should receive one color per series or one color per point.
    
    Since:
    
    7.2.1.0
  - setColorAxis
```
public void setColorAxis(String colorAxis)
```
    When using dual or multiple color axes, this defines which colorAxis the particular series is connected to. It refers to the {@link ColorAxis#getId().
    
    Since:
    
    7.2.1.0
  - setColorAxis
```
public void setColorAxis(boolean colorAxis)
```
    When using dual or multiple color axes, this defines which colorAxis the particular series is connected to. Set this option to false to prevent a series from connecting to the default color axis.
    
    Since:
    
    7.2.1.0
  - getColorKey
```
public String getColorKey()
```
    Returns 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'.
    Default: "y"
    
    Since:
    
    7.2.1.0
  - setColorKey
```
public void setColorKey(String colorKey)
```
    Sets 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'.
    
    Since:
    
    7.2.1.0
  - isConnectEnds
```
public boolean isConnectEnds()
```
    Returns polar charts only. Whether to connect the ends of a line series plot across the extremes.
  - setConnectEnds
```
public void setConnectEnds(boolean connectEnds)
```
    Sets polar charts only. Whether to connect the ends of a line series plot across the extremes.
  - isConnectNulls
```
public boolean isConnectNulls()
```
    Returns whether to connect a graph line across null points.
  - setConnectNulls
```
public void setConnectNulls(boolean connectNulls)
```
    Sets whether to connect a graph line across null points.
  - getCropThreshold
```
public Number getCropThreshold()
```
    Returns 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.
  - setCropThreshold
```
public void setCropThreshold(Number cropThreshold)
```
    Sets 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.
  - getCursor
```
public String getCursor()
```
    Returns 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.
  - setCursor
```
public void setCursor(String cursor)
```
    Sets 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.
  - getDashStyle
```
public String getDashStyle()
```
    Returns 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
  - setDashStyle
```
public void setDashStyle(String dashStyle)
```
    Sets 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
  - getDataLabels
```
public DataLabels getDataLabels()
```
    Returns the option of data labels.
  - setDataLabels
```
public void setDataLabels(DataLabels dataLabels)
```
    Sets the option of data labels.
    
    See Also:
    
    DataLabels
  - getDepth
```
public Number getDepth()
```
    Returns the depth of the series in a 3D chart.
    Default: 25
    
    Since:
    
    7.2.1.0
  - setDepth
```
public void setDepth(Number depth)
```
    Sets the depth of the series in a 3D chart.
    
    Since:
    
    7.2.1.0
  - getDescription
```
public String getDescription()
```
    Returns a description of the series to add to the screen reader information about the series.
    Default: null
    
    Since:
    
    7.2.1.0
  - setDescription
```
public void setDescription(String description)
```
    Sets a description of the series to add to the screen reader information about the series.
    
    Since:
    
    7.2.1.0
  - getDragDrop
```
public DragDrop getDragDrop()
```
    Returns the options of the draggable-points module allows points to be moved around or modified in the chart, if any. Otherwise, create a new one. In addition to the options mentioned under the dragDrop API structure, the module fires three events, point.dragStart, point.drag and point.drop.
    
    Since:
    
    7.2.1.0
  - setDragDrop
```
public void setDragDrop(DragDrop dragDrop)
```
    Sets the options of the draggable-points module allows points to be moved around or modified in the chart. In addition to the options mentioned under the dragDrop API structure, the module fires three events, point.dragStart, point.drag and point.drop.
    
    Since:
    
    7.2.1.0
  - isEnableMouseTracking
```
public boolean isEnableMouseTracking()
```
    Returns 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.
  - setEnableMouseTracking
```
public void setEnableMouseTracking(boolean enableMouseTracking)
```
    Sets 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.
  - getFindNearestPointBy
```
public String getFindNearestPointBy()
```
    Returns 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.
    Default: "x"
    
    Since:
    
    7.2.1.0
  - setFindNearestPointBy
```
public void setFindNearestPointBy(String findNearestPointBy)
```
    Sets 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.
    
    Since:
    
    7.2.1.0
  - isGetExtremesFromAll
```
public boolean isGetExtremesFromAll()
```
    Returns 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.
    Default: false
    
    Since:
    
    7.2.1.0
  - setGetExtremesFromAll
```
public void setGetExtremesFromAll(boolean getExtremesFromAll)
```
    Sets 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.
    
    Since:
    
    7.2.1.0
  - getGroupPadding
```
public Number getGroupPadding()
```
    Returns padding between each value groups, in x axis units.
    Default: 0.2
    
    Since:
    
    7.2.1.0
  - setGroupPadding
```
public void setGroupPadding(Number groupPadding)
```
    Sets padding between each value groups, in x axis units.
    
    Since:
    
    7.2.1.0
  - getId
```
public String getId()
```
    Returns an id for the series.
  - setId
```
public void setId(String id)
```
    Sets an id for the series.
  - isIncludeInDataExport
```
public boolean isIncludeInDataExport()
```
    When set to false will prevent the series data from being included in any form of data export.
    Default: true
    
    Since:
    
    7.2.1.0
  - setIncludeInDataExport
```
public void setIncludeInDataExport(boolean includeInDataExport)
```
    When set to false will prevent the series data from being included in any form of data export.
    
    Since:
    
    7.2.1.0
  - getLabel
```
public SeriesLabel getLabel()
```
    Returns series label options, if any. Otherwise, create a new one. Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series. The goal of this feature is to make the chart more easily readable, like if a human designer placed the labels in the optimal position. The series labels currently work with series types having a graph or an area.
    
    Since:
    
    7.2.1.0
  - setLabel
```
public void setLabel(SeriesLabel label)
```
    Sets series label options. Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series. The goal of this feature is to make the chart more easily readable, like if a human designer placed the labels in the optimal position. The series labels currently work with series types having a graph or an area.
    
    Since:
    
    7.2.1.0
  - getLinecap
```
public String getLinecap()
```
    Returns the line cap used for line ends and line joins on the graph.
    Default: "round"
    
    Since:
    
    7.2.1.0
  - setLinecap
```
public void setLinecap(String linecap)
```
    Sets the line cap used for line ends and line joins on the graph.
    
    Since:
    
    7.2.1.0
  - getLineWidth
```
public Number getLineWidth()
```
    Returns pixel with of the graph line.
  - setLineWidth
```
public void setLineWidth(Number lineWidth)
```
    Sets pixel with of the graph line.
  - getLinkedTo
```
public String getLinkedTo()
```
    Returns the setId(String) 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.
  - setLinkedTo
```
public void setLinkedTo(String linkedTo)
```
    Sets the setId(String) 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.
  - getMarker
```
public Marker getMarker()
```
    Returns the series marker
  - setMarker
```
public void setMarker(Marker marker)
```
    Sets the series marker
  - getNeckHeight
```
public String getNeckHeight()
```
    Returns the neck height for funnel chart only.
  - setNeckHeight
```
public void setNeckHeight(String neckHeight)
```
    Sets the neck height for funnel chart only.
  - getNeckWidth
```
public String getNeckWidth()
```
    Returns the neck width for funnel chart only.
  - setNeckWidth
```
public void setNeckWidth(String neckWidth)
```
    Sets the neck width for funnel chart only.
  - getNegativeColor
```
public Color getNegativeColor()
```
    Returns the color for the parts of the graph or points that are below the setThreshold(Number).
    Defaults to null.
  - setNegativeColor
```
public void setNegativeColor(Color color)
```
    Sets the color for the parts of the graph or points that are below the setThreshold(Number).
    Defaults to null.
  - setNegativeColor
```
public void setNegativeColor(String color)
```
    Sets the color for the parts of the graph or points that are below the setThreshold(Number).
    Defaults to null.
  - setNegativeColor
```
public void setNegativeColor(LinearGradient color)
```
    Sets the color for the parts of the graph or points that are below the setThreshold(Number).
    Defaults to null.
  - setNegativeColor
```
public void setNegativeColor(RadialGradient color)
```
    Sets the color for the parts of the graph or points that are below the setThreshold(Number).
    Defaults to null.
  - getOpacity
```
public Number getOpacity()
```
    Returns opacity of a series parts: line, fill (e.g. area) and dataLabels.
    Default: 1
    
    Since:
    
    7.2.1.0
  - setOpacity
```
public void setOpacity(Number opacity)
```
    Sets opacity of a series parts: line, fill (e.g. area) and dataLabels.
    
    Since:
    
    7.2.1.0
  - getPointInterval
```
public Number getPointInterval()
```
    Returns 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.
    Default: 1
  - setPointInterval
```
public void setPointInterval(Number pointInterval)
```
    Sets 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.
    Default: 1
  - getPointIntervalUnit
```
public String getPointIntervalUnit()
```
    On datetime series, this allows for setting the pointInterval to the two irregular time units, month and year. Combine it with pointInterval to draw quarters, 6 months, 10 years etc.
    Default: null
    
    Since:
    
    2.1.0
  - setPointIntervalUnit
```
public void setPointIntervalUnit(String pointIntervalUnit)
```
    Set the irregular time unit for point interval, only "month" or "year" is allowed.
    
    Parameters:
    
    pointIntervalUnit - either "month" or "year"
    
    Since:
    
    2.1.0
  - getPointPlacement
```
public Object getPointPlacement()
```
    Returns the point placement.
    Possible values: null, "on", "between" or numeric.
    
    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.
    
    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.
    
    Defaults to null in cartesian charts, "between" in polar charts.
  - setPointPlacement
```
public void setPointPlacement(String pointPlacement)
```
    Sets the point placement.
    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.
    Defaults to null in cartesian charts, "between" in polar charts.
  - setPointPlacement
```
public void setPointPlacement(Number pointPlacement)
```
    Sets the point placement with a number
    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.
  - getPointStart
```
public Number getPointStart()
```
    Returns 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.
  - setPointStart
```
public void setPointStart(Number pointStart)
```
    Sets 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.
  - isSelected
```
public boolean isSelected()
```
    Returns whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.
  - setSelected
```
public void setSelected(boolean selected)
```
    Sets whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.
  - isShadow
```
public boolean isShadow()
```
    Returns 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.
  - setShadow
```
public void setShadow(boolean shadow)
```
    Sets 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.
  - isShowCheckbox
```
public boolean isShowCheckbox()
```
    Returns 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.
  - setShowCheckbox
```
public void setShowCheckbox(boolean showCheckbox)
```
    Sets 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.
  - isShowInLegend
```
public boolean isShowInLegend()
```
    Returns whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.
  - setShowInLegend
```
public void setShowInLegend(boolean showInLegend)
```
    Sets whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.
  - isSkipKeyboardNavigation
```
public boolean isSkipKeyboardNavigation()
```
    If set to true, the accessibility module will skip past the points in this series for keyboard navigation.
    Default: false
    
    Since:
    
    7.2.1.0
  - setSkipKeyboardNavigation
```
public void setSkipKeyboardNavigation(boolean skipKeyboardNavigation)
```
    If set to true, the accessibility module will skip past the points in this series for keyboard navigation.
    
    Since:
    
    7.2.1.0
  - isSoftThreshold
```
public boolean isSoftThreshold()
```
    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.
    Default: true
    
    Since:
    
    7.2.1.0
  - 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.
    
    Since:
    
    7.2.1.0
  - getStacking
```
public String getStacking()
```
    Returns 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".
  - isStacking
```
public boolean isStacking()
```
    Returns whether to stack the values of each series on top of each other or not.
  - setStacking
```
public void setStacking(String stacking)
```
    Sets 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".
  - setStacking
```
public void setStacking(Boolean stacking)
```
  - getStates
```
public States getStates()
```
    Returns a wrapper object for all the series options in specific states.
  - setStates
```
public void setStates(States states)
```
    Sets a wrapper object for all the series options in specific states.
  - getStep
```
public String getStep()
```
    Returns whether to apply steps to the line. Possible values are left, center and right.
    Default: null
    
    Since:
    
    7.2.1.0
  - setStep
```
public void setStep(String step)
```
    Sets whether to apply steps to the line. Possible values are left, center and right.
    
    Since:
    
    7.2.1.0
  - isStickyTracking
```
public boolean isStickyTracking()
```
    Returns 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.isShared() 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, pies etc.
  - setStickyTracking
```
public void setStickyTracking(boolean stickyTracking)
```
    Sets 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.isShared() 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, pies etc.
  - getThreshold
```
public Number getThreshold()
```
    Returns the threshold, also called zero level or base level. For line type series this is only used in conjunction with setNegativeColor(String)
  - setThreshold
```
public void setThreshold(Number threshold)
```
    Sets the threshold, also called zero level or base level. For line type series this is only used in conjunction with setNegativeColor(String)
  - getTooltip
```
public TooltipPlotOptions getTooltip()
```
    Returns 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.
  - setTooltip
```
public void setTooltip(TooltipPlotOptions tooltip)
```
    Sets 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.
  - getTurboThreshold
```
public Number getTurboThreshold()
```
    Returns 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.
  - setTurboThreshold
```
public void setTurboThreshold(Number turboThreshold)
```
    Sets 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.
  - isVisible
```
public boolean isVisible()
```
    Returns set the initial visibility of the series.
  - setVisible
```
public void setVisible(boolean visible)
```
    Sets set the initial visibility of the series.
  - getZoneAxis
```
public String getZoneAxis()
```
    Defines the Axis on which the zones are applied.
    
    Returns:
    
    the zone axis or the default value "y"
    
    Since:
    
    7.2.1.0
  - setZoneAxis
```
public void setZoneAxis(String zoneAxis)
```
    Set the axis on which the zones are applied. Only X, Y, or Z axis are supported.
    
    Parameters:
    
    zoneAxis - either "x", "y", or "z"
    
    Since:
    
    7.2.1.0
  - getZones
```
public List<Zone> getZones()
```
    An list 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.
    
    Since:
    
    7.2.1.0
    
    See Also:
    
    Zone
  - setZones
```
public void setZones(List<Zone> zones)
```
    Set the zones within a series.
    
    Since:
    
    7.2.1.0
    
    See Also:
    
    getZones(), Zone

Class SeriesPlotOptions

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

Constructor Summary

Method Summary

Methods inherited from class org.zkoss.chart.Optionable

Methods inherited from class java.lang.Object

Methods inherited from interface org.zkoss.chart.OptionDataListener

Constructor Detail

SeriesPlotOptions

Method Detail

isAllowPointSelect

setAllowPointSelect

isAnimation

getAnimation

setAnimation

setAnimation

getBorderWidth

setBorderWidth

isClip

setClip

getColor

setColor

setColor

setColor

setColor

getColorAxis

setColorAxis

isColorByPoint

setColorByPoint

setColorAxis

setColorAxis

getColorKey

setColorKey

isConnectEnds

setConnectEnds

isConnectNulls

setConnectNulls

getCropThreshold

setCropThreshold

getCursor

setCursor

getDashStyle

setDashStyle

getDataLabels

setDataLabels

getDepth

setDepth

getDescription

setDescription

getDragDrop

setDragDrop

isEnableMouseTracking

setEnableMouseTracking

getFindNearestPointBy

setFindNearestPointBy

isGetExtremesFromAll

setGetExtremesFromAll

getGroupPadding

setGroupPadding

getId

setId

isIncludeInDataExport

setIncludeInDataExport

getLabel

setLabel

getLinecap

setLinecap

getLineWidth

setLineWidth

getLinkedTo

setLinkedTo

getMarker

setMarker

getNeckHeight

setNeckHeight

getNeckWidth

setNeckWidth

getNegativeColor

setNegativeColor