Package org.zkoss.chart.plotOptions
Class ArcDiagramPlotOptions
- java.lang.Object
-
- org.zkoss.chart.Optionable
-
- org.zkoss.chart.plotOptions.SeriesPlotOptions
-
- org.zkoss.chart.plotOptions.ArcDiagramPlotOptions
-
- All Implemented Interfaces:
Serializable
,OptionDataListener
,org.zkoss.json.JSONAware
public class ArcDiagramPlotOptions extends SeriesPlotOptions
An options for arc diagram plot.All the options in this class support
DynamicalAttribute
.- Since:
- 10.2.1.0
- Author:
- jumperchen
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.zkoss.chart.Optionable
NOT_NULL_VALUE, options
-
-
Constructor Summary
Constructors Constructor Description ArcDiagramPlotOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getBorderColor()
Returns the color of the border surrounding each column or bar.Number
getBorderWidth()
Returns the width of the border surrounding each column or bar.List<Color>
getColors()
Returns the series specific or series type specific color set to apply instead of the global colors whenisColorByPoint()
is true.List<Level>
getLevels()
Returns options on specific levels.Number
getLinkOpacity()
Returns linkOpacity on all points which lay on the same level.Number
getLinkWeight()
The global link weight.Number
getMinLinkWidth()
Returns the minimal width for a line of a sankey.Number
getNodeWidth()
Returns the pixel width of each node in a sankey diagram or dependency wheel, or the height in case the chart is inverted.String
getOffset()
Returns the offset of an arc diagram nodes column in relation to theplotArea
.boolean
isCenteredLinks()
Returns the option to center links rather than position them one after anotherboolean
isColorByPoint()
Returns whether the chart should receive one color per series or one color per point.boolean
isEqualNodes()
Returns whether nodes with different values should have the same size.boolean
isReversed()
Returns whether the series should be placed on the other side of the plotArea.void
setBorderColor(String borderColor)
Sets the color of the border surrounding each column or bar.void
setBorderWidth(Number borderWidth)
Sets the width of the border surrounding each column or bar.void
setCenteredLinks(boolean centeredLinks)
Sets the option to center links rather than position them one after anothervoid
setColorByPoint(boolean colorByPoint)
Sets whether the chart should receive one color per series or one color per point.void
setColors(String... colors)
Sets the series specific or series type specific color set to apply instead of the global colors whenisColorByPoint()
is true.void
setColors(List<Color> colors)
Sets the series specific or series type specific color set to apply instead of the global colors whenisColorByPoint()
is true.void
setColors(Color... colors)
Sets the series specific or series type specific color set to apply instead of the global colors whenisColorByPoint()
is true.void
setEqualNodes(boolean equalNodes)
Sets whether nodes with different values should have the same size.void
setLevels(List<Level> levels)
Set options on specific levels.void
setLevels(Level... levels)
Set options on specific levels.void
setLinkOpacity(Number linkOpacity)
Sets linkOpacity on all points which lay on the same level.void
setLinkWeight(Number linkWeight)
The global link weight.void
setMinLinkWidth(Number minLinkWidth)
Sets the minimal width for a line of a sankey.void
setNodeWidth(Number nodeWidth)
Sets the pixel width of each node in a sankey diagram or dependency wheel, or the height in case the chart is inverted.void
setOffset(String offset)
Sets the offset of an arc diagram nodes column in relation to theplotArea
.void
setReversed(boolean reversed)
Sets whether the series should be placed on the other side of the plotArea.-
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, getDataLabels, getDataLabelsList, getDataSorting, getDepth, 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, isConnectEnds, isConnectNulls, isCrisp, isDataAsColumns, isEnableMouseTracking, isGetExtremesFromAll, isIncludeInDataExport, isRelativeXValue, isSelected, isShadow, isShowCheckbox, isShowInLegend, isSkipKeyboardNavigation, isSoftThreshold, isStacking, isStickyTracking, isVisible, newDataLabels, setAccessibility, setAllowPointSelect, setAnimation, setAnimation, setAnimationLimit, setBoostBlending, setBoostThreshold, setBorderRadius, setBorderRadius, setCenter, setCenter, setCenterInCategory, setClassName, setClip, setColor, setColor, setColor, setColor, setColorAxis, setColorAxis, setColorAxis, setColorIndex, setColorKey, setConnectEnds, setConnectNulls, setConnectorWidth, setCrisp, setCropThreshold, setCursor, setCustom, setDashStyle, setDataAsColumns, setDataLabels, setDataLabels, setDataSorting, setDepth, 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, setRelativeXValue, setSelected, setShadow, setShowCheckbox, setShowInLegend, setSkipKeyboardNavigation, setSoftThreshold, setStacking, setStacking, setStates, setStep, setStickyTracking, setThreshold, setTooltip, setTurboThreshold, setVisible, setWidth, setZoneAxis, setZones, 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, 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
-
getBorderColor
public String getBorderColor()
Returns the color of the border surrounding each column or bar.Default:
#ffffff
-
setBorderColor
public void setBorderColor(String borderColor)
Sets the color of the border surrounding each column or bar.
-
getBorderWidth
public Number getBorderWidth()
Returns the width of the border surrounding each column or bar.Default:
0
when the columns are so dense that a border would cover the next column.- Overrides:
getBorderWidth
in classSeriesPlotOptions
-
setBorderWidth
public void setBorderWidth(Number borderWidth)
Sets the width of the border surrounding each column or bar.- Overrides:
setBorderWidth
in classSeriesPlotOptions
-
isCenteredLinks
public boolean isCenteredLinks()
Returns the option to center links rather than position them one after anotherDefault:
false
.
-
setCenteredLinks
public void setCenteredLinks(boolean centeredLinks)
Sets the option to center links rather than position them one after another
-
isColorByPoint
public boolean isColorByPoint()
Returns whether the chart should receive one color per series or one color per point.Default:
true
.- Overrides:
isColorByPoint
in classSeriesPlotOptions
-
setColorByPoint
public void setColorByPoint(boolean colorByPoint)
Sets whether the chart should receive one color per series or one color per point.- Overrides:
setColorByPoint
in classSeriesPlotOptions
-
setColors
public void setColors(List<Color> colors)
Sets the series specific or series type specific color set to apply instead of the global colors whenisColorByPoint()
is true.
-
setColors
public void setColors(String... colors)
Sets the series specific or series type specific color set to apply instead of the global colors whenisColorByPoint()
is true.
-
setColors
public void setColors(Color... colors)
Sets the series specific or series type specific color set to apply instead of the global colors whenisColorByPoint()
is true.
-
getColors
public List<Color> getColors()
Returns the series specific or series type specific color set to apply instead of the global colors whenisColorByPoint()
is true.
-
isEqualNodes
public boolean isEqualNodes()
Returns whether nodes with different values should have the same size. If set to true, all nodes are calculated based on the nodePadding and current plotArea.Default:
false
.
-
setEqualNodes
public void setEqualNodes(boolean equalNodes)
Sets whether nodes with different values should have the same size. If set to true, all nodes are calculated based on the nodePadding and current plotArea.
-
getLevels
public List<Level> getLevels()
Returns options on specific levels. Takes precedence over series options, but not node and link options.Default: null
-
setLevels
public void setLevels(List<Level> levels)
Set options on specific levels. Takes precedence over series options, but not node and link options.
-
setLevels
public void setLevels(Level... levels)
Set options on specific levels. Takes precedence over series options, but not node and link options.
-
getLinkOpacity
public Number getLinkOpacity()
Returns linkOpacity on all points which lay on the same level.Default:
0.5
-
setLinkOpacity
public void setLinkOpacity(Number linkOpacity)
Sets linkOpacity on all points which lay on the same level.
-
getLinkWeight
public Number getLinkWeight()
The global link weight. If not set, width is calculated per link, depending on the weight value. (Requires arcdiagram)Defaults to
null
.
-
setLinkWeight
public void setLinkWeight(Number linkWeight)
The global link weight. If not set, width is calculated per link, depending on the weight value. (Requires arcdiagram)Defaults to
null
.
-
getMinLinkWidth
public Number getMinLinkWidth()
Returns the minimal width for a line of a sankey.Default:
0
-
setMinLinkWidth
public void setMinLinkWidth(Number minLinkWidth)
Sets the minimal width for a line of a sankey.
-
getNodeWidth
public Number getNodeWidth()
Returns the pixel width of each node in a sankey diagram or dependency wheel, or the height in case the chart is inverted.Default:
20
-
setNodeWidth
public void setNodeWidth(Number nodeWidth)
Sets the pixel width of each node in a sankey diagram or dependency wheel, or the height in case the chart is inverted.
-
getOffset
public String getOffset()
Returns the offset of an arc diagram nodes column in relation to theplotArea
. The offset equal to 50% places nodes in the center of a chart. By default the series is placed so that the biggest node is touching the bottom border of theplotArea
.Default:
"100%"
-
setOffset
public void setOffset(String offset)
Sets the offset of an arc diagram nodes column in relation to theplotArea
. The offset equal to 50% places nodes in the center of a chart. By default the series is placed so that the biggest node is touching the bottom border of theplotArea
.Default:
"100%"
-
isReversed
public boolean isReversed()
Returns whether the series should be placed on the other side of the plotArea.Default:
false
.
-
setReversed
public void setReversed(boolean reversed)
Sets whether the series should be placed on the other side of the plotArea.
-
-