Highcharts .NET  11.3.0
Highsoft.Web.Mvc.Charts.PlotOptionsSunburst Class Reference

Inherits BaseObject.

Properties

PlotOptionsSunburstAccessibility Accessibility [get, set]
 Accessibility options for a series. More...
 
bool AllowDrillToNode [get, set]
 When enabled the user can click on a point which is a parent andzoom in on its children. Deprecated and replaced byallowTraversingTree. More...
 
bool AllowPointSelect [get, set]
 Allow this series' points to be selected by clicking on the graphic(columns, point markers, pie slices, map areas etc).The selected points can be handled by point select and unselectevents, or collectively by the getSelectedPoints function.And alternative way of selecting points is through dragging. More...
 
bool AllowTraversingTree [get, set]
 When enabled the user can click on a point which is a parent andzoom in on its children. More...
 
Animation Animation [get, set]
 Enable or disable the initial animation when a series is displayed.The animation can also be set as a configuration object. Pleasenote that this option only applies to the initial animation of theseries itself. For other animations, see chart.animation and the animation parameter under the API methods.The following properties are supported:- defer: The animation delay time in milliseconds.- duration: The duration of the animation in milliseconds. (Defaults to 1000)- easing: Can be a string reference to an easing function set on the Math object or a function. See the Custom easing function demo below. (Defaults to easeInOutSine)Due to poor performance, animation is disabled in old IE browsersfor several chart types. More...
 
bool AnimationBool [get, set]
 Enable or disable the initial animation when a series is displayed.The animation can also be set as a configuration object. Pleasenote that this option only applies to the initial animation of theseries itself. For other animations, see chart.animation and the animation parameter under the API methods.The following properties are supported:- defer: The animation delay time in milliseconds.- duration: The duration of the animation in milliseconds. (Defaults to 1000)- easing: Can be a string reference to an easing function set on the Math object or a function. See the Custom easing function demo below. (Defaults to easeInOutSine)Due to poor performance, animation is disabled in old IE browsersfor several chart types. More...
 
string BorderColor [get, set]
 The color of the border surrounding each slice. When null, theborder takes the same color as the slice fill. This can be usedtogether with a borderWidth to fill drawing gaps created byantialiazing artefacts in borderless pies.In styled mode, the border stroke is given in the .highcharts-pointclass. More...
 
Object BorderRadius [get, set]
 The corner radius of the border surrounding each slice. A numbersignifies pixels. A percentage string, like for example 50%, signifiesa size relative to the radius and the inner radius. More...
 
string BorderRadiusString [get, set]
 The corner radius of the border surrounding each slice. A numbersignifies pixels. A percentage string, like for example 50%, signifiesa size relative to the radius and the inner radius. More...
 
double BorderRadiusNumber [get, set]
 The corner radius of the border surrounding each slice. A numbersignifies pixels. A percentage string, like for example 50%, signifiesa size relative to the radius and the inner radius. More...
 
double BorderWidth [get, set]
 The width of the border surrounding each slice.When setting the border width to 0, there may be small gaps betweenthe slices due to SVG antialiasing artefacts. To work around this,keep the border width at 0.5 or 1, but set the borderColor tonull instead.In styled mode, the border stroke width is given in the<tt>.highcharts-point class. More...
 
PlotOptionsSunburstBreadcrumbs Breadcrumbs [get, set]
 Options for the breadcrumbs, the navigation at the top leading theway up through the traversed levels. More...
 
string [] Center [get, set]
 The center of the sunburst chart relative to the plot area. Can bepercentages or pixel values. More...
 
string ClassName [get, set]
 An additional class name to apply to the series' graphical elements.This option does not replace default class names of the graphicalelement. Changes to the series' color will also be reflected in achart's legend and tooltip. More...
 
bool Clip [get, set]
 
string Color [get, set]
 The main color of the series. In line type series it applies to theline and the point markers unless otherwise specified. In bar typeseries it applies to the bars unless a color is specified per point.The default value is pulled from the options.colors array.In styled mode, the color can be defined by thecolorIndex option. Also, the seriescolor can be set with the .highcharts-series,.highcharts-color-{n}, .highcharts-{type}-series or<tt>.highcharts-series-{n} class, or individual classes given by theclassName option. More...
 
