Series (The ZK Charts library 3.0.3 API)

java.lang.Object
- org.zkoss.chart.Optionable
- - org.zkoss.chart.Series

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware
```
public class Series
extends Optionable
implements OptionDataListener
```
The Series object is the JavaScript representation of each line, area series, pie etc. The object can be accessed in a number of ways. All series and point event handlers give a reference to the series object. The chart object has a series property that is a collection of all the chart's series. The point objects also have the same reference. Another way to reference the series programmatically is by id.
All the options in this class support DynamicalAttribute.

Author:

jumperchen

See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor and Description
`Series()`
`Series(String id, List<Point> data)` Constructs the series with id and a list of point data.
`Series(String id, Point... data)` Constructs the series with id and point data.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPoint(double y)` Add a number point to the end of the current points list.
`void`	`addPoint(double x, double y)` Add a point with x and y numbers to the end of the current points list.
`void`	`addPoint(double x, double low, double high)` Add a point with x, low, and high numbers to the end of the current points list.
`void`	`addPoint(Number y)` Add a number point to the end of the current points list.
`void`	`addPoint(Number x, Number y)` Add a point with x and y numbers to the end of the current points list.
`void`	`addPoint(Number x, Number low, Number high)` Add a point with x, low, and high numbers to the end of the current points list.
`void`	`addPoint(Point point)` Add a point at the end of the current points list.
`void`	`addPoint(Point point, boolean redraw, boolean shift, Animation animation)` Add a point at the end of the current points list.
`void`	`addPoint(Point point, boolean redraw, boolean shift, boolean animation)` Add a point to the end of the current points list.
`void`	`addPoint(String name, double y)` Add a point with name and number to the end of the current points list.
`void`	`addPoint(String name, Number y)` Add a point with name and number to the end of the current points list.
`void`	`addPoint(String name, Number y, Number x)` Add a point with name, Y number, and X index to the end of the current points list.
`boolean`	`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 individual color for the series.
`List<Point>`	`getData()` Returns the list of point data
`DataLabels`	`getDataLabels()` Returns the option of data labels.
`int`	`getGapSize()`
`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.
`int`	`getLegendIndex()` Returns the sequential index of the series in the legend.
`Number`	`getLineWidth()` Returns the width of the point marker's outline.
`Marker`	`getMarker()` Returns the marker for this series.
`String`	`getName()` Returns the name of the series as shown in the legend, tooltip etc.
`Number`	`getOvershoot()` Returns the amount of degrees that are allowed to overshoot Default: null
`SeriesPlotOptions`	`getPlotOptions()` Returns the plot options to the series.
`Point`	`getPoint(int index)` Returns the point in the list from the given index.
`Number`	`getPointInterval()` Returns the point interval of the series.
`String`	`getPointIntervalUnit()` On datetime series, this allows for setting the pointInterval to the two irregular time units, month and year.
`Number`	`getPointPadding()` Returns the padding between each column or bar, in x axis units.
`Object`	`getPointPlacement()` Returns the point placement.
`Object`	`getStack()` Returns the option allows grouping series in a stacked chart.
`Tooltip`	`getTooltip()` Returns the tooltip options.
`String`	`getType()` The type of series.
`Object`	`getXAxis()` When using dual or multiple x axes, this number defines which xAxis the particular series is connected to.
`Object`	`getYAxis()` When using dual or multiple y axes, this number defines which yAxis the particular series is connected to.
`int`	`getZIndex()` Define the visual z index of the series.
`String`	`getZoneAxis()` Defines the Axis on which the zones are applied.
`List<Zone>`	`getZones()` An list defining zones within a series.
`void`	`hide()` Hides the series if visible.
`boolean`	`isColorByPoint()` Returns whether color by point option is enabled or not
`boolean`	`isVisible()` Returns whether the series is visible or not.
`void`	`onChange(OptionDataEvent event)` Sent when the contents of the chart option has changed.
`void`	`remove()`
`void`	`select()`
`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`	`setColor(Color color)` Sets individual color for the series.
`void`	`setColor(LinearGradient color)` Sets individual color for the series.
`void`	`setColor(RadialGradient color)` Sets individual color for the series.
`void`	`setColor(String color)` Sets individual color for the series.
`void`	`setColorByPoint(boolean colorByPoint)` Sets whether to enable the color by point option or not
`void`	`setData(Double... data)` Sets an array of number data
`void`	`setData(Integer... data)` Sets an array of number data
`void`	`setData(List<? extends Number> data)` Sets a list of point data
`void`	`setData(Number... data)` Sets an array of number data
`void`	`setData(Point... data)` Sets an array of point data
`void`	`setDataLabels(DataLabels dataLabels)` Sets the option of data labels.
`void`	`setGapSize(int gapSize)`
`void`	`setId(String id)` Sets an id for the series.
`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`	`setLegendIndex(int legendIndex)` Sets the sequential index of the series in the legend.
`void`	`setLineWidth(Number lineWidth)` Sets the width of the point marker's outline.
`void`	`setMarker(Marker marker)` Sets the marker for this series.
`void`	`setName(String name)` Sets the name of the series as shown in the legend, tooltip etc.
`void`	`setOvershoot(Number overshoot)` Sets the amount of degrees that are allowed to overshoot
`void`	`setPlotOptions(SeriesPlotOptions plotOptions)` Sets the plot options to the series.
`void`	`setPointInterval(Number pointInterval)` Sets the point interval of the series.
`void`	`setPointIntervalUnit(String pointIntervalUnit)` Set the irregular time unit for point interval, only "month" or "year" is allowed.
`void`	`setPointPadding(Number pointPadding)` Sets the padding between each column or bar, in x axis units.
`void`	`setPointPlacement(Number pointPlacement)` Sets the point placement with a number
`void`	`setPointPlacement(String pointPlacement)` Sets the point placement.
`void`	`setStack(Number stack)` Sets the option allows grouping series in a stacked chart.
`void`	`setStack(String stack)` Sets the option allows grouping series in a stacked chart.
`void`	`setTooltip(Tooltip tooltip)` Sets the tooltip options.
`void`	`setType(String type)` The type of series.
`void`	`setVisible(boolean visible)` Sets whether the series is visible.
`boolean`	`setVisibleDirectly(boolean visible)` Sets whether the series is visible directly.
`void`	`setXAxis(int xAxis)` When using dual or multiple x axes, this number defines which xAxis the particular series is connected to.
`void`	`setXAxis(String xAxis)` When using dual or multiple x axes, this number defines which xAxis the particular series is connected to.
`void`	`setYAxis(int yAxis)` When using dual or multiple y axes, this number defines which yAxis the particular series is connected to.
`void`	`setYAxis(String yAxis)` When using dual or multiple y axes, this number defines which yAxis the particular series is connected to.
`void`	`setZIndex(int zIndex)` Define the visual z index 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`	`show()` Shows the series if hidden.
`String`	`toJSONString()` Encodes this object to a JSON string.

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

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

