HIVariablepie

java.lang.Object
- java.util.Observable
- - com.highsoft.highcharts.core.HIFoundation
  - - com.highsoft.highcharts.common.hichartsclasses.HISeries
    - - com.highsoft.highcharts.common.hichartsclasses.HIVariablepie

```
public class HIVariablepie
extends HISeries
```
A `variablepie` series. If the `type` option is not specified, it is inherited from `chart.type`. In TypeScript the `type` option must always be set. Configuration options for the series are given in three levels: 1. Options for all series in a chart are defined in the `plotOptions.series` object. 2. Options for all `variablepie` series are defined in `plotOptions.variablepie`. 3. Options for one single series are given in `the series instance array`. ``` Highcharts.chart('container', { plotOptions: { series: { // general options for all series }, variablepie: { // shared options for all variablepie series } }, series: [{ // specific options for this series instance type: 'variablepie' }] }); ```

Constructor Summary

Constructors
Constructor and Description

HIVariablepie()

Constructors
Constructor and Description
`HIVariablepie()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HIColor`	`getBorderColor()`
`HIBorderRadiusOptionsObject`	`getBorderRadius()`
`java.lang.Number`	`getBorderWidth()`
`java.util.ArrayList`	`getCenter()`
`java.util.ArrayList<java.lang.String>`	`getColors()`
`java.lang.Number`	`getDepth()`
`java.lang.Number`	`getEndAngle()`
`HIColor`	`getFillColor()`
`java.lang.Boolean`	`getIgnoreHiddenPoint()`
`java.lang.Object`	`getInnerSize()`
`java.lang.Object`	`getMaxPointSize()`
`java.lang.Object`	`getMinPointSize()`
`java.lang.Object`	`getMinSize()`
`java.util.HashMap<java.lang.String,java.lang.Object>`	`getParams()`
`java.lang.Object`	`getSize()`
`java.lang.String`	`getSizeBy()`
`java.lang.Number`	`getSlicedOffset()`
`java.lang.Number`	`getStartAngle()`
`java.lang.Number`	`getThickness()`
`java.lang.Number`	`getZMax()`
`java.lang.Number`	`getZMin()`
`void`	`setBorderColor(HIColor borderColor)` The color of the border surrounding each slice.
`void`	`setBorderRadius(HIBorderRadiusOptionsObject borderRadius)` The corner radius of the border surrounding each slice.
`void`	`setBorderWidth(java.lang.Number borderWidth)` The width of the border surrounding each slice.
`void`	`setCenter(java.util.ArrayList center)` The center of the pie chart relative to the plot area.
`void`	`setColors(java.util.ArrayList<java.lang.String> colors)` A series specific or series type specific color set to use instead of the global `colors`.
`void`	`setDepth(java.lang.Number depth)` The thickness of a 3D pie.
`void`	`setEndAngle(java.lang.Number endAngle)` The end angle of the pie in degrees where 0 is top and 90 is right.
`void`	`setFillColor(HIColor fillColor)` If the total sum of the pie's values is 0, the series is represented as an empty circle .
`void`	`setIgnoreHiddenPoint(java.lang.Boolean ignoreHiddenPoint)` Equivalent to `chart.ignoreHiddenSeries`, this option tells whether the series shall be redrawn as if the hidden point were `null`.
`void`	`setInnerSize(java.lang.Object innerSize)` The size of the inner diameter for the pie.
`void`	`setMaxPointSize(java.lang.Object maxPointSize)` The maximum size of the points' radius related to chart's `plotArea`.
`void`	`setMinPointSize(java.lang.Object minPointSize)` The minimum size of the points' radius related to chart's `plotArea`.
`void`	`setMinSize(java.lang.Object minSize)` The minimum size for a pie in response to auto margins.
`void`	`setSize(java.lang.Object size)` The diameter of the pie relative to the plot area.
`void`	`setSizeBy(java.lang.String sizeBy)` Whether the pie slice's value should be represented by the area or the radius of the slice.
`void`	`setSlicedOffset(java.lang.Number slicedOffset)` If a point is sliced, moved out from the center, how many pixels should it be moved?.
`void`	`setStartAngle(java.lang.Number startAngle)` The start angle of the pie slices in degrees where 0 is top and 90 right.
`void`	`setThickness(java.lang.Number thickness)` Thickness describing the ring size for a donut type chart, overriding `innerSize`.
`void`	`setZMax(java.lang.Number zMax)` The maximum possible z value for the point's radius calculation.
`void`	`setZMin(java.lang.Number zMin)` The minimum possible z value for the point's radius calculation.