bool ColorByPoint [get, set]
 
double ColorIndex [get, set]
 Styled mode only. A specific color index to use for the series, so itsgraphic representations are given the class name highcharts-color-{n}.Since v11, CSS variables on the form --highcharts-color-{n} makechanging the color scheme very convenient. More...
 
List< string > Colors [get, set]
 A series specific or series type specific color set to use insteadof the global colors. More...
 
bool Crisp [get, set]
 When true, each point or column edge is rounded to its nearest pixelin order to render sharp on screen. In some cases, when there are alot of densely packed columns, this leads to visible differencein column widths or distance between columns. In these cases,setting crisp to false may look better, even though each columnis rendered blurry. More...
 
PlotOptionsSunburstCursor Cursor [get, set]
 You can set the cursor to "pointer" if you have click events attachedto the series, to signal to the user that the points and lines canbe clicked.In styled mode, the series cursor can be set with the same classesas listed under series.color. More...
 
Hashtable Custom [get, set]
 A reserved subspace to store options and values for customizedfunctionality. Here you can add additional data for your own eventcallbacks and formatter callbacks. More...
 
PlotOptionsSunburstDataLabels DataLabels [get, set]
 
string Description [get, set]
 A description of the series to add to the screen reader informationabout the series. More...
 
bool EnableMouseTracking [get, set]
 Enable or disable the mouse tracking for a specific series. Thisincludes point tooltips and click events on graphs and points. Forlarge datasets it improves performance. More...
 
PlotOptionsSunburstEvents Events [get, set]
 General event handlers for the series items. These event hooks canalso be attached to the series at run time using theHighcharts.addEvent function. More...
 
Object FillColor [get, set]
 If the total sum of the pie's values is 0, the series is representedas an empty circle . The fillColor option defines the color of thatcircle. Use pie.borderWidth to setthe border thickness. More...
 
bool InactiveOtherPoints [get, set]
 Highlight only the hovered point and fade the remaining points.Scatter-type series require enabling the 'inactive' marker state andadjusting opacity. Note that this approach could affect performancewith large datasets. More...
 
bool IncludeInDataExport [get, set]
 When set to false will prevent the series data from being included inany form of data export.Since version 6.0.0 until 7.1.0 the option was existing undocumentedas includeInCSVExport. More...
 
List< string > Keys [get, set]
 An array specifying which option maps to which key in the data pointarray. This makes it convenient to work with unstructured data arraysfrom different sources. More...
 
PlotOptionsSunburstLegendSymbol LegendSymbol [get, set]
 What type of legend symbol to render for this series. Can be one ofareaMarker, lineMarker or rectangle. More...
 
bool LevelIsConstant [get, set]
 Used together with the levels and allowDrillToNode options. Whenset to false the first level visible when drilling is consideredto be level one. Otherwise the level will be the same as the treestructure. More...
 
List< PlotOptionsSunburstLevelsLevels [get, set]
 Set options on specific levels. Takes precedence over series options,but not point options. More...
 
PlotOptionsSunburstLevelSize LevelSize [get, set]
 Determines the width of the ring per level. More...
 
PlotOptionsSunburstOnPoint OnPoint [get, set]
 Options for the Series on point feature. Only pie and sunburst seriesare supported at this moment. More...
 
double Opacity [get, set]
 Opacity of a series parts: line, fill (e.g. area) and dataLabels. More...
 
PlotOptionsSunburstPoint Point [get, set]
 Properties for each single point. More...
 
string PointDescriptionFormat [get, set]
 Same asaccessibility.point.descriptionFormat,but for an individual series. Overrides the chart wide configuration. More...
 
string PointDescriptionFormatter [get, set]
 Same asaccessibility.series.descriptionFormatter,but for an individual series. Overrides the chart wide configuration. More...
 
bool RelativeXValue [get, set]
 When true, X values in the data set are relative to the currentpointStart, pointInterval and pointIntervalUnit settings. Thisallows compression of the data for datasets with irregular X values.The real X values are computed on the formula f(x) = ax + b, wherea is the pointInterval (optionally with a time unit given bypointIntervalUnit), and b is the pointStart. More...
 
string RootId [get, set]
 Which point to use as a root in the visualization. More...
 