- Constructor Detail
  - Series
```
public Series()
```
  - Series
```
public Series(String id,
              List<Point> data)
```
    Constructs the series with id and a list of point data.
  - Series
```
public Series(String id,
              Point... data)
```
    Constructs the series with id and point data.
- Method Detail
  - getId
```
public String getId()
```
    Returns an id for the series.
    Default: null.
  - setId
```
public void setId(String id)
```
    Sets an id for the series.
  - getAnimation
```
public boolean getAnimation()
```
    Returns whether to enable or disable the initial animation when a series is displayed.
    Default: true.
  - setAnimation
```
public void setAnimation(boolean animation)
```
    Sets whether to enable or disable the initial animation when a series is displayed.
  - getBorderWidth
```
public Number getBorderWidth()
```
    Returns the border width of the series.
  - setBorderWidth
```
public void setBorderWidth(Number borderWidth)
```
    Sets the border width of the series.
  - setPlotOptions
```
public void setPlotOptions(SeriesPlotOptions plotOptions)
```
    Sets the plot options to the series.
  - getPlotOptions
```
public SeriesPlotOptions getPlotOptions()
```
    Returns the plot options to the series. If null, it will create a new one.
  - addPoint
```
public void addPoint(Point point)
```
    Add a point at the end of the current points list.
    
    Parameters:
    
    point -
  - addPoint
```
public void addPoint(Point point,
                     boolean redraw,
                     boolean shift,
                     boolean animation)
```
    Add a point to the end of the current points list.
    
    Parameters:
    
    point - the point
    
    redraw - whether to redraw the chart
    
    shift - If shift is true, a point is shifted off the start of the series as one is appended to the end.
    
    animation - Whether to apply animation, and optionally animation configuration
  - addPoint
```
public void addPoint(Point point,
                     boolean redraw,
                     boolean shift,
                     Animation animation)
```
    Add a point at the end of the current points list.
    
    Parameters:
    
    point - the point
    
    redraw - whether to redraw the chart
    
    shift - If shift is true, a point is shifted off the start of the series as one is appended to the end.
    
    animation - Whether to apply animation, and optionally animation configuration
  - addPoint
