java.lang.Object
- org.zkoss.chart.Optionable
- - org.zkoss.chart.plotOptions.SeriesPlotOptions
  - - org.zkoss.chart.plotOptions.ColumnPlotOptions
    - - org.zkoss.chart.plotOptions.BoxPlotOptions

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

Direct Known Subclasses:

ErrorBarPlotOptions
```
public class BoxPlotOptions
extends ColumnPlotOptions
```
An option for box plot
All the options in this class support DynamicalAttribute.

Author:

RaymondChao

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.zkoss.chart.Optionable
  NOT_NULL_VALUE, options

Constructor Summary

Constructors
Constructor Description

BoxPlotOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getBoxDashStyle()`	Returns the dash style of the box.
`Color`	`getFillColor()`	Returns the fill color of the box.
`Number`	`getLineWidth()`	Returns the width of the line surrounding the box.
`String`	`getMedianColor()`	Returns the color of the median line.
`String`	`getMedianDashStyle()`	Returns a name for the dash style of the median.
`Number`	`getMedianWidth()`	Returns the pixel width of the median line.
`Color`	`getStemColor()`	Returns the color of the stem, the vertical line extending from the box to the whiskers.
`String`	`getStemDashStyle()`	Returns the dash style of the stem, the vertical line extending from the box to the whiskers.
`Number`	`getStemWidth()`	Returns the width of the stem, the vertical line extending from the box to the whiskers.
`Color`	`getWhiskerColor()`	Returns the color of the whiskers, the horizontal lines marking low and high values.
`String`	`getWhiskerDashStyle()`	Returns the dash style of the whisker.
`String`	`getWhiskerLength()`	Returns the length of the whiskers, the horizontal lines marking low and high values.
`Number`	`getWhiskerWidth()`	Returns the line width of the whiskers, the horizontal lines marking low and high values.
`void`	`setBoxDashStyle(String boxDashStyle)`	Sets the dash style of the box.
`void`	`setFillColor(String color)`	Sets the fill color of the box.
`void`	`setFillColor(Color color)`	Sets the fill color of the box.
`void`	`setFillColor(LinearGradient color)`	Sets the fill color of the box.
`void`	`setFillColor(RadialGradient color)`	Sets the fill color of the box.
`void`	`setLineWidth(Number lineWidth)`	Sets the width of the line surrounding the box.
`void`	`setMedianColor(String medianColor)`	Sets the color of the median line.
`void`	`setMedianColor(Color medianColor)`	Sets the color of the median line.
`void`	`setMedianColor(LinearGradient medianColor)`	Sets the color of the median line.
`void`	`setMedianColor(RadialGradient medianColor)`	Sets the color of the median line.
`void`	`setMedianDashStyle(String medianDashStyle)`	Sets a name for the dash style of the median.
`void`	`setMedianWidth(Number medianWidth)`	Sets the pixel width of the median line.
`void`	`setStemColor(String color)`	Sets the color of the stem, the vertical line extending from the box to the whiskers.
`void`	`setStemColor(Color color)`	Sets the color of the stem, the vertical line extending from the box to the whiskers.
`void`	`setStemColor(LinearGradient color)`	Sets the color of the stem, the vertical line extending from the box to the whiskers.
`void`	`setStemColor(RadialGradient color)`	Sets the color of the stem, the vertical line extending from the box to the whiskers.
`void`	`setStemDashStyle(String stemDashStyle)`	Sets the dash style of the stem, the vertical line extending from the box to the whiskers.
`void`	`setStemWidth(Number stemWidth)`	Sets the width of the stem, the vertical line extending from the box to the whiskers.
`void`	`setWhiskerColor(String color)`	Sets the color of the whiskers, the horizontal lines marking low and high values.
`void`	`setWhiskerColor(Color color)`	Sets the color of the whiskers, the horizontal lines marking low and high values.
`void`	`setWhiskerColor(LinearGradient color)`	Sets the color of the whiskers, the horizontal lines marking low and high values.
`void`	`setWhiskerColor(RadialGradient color)`	Sets the color of the whiskers, the horizontal lines marking low and high values.
`void`	`setWhiskerDashStyle(String whiskerDashStyle)`	Sets the dash style of the whisker.
`void`	`setWhiskerLength(Number whiskerLength)`	Sets the length of the whiskers, the horizontal lines marking low and high values.
`void`	`setWhiskerLength(String whiskerLength)`	Sets the length of the whiskers, the horizontal lines marking low and high values.
`void`	`setWhiskerWidth(Number whiskerWidth)`	Sets the line width of the whiskers, the horizontal lines marking low and high values.

Methods inherited from class org.zkoss.chart.plotOptions.SeriesPlotOptions
addDataLabels, getAccessibility, getAnimation, getAnimationLimit, getBoostBlending, getBoostThreshold, getClassName, getColor, getColorAxis, getColorIndex, getColorKey, getConnectorWidth, getCursor, getCustom, getDashStyle, getDataLabels, getDataLabelsList, getDataSorting, getDepth, getDescription, getDragDrop, getFindNearestPointBy, getId, getIndex, getKeys, getLabel, getLegendSymbol, getLinecap, getLinkedTo, getMarker, getName, getNeckHeight, getNeckWidth, getNegativeColor, getOnPoint, getOpacity, getPointDescriptionFormatter, getPointInterval, getPointIntervalUnit, getPointPlacement, getPointStart, getStacking, getStates, getStep, getThreshold, getTooltip, getTurboThreshold, getZoneAxis, getZones, isAllowPointSelect, isAnimation, isClip, isColorByPoint, isConnectEnds, isConnectNulls, isDataAsColumns, isEnableMouseTracking, isGetExtremesFromAll, isIncludeInDataExport, isRelativeXValue, isSelected, isShadow, isShowCheckbox, isShowInLegend, isSkipKeyboardNavigation, isSoftThreshold, isStacking, isStickyTracking, isVisible, isZoomEnabled, newDataLabels, setAccessibility, setAllowPointSelect, setAnimation, setAnimation, setAnimationLimit, setBoostBlending, setBoostThreshold, setBorderRadius, setBorderRadius, setCenter, setCenter, setClassName, setClip, setColor, setColor, setColor, setColor, setColorAxis, setColorAxis, setColorAxis, setColorByPoint, setColorIndex, setColorKey, setConnectEnds, setConnectNulls, setConnectorWidth, setCursor, setCustom, setDashStyle, setDataAsColumns, setDataLabels, setDataLabels, setDataSorting, setDepth, setDescription, setDragDrop, setEnableMouseTracking, setFindNearestPointBy, setGetExtremesFromAll, setId, setIncludeInDataExport, setIndex, setKeys, setLabel, setLegendSymbol, setLinecap, setLinkedTo, setMarker, setName, setNeckHeight, setNeckWidth, setNegativeColor, setNegativeColor, setNegativeColor, setNegativeColor, setOnPoint, setOpacity, setPointDescriptionFormatter, setPointInterval, setPointIntervalUnit, setPointPlacement, setPointPlacement, setPointStart, setPointStart, setRelativeXValue, setSelected, setShadow, setShowCheckbox, setShowInLegend, setSkipKeyboardNavigation, setSoftThreshold, setStacking, setStacking, setStates, setStep, setStickyTracking, 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

- Constructor Detail
  - BoxPlotOptions
```
public BoxPlotOptions()
```
- Method Detail
  - getBoxDashStyle
```
public String getBoxDashStyle()
```
    Returns the dash style of the box.
    Defaults to Solid.
    
    Since:
    
    10.2.1.
  - setBoxDashStyle
```
public void setBoxDashStyle(String boxDashStyle)
```
    Sets the dash style of the box.
    Defaults to Solid.
    
    Since:
    
    10.2.1.
  - getFillColor
```
public Color getFillColor()
```
    Returns the fill color of the box.
    Default: #FFFFFF
  - setFillColor
```
public void setFillColor(Color color)
```
    Sets the fill color of the box.
  - setFillColor
```
public void setFillColor(String color)
```
    Sets the fill color of the box.
  - setFillColor
```
public void setFillColor(LinearGradient color)
```
    Sets the fill color of the box.
  - setFillColor
```
public void setFillColor(RadialGradient color)
```
    Sets the fill color of the box.
  - getLineWidth
```
public Number getLineWidth()
```
    Returns the width of the line surrounding the box. If any of setStemWidth(Number) , setMedianWidth(Number), or setWhiskerWidth(Number) are null, the lineWidth also applies to these lines.
    
    Overrides:
    
    getLineWidth in class SeriesPlotOptions
  - setLineWidth
```
public void setLineWidth(Number lineWidth)
```
    Sets the width of the line surrounding the box. If any of setStemWidth(Number) , setMedianWidth(Number), or setWhiskerWidth(Number) are null, the lineWidth also applies to these lines.
    
    Overrides:
    
    setLineWidth in class SeriesPlotOptions
  - getMedianColor
```
public String getMedianColor()
```
    Returns the color of the median line. If null, the general series color applies.
  - setMedianColor
```
public void setMedianColor(String medianColor)
```
    Sets the color of the median line. If null, the general series color applies. 'medianColor the color of the median line. If null, the general series color applies.
  - setMedianColor
```
public void setMedianColor(Color medianColor)
```
    Sets the color of the median line. If null, the general series color applies. 'medianColor the color of the median line. If null, the general series color applies.
    
    Since:
    
    10.2.1.0
  - setMedianColor
```
public void setMedianColor(LinearGradient medianColor)
```
    Sets the color of the median line. If null, the general series color applies. 'medianColor the color of the median line. If null, the general series color applies.
    
    Since:
    
    10.2.1.0
  - setMedianColor
```
public void setMedianColor(RadialGradient medianColor)
```
    Sets the color of the median line. If null, the general series color applies. 'medianColor the color of the median line. If null, the general series color applies.
    
    Since:
    
    10.2.1.0
  - getMedianDashStyle
```
public String getMedianDashStyle()
```
    Returns a name for the dash style of the median. The value for the medianDashStyle include:
    
    Solid
    
    ShortDash
    
    ShortDot
    
    ShortDashDot
    
    ShortDashDotDot
    
    Dot
    
    Dash
    
    LongDash
    
    DashDot
    
    LongDashDot
    
    LongDashDotDot
    
    Default: "Solid"
    Since:
    
    10.2.1.0
  - setMedianDashStyle
```
public void setMedianDashStyle(String medianDashStyle)
```
    Sets a name for the dash style of the median. The value for the medianDashStyle include:
    
    Solid
    
    ShortDash
    
    ShortDot
    
    ShortDashDot
    
    ShortDashDotDot
    
    Dot
    
    Dash
    
    LongDash
    
    DashDot
    
    LongDashDot
    
    LongDashDotDot
    Since:
    
    10.2.1.0
  - getMedianWidth
```
public Number getMedianWidth()
```
    Returns the pixel width of the median line. If null, the setLineWidth(Number) is used.
    Default: 2
  - setMedianWidth
```
public void setMedianWidth(Number medianWidth)
```
    Sets the pixel width of the median line. If null, the setLineWidth(Number) is used.
    Default: 2
  - getStemColor
```
public Color getStemColor()
```
    Returns the color of the stem, the vertical line extending from the box to the whiskers. If null, the series color is used.
  - setStemColor
```
public void setStemColor(Color color)
```
    Sets the color of the stem, the vertical line extending from the box to the whiskers. If null, the series color is used.
  - setStemColor
```
public void setStemColor(String color)
```
    Sets the color of the stem, the vertical line extending from the box to the whiskers. If null, the series color is used.
  - setStemColor
```
public void setStemColor(LinearGradient color)
```
    Sets the color of the stem, the vertical line extending from the box to the whiskers. If null, the series color is used.
  - setStemColor
```
public void setStemColor(RadialGradient color)
```
    Sets the color of the stem, the vertical line extending from the box to the whiskers. If null, the series color is used.
  - getStemDashStyle
```
public String getStemDashStyle()
```
    Returns the dash style of the stem, the vertical line extending from the box to the whiskers.
  - setStemDashStyle
```
public void setStemDashStyle(String stemDashStyle)
```
    Sets the dash style of the stem, the vertical line extending from the box to the whiskers.
  - getStemWidth
```
public Number getStemWidth()
```
    Returns the width of the stem, the vertical line extending from the box to the whiskers. If null, the width is inherited from the setLineWidth(Number) option.
  - setStemWidth
```
public void setStemWidth(Number stemWidth)
```
    Sets the width of the stem, the vertical line extending from the box to the whiskers. If null, the width is inherited from the setLineWidth(Number) option.
  - getWhiskerColor
```
public Color getWhiskerColor()
```
    Returns the color of the whiskers, the horizontal lines marking low and high values. When null, the general series color is used.
    Default: null
  - setWhiskerColor
```
public void setWhiskerColor(Color color)
```
    Sets the color of the whiskers, the horizontal lines marking low and high values. When null, the general series color is used.
  - setWhiskerColor
```
public void setWhiskerColor(String color)
```
    Sets the color of the whiskers, the horizontal lines marking low and high values. When null, the general series color is used.
  - setWhiskerColor
```
public void setWhiskerColor(LinearGradient color)
```
    Sets the color of the whiskers, the horizontal lines marking low and high values. When null, the general series color is used.
  - setWhiskerColor
```
public void setWhiskerColor(RadialGradient color)
```
    Sets the color of the whiskers, the horizontal lines marking low and high values. When null, the general series color is used.
  - getWhiskerLength
```
public String getWhiskerLength()
```
    Returns the length of the whiskers, the horizontal lines marking low and high values. It can be a numerical pixel value, or a percentage value of the box width. Set 0 to disable whiskers.
    Default: 50%
  - setWhiskerLength
```
public void setWhiskerLength(String whiskerLength)
```
    Sets the length of the whiskers, the horizontal lines marking low and high values. It can be a numerical pixel value, or a percentage value of the box width. Set 0 to disable whiskers.
  - setWhiskerLength
```
public void setWhiskerLength(Number whiskerLength)
```
    Sets the length of the whiskers, the horizontal lines marking low and high values. It can be a numerical pixel value, or a percentage value of the box width. Set 0 to disable whiskers.
  - getWhiskerWidth
```
public Number getWhiskerWidth()
```
    Returns the line width of the whiskers, the horizontal lines marking low and high values. When null, the general setLineWidth(Number) applies.
  - setWhiskerWidth
```
public void setWhiskerWidth(Number whiskerWidth)
```
    Sets the line width of the whiskers, the horizontal lines marking low and high values. When null, the general setLineWidth(Number) applies.
  - getWhiskerDashStyle
```
public String getWhiskerDashStyle()
```
    Returns the dash style of the whisker.
    Defaults to Solid.
    
    Since:
    
    10.2.1.
  - setWhiskerDashStyle
```
public void setWhiskerDashStyle(String whiskerDashStyle)
```
    Sets the dash style of the whisker.
    Defaults to Solid.
    
    Since:
    
    10.2.1.

Class BoxPlotOptions

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

Constructor Summary

Method Summary

Methods inherited from class org.zkoss.chart.plotOptions.ColumnPlotOptions

Methods inherited from class org.zkoss.chart.plotOptions.SeriesPlotOptions

Methods inherited from class org.zkoss.chart.Optionable

Methods inherited from class java.lang.Object

Methods inherited from interface org.zkoss.chart.OptionDataListener

Constructor Detail

BoxPlotOptions

Method Detail

getBoxDashStyle

setBoxDashStyle

getFillColor

setFillColor

setFillColor

setFillColor

setFillColor

getLineWidth

setLineWidth

getMedianColor

setMedianColor

setMedianColor

setMedianColor

setMedianColor

getMedianDashStyle

setMedianDashStyle

getMedianWidth

setMedianWidth

getStemColor

setStemColor

setStemColor

setStemColor

setStemColor

getStemDashStyle

setStemDashStyle

getStemWidth

setStemWidth

getWhiskerColor

setWhiskerColor

setWhiskerColor

setWhiskerColor

setWhiskerColor

getWhiskerLength

setWhiskerLength

setWhiskerLength

getWhiskerWidth

setWhiskerWidth

getWhiskerDashStyle

setWhiskerDashStyle