bool Selected [get, set]
 Whether to select the series initially. If showCheckbox is true,the checkbox next to the series name in the legend will be checkedfor a selected series. More...
 
Shadow Shadow [get, set]
 Whether to apply a drop shadow to the graph line. Since 2.3 theshadow can be an object configuration containing color, offsetX,offsetY, opacity and width.Note that in some cases, like stacked columns or other dense layouts, theseries may cast shadows on each other. In that case, thechart.seriesGroupShadow allows applying a common drop shadow to thewhole series group. More...
 
bool ShadowBool [get, set]
 Whether to apply a drop shadow to the graph line. Since 2.3 theshadow can be an object configuration containing color, offsetX,offsetY, opacity and width.Note that in some cases, like stacked columns or other dense layouts, theseries may cast shadows on each other. In that case, thechart.seriesGroupShadow allows applying a common drop shadow to thewhole series group. More...
 
bool ShowCheckbox [get, set]
 If true, a checkbox is displayed next to the legend item to allowselecting the series. The state of the checkbox is determined bythe selected option. More...
 
bool ShowInLegend [get, set]
 Whether to display this particular series or series type in thelegend. Standalone series are shown in legend by default, and linkedseries are not. Since v7.2.0 it is possible to show series that usecolorAxis by setting this option to true. More...
 
string Size [get, set]
 The diameter of the pie relative to the plot area. Can be apercentage or pixel value. Pixel values are given as integers. Thedefault behaviour (as of 3.0) is to scale to the plot area and giveroom for data labels within the plot area.slicedOffset is also included in thedefault size calculation. As a consequence, the size of the pie mayvary when points are updated and data labels more around. In thatcase it is best to set a fixed value, for example "75%". More...
 
double SizeNumber [get, set]
 The diameter of the pie relative to the plot area. Can be apercentage or pixel value. Pixel values are given as integers. Thedefault behaviour (as of 3.0) is to scale to the plot area and giveroom for data labels within the plot area.slicedOffset is also included in thedefault size calculation. As a consequence, the size of the pie mayvary when points are updated and data labels more around. In thatcase it is best to set a fixed value, for example "75%". More...
 
bool SkipKeyboardNavigation [get, set]
 If set to true, the accessibility module will skip past the pointsin this series for keyboard navigation. More...
 
double SlicedOffset [get, set]
 If a point is sliced, moved out from the center, how many pixelsshould it be moved?. More...
 
PlotOptionsSunburstSonification Sonification [get, set]
 Sonification/audio chart options for a series. More...
 
double StartAngle [get, set]
 The start angle of the pie slices in degrees where 0 is top and 90right. More...
 
PlotOptionsSunburstStates States [get, set]
 
bool StickyTracking [get, set]
 Sticky tracking of mouse events. When true, the mouseOut event on aseries isn't triggered until the mouse moves over another series, orout of the plot area. When false, the mouseOut event on a series istriggered when the mouse leaves the area around the series' graph ormarkers. This also implies the tooltip when not shared. WhenstickyTracking is false and tooltip.shared is false, the tooltipwill be hidden when moving the mouse between series. Defaults to truefor line and area type series, but to false for columns, pies etc.**Note:** The boost module will force this option because oftechnical limitations. More...
 
double Thickness [get, set]
 Thickness describing the ring size for a donut type chart,overriding innerSize. More...
 
PlotOptionsSunburstTooltip Tooltip [get, set]
 A configuration object for the tooltip rendering of each singleseries. Properties are inherited from tooltip, but onlythe following properties can be defined on a series level. More...
 
PlotOptionsSunburstTraverseUpButton TraverseUpButton [get, set]
 Options for the button appearing when traversing down in a sunburst.Since v9.3.3 the traverseUpButton is replaced by breadcrumbs. More...
 
bool UseOhlcData [get, set]
 The parameter allows setting line series type and use OHLC indicators.Data in OHLC format is required. More...
 
bool Visible [get, set]
 Set the initial visibility of the series. More...
 
Hashtable CustomFields [get, set]
 

Property Documentation

◆ Accessibility

PlotOptionsSunburstAccessibility Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Accessibility
getset

Accessibility options for a series.

◆ AllowDrillToNode

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.AllowDrillToNode
getset

