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

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware
```
public class PlotOptions
extends Optionable
```
An option for all plots
All the options in this class support DynamicalAttribute.

Author:

RaymondChao

See Also:

Serialized Form

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

Constructor Summary

Constructors
Constructor Description

PlotOptions()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`ArcDiagramPlotOptions`	`getArcDiagram()`	Returns the arc diagram plot option
`AreaPlotOptions`	`getArea()`	Returns the area plot option
`AreaRangePlotOptions`	`getAreaRange()`	Returns the area range plot option
`AreaSplinePlotOptions`	`getAreaSpline()`	Returns the areaspline plot option
`AreaSplineRangePlotOptions`	`getAreaSplineRange()`	Returns the areaspline range plot option
`BarPlotOptions`	`getBar()`	Returns the bar plot option
`BellCurvePlotOptions`	`getBellCurve()`	Returns the bell curve plot option
`BoxPlotOptions`	`getBoxPlot()`	Returns the box plot option
`BubblePlotOptions`	`getBubble()`	Returns the bubble plot option
`BulletPlotOptions`	`getBullet()`	Returns the bullet plot option
`ColumnPlotOptions`	`getColumn()`	Returns the column plot option
`ColumnPyramidPlotOptions`	`getColumnPyramid()`	Returns the column pyramid plot option
`ColumnRangePlotOptions`	`getColumnRange()`	Returns the column range plot option
`CylinderPlotOptions`	`getCylinder()`	Returns the cylinder plot option
`DependencyWheelPlotOptions`	`getDependencyWheel()`	Returns the dependency wheel plot option
`DumbbellPlotOptions`	`getDumbbell()`	Returns the dumbbell plot option
`ErrorBarPlotOptions`	`getErrorBar()`	Returns the error bar plot option
`FunnelPlotOptions`	`getFunnel()`	Returns the funnel plot option
`Funnel3DPlotOptions`	`getFunnel3D()`	Returns the funnel 3d plot option
`GaugePlotOptions`	`getGauge()`	Returns the gauge plot option
`HeatmapPlotOptions`	`getHeat()`	Returns the heatmap plot option
`HistogramPlotOptions`	`getHistogram()`	Returns the histogram plot option
`ItemPlotOptions`	`getItem()`	Returns the item plot option
`LinePlotOptions`	`getLine()`	Returns the line plot option
`LollipopPlotOptions`	`getLollipop()`	Returns the lollipop plot option
`NetworkGraphPlotOptions`	`getNetworkGraph()`	Returns the networkgraph plot option.
`Boolean`	`getNullInteraction()`	Get whether or not data-points with the value of null should be interactive.
`OrganizationPlotOptions`	`getOrganization()`	Returns the organization plot option
`PackedBubblePlotOptions`	`getPackedBubble()`	Returns the packed bubble plot option
`ParetoPlotOptions`	`getPareto()`	Returns the pareto plot option
`PictorialPlotOptions`	`getPictorial()`	Returns the pictorial plot option
`PiePlotOptions`	`getPie()`	Returns the pie plot option
`PolygonPlotOptions`	`getPolygon()`	Returns the polygon plot option
`PyramidPlotOptions`	`getPyramid()`	Returns the pyramid plot option
`Pyramid3DPlotOptions`	`getPyramid3D()`	Returns the pyramid 3D plot option
`SankeyPlotOptions`	`getSankey()`	Returns the sankey plot option
`ScatterPlotOptions`	`getScatter()`	Returns the scatter plot option
`Scatter3DPlotOptions`	`getScatter3D()`	Returns the scatter 3D plot option
`SeriesPlotOptions`	`getSeries()`	Returns the series plot option
`SolidGaugePlotOptions`	`getSolidGauge()`	Returns the solid gauge plot option
`SeriesSonification`	`getSonification()`	Returns sonification/audio chart options for a series.
`SplinePlotOptions`	`getSpline()`	Returns the spline plot option
`StreamGraphPlotOptions`	`getStreamGraph()`	Returns the streamgraph plot option
`SunburstPlotOptions`	`getSunburst()`	Returns the sunburst plot option
`TilemapPlotOptions`	`getTilemap()`	Returns the tilemap plot option
`TimelinePlotOptions`	`getTimeline()`	Returns the timeline plot option
`TreemapPlotOptions`	`getTree()`	Deprecated. as release of 10.3.3.0, please use `getTreemap()` instead.
`TreegraphPlotOptions`	`getTreegraph()`	Returns the treemap plot option
`TreemapPlotOptions`	`getTreemap()`	Returns the treemap plot option
`VariablePiePlotOptions`	`getVariablePie()`	Returns the variable pie plot option
`VariwidePlotOptions`	`getVariwide()`	Returns the variwide plot option
`VectorPlotOptions`	`getVector()`	Returns the vector plot option
`VennPlotOptions`	`getVenn()`	Returns the venn plot option
`WaterfallPlotOptions`	`getWaterfall()`	Returns the water fall plot option
`WindBarbPlotOptions`	`getWindBarb()`	Returns the wind barb plot option
`WordCloudPlotOptions`	`getWordCloud()`	Returns the word cloud plot option
`XRangePlotOptions`	`getXRange()`	Returns the xrange plot option
`void`	`setNullInteraction(Boolean nullInteraction)`	Sets whether or not data-points with the value of null should be interactive.
`void`	`setSonification(SeriesSonification sonification)`	Sets sonification/audio chart options for 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

