Package org.zkoss.chart.plotOptions
Class Pyramid3DPlotOptions
- java.lang.Object
-
- org.zkoss.chart.Optionable
-
- org.zkoss.chart.plotOptions.SeriesPlotOptions
-
- org.zkoss.chart.plotOptions.PiePlotOptions
-
- org.zkoss.chart.plotOptions.FunnelPlotOptions
-
- org.zkoss.chart.plotOptions.PyramidPlotOptions
-
- org.zkoss.chart.plotOptions.Pyramid3DPlotOptions
-
- All Implemented Interfaces:
Serializable
,OptionDataListener
,org.zkoss.json.JSONAware
public class Pyramid3DPlotOptions extends PyramidPlotOptions
An option for pyramid 3D plot- 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 Pyramid3DPlotOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Color
getEdgeColor()
3D columns only.Number
getEdgeWidth()
3D columns only.Number
getGroupPadding()
Returns padding between each value groups, in x axis units.Number
getGroupZPadding()
Returns the spacing between columns on the Z Axis in a 3D chart.Number
getMaxPointWidth()
Returns the maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.Number
getMinPointLength()
Returns the minimal height for a column or width for a bar.Number
getPointPadding()
Returns padding between each column or bar, in x axis units.Number
getPointWidth()
Returns a pixel value specifying a fixed width for each column or bar.boolean
isCenterInCategory()
When true, the columns will center in the category, ignoring null or missing points.boolean
isGradientForSides()
By default sides fill is set to a gradient through this option being set to true.boolean
isGrouping()
Returns whether to group non-stacked columns or to let them render independent of each other.void
setCenterInCategory(boolean centerInCategory)
When true, the columns will center in the category, ignoring null or missing points.void
setEdgeColor(String color)
3D columns only.void
setEdgeColor(Color color)
3D columns only.void
setEdgeWidth(Number edgeWidth)
3D columns only.void
setGradientForSides(boolean gradientForSides)
By default sides fill is set to a gradient through this option being set to true.void
setGrouping(boolean grouping)
Sets whether to group non-stacked columns or to let them render independent of each other.void
setGroupPadding(Number groupPadding)
Sets padding between each value groups, in x axis units.void
setGroupZPadding(Number groupZPadding)
Sets the spacing between columns on the Z Axis in a 3D chart.void
setMaxPointWidth(Number maxPointWidth)
Sets the maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.void
setMinPointLength(Number minPointLength)
Sets the minimal height for a column or width for a bar.void
setPointPadding(Number pointPadding)
Sets padding between each column or bar, in x axis units.void
setPointWidth(Number pointWidth)
Sets a pixel value specifying a fixed width for each column or bar.-
Methods inherited from class org.zkoss.chart.plotOptions.PyramidPlotOptions
isReversed
-
Methods inherited from class org.zkoss.chart.plotOptions.FunnelPlotOptions
getBorderRadius, getDataLabels, getHeight, getNeckHeight, getNeckWidth, getWidth, newDataLabels, setHeight, setNeckHeight, setNeckWidth, setReversed, setWidth
-
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, getClassName, getColor, getColorAxis, getColorIndex, getColorKey, getConnectorWidth, getCropThreshold, getCursor, getCustom, getDashStyle, getDataLabelsList, getDataSorting, getDescription, getDragDrop, getFindNearestPointBy, getId, getIndex, getKeys, getLabel, getLegendSymbol, getLinecap, getLineWidth, getLinkedTo, getMarker, getName, getNegativeColor, getOnPoint, getOpacity, getPointDescriptionFormatter, getPointInterval, getPointIntervalUnit, getPointPlacement, getPointStart, getStacking, getStates, getStep, getThreshold, getTooltip, getTurboThreshold, getZoneAxis, getZones, isAllowPointSelect, isAnimation, isClip, isColorByPoint, isConnectEnds, isConnectNulls, isCrisp, isDataAsColumns, isEnableMouseTracking, isGetExtremesFromAll, isIncludeInDataExport, isRelativeXValue, isSelected, isShadow, isShowCheckbox, isSkipKeyboardNavigation, isSoftThreshold, isStacking, isVisible, setAccessibility, setAllowPointSelect, setAnimation, setAnimation, setAnimationLimit, setBoostBlending, setBoostThreshold, setBorderRadius, setBorderRadius, 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, setId, setIncludeInDataExport, setIndex, setKeys, setLabel, setLegendSymbol, setLinecap, setLineWidth, setLinkedTo, setMarker, setName, setNegativeColor, setNegativeColor, setNegativeColor, setNegativeColor, setOnPoint, setOpacity, setPointDescriptionFormatter, setPointInterval, setPointIntervalUnit, setPointPlacement, setPointPlacement, setPointStart, setRelativeXValue, setSelected, setShadow, setShowCheckbox, setSkipKeyboardNavigation, setSoftThreshold, setStacking, setStacking, setStates, setStep, setThreshold, setTooltip, setTurboThreshold, setVisible, 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
-
isCenterInCategory
public boolean isCenterInCategory()
When true, the columns will center in the category, ignoring null or missing points. When false, space will be reserved for null or missing points.Default:
false
.- Overrides:
isCenterInCategory
in classSeriesPlotOptions
- Since:
- 10.2.1.0
-
setCenterInCategory
public void setCenterInCategory(boolean centerInCategory)
When true, the columns will center in the category, ignoring null or missing points. When false, space will be reserved for null or missing points.- Overrides:
setCenterInCategory
in classSeriesPlotOptions
- Since:
- 10.2.1.0
-
getEdgeWidth
public Number getEdgeWidth()
3D columns only. Returns the width of the colored edges.Default: 0
-
setEdgeWidth
public void setEdgeWidth(Number edgeWidth)
3D columns only. Sets the width of the colored edges.
-
getEdgeColor
public Color getEdgeColor()
3D columns only. The color of the edges. Similar toborderColor
, except it defaults to the same color as the column.Default:
null
- Since:
- 10.2.1.0
-
setEdgeColor
public void setEdgeColor(Color color)
3D columns only. The color of the edges. Similar toborderColor
, except it defaults to the same color as the column.Default:
null
- Since:
- 10.2.1.0
-
setEdgeColor
public void setEdgeColor(String color)
3D columns only. The color of the edges. Similar toborderColor
, except it defaults to the same color as the column.Default:
null
- Since:
- 10.2.1.0
-
isGradientForSides
public boolean isGradientForSides()
By default sides fill is set to a gradient through this option being set to true. Set to false to get solid color for the sides.Default: true
-
setGradientForSides
public void setGradientForSides(boolean gradientForSides)
By default sides fill is set to a gradient through this option being set to true. Set to false to get solid color for the sides.
-
isGrouping
public boolean isGrouping()
Returns whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other.Default:
true
- Since:
- 10.2.1.0
-
setGrouping
public void setGrouping(boolean grouping)
Sets whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other.Default:
true
- Since:
- 10.2.1.0
-
getGroupPadding
public Number getGroupPadding()
Returns padding between each value groups, in x axis units.Default: 0.2
- Overrides:
getGroupPadding
in classSeriesPlotOptions
- Since:
- 10.2.1.0
-
setGroupPadding
public void setGroupPadding(Number groupPadding)
Sets padding between each value groups, in x axis units.- Overrides:
setGroupPadding
in classSeriesPlotOptions
- Since:
- 10.2.1.0
-
getGroupZPadding
public Number getGroupZPadding()
Returns the spacing between columns on the Z Axis in a 3D chart.Default: 1
-
setGroupZPadding
public void setGroupZPadding(Number groupZPadding)
Sets the spacing between columns on the Z Axis in a 3D chart.Default: 1
-
getMaxPointWidth
public Number getMaxPointWidth()
Returns the maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart.Default: null
- Since:
- 10.2.1.0
-
setMaxPointWidth
public void setMaxPointWidth(Number maxPointWidth)
Sets the maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart.- Since:
- 10.2.1.0
-
getMinPointLength
public Number getMinPointLength()
Returns the minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed values.Default: 0
- Since:
- 10.2.1.0
-
setMinPointLength
public void setMinPointLength(Number minPointLength)
Sets the minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed values.- Since:
- 10.2.1.0
-
getPointPadding
public Number getPointPadding()
Returns padding between each column or bar, in x axis units.Default:
0.1
- Since:
- 10.2.1.0
-
setPointPadding
public void setPointPadding(Number pointPadding)
Sets padding between each column or bar, in x axis units. 'pointPadding padding between each column or bar, in x axis units.- Since:
- 10.2.1.0
-
getPointWidth
public Number getPointWidth()
Returns a pixel value specifying a fixed width for each column or bar. Whennull
, the width is calculated from thepointPadding
andgroupPadding
.Default: null
- Since:
- 10.2.1.0
-
setPointWidth
public void setPointWidth(Number pointWidth)
Sets a pixel value specifying a fixed width for each column or bar. Whennull
, the width is calculated from thepointPadding
andgroupPadding
.- Since:
- 10.2.1.0
-
-