Series (The ZK Charts library 7.2.1.0 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.
`void`	`addPoint(String from, String to)` Add a point with from and to to the end of the current points list.
`void`	`addPoint(String from, String to, Number weight)` Add a point with from, to and weight to the end of the current points list.
`Animation`	`getAnimation()` Returns whether to enable or disable the initial animation when a series is displayed.
`Object`	`getBaseSeries()` Returns an integer identifying the index to use for the base series, or a string representing the id of the series.
`Color`	`getBorderColor()` Returns the color of the border surrounding each slice.
`Number`	`getBorderRadius()` Returns the border radius of the series.
`Number`	`getBorderWidth()` Returns the border width of the series.
`List<String>`	`getCenter()` Returns the center of the pie chart relative to the plot area.
`Color`	`getColor()` Returns individual color for the series.
`Object`	`getColorAxis()` When using dual or multiple color axes, this defines which colorAxis the particular series is connected to.
`String`	`getColorKey()` Returns what data value should be used to calculate point color if colorAxis is used.
`List<Color>`	`getColors()` Returns a series specific or series type specific color set to apply instead of the global `Charts.getColors()` when `setColorByPoint(boolean)` is true.
`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.
`List<Point>`	`getData()` Returns the list of point data
`DataLabels`	`getDataLabels()` Returns the option of data labels.
`DragDrop`	`getDragDrop()` Returns the options of the draggable-points module allows points to be moved around or modified in the chart, if any.
`Number`	`getEndAngle()` In circular view, returns the end angle of the item layout, in degrees where 0 is up.
`Color`	`getFillColor()` Returns fill color or gradient for the area.
`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.
`Object`	`getInnerSize()` In circular view, returns the size of the inner diameter of the circle.
`Number`	`getIntervals()` Returns the length of the bell curve.
`String`	`getLayout()` Returns the layout of the items in rectangular view.
`int`	`getLegendIndex()` Returns the sequential index of the series in the legend.
`Number`	`getLineWidth()` Returns the width of the point marker's outline.
`NetworkGraphLink`	`getLink()` Returns the link style options, if any.
`Marker`	`getMarker()` Returns the marker for this series.
`Object`	`getMaxSize()` Returns maximum bubble size.
`Object`	`getMinSize()` Returns the minimum size.
`String`	`getName()` Returns the name of the series as shown in the legend, tooltip etc.
`Node`	`getNodes()` Returns the Node options, if any.
`Node`	`getNodes(int index)` Returns the Node options from the given index, if any.
`int`	`getNodesSize()` Returns the size of nodes.
`String`	`getOnSeries()` Returns the id of another series in the chart that the wind barbs are projected on.
`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.
`Number`	`getPointRange()` Default: null
`Number`	`getPointsInInterval()` Returns how many points should be plotted within 1 interval.
`Number`	`getPointStart()` If no x values are given for the points in a series, pointStart defines on what value to start.
`Number`	`getRows()` Returns the number of rows to display in the rectangular or circular view.
`Object`	`getSize()` Returns the diameter of the pie relative to the plot area.
`String`	`getSizeBy()` Returns what the plot area value should be represented by.
`Object`	`getStack()` Returns the option allows grouping series in a stacked chart.
`Number`	`getStartAngle()` In circular view, returns the start angle of the item layout, in degrees where 0 is up.
`TargetOptions`	`getTargetOptions()` Returns all options related with look and position of targets, if any.
`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`	`isAnimation()` Returns whether to enable or disable the initial animation when a series is displayed.
`boolean`	`isColorByPoint()` Returns whether color by point option is enabled or not
`boolean`	`isEnableMouseTracking()` Returns enable or disable the mouse tracking for a specific series.
`boolean`	`isShowInLegend()` Returns whether to display this particular series or series type in the legend.
`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(Animation animation)` Sets the initial animation when a series is displayed.
`void`	`setAnimation(boolean animation)` Sets whether to enable or disable the initial animation when a series is displayed.
`void`	`setBaseSeries(int baseSeries)` Sets an integer identifying the index to use for the base series.
`void`	`setBaseSeries(String baseSeries)` Sets a string representing the id of the series to use for the base series.
`void`	`setBorderColor(Color borderColor)` Sets the color of the border surrounding each slice.
`void`	`setBorderColor(LinearGradient borderColor)` Sets the color of the border surrounding each slice.
`void`	`setBorderColor(RadialGradient borderColor)` Sets the color of the border surrounding each slice.
`void`	`setBorderColor(String borderColor)` Sets the color of the border surrounding each slice.
`void`	`setBorderRadius(Number borderRadius)` Sets the border radius of the series.
`void`	`setBorderWidth(Number borderWidth)` Sets the border width of the series.
`void`	`setCenter(List<Object> center)` Sets the center of the pie chart relative to the plot area.
`void`	`setCenter(Object... center)` Sets the center of the pie chart relative to the plot area.
`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`	`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 whether to enable the color by point option or not
`void`	`setColorKey(String colorKey)` Sets what data value should be used to calculate point color if colorAxis is used.
`void`	`setColors(List<Color> colors)` Sets a series specific or series type specific color set to apply instead of the global `Charts.getColors()` when `setColorByPoint(boolean)` is true.
`void`	`setColors(String... source)` Sets a series specific or series type specific color set to apply instead of the global `Charts.getColors()` when `setColorByPoint(boolean)` is true.
`void`	`setCursor(String cursor)` Sets you can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
`void`	`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`	`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`	`setEndAngle(Number endAngle)` In circular view, sets the end angle of the item layout, in degrees where 0 is up.
`void`	`setFillColor(Color color)` Sets fill color for the area.
`void`	`setFillColor(LinearGradient color)` Sets fill gradient for the area.
`void`	`setFillColor(RadialGradient color)` Sets fill gradient for the area.
`void`	`setFillColor(String color)` Sets fill color for the area.
`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`	`setInnerSize(int innerSize)` In circular view, sets the size of the inner diameter of the circle.
`void`	`setInnerSize(String innerSize)` In circular view, sets the size of the inner diameter of the circle.
`void`	`setIntervals(Number intervals)` Sets the length of the bell curve.
`void`	`setLayout(String layout)` Sets the layout of the items in rectangular view.
`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`	`setLink(NetworkGraphLink link)` Sets the link style options.
`void`	`setMarker(Marker marker)` Sets the marker for this series.
`void`	`setMaxSize(Number maxSize)` Sets maximum bubble size.
`void`	`setMaxSize(String maxSize)` Sets maximum bubble size.
`void`	`setMinSize(Number minSize)` Sets the minimum size.
`void`	`setMinSize(String minSize)` Sets the minimum size.
`void`	`setName(String name)` Sets the name of the series as shown in the legend, tooltip etc.
`void`	`setOnSeries(String onSeries)` Sets the id of another series in the chart that the wind barbs are projected on.
`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`	`setPointRange(Number pointRange)`
`void`	`setPointsInInterval(Number pointsInInterval)` Sets how many points should be plotted within 1 interval.
`void`	`setPointStart(Number pointStart)` If no x values are given for the points in a series, pointStart defines on what value to start.
`void`	`setRows(Number rows)` Sets the number of rows to display in the rectangular or circular view.
`void`	`setShowInLegend(boolean showInLegend)` Sets whether to display this particular series or series type in the legend.
`void`	`setSize(Number size)` Sets the diameter of the pie relative to the plot area.
`void`	`setSize(String size)` Sets the diameter of the pie relative to the plot area.
`void`	`setSizeBy(String sizeBy)` Sets what the plot area value should be represented by.
`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`	`setStartAngle(Number startAngle)` In circular view, sets the start angle of the item layout, in degrees where 0 is up.
`void`	`setTargetOptions(TargetOptions targetOptions)` Sets all options related with look and position of targets.
`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.
  - isAnimation
```
public boolean isAnimation()
```
    Returns whether to enable or disable the initial animation when a series is displayed.
    Default: true.
    
    Since:
    
    7.2.1.0
  - setAnimation
```
public void setAnimation(boolean animation)
```
    Sets whether to enable or disable the initial animation when a series is displayed.
    
    See Also:
    
    setAnimation(Animation)
  - getAnimation
```
public Animation getAnimation()
```
    Returns whether to enable or disable the initial animation when a series is displayed.
    Default: an instance of Animation.
    
    Since:
    
    7.2.1.0
  - setAnimation
```
public void setAnimation(Animation animation)
```
    Sets the initial animation when a series is displayed. Please note that this option only applies to the initial animation of the series itself. For other animations, see chart.animation and the animation parameter under the API methods.
    
    Since:
    
    7.2.1.0
    
    See Also:
    
    setAnimation(boolean)
  - getBaseSeries
```
public Object getBaseSeries()
```
    Returns an integer identifying the index to use for the base series, or a string representing the id of the series.
    Default: null
    
    Since:
    
    7.2.1.0
  - setBaseSeries
```
public void setBaseSeries(int baseSeries)
```
    Sets an integer identifying the index to use for the base series.
    
    Since:
    
    7.2.1.0
  - setBaseSeries
```
public void setBaseSeries(String baseSeries)
```
    Sets a string representing the id of the series to use for the base series.
    
    Since:
    
    7.2.1.0
  - getBorderColor
```
public Color getBorderColor()
```
    Returns the color of the border surrounding each slice.
    Default: #ffffff
    
    Since:
    
    7.2.1.0
  - setBorderColor
```
public void setBorderColor(Color borderColor)
```
    Sets the color of the border surrounding each slice.
    
    Since:
    
    7.2.1.0
  - setBorderColor
```
public void setBorderColor(String borderColor)
```
    Sets the color of the border surrounding each slice.
    
    Since:
    
    7.2.1.0
  - setBorderColor
```
public void setBorderColor(LinearGradient borderColor)
```
    Sets the color of the border surrounding each slice.
    
    Since:
    
    7.2.1.0
  - setBorderColor
```
public void setBorderColor(RadialGradient borderColor)
```
    Sets the color of the border surrounding each slice.
    
    Since:
    
    7.2.1.0
  - getBorderRadius
```
public Number getBorderRadius()
```
    Returns the border radius of the series.
    
    Since:
    
    7.2.1.0
  - setBorderRadius
```
public void setBorderRadius(Number borderRadius)
```
    Sets the border radius of the series.
    
    Since:
    
    7.2.1.0
  - getBorderWidth
```
public Number getBorderWidth()
```
    Returns the border width of the series.
  - setBorderWidth
```
public void setBorderWidth(Number borderWidth)
```
    Sets the border width of the series.
  - getCenter
```
public List<String> getCenter()
```
    Returns 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%"].
    Default: [null, null]
    
    Since:
    
    7.2.1.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:
    
    7.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:
    
    7.2.1.0
  - 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.
  - addPoint
```
public void addPoint(String from,
                     String to)
```
    Add a point with from and to to the end of the current points list.
    
    Since:
    
    7.2.1.0
  - addPoint
```
public void addPoint(String from,
                     String to,
                     Number weight)
```
    Add a point with from, to and weight to the end of the current points list.
    
    Since:
    
    7.2.1.0
  - 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.
  - getIntervals
```
public Number getIntervals()
```
    Returns the length of the bell curve. A unit of the length of the bell curve is standard deviation. Requires bellcurve.
    Default: 3
    
    Since:
    
    7.2.1.0
  - setIntervals
```
public void setIntervals(Number intervals)
```
    Sets the length of the bell curve. A unit of the length of the bell curve is standard deviation. Requires bellcurve.
    
    Since:
    
    7.2.1.0
  - getInnerSize
```
public Object getInnerSize()
```
    In circular view, returns the size of the inner diameter of the circle. Can be a percentage or pixel value. Percentages are relative to the outer perimeter. Pixel values are given as integers. If the getRows() option is set, it overrides the innerSize setting.
    Default: "40%"
    
    Since:
    
    7.2.1.0
  - setInnerSize
```
public void setInnerSize(String innerSize)
```
    In circular view, sets the size of the inner diameter of the circle. Can be a percentage. Percentages are relative to the outer perimeter. If the getRows() option is set, it overrides the innerSize setting.
    
    Since:
    
    7.2.1.0
  - setInnerSize
```
public void setInnerSize(int innerSize)
```
    In circular view, sets the size of the inner diameter of the circle. Can be a pixel value. Pixel values are given as integers. If the getRows() option is set, it overrides the innerSize setting.
  - 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.
  - 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
  - setColorAxis
```
public void setColorAxis(String colorAxis)
```
    When using dual or multiple color axes, this defines which colorAxis the particular series is connected to. It refers to the {@link ColorAxis#getId().
    
    Since:
    
    7.2.1.0
  - setColorAxis
```
public void setColorAxis(boolean colorAxis)
```
    When using dual or multiple color axes, this defines which colorAxis the particular series is connected to. Set this option to false to prevent a series from connecting to the default color axis.
    
    Since:
    
    7.2.1.0
  - getColorKey
```
public String getColorKey()
```
    Returns what data value should be used to calculate point color if colorAxis is used. Requires to set min and max if some custom point property is used or if approximation for data grouping is set to 'sum'.
    Default: "y"
    
    Since:
    
    7.2.1.0
  - setColorKey
```
public void setColorKey(String colorKey)
```
    Sets what data value should be used to calculate point color if colorAxis is used. Requires to set min and max if some custom point property is used or if approximation for data grouping is set to 'sum'.
    
    Since:
    
    7.2.1.0
  - 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
  - getColors
```
public List<Color> getColors()
```
    Returns a series specific or series type specific color set to apply instead of the global Charts.getColors() when setColorByPoint(boolean) is true.
    
    Since:
    
    7.2.1.0
  - setColors
```
public void setColors(List<Color> colors)
```
    Sets a series specific or series type specific color set to apply instead of the global Charts.getColors() when setColorByPoint(boolean) is true.
    
    Since:
    
    7.2.1.0
  - setColors
```
public void setColors(String... source)
```
    Sets a series specific or series type specific color set to apply instead of the global Charts.getColors() when setColorByPoint(boolean) is true.
    
    Since:
    
    7.2.1.0
  - 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.
    Default: null
    
    Since:
    
    7.2.1.0
  - 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.
    
    Since:
    
    7.2.1.0
  - getDragDrop
```
public DragDrop getDragDrop()
```
    Returns the options of the draggable-points module allows points to be moved around or modified in the chart, if any. Otherwise, create a new one. In addition to the options mentioned under the dragDrop API structure, the module fires three events, point.dragStart, point.drag and point.drop.
    
    Since:
    
    7.2.1.0
  - setDragDrop
```
public void setDragDrop(DragDrop dragDrop)
```
    Sets the options of the draggable-points module allows points to be moved around or modified in the chart. In addition to the options mentioned under the dragDrop API structure, the module fires three events, point.dragStart, point.drag and point.drop.
    
    Since:
    
    7.2.1.0
  - isEnableMouseTracking
```
public boolean isEnableMouseTracking()
```
    Returns enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.
    
    Since:
    
    7.2.1.0
  - 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.
    
    Since:
    
    7.2.1.0
  - getEndAngle
```
public Number getEndAngle()
```
    In circular view, returns the end angle of the item layout, in degrees where 0 is up. Default: null
    
    Since:
    
    7.2.1.0
  - setEndAngle
```
public void setEndAngle(Number endAngle)
```
    In circular view, sets the end angle of the item layout, in degrees where 0 is up.
    
    Since:
    
    7.2.1.0
  - getFillColor
```
public Color getFillColor()
```
    Returns fill color or gradient for the area. When null, the series' color is used with the series' fillOpacity.
    Default: null
    
    Since:
    
    7.2.1.0
  - setFillColor
```
public void setFillColor(Color color)
```
    Sets fill color for the area. When null, the series' color is used with the series' fillOpacity.
    
    Since:
    
    7.2.1.0
  - setFillColor
```
public void setFillColor(String color)
```
    Sets fill color for the area. When null, the series' color is used with the series' fillOpacity.
    
    Since:
    
    7.2.1.0
  - setFillColor
```
public void setFillColor(LinearGradient color)
```
    Sets fill gradient for the area. When null, the series' color is used with the series' fillOpacity.
    
    Since:
    
    7.2.1.0
  - setFillColor
```
public void setFillColor(RadialGradient color)
```
    Sets fill gradient for the area. When null, the series' color is used with the series' fillOpacity.
    
    Since:
    
    7.2.1.0
  - getGapSize
```
public int getGapSize()
```
  - setGapSize
```
public void setGapSize(int gapSize)
```
  - getLayout
```
public String getLayout()
```
    Returns the layout of the items in rectangular view. Can be either horizontal or vertical
    Default: "vertical"
    
    Since:
    
    7.2.1.0
  - setLayout
```
public void setLayout(String layout)
```
    Sets the layout of the items in rectangular view. Can be either horizontal or vertical
    
    Since:
    
    7.2.1.0
  - 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.
  - getLink
```
public NetworkGraphLink getLink()
```
    Returns the link style options, if any. Otherwise, create a new one.
    
    Since:
    
    7.2.1.0
  - setLink
```
public void setLink(NetworkGraphLink link)
```
    Sets the link style options.
    
    Since:
    
    7.2.1.0
  - getMarker
```
public Marker getMarker()
```
    Returns the marker for this series.
  - setMarker
```
public void setMarker(Marker marker)
```
    Sets the marker for this series.
  - getMaxSize
```
public Object getMaxSize()
```
    Returns maximum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z value of each bubble. Can be either pixels (when no unit is given), or a percentage of the smallest one of the plot width and height.
    Default: "20%"
    
    Since:
    
    7.2.1.0
  - setMaxSize
```
public void setMaxSize(Number maxSize)
```
    Sets maximum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z value of each bubble. Can be pixels (when no unit is given).
    
    Since:
    
    7.2.1.0
  - setMaxSize
```
public void setMaxSize(String maxSize)
```
    Sets maximum bubble size. Bubbles will automatically size between the minSize and maxSize to reflect the z value of each bubble. Can be a percentage of the smallest one of the plot width and height.
    
    Since:
    
    7.2.1.0
  - getMinSize
```
public Object getMinSize()
```
    Returns the minimum size.
    
    Since:
    
    7.2.1.0
  - setMinSize
```
public void setMinSize(Number minSize)
```
    Sets the minimum size.
    
    Since:
    
    7.2.1.0
  - setMinSize
```
public void setMinSize(String minSize)
```
    Sets the minimum size.
    
    Since:
    
    7.2.1.0
  - setName
```
public void setName(String name)
```
    Sets the name of the series as shown in the legend, tooltip etc.
  - getOnSeries
```
public String getOnSeries()
```
    Returns the id of another series in the chart that the wind barbs are projected on. When null, the wind symbols are drawn on the X axis, but offset up or down by the yOffset setting.
    Default: null
    
    Since:
    
    7.2.1.0
  - setOnSeries
```
public void setOnSeries(String onSeries)
```
    Sets the id of another series in the chart that the wind barbs are projected on. When null, the wind symbols are drawn on the X axis, but offset up or down by the yOffset setting.
    
    Since:
    
    7.2.1.0
  - 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.
  - getPointsInInterval
```
public Number getPointsInInterval()
```
    Returns how many points should be plotted within 1 interval. See plotOptions.bellcurve.intervals. Requires bellcurve.
    Default: 3
    
    Since:
    
    7.2.1.0
  - setPointsInInterval
```
public void setPointsInInterval(Number pointsInInterval)
```
    Sets how many points should be plotted within 1 interval. See plotOptions.bellcurve.intervals. Requires bellcurve.
    
    Since:
    
    7.2.1.0
  - getPointStart
```
public Number getPointStart()
```
    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. Requires bellcurve.
    Default: 0
    
    Since:
    
    7.2.1.0
  - setPointStart
```
public void setPointStart(Number pointStart)
```
    If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945. Requires bellcurve.
    
    Since:
    
    7.2.1.0
  - getPointRange
```
public Number getPointRange()
```
    Default: null
    
    Since:
    
    7.2.1.0
  - setPointRange
```
public void setPointRange(Number pointRange)
```
    Since:
    
    7.2.1.0
  - getName
```
public String getName()
```
    Returns the name of the series as shown in the legend, tooltip etc.
  - getNodesSize
```
public int getNodesSize()
```
    Returns the size of nodes.
    
    Since:
    
    7.2.1.0
  - getNodes
```
public Node getNodes()
```
    Returns the Node options, if any. Otherwise, create a new one.
    Returns the first node (index 0) by default.
    
    Since:
    
    7.2.1.0
    
    See Also:
    
    Node, getNodes(int)
  - getNodes
```
public Node getNodes(int index)
```
    Returns the Node options from the given index, if any. Otherwise, create a new one.
    
    Since:
    
    7.2.1.0
    
    See Also:
    
    Node
  - getRows
```
public Number getRows()
```
    Returns the number of rows to display in the rectangular or circular view. If the getInnerSize() is set, it will be overridden by the rows setting.
    Default: null
    
    Since:
    
    7.2.1.0
  - setRows
```
public void setRows(Number rows)
```
    Sets the number of rows to display in the rectangular or circular view. If the getInnerSize() is set, it will be overridden by the rows setting.
    
    Since:
    
    7.2.1.0
  - isShowInLegend
```
public boolean isShowInLegend()
```
    Returns whether to display this particular series or series type in the legend. Standalone series are shown in legend by default, and linked series are not. It is possible to show series that use colorAxis by setting this option to true.
    Default: true
    
    Since:
    
    7.2.1.0
  - setShowInLegend
```
public void setShowInLegend(boolean showInLegend)
```
    Sets whether to display this particular series or series type in the legend. Standalone series are shown in legend by default, and linked series are not. It is possible to show series that use colorAxis by setting this option to true.
    
    Since:
    
    7.2.1.0
  - getSize
```
public Object getSize()
```
    Returns the diameter of the pie relative to the plot area. Can be a percentage or pixel value. Pixel values are given as integers. The default behaviour is to scale to the plot area and give room for data labels within the plot area. slicedOffset is also included in the default size calculation. As a consequence, the size of the pie may vary when points are updated and data labels more around. In that case it is best to set a fixed value, for example "75%".
    Default: null
    
    Since:
    
    7.2.1.0
  - setSize
```
public void setSize(Number size)
```
    Sets the diameter of the pie relative to the plot area. Can be a percentage or pixel value. Pixel values are given as integers. The default behaviour is to scale to the plot area and give room for data labels within the plot area. slicedOffset is also included in the default size calculation. As a consequence, the size of the pie may vary when points are updated and data labels more around. In that case it is best to set a fixed value, for example "75%".
    
    Since:
    
    7.2.1.0
  - setSize
```
public void setSize(String size)
```
    Sets the diameter of the pie relative to the plot area. Can be a percentage or pixel value. Pixel values are given as integers. The default behaviour is to scale to the plot area and give room for data labels within the plot area. slicedOffset is also included in the default size calculation. As a consequence, the size of the pie may vary when points are updated and data labels more around. In that case it is best to set a fixed value, for example "75%".
    
    Since:
    
    7.2.1.0
  - getSizeBy
```
public String getSizeBy()
```
    Returns what the plot area value should be represented by. The default, area, corresponds best to the human perception of the size of each area.
    Default: "area"
    
    Since:
    
    7.2.1.0
  - setSizeBy
```
public void setSizeBy(String sizeBy)
```
    Sets what the plot area value should be represented by.
    
    Since:
    
    7.2.1.0
  - 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.
  - getStartAngle
```
public Number getStartAngle()
```
    In circular view, returns the start angle of the item layout, in degrees where 0 is up. Default: null
    
    Since:
    
    7.2.1.0
  - setStartAngle
```
public void setStartAngle(Number startAngle)
```
    In circular view, sets the start angle of the item layout, in degrees where 0 is up.
    
    Since:
    
    7.2.1.0
  - getTargetOptions
```
public TargetOptions getTargetOptions()
```
    Returns all options related with look and position of targets, if any. Otherwise, create a new one.
    
    Since:
    
    7.2.1.0
  - setTargetOptions
```
public void setTargetOptions(TargetOptions targetOptions)
```
    Sets all options related with look and position of targets.
    
    Since:
    
    7.2.1.0
  - 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

isAnimation

setAnimation

getAnimation

setAnimation

getBaseSeries

setBaseSeries

setBaseSeries

getBorderColor

setBorderColor

setBorderColor

setBorderColor

setBorderColor

getBorderRadius

setBorderRadius

getBorderWidth

setBorderWidth

getCenter

setCenter

setCenter

setPlotOptions

getPlotOptions

addPoint

addPoint

addPoint

addPoint

addPoint

addPoint

addPoint

addPoint

addPoint

addPoint

addPoint

addPoint

addPoint

addPoint

setData

setData

setData

setData

setData

getData

getPoint

setIndex

getIndex

getIntervals

setIntervals

getInnerSize

setInnerSize

setInnerSize

setDataLabels

getDataLabels

getColor

setColor

setColor

setColor

setColor

getColorAxis

setColorAxis

setColorAxis

setColorAxis

getColorKey

setColorKey

isColorByPoint

setColorByPoint

getColors

setColors