- Constructor Detail
  - PlotOptions
```
public PlotOptions()
```
- Method Detail
  - getArcDiagram
```
public ArcDiagramPlotOptions getArcDiagram()
```
    Returns the arc diagram plot option
    
    Since:
    
    10.2.1.0
  - getArea
```
public AreaPlotOptions getArea()
```
    Returns the area plot option
  - getAreaRange
```
public AreaRangePlotOptions getAreaRange()
```
    Returns the area range plot option
  - getAreaSpline
```
public AreaSplinePlotOptions getAreaSpline()
```
    Returns the areaspline plot option
  - getAreaSplineRange
```
public AreaSplineRangePlotOptions getAreaSplineRange()
```
    Returns the areaspline range plot option
  - getBar
```
public BarPlotOptions getBar()
```
    Returns the bar plot option
  - getBellCurve
```
public BellCurvePlotOptions getBellCurve()
```
    Returns the bell curve plot option
    
    Since:
    
    7.2.1.0
  - getBoxPlot
```
public BoxPlotOptions getBoxPlot()
```
    Returns the box plot option
  - getBubble
```
public BubblePlotOptions getBubble()
```
    Returns the bubble plot option
  - getBullet
```
public BulletPlotOptions getBullet()
```
    Returns the bullet plot option
    
    Since:
    
    7.2.1.0
  - getColumn
```
public ColumnPlotOptions getColumn()
```
    Returns the column plot option
  - getColumnPyramid
```
public ColumnPyramidPlotOptions getColumnPyramid()
```
    Returns the column pyramid plot option
    
    Since:
    
    7.2.1.0
  - getColumnRange
```
public ColumnRangePlotOptions getColumnRange()
```
    Returns the column range plot option
  - getCylinder
```
public CylinderPlotOptions getCylinder()
```
    Returns the cylinder plot option
    
    Since:
    
    7.2.1.0
  - getDependencyWheel
```
public DependencyWheelPlotOptions getDependencyWheel()
```
    Returns the dependency wheel plot option
    
    Since:
    
    7.2.1.0
  - getErrorBar
```
public ErrorBarPlotOptions getErrorBar()
```
    Returns the error bar plot option
  - getDumbbell
```
public DumbbellPlotOptions getDumbbell()
```
    Returns the dumbbell plot option
    
    Since:
    
    10.2.1.0
  - getFunnel
```
public FunnelPlotOptions getFunnel()
```
    Returns the funnel plot option
  - getFunnel3D
```
public Funnel3DPlotOptions getFunnel3D()
```
    Returns the funnel 3d plot option
    
    Since:
    
    7.2.1.0
  - getGauge
```
public GaugePlotOptions getGauge()
```
    Returns the gauge plot option
  - getHeat
```
public HeatmapPlotOptions getHeat()
```
    Returns the heatmap plot option
  - getHistogram
```
public HistogramPlotOptions getHistogram()
```
    Returns the histogram plot option
    
    Since:
    
    7.2.1.0
  - getItem
```
public ItemPlotOptions getItem()
```
    Returns the item plot option
    
    Since:
    
    7.2.1.0
  - getLine
```
public LinePlotOptions getLine()
```
    Returns the line plot option
  - getLollipop
```
public LollipopPlotOptions getLollipop()
```
    Returns the lollipop plot option
    
    Since:
    
    10.2.1.0
  - getNetworkGraph
```
public NetworkGraphPlotOptions getNetworkGraph()
```
    Returns the networkgraph plot option.
    
    Since:
    
    7.2.1.0
  - getOrganization
```
public OrganizationPlotOptions getOrganization()
```
    Returns the organization plot option
    
    Since:
    
    7.2.1.0
  - getPackedBubble
```
public PackedBubblePlotOptions getPackedBubble()
```
    Returns the packed bubble plot option
    
    Since:
    
    7.2.1.0
  - getPareto
```
public ParetoPlotOptions getPareto()
```
    Returns the pareto plot option
    
    Since:
    
    7.2.1.0
  - getPictorial
```
public PictorialPlotOptions getPictorial()
```
    Returns the pictorial plot option
    
    Since:
    
    11.2.0.0
  - getPie
```
public PiePlotOptions getPie()
```
    Returns the pie plot option
  - getPolygon
```
public PolygonPlotOptions getPolygon()
```
    Returns the polygon plot option
    
    Since:
    
    7.2.1.0
  - getPyramid
```
public PyramidPlotOptions getPyramid()
```
    Returns the pyramid plot option
    
    Since:
    
    7.2.1.0
  - getPyramid3D
```
public Pyramid3DPlotOptions getPyramid3D()
```
    Returns the pyramid 3D plot option
    
    Since:
    
    7.2.1.0
  - getSankey
