Package org.zkoss.chart
Class Level
- java.lang.Object
-
- org.zkoss.chart.Optionable
-
- org.zkoss.chart.Level
-
- All Implemented Interfaces:
Serializable
,OptionDataListener
,org.zkoss.json.JSONAware
public class Level extends Optionable
Set options on specific levels. Takes precedence over series options, but not point options.- Author:
- Christopher
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.zkoss.chart.Optionable
NOT_NULL_VALUE, options
-
-
Constructor Summary
Constructors Constructor Description Level()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Color
getBorderColor()
Set the borderColor on all points which lies on the same level.String
getBorderDashStyle()
Returns a name for the dash style to use for the graph.Number
getBorderWidth()
Get the width of the border.Color
getColor()
Get the color on all points which lies on the same level.ColorVariation
getColorVariation()
Returns a configuration object to define how the color of a child varies from the parent's color, if any.DataLabels
getDataLabels()
Get the options of dataLabels on each point which lies on the level, if any.String
getLayoutAlgorithm()
Get the layoutAlgorithm option on a specific level.String
getLayoutStartingDirection()
Get the layoutStartingDirection option on a specific level.Number
getLevel()
Decides which level takes effect from the options set in the levels object.LevelSize
getLevelSize()
Returns options of determining the width of the ring per level, if any.Marker
getMarker()
Returns the level markerNumber
getRotation()
Returns a rotation on all points which lies on the same level.String
getRotationMode()
Returns a rotationMode on all points which lies on the same level.boolean
isColorByPoint()
Returns whether color by point option is enabled or notboolean
isLevelIsConstant()
Used together with the levels and allowTraversingTree options.void
setBorderColor(String color)
Set the borderColor on all points which lies on the same level.void
setBorderColor(Color color)
Set the borderColor on all points which lies on the same level.void
setBorderColor(LinearGradient color)
Set the borderColor on all points which lies on the same level.void
setBorderColor(RadialGradient color)
Set the borderColor on all points which lies on the same level.void
setBorderDashStyle(String borderDashStyle)
Set the dash style for the border.void
setBorderWidth(Number borderWidth)
Set the width of the border.void
setColor(String color)
Set the color on all points which lies on the same level.void
setColor(Color color)
Set the color on all points which lies on the same level.void
setColor(LinearGradient color)
Set the color on all points which lies on the same level.void
setColor(RadialGradient color)
Set the color on all points which lies on the same level.void
setColorByPoint(boolean colorByPoint)
Sets whether to enable the color by point option or notvoid
setColorVariation(ColorVariation colorVariation)
Sets a configuration object to define how the color of a child varies from the parent's color.void
setDataLabels(DataLabels dataLabels)
Set the options of dataLabels on each point which lies on the level.void
setLayoutAlgorithm(String layoutAlgorithm)
Set the layoutAlgorithm option on a specific level.void
setLayoutStartingDirection(String layoutStartingDirection)
Set the layoutStartingDirection option on a specific level.void
setLevel(Number level)
Set which level takes effect from the options set in the levels object.void
setLevelIsConstant(boolean levelIsConstant)
Used together with the levels and allowTraversingTree options.void
setLevelSize(LevelSize levelSize)
Sets options of determining the width of the ring per level.void
setMarker(Marker marker)
Sets the level markervoid
setRotation(Number rotation)
Sets a rotation on all points which lies on the same level.void
setRotationMode(String rotationMode)
Sets a rotationMode on all points which lies on the same level.-
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
-
-
-
-
Method Detail
-
getBorderColor
public Color getBorderColor()
Set the borderColor on all points which lies on the same level.Default: null
- Since:
- 2.1.0
-
setBorderColor
public void setBorderColor(Color color)
Set the borderColor on all points which lies on the same level.- Parameters:
color
-- Since:
- 2.1.0
-
setBorderColor
public void setBorderColor(String color)
Set the borderColor on all points which lies on the same level.- Parameters:
color
-- Since:
- 2.1.0
-
setBorderColor
public void setBorderColor(LinearGradient color)
Set the borderColor on all points which lies on the same level.- Parameters:
color
-- Since:
- 2.1.0
-
setBorderColor
public void setBorderColor(RadialGradient color)
Set the borderColor on all points which lies on the same level.- Parameters:
color
-- Since:
- 2.1.0
-
getBorderDashStyle
public String getBorderDashStyle()
Returns a name for the dash style to use for the graph. Applies only to series type having a graph, likeline
,spline
,area
andscatter
in case it has alineWidth
. The value for thedashStyle
include:- Solid
- ShortDash
- ShortDot
- ShortDashDot
- ShortDashDotDot
- Dot
- Dash
- LongDash
- DashDot
- LongDashDot
- LongDashDotDot
- Since:
- 2.1.0
-
setBorderDashStyle
public void setBorderDashStyle(String borderDashStyle)
Set the dash style for the border.- Parameters:
borderDashStyle
-- Since:
- 2.1.0
- See Also:
getBorderDashStyle()
-
getBorderWidth
public Number getBorderWidth()
Get the width of the border.Default: null
- Since:
- 2.1.0
-
setBorderWidth
public void setBorderWidth(Number borderWidth)
Set the width of the border.- Parameters:
borderWidth
-- Since:
- 2.1.0
-
getColor
public Color getColor()
Get the color on all points which lies on the same level.Default: null
- Since:
- 2.1.0
-
setColor
public void setColor(Color color)
Set the color on all points which lies on the same level.- Since:
- 2.1.0
-
setColor
public void setColor(String color)
Set the color on all points which lies on the same level.- Since:
- 2.1.0
-
setColor
public void setColor(LinearGradient color)
Set the color on all points which lies on the same level.- Since:
- 2.1.0
-
setColor
public void setColor(RadialGradient color)
Set the color on all points which lies on the same level.- Since:
- 2.1.0
-
isColorByPoint
public boolean isColorByPoint()
Returns whether color by point option is enabled or notDefault: false
- Since:
- 7.2.1.0
-
setColorByPoint
public void setColorByPoint(boolean colorByPoint)
Sets whether to enable the color by point option or not- Since:
- 7.2.1.0
-
getColorVariation
public ColorVariation getColorVariation()
Returns a configuration object to define how the color of a child varies from the parent's color, if any. Otherwise, create a new one.- Since:
- 7.2.1.0
-
setColorVariation
public void setColorVariation(ColorVariation colorVariation)
Sets a configuration object to define how the color of a child varies from the parent's color.- Since:
- 7.2.1.0
-
getDataLabels
public DataLabels getDataLabels()
Get the options of dataLabels on each point which lies on the level, if any. Otherwise, create a new one.Default: null
- Since:
- 2.1.0
-
setDataLabels
public void setDataLabels(DataLabels dataLabels)
Set the options of dataLabels on each point which lies on the level.- Since:
- 2.1.0
-
getLayoutAlgorithm
public String getLayoutAlgorithm()
Get the layoutAlgorithm option on a specific level.Default: null
- Since:
- 2.1.0
-
setLayoutAlgorithm
public void setLayoutAlgorithm(String layoutAlgorithm)
Set the layoutAlgorithm option on a specific level.- Since:
- 2.1.0
-
getLayoutStartingDirection
public String getLayoutStartingDirection()
Get the layoutStartingDirection option on a specific level.Default: null
- Since:
- 2.1.0
-
setLayoutStartingDirection
public void setLayoutStartingDirection(String layoutStartingDirection)
Set the layoutStartingDirection option on a specific level.- Since:
- 2.1.0
-
getLevel
public Number getLevel()
Decides which level takes effect from the options set in the levels object.Default: null
- Since:
- 2.1.0
-
setLevel
public void setLevel(Number level)
Set which level takes effect from the options set in the levels object.- Since:
- 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.- Since:
- 7.2.1.0
-
setLevelSize
public void setLevelSize(LevelSize levelSize)
Sets options of determining the width of the ring per level.- Since:
- 7.2.1.0
-
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
- Since:
- 7.2.1.0
-
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.- Since:
- 7.2.1.0
-
getMarker
public Marker getMarker()
Returns the level marker- Since:
- 10.3.3.0
-
setMarker
public void setMarker(Marker marker)
Sets the level marker- Since:
- 10.3.3.0
-
getRotation
public Number getRotation()
Returns a rotation on all points which lies on the same level.Default: null
- Since:
- 7.2.1.0
-
setRotation
public void setRotation(Number rotation)
Sets a rotation on all points which lies on the same level.- Since:
- 7.2.1.0
-
getRotationMode
public String getRotationMode()
Returns a rotationMode on all points which lies on the same level.Default: null
- Since:
- 7.2.1.0
-
setRotationMode
public void setRotationMode(String rotationMode)
Sets a rotationMode on all points which lies on the same level.- Since:
- 7.2.1.0
-
-