When enabled the user can click on a point which is a parent andzoom in on its children. Deprecated and replaced byallowTraversingTree.

◆ AllowPointSelect

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.AllowPointSelect
getset

Allow this series' points to be selected by clicking on the graphic(columns, point markers, pie slices, map areas etc).The selected points can be handled by point select and unselectevents, or collectively by the getSelectedPoints function.And alternative way of selecting points is through dragging.

◆ AllowTraversingTree

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.AllowTraversingTree
getset

When enabled the user can click on a point which is a parent andzoom in on its children.

◆ Animation

Animation Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Animation
getset

Enable or disable the initial animation when a series is displayed.The animation can also be set as a configuration object. Pleasenote that this option only applies to the initial animation of theseries itself. For other animations, see chart.animation and the animation parameter under the API methods.The following properties are supported:- defer: The animation delay time in milliseconds.- duration: The duration of the animation in milliseconds. (Defaults to 1000)- easing: Can be a string reference to an easing function set on the Math object or a function. See the Custom easing function demo below. (Defaults to easeInOutSine)Due to poor performance, animation is disabled in old IE browsersfor several chart types.

◆ AnimationBool

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.AnimationBool
getset

Enable or disable the initial animation when a series is displayed.The animation can also be set as a configuration object. Pleasenote that this option only applies to the initial animation of theseries itself. For other animations, see chart.animation and the animation parameter under the API methods.The following properties are supported:- defer: The animation delay time in milliseconds.- duration: The duration of the animation in milliseconds. (Defaults to 1000)- easing: Can be a string reference to an easing function set on the Math object or a function. See the Custom easing function demo below. (Defaults to easeInOutSine)Due to poor performance, animation is disabled in old IE browsersfor several chart types.

◆ BorderColor

string Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.BorderColor
getset

The color of the border surrounding each slice. When null, theborder takes the same color as the slice fill. This can be usedtogether with a borderWidth to fill drawing gaps created byantialiazing artefacts in borderless pies.In styled mode, the border stroke is given in the .highcharts-pointclass.

◆ BorderRadius

Object Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.BorderRadius
getset

The corner radius of the border surrounding each slice. A numbersignifies pixels. A percentage string, like for example 50%, signifiesa size relative to the radius and the inner radius.

◆ BorderRadiusNumber

double Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.BorderRadiusNumber
getset

The corner radius of the border surrounding each slice. A numbersignifies pixels. A percentage string, like for example 50%, signifiesa size relative to the radius and the inner radius.

◆ BorderRadiusString

string Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.BorderRadiusString
getset

The corner radius of the border surrounding each slice. A numbersignifies pixels. A percentage string, like for example 50%, signifiesa size relative to the radius and the inner radius.

◆ BorderWidth

double Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.BorderWidth
getset

The width of the border surrounding each slice.When setting the border width to 0, there may be small gaps betweenthe slices due to SVG antialiasing artefacts. To work around this,keep the border width at 0.5 or 1, but set the borderColor tonull instead.In styled mode, the border stroke width is given in the<tt>.highcharts-point class.

◆ Breadcrumbs

PlotOptionsSunburstBreadcrumbs Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Breadcrumbs
getset

Options for the breadcrumbs, the navigation at the top leading theway up through the traversed levels.

◆ Center

string [] Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Center
getset

The center of the sunburst chart relative to the plot area. Can bepercentages or pixel values.

◆ ClassName

string Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.ClassName
getset

An additional class name to apply to the series' graphical elements.This option does not replace default class names of the graphicalelement. Changes to the series' color will also be reflected in achart's legend and tooltip.

◆ Clip

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Clip
getset

◆ Color

string Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Color
getset

The main color of the series. In line type series it applies to theline and the point markers unless otherwise specified. In bar typeseries it applies to the bars unless a color is specified per point.The default value is pulled from the options.colors array.In styled mode, the color can be defined by thecolorIndex option. Also, the seriescolor can be set with the .highcharts-series,.highcharts-color-{n}, .highcharts-{type}-series or<tt>.highcharts-series-{n} class, or individual classes given by theclassName option.

◆ ColorByPoint

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.ColorByPoint
getset

◆ ColorIndex

double Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.ColorIndex
getset