Methods inherited from class com.highsoft.highcharts.common.hichartsclasses.HISeries
addPoint, addPoint, addPoint, addPoint, animate, drawGraph, drawPoints, getAccessibility, getAllowPointSelect, getAnimation, getAnimationLimit, getBoostBlending, getBoostThreshold, getClassName, getClip, getColor, getColorAxis, getColorIndex, getColorKey, getConnectEnds, getConnectNulls, getCrisp, getCropThreshold, getCursor, getCustom, getDashStyle, getData, getDataLabels, getDataSorting, getDefinition, getDescribeSingleSeries, getDescriptionFormat, getDescriptionFormatter, getDragDrop, getEnableMouseTracking, getEvents, getFindNearestPointBy, getGetExtremesFromAll, getId, getInactiveOtherPoints, getIncludeInDataExport, getIndex, getKeys, getLabel, getLegendIndex, getLegendSymbol, getLinecap, getLineWidth, getLinkedTo, getMarker, getName, getNegativeColor, getNullPointValue, getOnPoint, getOpacity, getPoint, getPointAnnotationsDescription, getPointDescriptionEnabledThreshold, getPointDescriptionFormat, getPointDescriptionFormatter, getPointInterval, getPointIntervalUnit, getPointPlacement, getPointStart, getRelativeXValue, getSelected, getShadow, getShowCheckbox, getShowInLegend, getSkipKeyboardNavigation, getSoftThreshold, getSonification, getStack, getStacking, getStates, getStep, getStickyTracking, getSummary, getThreshold, getTooltip, getTurboThreshold, getType, getVisible, getXAxis, getXAxisDescription, getYAxis, getYAxisDescription, getZIndex, getZoneAxis, getZones, hide, onMouseOut, onMouseOver, remove, remove, remove, remove, removePoint, removePoint, removePoint, render, select, select, setAccessibility, setAllowPointSelect, setAnimation, setAnimationLimit, setBoostBlending, setBoostThreshold, setClassName, setClip, setColor, setColorAxis, setColorIndex, setColorKey, setConnectEnds, setConnectNulls, setCrisp, setCropThreshold, setCursor, setCustom, setDashStyle, setData, setDataLabels, setDataSorting, setDefinition, setDescribeSingleSeries, setDescriptionFormat, setDescriptionFormatter, setDragDrop, setEnableMouseTracking, setEvents, setFindNearestPointBy, setGetExtremesFromAll, setId, setInactiveOtherPoints, setIncludeInDataExport, setIndex, setKeys, setLabel, setLegendIndex, setLegendSymbol, setLinecap, setLineWidth, setLinkedTo, setMarker, setName, setNegativeColor, setNullPointValue, setOnPoint, setOpacity, setOptions, setPoint, setPointAnnotationsDescription, setPointDescriptionEnabledThreshold, setPointDescriptionFormat, setPointDescriptionFormatter, setPointInterval, setPointIntervalUnit, setPointPlacement, setPointStart, setProperty, setRelativeXValue, setSelected, setSeriesData, setSeriesData, setSeriesData, setSeriesData, setSeriesVisible, setSeriesVisible, setSeriesVisible, setShadow, setShowCheckbox, setShowInLegend, setSkipKeyboardNavigation, setSoftThreshold, setSonification, setStack, setStacking, setState, setState, setStates, setStep, setStickyTracking, setSummary, setThreshold, setTooltip, setTurboThreshold, setType, setVisible, setXAxis, setXAxisDescription, setYAxis, setYAxisDescription, setZIndex, setZoneAxis, setZones, show, sonify, translate, update, update