```
public SankeyPlotOptions getSankey()
```
    Returns the sankey plot option
    
    Since:
    
    7.2.1.0
  - getScatter
```
public ScatterPlotOptions getScatter()
```
    Returns the scatter plot option
  - getScatter3D
```
public Scatter3DPlotOptions getScatter3D()
```
    Returns the scatter 3D plot option
    
    Since:
    
    7.2.1.0
  - getSeries
```
public SeriesPlotOptions getSeries()
```
    Returns the series plot option
  - getSonification
```
public SeriesSonification getSonification()
```
    Returns sonification/audio chart options for a series.
    
    Since:
    
    11.2.0.0
  - setSonification
```
public void setSonification(SeriesSonification sonification)
```
    Sets sonification/audio chart options for a series.
    
    Since:
    
    11.2.0.0
  - getSolidGauge
```
public SolidGaugePlotOptions getSolidGauge()
```
    Returns the solid gauge plot option
  - getSpline
```
public SplinePlotOptions getSpline()
```
    Returns the spline plot option
  - getStreamGraph
```
public StreamGraphPlotOptions getStreamGraph()
```
    Returns the streamgraph plot option
    
    Since:
    
    7.2.1.0
  - getSunburst
```
public SunburstPlotOptions getSunburst()
```
    Returns the sunburst plot option
    
    Since:
    
    7.2.1.0
  - getTilemap
```
public TilemapPlotOptions getTilemap()
```
    Returns the tilemap plot option
    
    Since:
    
    7.2.1.0
  - getTimeline
```
public TimelinePlotOptions getTimeline()
```
    Returns the timeline plot option
    
    Since:
    
    7.2.1.0
  - getTree
```
public TreemapPlotOptions getTree()
```
    Deprecated.
    as release of 10.3.3.0, please use getTreemap() instead.
    
    Returns the treemap plot option
  - getTreemap
```
public TreemapPlotOptions getTreemap()
```
    Returns the treemap plot option
    
    Since:
    
    10.3.3.0
  - getTreegraph
```
public TreegraphPlotOptions getTreegraph()
```
    Returns the treemap plot option
    
    Since:
    
    10.3.3.0
  - getVariablePie
```
public VariablePiePlotOptions getVariablePie()
```
    Returns the variable pie plot option
    
    Since:
    
    7.2.1.0
  - getVariwide
```
public VariwidePlotOptions getVariwide()
```
    Returns the variwide plot option
    
    Since:
    
    7.2.1.0
  - getVector
```
public VectorPlotOptions getVector()
```
    Returns the vector plot option
    
    Since:
    
    7.2.1.0
  - getVenn
```
public VennPlotOptions getVenn()
```
    Returns the venn plot option
    
    Since:
    
    7.2.1.0
  - getWaterfall
```
public WaterfallPlotOptions getWaterfall()
```
    Returns the water fall plot option
  - getWindBarb
```
public WindBarbPlotOptions getWindBarb()
```
    Returns the wind barb plot option
    
    Since:
    
    7.2.1.0
  - getWordCloud
```
public WordCloudPlotOptions getWordCloud()
```
    Returns the word cloud plot option
    
    Since:
    
    7.2.1.0
  - getXRange
```
public XRangePlotOptions getXRange()
```
    Returns the xrange plot option
    
    Since:
    
    7.2.1.0
  - getNullInteraction
```
public Boolean getNullInteraction()
```
    Get whether or not data-points with the value of null should be interactive. When this is set to true, tooltips may highlight these points, and this option also enables keyboard navigation for such points. Format options for such points include nullFormat and nullFormater. Works for these series: line, spline, area, area-spline, column, bar, and* timeline. Default: null.
    
    Since:
    
    12.2.0.0
  - setNullInteraction
```
public void setNullInteraction(Boolean nullInteraction)
```
    Sets whether or not data-points with the value of null should be interactive. When this is set to true, tooltips may highlight these points, and this option also enables keyboard navigation for such points. Format options for such points include nullFormat and nullFormater. Works for these series: line, spline, area, area-spline, column, bar, and* timeline. Default: null.
    
    Since:
    
    12.2.0.0

Class PlotOptions

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

PlotOptions

Method Detail

getArcDiagram

getArea

getAreaRange

getAreaSpline

getAreaSplineRange

getBar

getBellCurve

getBoxPlot

getBubble

getBullet

getColumn

getColumnPyramid

getColumnRange

getCylinder

getDependencyWheel

getErrorBar

getDumbbell

getFunnel

getFunnel3D

getGauge

getHeat

getHistogram

getItem

getLine

getLollipop

getNetworkGraph

getOrganization

getPackedBubble

getPareto

getPictorial

getPie

getPolygon

getPyramid

getPyramid3D

getSankey

getScatter

getScatter3D

getSeries

getSonification

setSonification

getSolidGauge

getSpline

getStreamGraph

getSunburst

getTilemap

getTimeline

getTree

getTreemap

getTreegraph

getVariablePie

getVariwide

getVector

getVenn

getWaterfall

getWindBarb

getWordCloud

getXRange

getNullInteraction

setNullInteraction