Styled mode only. A specific color index to use for the series, so itsgraphic representations are given the class name highcharts-color-{n}.Since v11, CSS variables on the form --highcharts-color-{n} makechanging the color scheme very convenient.

◆ Colors

List<string> Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Colors
getset

A series specific or series type specific color set to use insteadof the global colors.

◆ Crisp

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Crisp
getset

When true, each point or column edge is rounded to its nearest pixelin order to render sharp on screen. In some cases, when there are alot of densely packed columns, this leads to visible differencein column widths or distance between columns. In these cases,setting crisp to false may look better, even though each columnis rendered blurry.

◆ Cursor

PlotOptionsSunburstCursor Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Cursor
getset

You can set the cursor to "pointer" if you have click events attachedto the series, to signal to the user that the points and lines canbe clicked.In styled mode, the series cursor can be set with the same classesas listed under series.color.

◆ Custom

Hashtable Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Custom
getset

A reserved subspace to store options and values for customizedfunctionality. Here you can add additional data for your own eventcallbacks and formatter callbacks.

◆ DataLabels

PlotOptionsSunburstDataLabels Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.DataLabels
getset

◆ Description

string Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Description
getset

A description of the series to add to the screen reader informationabout the series.

◆ EnableMouseTracking

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.EnableMouseTracking
getset

Enable or disable the mouse tracking for a specific series. Thisincludes point tooltips and click events on graphs and points. Forlarge datasets it improves performance.

◆ Events

PlotOptionsSunburstEvents Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Events
getset

General event handlers for the series items. These event hooks canalso be attached to the series at run time using theHighcharts.addEvent function.

◆ FillColor

Object Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.FillColor
getset

If the total sum of the pie's values is 0, the series is representedas an empty circle . The fillColor option defines the color of thatcircle. Use pie.borderWidth to setthe border thickness.

◆ InactiveOtherPoints

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.InactiveOtherPoints
getset

Highlight only the hovered point and fade the remaining points.Scatter-type series require enabling the 'inactive' marker state andadjusting opacity. Note that this approach could affect performancewith large datasets.

◆ IncludeInDataExport

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.IncludeInDataExport
getset

When set to false will prevent the series data from being included inany form of data export.Since version 6.0.0 until 7.1.0 the option was existing undocumentedas includeInCSVExport.

◆ Keys

List<string> Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Keys
getset

An array specifying which option maps to which key in the data pointarray. This makes it convenient to work with unstructured data arraysfrom different sources.

◆ LegendSymbol

PlotOptionsSunburstLegendSymbol Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.LegendSymbol
getset

What type of legend symbol to render for this series. Can be one ofareaMarker, lineMarker or rectangle.

◆ LevelIsConstant

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.LevelIsConstant
getset

Used together with the levels and allowDrillToNode options. Whenset to false the first level visible when drilling is consideredto be level one. Otherwise the level will be the same as the treestructure.

◆ Levels

List<PlotOptionsSunburstLevels> Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Levels
getset

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

◆ LevelSize

PlotOptionsSunburstLevelSize Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.LevelSize
getset

Determines the width of the ring per level.

◆ OnPoint

PlotOptionsSunburstOnPoint Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.OnPoint
getset

Options for the Series on point feature. Only pie and sunburst seriesare supported at this moment.

◆ Opacity

double Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Opacity
getset

Opacity of a series parts: line, fill (e.g. area) and dataLabels.

◆ Point

PlotOptionsSunburstPoint Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Point
getset

Properties for each single point.

◆ PointDescriptionFormat

string Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.PointDescriptionFormat
getset

Same asaccessibility.point.descriptionFormat,but for an individual series. Overrides the chart wide configuration.

◆ PointDescriptionFormatter

string Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.PointDescriptionFormatter
getset

Same asaccessibility.series.descriptionFormatter,but for an individual series. Overrides the chart wide configuration.

◆ RelativeXValue

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.RelativeXValue
getset

When true, X values in the data set are relative to the currentpointStart, pointInterval and pointIntervalUnit settings. Thisallows compression of the data for datasets with irregular X values.The real X values are computed on the formula f(x) = ax + b, wherea is the pointInterval (optionally with a time unit given bypointIntervalUnit), and b is the pointStart.

◆ RootId

string Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.RootId
getset

