HISunburst

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

```
public class HISunburst
extends HISeries
```
A `sunburst` 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 `sunburst` series are defined in `plotOptions.sunburst`. 3. Options for one single series are given in `the series instance array`. ``` Highcharts.chart('container', { plotOptions: { series: { // general options for all series }, sunburst: { // shared options for all sunburst series } }, series: [{ // specific options for this series instance type: 'sunburst' }] }); ```

Constructor Summary

Constructors
Constructor and Description

HISunburst()

Constructors
Constructor and Description
`HISunburst()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Boolean`	`getAllowTraversingTree()`
`HIColor`	`getBorderColor()`
`HIBorderRadiusOptionsObject`	`getBorderRadius()`
`java.lang.Number`	`getBorderWidth()`
`HIBreadcrumbs`	`getBreadcrumbs()`
`java.util.ArrayList`	`getCenter()`
`java.lang.Boolean`	`getColorByPoint()`
`java.util.ArrayList<java.lang.String>`	`getColors()`
`HIColor`	`getFillColor()`
`java.lang.Boolean`	`getLevelIsConstant()`
`java.util.ArrayList`	`getLevels()`
`HILevelSize`	`getLevelSize()`
`java.util.HashMap<java.lang.String,java.lang.Object>`	`getParams()`
`java.lang.String`	`getRootId()`
`java.lang.Object`	`getSize()`
`java.lang.Number`	`getSlicedOffset()`
`java.lang.Number`	`getStartAngle()`
`java.lang.Number`	`getThickness()`
`void`	`setAllowTraversingTree(java.lang.Boolean allowTraversingTree)` When enabled the user can click on a point which is a parent and zoom in on its children.
`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`	`setBreadcrumbs(HIBreadcrumbs breadcrumbs)` Options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.
`void`	`setCenter(java.util.ArrayList center)` /** * description: The center of the sunburst chart relative to the plot area.
`void`	`setColorByPoint(java.lang.Boolean colorByPoint)`
`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`	`setFillColor(HIColor fillColor)` If the total sum of the pie's values is 0, the series is represented as an empty circle .
`void`	`setLevelIsConstant(java.lang.Boolean levelIsConstant)` Used together with the levels and `allowDrillToNode` options.
`void`	`setLevels(java.util.ArrayList levels)` Set options on specific levels.
`void`	`setLevelSize(HILevelSize levelSize)` Determines the width of the ring per level.
`void`	`setRootId(java.lang.String rootId)` Which point to use as a root in the visualization.
`void`	`setSize(java.lang.Object size)` The diameter of the pie relative to the plot area.
`void`	`setSlicedOffset(java.lang.Number slicedOffset)` /** * description: 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`.

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
  - HISunburst
```
public HISunburst()
```
- Method Detail
  - getAllowTraversingTree
```
public java.lang.Boolean getAllowTraversingTree()
```
  - getBorderColor
```
public HIColor getBorderColor()
```
  - getBorderRadius
```
public HIBorderRadiusOptionsObject getBorderRadius()
```
  - getBorderWidth
```
public java.lang.Number getBorderWidth()
```
  - getBreadcrumbs
```
public HIBreadcrumbs getBreadcrumbs()
```
  - getCenter
```
public java.util.ArrayList getCenter()
```
  - getColorByPoint
```
public java.lang.Boolean getColorByPoint()
```
  - getColors
```
public java.util.ArrayList<java.lang.String> getColors()
```
  - getFillColor
```
public HIColor getFillColor()
```
  - getLevelIsConstant
```
public java.lang.Boolean getLevelIsConstant()
```
  - getLevels
```
public java.util.ArrayList getLevels()
```
  - getLevelSize
```
public HILevelSize getLevelSize()
```
  - getParams
```
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
```
    Overrides:
    
    getParams in class HISeries
  - getRootId
```
public java.lang.String getRootId()
```
  - getSize
```
public java.lang.Object getSize()
```
  - getSlicedOffset
```
public java.lang.Number getSlicedOffset()
```
  - getStartAngle
```
public java.lang.Number getStartAngle()
```
  - getThickness
```
public java.lang.Number getThickness()
```
  - setAllowTraversingTree
```
public void setAllowTraversingTree(java.lang.Boolean allowTraversingTree)
```
    When enabled the user can click on a point which is a parent and zoom in on its children.
    
    defaults:
    
    false
  - 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
  - setBreadcrumbs
```
public void setBreadcrumbs(HIBreadcrumbs breadcrumbs)
```
    Options for the breadcrumbs, the navigation at the top leading the way up through the traversed levels.
  - setCenter
```
public void setCenter(java.util.ArrayList center)
```
    /** * description: The center of the sunburst chart relative to the plot area. Can be percentages or pixel values. * demo: * [Centered at 100, 100](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/pie-center/) defaults: ["50%", "50%"]
  - setColorByPoint
```
public void setColorByPoint(java.lang.Boolean colorByPoint)
```
  - 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`.
  - 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
  - setLevelIsConstant
```
public void setLevelIsConstant(java.lang.Boolean levelIsConstant)
```
    Used together with the levels and `allowDrillToNode` 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.
    
    defaults:
    
    True
  - setLevels
```
public void setLevels(java.util.ArrayList levels)
```
    Set options on specific levels. Takes precedence over series options, but not point options.
  - setLevelSize
```
public void setLevelSize(HILevelSize levelSize)
```
    Determines the width of the ring per level.
  - setRootId
```
public void setRootId(java.lang.String rootId)
```
    Which point to use as a root in the visualization.
    
    defaults:
    
    undefined
  - 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%"`.
  - setSlicedOffset
```
public void setSlicedOffset(java.lang.Number slicedOffset)
```
    /** * description: If a point is sliced, moved out from the center, how many pixels should it be moved?. * demo: * [Sliced sunburst](https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/highcharts/plotoptions/sunburst-sliced) 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

Class HISunburst

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

HISunburst

Method Detail

getAllowTraversingTree

getBorderColor

getBorderRadius

getBorderWidth

getBreadcrumbs

getCenter

getColorByPoint

getColors

getFillColor

getLevelIsConstant

getLevels

getLevelSize

getParams

getRootId

getSize

getSlicedOffset

getStartAngle

getThickness

setAllowTraversingTree

setBorderColor

setBorderRadius

setBorderWidth

setBreadcrumbs

setCenter

setColorByPoint

setColors

setFillColor

setLevelIsConstant

setLevels

setLevelSize

setRootId

setSize

setSlicedOffset

setStartAngle

setThickness