Package org.zkoss.chart
Class ColorAxis
- java.lang.Object
-
- org.zkoss.chart.Optionable
-
- org.zkoss.chart.Axis
-
- org.zkoss.chart.XAxis
-
- org.zkoss.chart.YAxis
-
- org.zkoss.chart.ColorAxis
-
- All Implemented Interfaces:
Serializable
,OptionDataListener
,org.zkoss.json.JSONAware
public class ColorAxis extends YAxis
A Color Axis used for heat map plots onlyAll the options in this class support
DynamicalAttribute
.- Author:
- hanhsu
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.zkoss.chart.Optionable
NOT_NULL_VALUE, options
-
-
Constructor Summary
Constructors Constructor Description ColorAxis()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AxisAccessibility
getAccessibility()
Returns an accessibility options for an axis, if null, it will create new one.String
getDataClassColor()
Determines how to set each data class' color if no individual color is set.List<DataClass>
getDataClasses()
Returns a list of data classes or ranges for the choropleth map, if any.String
getLayout()
Returns the layout of the color axis.boolean
isShowInLegend()
Returns whether to display the colorAxis in the legend.void
setAccessibility(AxisAccessibility accessibility)
Sets an accessibility options for an axis.void
setDataClassColor(String dataClassColor)
Determines how to set each data class' color if no individual color is set.void
setDataClasses(List<DataClass> dataClasses)
Sets a list of data classes or ranges for the choropleth map.void
setDataClasses(DataClass... dataClasses)
Sets a list of data classes or ranges for the choropleth map.void
setLayout(String layout)
Sets the layout of the color axis.void
setShowInLegend(boolean showInLegend)
Sets whether to display the colorAxis in the legend.-
Methods inherited from class org.zkoss.chart.YAxis
getGridLineInterpolation, getGridLineWidth, getLabels, getLineWidth, getMaxColor, getMaxPadding, getMinColor, getMinPadding, getStackLabels, getStackShadow, getStops, getTickPixelInterval, getTickWidth, getTitle, getTooltipValueFormat, isEndOnTick, isReversed, isReversedStacks, isStartOnTick, onChange, setEndOnTick, setGridLineInterpolation, setGridLineWidth, setLineWidth, setMaxColor, setMaxColor, setMaxColor, setMaxColor, setMaxPadding, setMinColor, setMinColor, setMinColor, setMinColor, setMinPadding, setReversed, setReversedStacks, setStackLabels, setStackShadow, setStops, setStops, setTickPixelInterval, setTickWidth, setTooltipValueFormat
-
Methods inherited from class org.zkoss.chart.XAxis
getBreaks, getCrosshair, getHeight, getLeft, getLineColor, getTop, getWidth, isShowEmpty, setBreaks, setCrosshair, setCrosshair, setHeight, setLeft, setLeft, setLineColor, setLineColor, setLineColor, setLineColor, setShowEmpty, setTop, setTop, setWidth
-
Methods inherited from class org.zkoss.chart.Axis
addPlotBand, addPlotLine, getAlternateGridColor, getAngle, getCategories, getCeiling, getClassName, getCrossing, getDateTimeLabelFormats, getFloor, getGridLineColor, getGridLineDashStyle, getGridZIndex, getId, getLinkedTo, getMargin, getMax, getMin, getMinorGridLineColor, getMinorGridLineDashStyle, getMinorGridLineWidth, getMinorTickColor, getMinorTickInterval, getMinorTickLength, getMinorTickPosition, getMinorTicksPerMajor, getMinorTickWidth, getMinRange, getMinTickInterval, getOffset, getPane, getPlotBands, getPlotLines, getSoftMax, getSoftMin, getStartOfWeek, getTickAmount, getTickColor, getTickInterval, getTickLength, getTickmarkPlacement, getTickPosition, getTickPositions, getType, getZIndex, isAlignTicks, isAllowDecimals, isAllowNegativeLog, isMinorTicks, isOpposite, isPanningEnabled, isShowFirstLabel, isShowLastLabel, isUniqueNames, isVisible, isZoomEnabled, remove, removePlotBand, removePlotBand, removePlotLine, removePlotLine, setAlignTicks, setAllowDecimals, setAllowNegativeLog, setAlternateGridColor, setAlternateGridColor, setAlternateGridColor, setAlternateGridColor, setAngle, setCategories, setCategories, setCeiling, setClassName, setCrossing, setDateTimeLabelFormats, setExtremes, setExtremes, setFloor, setGridLineColor, setGridLineColor, setGridLineColor, setGridLineColor, setGridLineDashStyle, setGridZIndex, setId, setLabels, setLinkedTo, setMargin, setMax, setMin, setMinorGridLineColor, setMinorGridLineColor, setMinorGridLineColor, setMinorGridLineColor, setMinorGridLineDashStyle, setMinorGridLineWidth, setMinorTickColor, setMinorTickColor, setMinorTickColor, setMinorTickColor, setMinorTickInterval, setMinorTickInterval, setMinorTickLength, setMinorTickPosition, setMinorTicks, setMinorTicksPerMajor, setMinorTickWidth, setMinRange, setMinTickInterval, setOffset, setOpposite, setPane, setPanningEnabled, setPlotBands, setPlotBands, setPlotLines, setPlotLines, setShowFirstLabel, setShowLastLabel, setSoftMax, setSoftMin, setStartOfWeek, setStartOnTick, setTickAmount, setTickColor, setTickInterval, setTickLength, setTickmarkPlacement, setTickPosition, setTickPositions, setTitle, setTitle, setType, setUniqueNames, setVisible, setZIndex, setZoomEnabled
-
Methods inherited from class org.zkoss.chart.Optionable
addExtraAttr, addOptionDataListener, clearOptonDataListener, clone, containsKey, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, getAttr, getAttr, getClientState, getExtraAttr, merge, removeExtraAttr, removeKey, removeOptionDataListener, setAttr, setAttr, setAttr, setAttr, toJSONString, toString
-
-
-
-
Method Detail
-
getAccessibility
public AxisAccessibility getAccessibility()
Returns an accessibility options for an axis, if null, it will create new one.- Overrides:
getAccessibility
in classAxis
- Since:
- 10.2.1.0
-
setAccessibility
public void setAccessibility(AxisAccessibility accessibility)
Sets an accessibility options for an axis.- Overrides:
setAccessibility
in classAxis
- Since:
- 10.2.1.0
-
getDataClassColor
public String getDataClassColor()
Determines how to set each data class' color if no individual color is set. The default value, tween, computes intermediate colors between minColor and maxColor. The other possible value, category, pulls colors from the global or chart specific colors array.Default: "tween"
- Since:
- 7.2.1.0
-
setDataClassColor
public void setDataClassColor(String dataClassColor)
Determines how to set each data class' color if no individual color is set. The default value, tween, computes intermediate colors between minColor and maxColor. The other possible value, category, pulls colors from the global or chart specific colors array.- Since:
- 7.2.1.0
-
getDataClasses
public List<DataClass> getDataClasses()
Returns a list of data classes or ranges for the choropleth map, if any. Otherwise, create a new one. If none given, the color axis is scalar and values are distributed as a gradient between the minimum and maximum colors.- Since:
- 7.2.1.0
-
setDataClasses
public void setDataClasses(List<DataClass> dataClasses)
Sets a list of data classes or ranges for the choropleth map.- Since:
- 7.2.1.0
-
setDataClasses
public void setDataClasses(DataClass... dataClasses)
Sets a list of data classes or ranges for the choropleth map.- Since:
- 7.2.1.0
-
getLayout
public String getLayout()
Returns the layout of the color axis. Can be 'horizontal' or 'vertical'. If none given, the color axis has the same layout as the legend.Default: null
- Since:
- 7.2.1.0
-
setLayout
public void setLayout(String layout)
Sets the layout of the color axis. Can be 'horizontal' or 'vertical'. If none given, the color axis has the same layout as the legend.- Since:
- 7.2.1.0
-
isShowInLegend
public boolean isShowInLegend()
Returns whether to display the colorAxis in the legend.Default: true
- Since:
- 7.2.1.0
-
setShowInLegend
public void setShowInLegend(boolean showInLegend)
Sets whether to display the colorAxis in the legend.- Since:
- 7.2.1.0
-
-