Methods inherited from class java.util.Observable
addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HIVariablepie
```
public HIVariablepie()
```
- Method Detail
  - getBorderColor
```
public HIColor getBorderColor()
```
  - getBorderRadius
```
public HIBorderRadiusOptionsObject getBorderRadius()
```
  - getBorderWidth
```
public java.lang.Number getBorderWidth()
```
  - getCenter
```
public java.util.ArrayList getCenter()
```
  - getColors
```
public java.util.ArrayList<java.lang.String> getColors()
```
  - getDepth
```
public java.lang.Number getDepth()
```
  - getEndAngle
```
public java.lang.Number getEndAngle()
```
  - getFillColor
```
public HIColor getFillColor()
```
  - getIgnoreHiddenPoint
```
public java.lang.Boolean getIgnoreHiddenPoint()
```
  - getInnerSize
```
public java.lang.Object getInnerSize()
```
  - getMaxPointSize
```
public java.lang.Object getMaxPointSize()
```
  - getMinPointSize
```
public java.lang.Object getMinPointSize()
```
  - getMinSize
```
public java.lang.Object getMinSize()
```
  - getParams
```
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
```
    Overrides:
    
    getParams in class HISeries
  - getSize
```
public java.lang.Object getSize()
```
  - getSizeBy
```
public java.lang.String getSizeBy()
```
  - getSlicedOffset
```
public java.lang.Number getSlicedOffset()
```
  - getStartAngle
```
public java.lang.Number getStartAngle()
```
  - getThickness
```
public java.lang.Number getThickness()
```
  - getZMax
```
public java.lang.Number getZMax()
```
  - getZMin
```
public java.lang.Number getZMin()
```
  - setBorderColor
```
public void setBorderColor(HIColor borderColor)
```
    The color of the border surrounding each slice. When `null`, the border takes the same color as the slice fill. This can be used together with a `borderWidth` to fill drawing gaps created by antialiazing artefacts in borderless pies. In styled mode, the border stroke is given in the `.highcharts-point` class.
    
    defaults:
    
    #ffffff
  - setBorderRadius
```
public void setBorderRadius(HIBorderRadiusOptionsObject borderRadius)
```
    The corner radius of the border surrounding each slice. A number signifies pixels. A percentage string, like for example `50%`, signifies a size relative to the radius and the inner radius.
    
    defaults:
    
    3
  - setBorderWidth
```
public void setBorderWidth(java.lang.Number borderWidth)
```
    The width of the border surrounding each slice. When setting the border width to 0, there may be small gaps between the slices due to SVG antialiasing artefacts. To work around this, keep the border width at 0.5 or 1, but set the `borderColor` to `null` instead. In styled mode, the border stroke width is given in the `.highcharts-point` class.
    
    defaults:
    
    1
  - setCenter
```
public void setCenter(java.util.ArrayList center)
```
    The center of the pie chart relative to the plot area. Can be percentages or pixel values. The defaults behaviour (as of 3.0) is to center the pie so that all slices and data labels are within the plot area. As a consequence, the pie may actually jump around in a chart with dynamic values, as the data labels move. In that case, the center should be explicitly set, for example to `["50%", "50%"]`.
    
    defaults:
    
    [null, null]
  - setColors
```
public void setColors(java.util.ArrayList<java.lang.String> colors)
```
    A series specific or series type specific color set to use instead of the global `colors`.
  - setDepth
```
public void setDepth(java.lang.Number depth)
```
    The thickness of a 3D pie.
    
    defaults:
    
    0
  - setEndAngle
```
public void setEndAngle(java.lang.Number endAngle)
```
    The end angle of the pie in degrees where 0 is top and 90 is right. Defaults to `startAngle` plus 360.
  - setFillColor
```
public void setFillColor(HIColor fillColor)
```
    If the total sum of the pie's values is 0, the series is represented as an empty circle . The `fillColor` option defines the color of that circle. Use `pie.borderWidth` to set the border thickness.
    
    defaults:
    
    undefined
  - setIgnoreHiddenPoint
