org.fujion.highcharts

Class PlotSunburst

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.PlotOptions

org.fujion.highcharts.PlotSunburst

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class PlotSunburst
extends PlotOptions

Options for sunburst plot.

A sunburst displays hierarchical data, where a level in the hierarchy is represented by a circle. The center represents the root node of the tree. The visualization bears a resemblance to both tree map and pie charts.

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	allowDrillToNode When enabled the user can click on a point which is a parent and zoom in on its children.
List<String>	center The center of the sunburst chart relative to the plot area.
Boolean	levelIsConstant Used together with the levels and allowDrillToNode options.
List<LevelOptions>	levels Set options on specific levels.
String	levelSize_unit How to interpret levelSize.value.
Double	levelSize_value The value used for calculating the width of the ring.
String	rootId Which point to use as a root in the visualization.
Integer	slicedOffset If a point is sliced, moved out from the center, how many pixels should it be moved?.
Double	startAngle The start angle of the pie slices in degrees where 0 is top and 90 right.

Fields inherited from class org.fujion.highcharts.PlotOptions

allowPointSelect, animation, animationLimit, boostThreshold, className, color, colorByPoint, colorIndex, colors, connectEnds, connectNulls, cropThreshold, cursor, dashStyle, dataLabels, description, enableMouseTracking, exposeElementToA11y, findNearestPointBy, getExtremesFromAll, id, keys, label, linecap, lineWidth, linkedTo, marker, negativeColor, pointInterval, pointIntervalUnit, pointPlacement, pointStart, selected, shadow, showCheckbox, showInLegend, skipKeyboardNavigation, softThreshold, stacking, step, stickyTracking, threshold, tooltip, turboThreshold, type, visible, zoneAxis, zones

Constructor Summary

Constructors

Constructor and Description
PlotSunburst()

Method Summary

Methods inherited from class org.fujion.highcharts.PlotOptions

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter

transformForClient

Field Detail

allowDrillToNode

@Option
public Boolean allowDrillToNode

When enabled the user can click on a point which is a parent and zoom in on its children. Defaults to false.

center

@Option
public List<String> center

The center of the sunburst chart relative to the plot area. Can be percentages or pixel values. Defaults to undefined.

levelIsConstant

@Option
public 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 to true.

levels

@Option
public final List<LevelOptions> levels

Set options on specific levels. Takes precedence over series options, but not point options.

levelSize_unit

@Option(value="levelSize.unit")
public String levelSize_unit

How to interpret levelSize.value. percentage gives a width relative to result of outer radius minus inner radius. pixels gives the ring a fixed width in pixels. weight takes the remaining width after percentage and pixels, and distributes it accross all "weighted" levels. The value relative to the sum of all weights determines the width. Defaults to weight.

levelSize_value

@Option(value="levelSize.value")
public Double levelSize_value

The value used for calculating the width of the ring. Its' affect is determined by levelSize.unit. Defaults to 1.

rootId

@Option
public String rootId

Which point to use as a root in the visualization. Defaults to undefined.

slicedOffset

@Option
public Integer slicedOffset

If a point is sliced, moved out from the center, how many pixels should it be moved?. Defaults to 10.

startAngle

@Option
public Double startAngle

The start angle of the pie slices in degrees where 0 is top and 90 right. Defaults to 0.

Constructor Detail

PlotSunburst

public PlotSunburst()