Package 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 plotAll 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 Description SunburstPlotOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BreadcrumbsgetBreadcrumbs()Returns the options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.SunburstDataLabelsgetDataLabels()Returns the first or single option of data labels.List<Level>getLevels()Set options on specific levels.LevelSizegetLevelSize()Returns options of determining the width of the ring per level, if any.StringgetRootId()Returns which point to use as a root in the visualization.TraverseUpButtongetTraverseUpButton()Returns options for the button appearing when traversing down in a treemap, if any.booleanisAllowTraversingTree()When enabled the user can click on a point which is a parent and zoom in on its children.booleanisLevelIsConstant()Used together with the levels and allowTraversingTree options.protected DataLabelsnewDataLabels()Internal method for subclasses to provide specific type of data labels.voidsetAllowTraversingTree(boolean allowTraversingTree)When enabled the user can click on a point which is a parent and zoom in on its children.voidsetBreadcrumbs(Breadcrumbs breadcrumbs)Sets the options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.voidsetLevelIsConstant(boolean levelIsConstant)Used together with the levels and allowTraversingTree options.voidsetLevels(List<Level> levels)voidsetLevels(Level... levels)Set options on specific levels.voidsetLevelSize(LevelSize levelSize)Sets options of determining the width of the ring per level.voidsetRootId(String rootId)Sets which point to use as a root in the visualization.voidsetTraverseUpButton(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, getDepth, getEndAngle, getFillColor, getInnerSize, getMinSize, getSize, getSlicedOffset, getStartAngle, getThickness, 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, setThickness
-
Methods inherited from class org.zkoss.chart.plotOptions.SeriesPlotOptions
addDataLabels, getAccessibility, getAnimation, getAnimationLimit, getBoostBlending, getBoostThreshold, getBorderRadius, getClassName, getColor, getColorAxis, getColorIndex, getColorKey, getConnectorWidth, getCropThreshold, getCursor, getCustom, getDashStyle, getDataLabelsList, getDataSorting, getDescription, getDragDrop, getFindNearestPointBy, getGroupPadding, getId, getIndex, getKeys, getLabel, getLegendSymbol, getLinecap, getLineWidth, getLinkedTo, getMarker, getName, getNeckHeight, getNeckWidth, getNegativeColor, getOnPoint, getOpacity, getPointDescriptionFormatter, getPointInterval, getPointIntervalUnit, getPointPlacement, getPointStart, getStacking, getStates, getStep, getThreshold, getTooltip, getTurboThreshold, getZoneAxis, getZones, isAllowPointSelect, isAnimation, isCenterInCategory, isClip, isColorByPoint, isConnectEnds, isConnectNulls, isCrisp, isDataAsColumns, isEnableMouseTracking, isGetExtremesFromAll, isIncludeInDataExport, isRelativeXValue, isSelected, isShadow, isShowCheckbox, isSkipKeyboardNavigation, isSoftThreshold, isStacking, isVisible, isZoomEnabled, setAccessibility, setAllowPointSelect, setAnimation, setAnimation, setAnimationLimit, setBoostBlending, setBoostThreshold, setBorderRadius, setBorderRadius, setCenterInCategory, setClassName, setClip, setColor, setColor, setColor, setColor, setColorAxis, setColorAxis, setColorAxis, setColorByPoint, setColorIndex, setColorKey, setConnectEnds, setConnectNulls, setConnectorWidth, setCrisp, setCropThreshold, setCursor, setCustom, setDashStyle, setDataAsColumns, setDataLabels, setDataLabels, setDataSorting, setDescription, setDragDrop, setEnableMouseTracking, setFindNearestPointBy, setGetExtremesFromAll, setGroupPadding, setId, setIncludeInDataExport, setIndex, setKeys, setLabel, setLegendSymbol, setLinecap, setLineWidth, setLinkedTo, setMarker, setName, setNeckHeight, setNeckWidth, setNegativeColor, setNegativeColor, setNegativeColor, setNegativeColor, setOnPoint, setOpacity, setPointDescriptionFormatter, setPointInterval, setPointIntervalUnit, setPointPlacement, setPointPlacement, setPointStart, setPointStart, setRelativeXValue, setSelected, setShadow, setShowCheckbox, setSkipKeyboardNavigation, setSoftThreshold, setStacking, setStacking, setStates, setStep, setThreshold, setTooltip, setTurboThreshold, setVisible, setWidth, setZoneAxis, setZones, setZones, setZoomEnabled
-
Methods inherited from class org.zkoss.chart.Optionable
addExtraAttr, addOptionDataListener, clearOptonDataListener, clone, containsKey, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, getAttr, getAttr, getClientState, getExtraAttr, merge, onChange, removeExtraAttr, removeKey, removeOptionDataListener, setAttr, setAttr, setAttr, setAttr, toJSONString, toString
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.zkoss.chart.OptionDataListener
onChange
-
-
-
-
Method Detail
-
newDataLabels
protected DataLabels newDataLabels()
Description copied from class:SeriesPlotOptionsInternal method for subclasses to provide specific type of data labels.- Overrides:
newDataLabelsin classPiePlotOptions
-
getDataLabels
public SunburstDataLabels getDataLabels()
Description copied from class:SeriesPlotOptionsReturns the first or single option of data labels.- Overrides:
getDataLabelsin classSeriesPlotOptions
-
getBreadcrumbs
public Breadcrumbs getBreadcrumbs()
Returns the options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.Default: an instance of Breadcrumbs
- Since:
- 10.2.1.0
-
setBreadcrumbs
public void setBreadcrumbs(Breadcrumbs breadcrumbs)
Sets the options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.Default: an instance of Breadcrumbs
- Since:
- 10.2.1.0
-
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()
-
setLevels
public void setLevels(Level... levels)
Set options on specific levels. Takes precedence over series options, but not node and link options.- Since:
- 10.2.1.0
-
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.
-
-