```
public void setIgnoreHiddenPoint(java.lang.Boolean ignoreHiddenPoint)
```
    Equivalent to `chart.ignoreHiddenSeries`, this option tells whether the series shall be redrawn as if the hidden point were `null`. The defaults value changed from `false` to `true` with Highcharts 3.0.
    
    defaults:
    
    True
  - setInnerSize
```
public void setInnerSize(java.lang.Object innerSize)
```
    The size of the inner diameter for the pie. A size greater than 0 renders a donut chart. Can be a percentage or pixel value. Percentages are relative to the pie size. Pixel values are given as integers. Setting overridden by thickness. Note: in Highcharts < 4.1.2, the percentage was relative to the plot area, not the pie size.
    
    defaults:
    
    0
  - setMaxPointSize
```
public void setMaxPointSize(java.lang.Object maxPointSize)
```
    The maximum size of the points' radius related to chart's `plotArea`. If a number is set, it applies in pixels.
    
    defaults:
    
    100%
  - setMinPointSize
```
public void setMinPointSize(java.lang.Object minPointSize)
```
    The minimum size of the points' radius related to chart's `plotArea`. If a number is set, it applies in pixels.
    
    defaults:
    
    10%
  - setMinSize
```
public void setMinSize(java.lang.Object minSize)
```
    The minimum size for a pie in response to auto margins. The pie will try to shrink to make room for data labels in side the plot area, but only to this size.
    
    defaults:
    
    80
  - setSize
```
public void setSize(java.lang.Object size)
```
    The diameter of the pie relative to the plot area. Can be a percentage or pixel value. Pixel values are given as integers. The defaults behaviour (as of 3.0) is to scale to the plot area and give room for data labels within the plot area. `slicedOffset` is also included in the defaults size calculation. As a consequence, the size of the pie may vary when points are updated and data labels more around. In that case it is best to set a fixed value, for example `"75%"`.
  - setSizeBy
```
public void setSizeBy(java.lang.String sizeBy)
```
    Whether the pie slice's value should be represented by the area or the radius of the slice. Can be either `area` or `radius`. The defaults, `area`, corresponds best to the human perception of the size of each pie slice.
    
    defaults:
    
    area
  - setSlicedOffset
```
public void setSlicedOffset(java.lang.Number slicedOffset)
```
    If a point is sliced, moved out from the center, how many pixels should it be moved?.
    
    defaults:
    
    10
  - setStartAngle
```
public void setStartAngle(java.lang.Number startAngle)
```
    The start angle of the pie slices in degrees where 0 is top and 90 right.
    
    defaults:
    
    0
  - setThickness
```
public void setThickness(java.lang.Number thickness)
```
    Thickness describing the ring size for a donut type chart, overriding `innerSize`.
    
    defaults:
    
    undefined
  - setZMax
```
public void setZMax(java.lang.Number zMax)
```
    The maximum possible z value for the point's radius calculation. If the point's Z value is bigger than zMax, the slice will be drawn according to the zMax value
  - setZMin
```
public void setZMin(java.lang.Number zMin)
```
    The minimum possible z value for the point's radius calculation. If the point's Z value is smaller than zMin, the slice will be drawn according to the zMin value.

Class HIVariablepie

Constructor Summary

Method Summary

Methods inherited from class com.highsoft.highcharts.common.hichartsclasses.HISeries

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Constructor Detail

HIVariablepie

Method Detail

getBorderColor

getBorderRadius

getBorderWidth

getCenter

getColors

getDepth

getEndAngle

getFillColor

getIgnoreHiddenPoint

getInnerSize

getMaxPointSize

getMinPointSize

getMinSize

getParams

getSize

getSizeBy

getSlicedOffset

getStartAngle

getThickness

getZMax

getZMin

setBorderColor

setBorderRadius

setBorderWidth

setCenter

setColors

setDepth

setEndAngle

setFillColor

setIgnoreHiddenPoint

setInnerSize

setMaxPointSize

setMinPointSize

setMinSize

setSize

setSizeBy

setSlicedOffset

setStartAngle

setThickness

setZMax

setZMin