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

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

Direct Known Subclasses:

ArcDiagramPlotOptions, AreaPlotOptions, BellCurvePlotOptions, ColumnPlotOptions, ColumnPyramidPlotOptions, ColumnRangePlotOptions, DumbbellPlotOptions, GaugePlotOptions, HeatmapPlotOptions, HistogramPlotOptions, ItemPlotOptions, LinePlotOptions, NetworkGraphPlotOptions, ParetoPlotOptions, PictorialPlotOptions, PiePlotOptions, PolygonPlotOptions, SankeyPlotOptions, ScatterPlotOptions, SplinePlotOptions, StreamGraphPlotOptions, TimelinePlotOptions, TreegraphPlotOptions, 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 Description

SeriesPlotOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addDataLabels(DataLabels dataLabels)`	Add an option of data labels to the list.
`SeriesAccessibility`	`getAccessibility()`	Returns accessibility options for a series.
`Animation`	`getAnimation()`	Returns whether to enable or disable the initial animation when a series is displayed.
`Number`	`getAnimationLimit()`	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.
`String`	`getBoostBlending()`	Returns the color blending in the boost module.
`Number`	`getBoostThreshold()`	Returns the point threshold for when a series should enter boost mode.
`Object`	`getBorderRadius()`	Returns the corner radius of the border surrounding each column or bar.
`Number`	`getBorderWidth()`	Returns the border width of the series.
`String`	`getClassName()`	Returns an additional class name to apply to the series' graphical elements.
`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.
`Number`	`getColorIndex()`	Returns a specific color index to use for the series, so its graphic representations are given the class name `"highcharts-color-{n}"`.
`String`	`getColorKey()`	Returns what data value should be used to calculate point color if colorAxis is used.
`Number`	`getConnectorWidth()`	Returns the width of the line connecting the data label.
`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.
`<K,V> Map<K,V>`	`getCustom()`	Returns a reserved subspace to store options and values for customized functionality.
`String`	`getDashStyle()`	Returns a name for the dash style to use for the graph.
`DataLabels`	`getDataLabels()`	Returns the first or single option of data labels.
`List<DataLabels>`	`getDataLabelsList()`	Returns the list of options of data labels.
`DataSorting`	`getDataSorting()`	Returns the series data sorting.
`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.
`int`	`getIndex()`	Returns the index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.
`List<String>`	`getKeys()`	Returns an array specifying which option maps to which key in the data point array.
`SeriesLabel`	`getLabel()`	Returns series label options, if any.
`String`	`getLegendSymbol()`	Returns the type of legend symbol to render for this series.
`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`	`getName()`	Returns the name of the series as shown in the legend, tooltip etc.
`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)`.
`OnPoint`	`getOnPoint()`	Returns the Series on point feature.
`Number`	`getOpacity()`	Returns opacity of a series parts: line, fill (e.g.
`org.zkoss.json.JavaScriptValue`	`getPointDescriptionFormatter()`	Returns the formatter function to use instead of the default for series descriptions.
`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`	`isCenterInCategory()`	When true, the columns will center in the category, ignoring null or missing points.
`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`	`isCrisp()`	When true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen.
`boolean`	`isDataAsColumns()`	Indicates data is structured as columns instead of rows.
`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`	`isRelativeXValue()`	When true, X values in the data set are relative to the current `pointStart`, `pointInterval` and `pointIntervalUnit` settings.
`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.
`protected DataLabels`	`newDataLabels()`	Internal method for subclasses to provide specific type of data labels.
`void`	`setAccessibility(SeriesAccessibility accessibility)`	Sets accessibility options for a 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(boolean animation)`	Sets whether to enable or disable the initial animation when a series is displayed.
`void`	`setAnimation(Animation animation)`	Sets whether to 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`	`setBoostBlending(String boostBlending)`	Sets the color blending in the boost module.
`void`	`setBoostThreshold(Number boostThreshold)`	Sets the point threshold for when a series should enter boost mode.
`void`	`setBorderRadius(Number borderRadius)`	Sets the corner radius of the border surrounding each column or bar.
`void`	`setBorderRadius(String borderRadius)`	Sets the corner radius of the border surrounding each column or bar.
`void`	`setBorderWidth(Number borderWidth)`	Sets the border width of the series.
`void`	`setCenter(Object... center)`	Sets the center of the pie chart relative to the plot area.
`void`	`setCenter(List<Object> center)`	Sets the center of the pie chart relative to the plot area.
`void`	`setCenterInCategory(boolean centerInCategory)`	When true, the columns will center in the category, ignoring null or missing points.
`void`	`setClassName(String className)`	Sets an additional 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(String color)`	Sets the main color of the series.
`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`	`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`	`setColorIndex(Number colorIndex)`	Sets a specific color index to use for the series, so its graphic representations are given the class name `"highcharts-color-{n}"`.
`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`	`setConnectorWidth(Number connectorWidth)`	Sets the width of the line connecting the data label.
`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)`	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.
`<K,V> void`	`setCustom(Map<K,V> custom)`	Sets a reserved subspace to store options and values for customized functionality.
`void`	`setDashStyle(String dashStyle)`	Sets a name for the dash style to use for the graph.
`void`	`setDataAsColumns(boolean dataAsColumns)`	Indicates data is structured as columns instead of rows.
`void`	`setDataLabels(List<DataLabels> dataLabels)`	Sets the list of options of data labels.
`void`	`setDataLabels(DataLabels dataLabels)`	Sets the first or single option of data labels.
`void`	`setDataSorting(DataSorting dataSorting)`	Sets the series data sorting.
`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`	`setIndex(int index)`	Sets the index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.
`void`	`setKeys(List<String> keys)`	Returns an array specifying which option maps to which key in the data point array.
`void`	`setLabel(SeriesLabel label)`	Sets series label options.
`void`	`setLegendSymbol(String legendSymbol)`	Sets the type of legend symbol to render for this series.
`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`	`setName(String name)`	Sets the name of the series as shown in the legend, tooltip etc.
`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(String color)`	Sets the color for the parts of the graph or points that are below the `setThreshold(Number)`.
`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`	`setOnPoint(OnPoint onPoint)`	Sets the Series on point feature.
`void`	`setOpacity(Number opacity)`	Sets opacity of a series parts: line, fill (e.g.
`void`	`setPointDescriptionFormatter(org.zkoss.json.JavaScriptValue pointDescriptionFormatter)`	Sets the formatter function to use instead of the default for series descriptions.
`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 "day", "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`	`setRelativeXValue(boolean relativeXValue)`	When true, X values in the data set are relative to the current `pointStart`, `pointInterval` and `pointIntervalUnit` settings.
`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`	`setWidth(String width)`	Sets the width 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.
`void`	`setZones(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, 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
  - getAccessibility
```
public SeriesAccessibility getAccessibility()
```
    Returns accessibility options for a series. If null, create a new one.
    Default: an instance of SeriesAccessibility
    
    Since:
    
    10.2.1.0
  - setAccessibility
```
public void setAccessibility(SeriesAccessibility accessibility)
```
    Sets accessibility options for a series.
    
    Since:
    
    10.2.1.0
  - getClassName
```
public String getClassName()
```
    Returns an additional class name to apply to the series' graphical elements. This option does not replace default class names of the graphical element.
    Default: null
    
    Since:
    
    10.2.1.0
  - setClassName
```
public void setClassName(String className)
```
    Sets an additional class name to apply to the series' graphical elements. This option does not replace default class names of the graphical element.
    Default: null
    
    Since:
    
    10.2.1.0
  - isCenterInCategory
```
public boolean isCenterInCategory()
```
    When true, the columns will center in the category, ignoring null or missing points. When false, space will be reserved for null or missing points.
    Default: false.
    
    Since:
    
    11.2.0.0
  - setCenterInCategory
```
public void setCenterInCategory(boolean centerInCategory)
```
    When true, the columns will center in the category, ignoring null or missing points. When false, space will be reserved for null or missing points.
    
    Since:
    
    11.2.0.0
  - setCenter
```
public void setCenter(List<Object> center)
```
    Sets the center of the pie chart relative to the plot area. Can be percentages or pixel values. The default behaviour is to center the pie so that all slices and data labels are within the plot area. As a consequence, the pie may actually jump around in a chart with dynamic values, as the data labels move. In that case, the center should be explicitly set, for example to ["50%", "50%"].
    
    Since:
    
    10.2.1.0
  - setCenter
```
public void setCenter(Object... center)
```
    Sets the center of the pie chart relative to the plot area. Can be percentages or pixel values. The default behaviour is to center the pie so that all slices and data labels are within the plot area. As a consequence, the pie may actually jump around in a chart with dynamic values, as the data labels move. In that case, the center should be explicitly set, for example to ["50%", "50%"].
    
    Since:
    
    10.2.1.0
  - getBoostBlending
```
public String getBoostBlending()
```
    Returns the color blending in the boost module.
    Defaults to null.
    
    Since:
    
    10.2.1.0
  - setBoostBlending
```
public void setBoostBlending(String boostBlending)
```
    Sets the color blending in the boost module.
    Defaults to null.
    
    Since:
    
    10.2.1.0
  - getBoostThreshold
```
public Number getBoostThreshold()
```
    Returns the point threshold for when a series should enter boost mode. Setting it to e.g. 2000 will cause the series to enter boost mode when there are 2000 or more points in the series. To disable boosting on the series, set the boostThreshold to 0. Setting it to 1 will force boosting.
    Note that the cropThreshold also affects this setting. When zooming in on a series that has fewer points than the cropThreshold, all points are rendered although outside the visible plot area, and the boostThreshold won't take effect.
    Defaults to 5000.
    
    Since:
    
    10.2.1.0
  - setBoostThreshold
```
public void setBoostThreshold(Number boostThreshold)
```
    Sets the point threshold for when a series should enter boost mode. Setting it to e.g. 2000 will cause the series to enter boost mode when there are 2000 or more points in the series. To disable boosting on the series, set the boostThreshold to 0. Setting it to 1 will force boosting.
    Note that the cropThreshold also affects this setting. When zooming in on a series that has fewer points than the cropThreshold, all points are rendered although outside the visible plot area, and the boostThreshold won't take effect.
    Defaults to 5000.
    
    Since:
    
    10.2.1.0
  - getAnimationLimit
```
public Number getAnimationLimit()
```
    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 does not run if there is more than 250 points totally. To disable this cap, set animationLimit to Infinity.
    Default: undefined
    
    Since:
    
    10.2.1.0
  - 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 does not run if there is more than 250 points totally. To disable this cap, set animationLimit to Infinity.
    Default: undefined
    
    Since:
    
    10.2.1.0
  - 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
  - getBorderRadius
```
public Object getBorderRadius()
```
    Returns the corner radius of the border surrounding each column or bar.
    A number signifies pixels.
    A percentage string, like for example 50%, signifies a relative size.
    For columns this is relative to the column width, for pies it is relative to the radius and the inner radius.
    Default: 3
    
    Since:
    
    11.2.0.0
  - setBorderRadius
```
public void setBorderRadius(Number borderRadius)
```
    Sets the corner radius of the border surrounding each column or bar.
    A number signifies pixels.
    A percentage string, like for example 50%, signifies a relative size.
    For columns this is relative to the column width, for pies it is relative to the radius and the inner radius.
    
    Since:
    
    11.2.0.0
  - setBorderRadius
```
public void setBorderRadius(String borderRadius)
```
    Sets the corner radius of the border surrounding each column or bar.
    A number signifies pixels.
    A percentage string, like for example 50%, signifies a relative size.
    For columns this is relative to the column width, for pies it is relative to the radius and the inner radius.
    
    Since:
    
    11.2.0.0
  - 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
  - getColorIndex
```
public Number getColorIndex()
```
    Returns a specific color index to use for the series, so its graphic representations are given the class name "highcharts-color-{n}".
    Default: null
    
    Since:
    
    10.2.1.0
  - setColorIndex
```
public void setColorIndex(Number colorIndex)
```
    Sets a specific color index to use for the series, so its graphic representations are given the class name "highcharts-color-{n}".
    Default: null
    
    Since:
    
    10.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 Axis.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.
  - getConnectorWidth
```
public Number getConnectorWidth()
```
    Returns the width of the line connecting the data label.
    Default: 1
    
    Since:
    
    11.2.0.0
  - setConnectorWidth
```
public void setConnectorWidth(Number connectorWidth)
```
    Sets the width of the line connecting the data label.
    
    Since:
    
    11.2.0.0
  - isCrisp
```
public boolean isCrisp()
```
    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.
    Default: true.
    
    Since:
    
    10.2.1.0
  - 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.
    Default: true.
    
    Since:
    
    10.2.1.0
  - getCustom
```
public <K,V> Map<K,V> getCustom()
```
    Returns a reserved subspace to store options and values for customized functionality. Here you can add additional data for your own event callbacks and formatter callbacks.
    Default: null.
    
    Since:
    
    10.2.1.0
  - setCustom
```
public <K,V> void setCustom(Map<K,V> custom)
```
    Sets a reserved subspace to store options and values for customized functionality. Here you can add additional data for your own event callbacks and formatter callbacks.
    Default: null.
    
    Since:
    
    10.2.1.0
  - 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
  - isDataAsColumns
```
public boolean isDataAsColumns()
```
    Indicates data is structured as columns instead of rows.
    Default: false.
    
    Since:
    
    10.2.1.0
  - setDataAsColumns
```
public void setDataAsColumns(boolean dataAsColumns)
```
    Indicates data is structured as columns instead of rows.
    Default: false.
    
    Since:
    
    10.2.1.0
  - getDataLabels
```
public DataLabels getDataLabels()
```
    Returns the first or single option of data labels.
  - setDataLabels
```
public void setDataLabels(DataLabels dataLabels)
```
    Sets the first or single option of data labels.
    
    See Also:
    
    DataLabels
  - getDataLabelsList
```
public List<DataLabels> getDataLabelsList()
```
    Returns the list of options of data labels.
    
    Since:
    
    7.2.2.0
  - setDataLabels
```
public void setDataLabels(List<DataLabels> dataLabels)
```
    Sets the list of options of data labels.
    
    Since:
    
    7.2.2.0
    
    See Also:
    
    DataLabels
  - addDataLabels
```
public void addDataLabels(DataLabels dataLabels)
```
    Add an option of data labels to the list.
    
    Since:
    
    7.2.2.0
    
    See Also:
    
    DataLabels
  - newDataLabels
```
protected DataLabels newDataLabels()
```
    Internal method for subclasses to provide specific type of data labels.
    
    Since:
    
    7.2.2.0
  - 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
  - getDataSorting
```
public DataSorting getDataSorting()
```
    Returns the series data sorting.
    Default: an instance of DataSoring.
    
    Since:
    
    10.2.1.0
    
    See Also:
    
    DataSorting
  - setDataSorting
```
public void setDataSorting(DataSorting dataSorting)
```
    Sets the series data sorting.
    Default: an instance of DataSoring.
    
    Since:
    
    10.2.1.0
    
    See Also:
    
    DataSorting
  - 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
  - setIndex
```
public void setIndex(int index)
```
    Sets the index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.
    
    Since:
    
    10.2.1.0
  - getIndex
```
public int getIndex()
```
    Returns the index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.
    Default: -1, it means depended on the implementaion.
    
    Since:
    
    10.2.1.0
  - getKeys
```
public List<String> getKeys()
```
    Returns 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.
    Defaults: null.
    
    Since:
    
    10.2.1.0
  - setKeys
```
public void setKeys(List<String> keys)
```
    Returns 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.
    Defaults: null.
    
    Since:
    
    10.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
  - getLegendSymbol
```
public String getLegendSymbol()
```
    Returns the type of legend symbol to render for this series. Can be one of lineMarker or rectangle.
    Default: "rectangle"
    
    Since:
    
    11.2.0.0
  - setLegendSymbol
```
public void setLegendSymbol(String legendSymbol)
```
    Sets the type of legend symbol to render for this series. Can be one of lineMarker or rectangle.
    
    Since:
    
    11.2.0.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.
  - getName
```
public String getName()
```
    Returns the name of the series as shown in the legend, tooltip etc.
    
    Since:
    
    10.2.1.0
  - setName
```
public void setName(String name)
```
    Sets the name of the series as shown in the legend, tooltip etc.
    
    Since:
    
    10.2.1.0
  - 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.
  - getOnPoint
```
public OnPoint getOnPoint()
```
    Returns the Series on point feature. Only pie and sunburst series are supported at this moment.
    Default: an instance of OnPoint
    
    Since:
    
    10.2.1.0
    
    See Also:
    
    OnPoint
  - setOnPoint
```
public void setOnPoint(OnPoint onPoint)
```
    Sets the Series on point feature. Only pie and sunburst series are supported at this moment.
    Default: an instance of OnPoint
    
    Since:
    
    10.2.1.0
    
    See Also:
    
    OnPoint
  - 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
  - getPointDescriptionFormatter
```
public org.zkoss.json.JavaScriptValue getPointDescriptionFormatter()
```
    Returns the formatter function to use instead of the default for series descriptions. Receives one argument, series, referring to the series to describe. Should return a string with the description of the series for a screen reader user. If false is returned, the default formatter will be used for that series.
    Default: null.
    
    Since:
    
    10.2.1.0
  - setPointDescriptionFormatter
```
public void setPointDescriptionFormatter(org.zkoss.json.JavaScriptValue pointDescriptionFormatter)
```
    Sets the formatter function to use instead of the default for series descriptions. Receives one argument, series, referring to the series to describe. Should return a string with the description of the series for a screen reader user. If false is returned, the default formatter will be used for that series.
    Default: null.
    
    Since:
    
    10.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 "day", "month" or "year" is allowed.
    
    Parameters:
    
    pointIntervalUnit - "day", "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.
  - isRelativeXValue
```
public boolean isRelativeXValue()
```
    When true, X values in the data set are relative to the current pointStart, pointInterval and pointIntervalUnit settings. This allows compression of the data for datasets with irregular X values.
    The real X values are computed on the formula f(x) = ax + b, where a is the pointInterval (optionally with a time unit given by pointIntervalUnit), and b is the pointStart.
    Defaults to false.
    
    Since:
    
    10.2.1.0
  - setRelativeXValue
```
public void setRelativeXValue(boolean relativeXValue)
```
    When true, X values in the data set are relative to the current pointStart, pointInterval and pointIntervalUnit settings. This allows compression of the data for datasets with irregular X values.
    The real X values are computed on the formula f(x) = ax + b, where a is the pointInterval (optionally with a time unit given by pointIntervalUnit), and b is the pointStart.
    Defaults to false.
    
    Since:
    
    10.2.1.0
  - 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.
    Default: false
  - 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
  - setZones
```
public void setZones(Zone... zones)
```
    Set the zones within a series.
    
    Since:
    
    10.2.1.0
    
    See Also:
    
    getZones(), Zone
  - setWidth
```
public void setWidth(String width)
```
    Sets the width of the series.
    
    Since:
    
    10.2.1.0

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

getAccessibility

setAccessibility

getClassName

setClassName

isCenterInCategory

setCenterInCategory

setCenter

setCenter

getBoostBlending

setBoostBlending

getBoostThreshold

setBoostThreshold

getAnimationLimit

setAnimationLimit

isAllowPointSelect

setAllowPointSelect

isAnimation

getAnimation

setAnimation

setAnimation

getBorderRadius

setBorderRadius

setBorderRadius

getBorderWidth

setBorderWidth

isClip

setClip

getColor

setColor

setColor

setColor

setColor

getColorAxis

setColorAxis

isColorByPoint

setColorByPoint

getColorIndex

setColorIndex

setColorAxis

setColorAxis

getColorKey

setColorKey

isConnectEnds

setConnectEnds

isConnectNulls

setConnectNulls

getConnectorWidth

setConnectorWidth

isCrisp

setCrisp

getCustom

setCustom

getCropThreshold

setCropThreshold

getCursor

setCursor

getDashStyle

setDashStyle

isDataAsColumns

setDataAsColumns

getDataLabels

setDataLabels

getDataLabelsList

setDataLabels

addDataLabels

newDataLabels

getDepth

setDepth

getDescription