```
public void addPoint(Number y)
```
    Add a number point to the end of the current points list.
  - addPoint
```
public void addPoint(double y)
```
    Add a number point to the end of the current points list.
  - addPoint
```
public void addPoint(Number x,
                     Number y)
```
    Add a point with x and y numbers to the end of the current points list.
  - addPoint
```
public void addPoint(double x,
                     double y)
```
    Add a point with x and y numbers to the end of the current points list.
  - addPoint
```
public void addPoint(Number x,
                     Number low,
                     Number high)
```
    Add a point with x, low, and high numbers to the end of the current points list.
  - addPoint
```
public void addPoint(double x,
                     double low,
                     double high)
```
    Add a point with x, low, and high numbers to the end of the current points list.
  - addPoint
```
public void addPoint(String name,
                     Number y)
```
    Add a point with name and number to the end of the current points list.
  - addPoint
```
public void addPoint(String name,
                     Number y,
                     Number x)
```
    Add a point with name, Y number, and X index to the end of the current points list.
    
    Since:
    
    1.1
  - addPoint
```
public void addPoint(String name,
                     double y)
```
    Add a point with name and number to the end of the current points list.
  - setData
```
public void setData(List<? extends Number> data)
```
    Sets a list of point data
  - setData
```
public void setData(Point... data)
```
    Sets an array of point data
  - setData
```
public void setData(Number... data)
```
    Sets an array of number data
  - setData
```
public void setData(Double... data)
```
    Sets an array of number data
  - setData
```
public void setData(Integer... data)
```
    Sets an array of number data
  - getData
```
public List<Point> getData()
```
    Returns the list of point data
  - getPoint
```
public Point getPoint(int index)
```
    Returns the point in the list from the given index.
  - 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.
  - 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.
  - setDataLabels
```
public void setDataLabels(DataLabels dataLabels)
```
    Sets the option of data labels.
    
    Parameters:
    
    dataLabels -
    
    See Also:
    
    SeriesPlotOptions.setDataLabels(DataLabels)
  - getDataLabels
```
public DataLabels getDataLabels()
```
    Returns the option of data labels.
    
    See Also:
    
    SeriesPlotOptions.getDataLabels()
  - getColor
```
public Color getColor()
```
    Returns individual color for the series. By default the color is pulled from the global colors array.
    Default: null.
  - setColor
```
public void setColor(Color color)
```
    Sets individual color for the series. By default the color is pulled from the global colors array.
  - setColor
```
public void setColor(String color)
```
    Sets individual color for the series. By default the color is pulled from the global colors array.
  - setColor
```
public void setColor(LinearGradient color)
```
    Sets individual color for the series. By default the color is pulled from the global colors array.
  - setColor
```
public void setColor(RadialGradient color)
```
    Sets individual color for the series. By default the color is pulled from the global colors array.
  - isColorByPoint
```
public boolean isColorByPoint()
```
    Returns whether color by point option is enabled or not
  - setColorByPoint
```
public void setColorByPoint(boolean colorByPoint)
```
    Sets whether to enable the color by point option or not
  - getGapSize
```
public int getGapSize()
```
  - setGapSize
```
public void setGapSize(int gapSize)
```
  - setLegendIndex
```
public void setLegendIndex(int legendIndex)
```
    Sets the sequential index of the series in the legend.
  - getLegendIndex
```
public int getLegendIndex()
```
    Returns the sequential index of the series in the legend.
  - getLineWidth
```
public Number getLineWidth()
```
    Returns the width of the point marker's outline.
  - setLineWidth
```
public void setLineWidth(Number lineWidth)
```
    Sets the width of the point marker's outline.
  - getMarker
```
public Marker getMarker()
```
    Returns the marker for this series.
  - setMarker
```
public void setMarker(Marker marker)
```
    Sets the marker for this series.
  - setName
```
public void setName(String name)
```
    Sets the name of the series as shown in the legend, tooltip etc.
  - getOvershoot
```
public Number getOvershoot()
```
    Returns the amount of degrees that are allowed to overshoot Default: null
  - setOvershoot
```
public void setOvershoot(Number overshoot)
```
    Sets the amount of degrees that are allowed to overshoot
  - getPointInterval
```
public Number getPointInterval()
```
    Returns the point interval of the series. Default: null
  - setPointInterval
```
public void setPointInterval(Number pointInterval)
```
    Sets the point interval of the series.
  - 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
  - getPointPadding
```
public Number getPointPadding()
```
    Returns the padding between each column or bar, in x axis units. Default: 0.1
  - setPointPadding