Which point to use as a root in the visualization.

◆ Selected

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Selected
getset

Whether to select the series initially. If showCheckbox is true,the checkbox next to the series name in the legend will be checkedfor a selected series.

◆ Shadow

Shadow Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Shadow
getset

Whether to apply a drop shadow to the graph line. Since 2.3 theshadow can be an object configuration containing color, offsetX,offsetY, opacity and width.Note that in some cases, like stacked columns or other dense layouts, theseries may cast shadows on each other. In that case, thechart.seriesGroupShadow allows applying a common drop shadow to thewhole series group.

◆ ShadowBool

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.ShadowBool
getset

Whether to apply a drop shadow to the graph line. Since 2.3 theshadow can be an object configuration containing color, offsetX,offsetY, opacity and width.Note that in some cases, like stacked columns or other dense layouts, theseries may cast shadows on each other. In that case, thechart.seriesGroupShadow allows applying a common drop shadow to thewhole series group.

◆ ShowCheckbox

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.ShowCheckbox
getset

If true, a checkbox is displayed next to the legend item to allowselecting the series. The state of the checkbox is determined bythe selected option.

◆ ShowInLegend

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.ShowInLegend
getset

Whether to display this particular series or series type in thelegend. Standalone series are shown in legend by default, and linkedseries are not. Since v7.2.0 it is possible to show series that usecolorAxis by setting this option to true.

◆ Size

string Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Size
getset

The diameter of the pie relative to the plot area. Can be apercentage or pixel value. Pixel values are given as integers. Thedefault behaviour (as of 3.0) is to scale to the plot area and giveroom for data labels within the plot area.slicedOffset is also included in thedefault size calculation. As a consequence, the size of the pie mayvary when points are updated and data labels more around. In thatcase it is best to set a fixed value, for example "75%".

◆ SizeNumber

double Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.SizeNumber
getset

The diameter of the pie relative to the plot area. Can be apercentage or pixel value. Pixel values are given as integers. Thedefault behaviour (as of 3.0) is to scale to the plot area and giveroom for data labels within the plot area.slicedOffset is also included in thedefault size calculation. As a consequence, the size of the pie mayvary when points are updated and data labels more around. In thatcase it is best to set a fixed value, for example "75%".

◆ SkipKeyboardNavigation

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.SkipKeyboardNavigation
getset

If set to true, the accessibility module will skip past the pointsin this series for keyboard navigation.

◆ SlicedOffset

double Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.SlicedOffset
getset

If a point is sliced, moved out from the center, how many pixelsshould it be moved?.

◆ Sonification

PlotOptionsSunburstSonification Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Sonification
getset

Sonification/audio chart options for a series.

◆ StartAngle

double Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.StartAngle
getset

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

◆ States

PlotOptionsSunburstStates Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.States
getset

◆ StickyTracking

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.StickyTracking
getset

Sticky tracking of mouse events. When true, the mouseOut event on aseries isn't triggered until the mouse moves over another series, orout of the plot area. When false, the mouseOut event on a series istriggered when the mouse leaves the area around the series' graph ormarkers. This also implies the tooltip when not shared. WhenstickyTracking is false and tooltip.shared is false, the tooltipwill be hidden when moving the mouse between series. Defaults to truefor line and area type series, but to false for columns, pies etc.**Note:** The boost module will force this option because oftechnical limitations.

◆ Thickness

double Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Thickness
getset

Thickness describing the ring size for a donut type chart,overriding innerSize.

◆ Tooltip

PlotOptionsSunburstTooltip Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Tooltip
getset

A configuration object for the tooltip rendering of each singleseries. Properties are inherited from tooltip, but onlythe following properties can be defined on a series level.

◆ TraverseUpButton

PlotOptionsSunburstTraverseUpButton Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.TraverseUpButton
getset

Options for the button appearing when traversing down in a sunburst.Since v9.3.3 the traverseUpButton is replaced by breadcrumbs.

◆ UseOhlcData

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.UseOhlcData
getset

The parameter allows setting line series type and use OHLC indicators.Data in OHLC format is required.

◆ Visible

bool Highsoft.Web.Mvc.Charts.PlotOptionsSunburst.Visible
getset

Set the initial visibility of the series.


The documentation for this class was generated from the following file: