org.zkoss.chart.plotOptions

Class SunburstPlotOptions

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.plotOptions.SeriesPlotOptions

org.zkoss.chart.plotOptions.PiePlotOptions

org.zkoss.chart.plotOptions.SunburstPlotOptions

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class SunburstPlotOptions
extends PiePlotOptions

An option for sunburst plot

All the options in this class support DynamicalAttribute.

Since:

7.2.1.0

Author:

rudyhuang

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

NOT_NULL_VALUE, options

Constructor Summary

Constructors

Constructor and Description
SunburstPlotOptions()

Method Summary

Modifier and Type	Method and Description
List<Level>	getLevels() Set options on specific levels.
LevelSize	getLevelSize() Returns options of determining the width of the ring per level, if any.
String	getRootId() Returns which point to use as a root in the visualization.
TraverseUpButton	getTraverseUpButton() Returns options for the button appearing when traversing down in a treemap, if any.
boolean	isAllowTraversingTree() When enabled the user can click on a point which is a parent and zoom in on its children.
boolean	isLevelIsConstant() Used together with the levels and allowTraversingTree options.
void	setAllowTraversingTree(boolean allowTraversingTree) When enabled the user can click on a point which is a parent and zoom in on its children.
void	setLevelIsConstant(boolean levelIsConstant) Used together with the levels and allowTraversingTree options.
void	setLevels(List<Level> levels)
void	setLevelSize(LevelSize levelSize) Sets options of determining the width of the ring per level.
void	setRootId(String rootId) Sets which point to use as a root in the visualization.
void	setTraverseUpButton(TraverseUpButton traverseUpButton) Sets options for the button appearing when traversing down in a treemap.

Methods inherited from class org.zkoss.chart.plotOptions.PiePlotOptions

getBorderColor, getBorderWidth, getCenter, getColors, getDataLabels, getDepth, getEndAngle, getFillColor, getInnerSize, getMinSize, getSize, getSlicedOffset, getStartAngle, isIgnoreHiddenPoint, isShowInLegend, isStickyTracking, setBorderColor, setBorderColor, setBorderColor, setBorderColor, setBorderWidth, setCenter, setCenter, setColors, setColors, setDepth, setEndAngle, setFillColor, setFillColor, setFillColor, setFillColor, setIgnoreHiddenPoint, setInnerSize, setInnerSize, setMinSize, setShowInLegend, setSize, setSize, setSlicedOffset, setStartAngle, setStickyTracking

Methods inherited from class org.zkoss.chart.plotOptions.SeriesPlotOptions

getAnimation, getColor, getColorAxis, getColorKey, getCropThreshold, getCursor, getDashStyle, getDescription, getDragDrop, getFindNearestPointBy, getGroupPadding, getId, getLabel, getLinecap, getLineWidth, getLinkedTo, getMarker, getNeckHeight, getNeckWidth, getNegativeColor, getOpacity, getPointInterval, getPointIntervalUnit, getPointPlacement, getPointStart, getStacking, getStates, getStep, getThreshold, getTooltip, getTurboThreshold, getZoneAxis, getZones, isAllowPointSelect, isAnimation, isClip, isColorByPoint, isConnectEnds, isConnectNulls, isEnableMouseTracking, isGetExtremesFromAll, isIncludeInDataExport, isSelected, isShadow, isShowCheckbox, isSkipKeyboardNavigation, isSoftThreshold, isStacking, isVisible, setAllowPointSelect, setAnimation, setAnimation, setClip, setColor, setColor, setColor, setColor, setColorAxis, setColorAxis, setColorAxis, setColorByPoint, setColorKey, setConnectEnds, setConnectNulls, setCropThreshold, setCursor, setDashStyle, setDataLabels, setDescription, setDragDrop, setEnableMouseTracking, setFindNearestPointBy, setGetExtremesFromAll, setGroupPadding, setId, setIncludeInDataExport, setLabel, setLinecap, setLineWidth, setLinkedTo, setMarker, setNeckHeight, setNeckWidth, setNegativeColor, setNegativeColor, setNegativeColor, setNegativeColor, setOpacity, setPointInterval, setPointIntervalUnit, setPointPlacement, setPointPlacement, setPointStart, setSelected, setShadow, setShowCheckbox, setSkipKeyboardNavigation, setSoftThreshold, setStacking, setStacking, setStates, setStep, setThreshold, setTooltip, setTurboThreshold, setVisible, setZoneAxis, setZones

Methods inherited from class org.zkoss.chart.Optionable

addExtraAttr, addOptionDataListener, clearOptonDataListener, clone, containsKey, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, getAttr, getAttr, getClientState, getExtraAttr, merge, onChange, removeExtraAttr, removeKey, removeOptionDataListener, setAttr, setAttr, setAttr, toJSONString, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.zkoss.chart.OptionDataListener

onChange

Constructor Detail

SunburstPlotOptions

public SunburstPlotOptions()

Method Detail

isAllowTraversingTree

public boolean isAllowTraversingTree()

When enabled the user can click on a point which is a parent and zoom in on its children.

Default: false

setAllowTraversingTree

public void setAllowTraversingTree(boolean allowTraversingTree)

When enabled the user can click on a point which is a parent and zoom in on its children.

isLevelIsConstant

public boolean isLevelIsConstant()

Used together with the levels and allowTraversingTree options. When set to false the first level visible when drilling is considered to be level one. Otherwise the level will be the same as the tree structure.

Default: true

setLevelIsConstant

public void setLevelIsConstant(boolean levelIsConstant)

Used together with the levels and allowTraversingTree options. When set to false the first level visible when drilling is considered to be level one. Otherwise the level will be the same as the tree structure.

getLevels

public List<Level> getLevels()

Set options on specific levels. Takes precedence over series options, but not point options.

Default: null

setLevels

public void setLevels(List<Level> levels)

Parameters:

levels -

See Also:

getLevels()

getLevelSize

public LevelSize getLevelSize()

Returns options of determining the width of the ring per level, if any. Otherwise, create a new one.

setLevelSize

public void setLevelSize(LevelSize levelSize)

Sets options of determining the width of the ring per level.

getRootId

public String getRootId()

Returns which point to use as a root in the visualization.

Default: null

setRootId

public void setRootId(String rootId)

Sets which point to use as a root in the visualization.

getTraverseUpButton

public TraverseUpButton getTraverseUpButton()

Returns options for the button appearing when traversing down in a treemap, if any. Otherwise, create a new one.

setTraverseUpButton

public void setTraverseUpButton(TraverseUpButton traverseUpButton)

Sets options for the button appearing when traversing down in a treemap.