```
public void setPointPadding(Number pointPadding)
```
    Sets the padding between each column or bar, in x axis units.
  - 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.
  - getName
```
public String getName()
```
    Returns the name of the series as shown in the legend, tooltip etc.
  - setStack
```
public void setStack(String stack)
```
    Sets the option allows grouping series in a stacked chart. The stack option can be a string or a number or anything else, as long as the grouped series' stack options match each other.
  - setStack
```
public void setStack(Number stack)
```
    Sets the option allows grouping series in a stacked chart. The stack option can be a string or a number or anything else, as long as the grouped series' stack options match each other.
  - getStack
```
public Object getStack()
```
    Returns the option allows grouping series in a stacked chart. The stack option can be a string or a number or anything else, as long as the grouped series' stack options match each other.
  - getTooltip
```
public Tooltip getTooltip()
```
    Returns the tooltip options.
  - setTooltip
```
public void setTooltip(Tooltip tooltip)
```
    Sets the tooltip options.
  - setType
```
public void setType(String type)
```
    The type of series. Can be one of area, areaspline, bar, column, line, pie, scatter, spline, arearange, areasplinerange and columnrange.
  - getType
```
public String getType()
```
    The type of series. Can be one of area, areaspline, bar, column, line, pie, scatter, spline, arearange, areasplinerange and columnrange.
  - setXAxis
```
public void setXAxis(int xAxis)
```
    When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first. Defaults to 0.
  - setXAxis
```
public void setXAxis(String xAxis)
```
    When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first. Defaults to 0.
  - getXAxis
```
public Object getXAxis()
```
    When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first. Defaults to 0.
  - setYAxis
```
public void setYAxis(int yAxis)
```
    When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first. Defaults to 0.
  - setYAxis
```
public void setYAxis(String yAxis)
```
    When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first. Defaults to 0.
  - getYAxis
```
public Object getYAxis()
```
    When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first. Defaults to 0.
  - setZIndex
```
public void setZIndex(int zIndex)
```
    Define the visual z index of the series.
  - getZIndex
```
public int getZIndex()
```
    Define the visual z index 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:
    
    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:
    
    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:
    
    2.1.0
    
    See Also:
    
    Zone
  - setZones
```
public void setZones(List<Zone> zones)
```
    Set the zones within a series.
    
    Since:
    
    2.1.0
    
    See Also:
    
    getZones(), Zone
  - hide
```
public void hide()
```
    Hides the series if visible. If the Chart.isIgnoreHiddenSeries() option is true,the chart is redrawn without this series.
  - isVisible
```
public boolean isVisible()
```
    Returns whether the series is visible or not.
    Default: true
  - setVisible
```
public void setVisible(boolean visible)
```
    Sets whether the series is visible.
  - setVisibleDirectly
```
public boolean setVisibleDirectly(boolean visible)
```
    Sets whether the series is visible directly.
  - show
```
public void show()
```
    Shows the series if hidden.
  - remove
```
public void remove()
```
  - select
```
public void select()
```
  - onChange
```
public void onChange(OptionDataEvent event)
```
    Description copied from interface: OptionDataListener
    
    Sent when the contents of the chart option has changed.
    
    Specified by:
    
    onChange in interface OptionDataListener
    
    Overrides:
    
    onChange in class Optionable
  - toJSONString
```
public String toJSONString()
```
    Description copied from class: Optionable
    
    Encodes this object to a JSON string. It is the same as Optionable.toString().
    
    Specified by:
    
    toJSONString in interface org.zkoss.json.JSONAware
    
    Overrides:
    
    toJSONString in class Optionable

Class Series

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

Constructor Detail

Series

Series

Series

Method Detail

getId

setId

getAnimation

setAnimation

getBorderWidth

setBorderWidth

setPlotOptions

getPlotOptions

addPoint

addPoint

addPoint

addPoint

addPoint

addPoint

addPoint

addPoint

addPoint

addPoint

addPoint

addPoint

setData

setData

setData

setData

setData

getData

getPoint

setIndex

getIndex

setDataLabels

getDataLabels

getColor

setColor

setColor

setColor

setColor

isColorByPoint

setColorByPoint

getGapSize

setGapSize

setLegendIndex

getLegendIndex

getLineWidth

setLineWidth

getMarker

setMarker

setName

getOvershoot

setOvershoot

getPointInterval

setPointInterval

getPointIntervalUnit

setPointIntervalUnit

getPointPadding

setPointPadding

getPointPlacement

setPointPlacement

setPointPlacement

getName

setStack

setStack

getStack

getTooltip

setTooltip

setType

getType

setXAxis

setXAxis