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

Inherits Highsoft.Web.Mvc.Charts.Series.

Properties

VariablepieSeriesAccessibility Accessibility [get, set]
 Accessibility options for a series. 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...
 
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...
 
string [] Center [get, set]
 The center of the pie chart relative to the plot area. Can bepercentages or pixel values. The default behaviour (as of 3.0) is tocenter the pie so that all slices and data labels are within the plotarea. As a consequence, the pie may actually jump around in a chartwith dynamic values, as the data labels move. In that case, thecenter should be explicitly set, for example to ["50%", "50%"]. 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]
 Disable this option to allow series rendering in the whole plottingarea.**Note:** Clipping should be always enabled whenchart.zoomType is set More...
 
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...
 
string ColorAxis [get, set]
 When using dual or multiple color axes, this number defines whichcolorAxis the particular series is connected to. It refers toeither theidor the index of the axis in the colorAxis array, with 0 being thefirst. Set this option to false to prevent a series from connectingto the default color axis.Since v7.2.0 the option can also be an axis id or an axis indexinstead of a boolean flag. More...
 
double ColorAxisNumber [get, set]
 When using dual or multiple color axes, this number defines whichcolorAxis the particular series is connected to. It refers toeither theidor the index of the axis in the colorAxis array, with 0 being thefirst. Set this option to false to prevent a series from connectingto the default color axis.Since v7.2.0 the option can also be an axis id or an axis indexinstead of a boolean flag. More...
 
bool ColorAxisBool [get, set]
 When using dual or multiple color axes, this number defines whichcolorAxis the particular series is connected to. It refers toeither theidor the index of the axis in the colorAxis array, with 0 being thefirst. Set this option to false to prevent a series from connectingto the default color axis.Since v7.2.0 the option can also be an axis id or an axis indexinstead of a boolean flag. More...
 
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...
 
string ColorKey [get, set]
 Determines what data value should be used to calculate point colorif colorAxis is used. Requires to set min and max if somecustom point property is used or if approximation for data groupingis set to ‘'sum’`. 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...
 
VariablepieSeriesCursor 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...
 
List< VariablepieSeriesDataData [get, set]
 An array of data points for the series. For the variablepie series type,points can be given in the following ways:1. An array of arrays with 2 values. In this case, the numerical values will be interpreted as y, z options. Example: js data: [ [40, 75], [50, 50], [60, 40] ]2. An array of objects with named values. The following snippet shows only a few settings, see the complete options set below. If the total number of data points exceeds the series' turboThreshold, this option is not available. js data: [{ y: 1, z: 4, name: "Point2", color: "#00FF00" }, { y: 7, z: 10, name: "Point1", color: "#FF00FF" }] More...
 
VariablepieSeriesDataLabels DataLabels [get, set]
 Options for the series data labels, appearing next to each datapoint.Since v6.2.0, multiple data labels can be applied to each singlepoint by defining them as an array of configs.In styled mode, the data labels can be styled with the<tt>.highcharts-data-label-box and .highcharts-data-label class names(see example). More...
 
double Depth [get, set]
 The thickness of a 3D pie. More...
 
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...
 
double EndAngle [get, set]
 The end angle of the pie in degrees where 0 is top and 90 is right.Defaults to startAngle plus 360. More...
 
VariablepieSeriesEvents 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...
 
override string Id [get, set]
 An id for the series. This can be used after render time to get a pointerto the series object through chart.get(). More...
 
override string Id_DefaultValue [get, set]
 
bool IgnoreHiddenPoint [get, set]
 Equivalent to chart.ignoreHiddenSeries,this option tells whether the series shall be redrawn as if thehidden point were null.The default value changed from false to true with Highcharts3.0. 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...
 
override double Index [get, set]
 The index of the series in the chart, affecting the internal index in thechart.series array, the visible Z index as well as the order in thelegend. More...
 
override double Index_DefaultValue [get, set]
 
string InnerSize [get, set]
 The size of the inner diameter for the pie. A size greater than 0renders a donut chart. Can be a percentage or pixel value.Percentages are relative to the pie size. Pixel values are given asintegers. Setting overridden by thickness.Note: in Highcharts < 4.1.2, the percentage was relative to the plotarea, not the pie size. More...
 
double InnerSizeNumber [get, set]
 The size of the inner diameter for the pie. A size greater than 0renders a donut chart. Can be a percentage or pixel value.Percentages are relative to the pie size. Pixel values are given asintegers. Setting overridden by thickness.Note: in Highcharts < 4.1.2, the percentage was relative to the plotarea, not the pie size. 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...
 
override double LegendIndex [get, set]
 The sequential index of the series in the legend. More...
 
override double LegendIndex_DefaultValue [get, set]
 
VariablepieSeriesLegendSymbol LegendSymbol [get, set]
 What type of legend symbol to render for this series. Can be one ofareaMarker, lineMarker or rectangle. More...
 
VariablepieSeriesLinecap Linecap [get, set]
 The line cap used for line ends and line joins on the graph. More...
 
string MaxPointSize [get, set]
 The maximum size of the points' radius related to chart's plotArea.If a number is set, it applies in pixels. More...
 
double MaxPointSizeNumber [get, set]
 The maximum size of the points' radius related to chart's plotArea.If a number is set, it applies in pixels. More...
 
string MinPointSize [get, set]
 The minimum size of the points' radius related to chart's plotArea.If a number is set, it applies in pixels. More...
 
double MinPointSizeNumber [get, set]
 The minimum size of the points' radius related to chart's plotArea.If a number is set, it applies in pixels. More...
 
string MinSize [get, set]
 The minimum size for a pie in response to auto margins. The pie willtry to shrink to make room for data labels in side the plot area, but only to this size. More...
 
double MinSizeNumber [get, set]
 The minimum size for a pie in response to auto margins. The pie willtry to shrink to make room for data labels in side the plot area, but only to this size. More...
 
override string Name [get, set]
 The name of the series as shown in the legend, tooltip etc. More...
 
override string Name_DefaultValue [get, set]
 
VariablepieSeriesOnPoint 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...
 
VariablepieSeriesPoint 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...
 
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...
 
string SizeBy [get, set]
 Whether the pie slice's value should be represented by the area orthe radius of the slice. Can be either area or radius. Thedefault, area, corresponds best to the human perception of the sizeof each pie slice. 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...
 
VariablepieSeriesSonification 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...
 
VariablepieSeriesStates 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...
 
VariablepieSeriesTooltip 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...
 
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...
 
override double ZIndex [get, set]
 Define the visual z index of the series. More...
 
override double ZIndex_DefaultValue [get, set]
 
double ZMax [get, set]
 The maximum possible z value for the point's radius calculation. Ifthe point's Z value is bigger than zMax, the slice will be drawnaccording to the zMax value More...
 
double ZMin [get, set]
 The minimum possible z value for the point's radius calculation. Ifthe point's Z value is smaller than zMin, the slice will be drawnaccording to the zMin value. More...
 
Hashtable CustomFields [get, set]
 
- Properties inherited from Highsoft.Web.Mvc.Charts.Series
virtual string Id [get, set]
 An id for the series. This can be used after render time to get a pointerto the series object through chart.get(). More...
 
virtual string Id_DefaultValue [get, set]
 
virtual double Index [get, set]
 The index of the series in the chart, affecting the internal index in thechart.series array, the visible Z index as well as the order in thelegend. More...
 
virtual double Index_DefaultValue [get, set]
 
virtual double LegendIndex [get, set]
 The sequential index of the series in the legend. More...
 
virtual double LegendIndex_DefaultValue [get, set]
 
virtual string Name [get, set]
 The name of the series as shown in the legend, tooltip etc. More...
 
virtual string Name_DefaultValue [get, set]
 
virtual string Stack [get, set]
 This option allows grouping series in a stacked chart. The stack optioncan be a string or anything else, as long as the grouped series' stackoptions match each other after conversion into a string. More...
 
virtual string Stack_DefaultValue [get, set]
 
virtual double StackNumber [get, set]
 This option allows grouping series in a stacked chart. The stack optioncan be a string or anything else, as long as the grouped series' stackoptions match each other after conversion into a string. More...
 
virtual double StackNumber_DefaultValue [get, set]
 
virtual string XAxis [get, set]
 When using dual or multiple x axes, this number defines which xAxis theparticular series is connected to. It refers to either theidor the index of the axis in the xAxis array, with 0 being the first. More...
 
virtual string XAxis_DefaultValue [get, set]
 
virtual double XAxisNumber [get, set]
 When using dual or multiple x axes, this number defines which xAxis theparticular series is connected to. It refers to either theidor the index of the axis in the xAxis array, with 0 being the first. More...
 
virtual double XAxisNumber_DefaultValue [get, set]
 
virtual string YAxis [get, set]
 When using dual or multiple y axes, this number defines which yAxis theparticular series is connected to. It refers to either theidor the index of the axis in the yAxis array, with 0 being the first. More...
 
virtual string YAxis_DefaultValue [get, set]
 
virtual double YAxisNumber [get, set]
 When using dual or multiple y axes, this number defines which yAxis theparticular series is connected to. It refers to either theidor the index of the axis in the yAxis array, with 0 being the first. More...
 
virtual double YAxisNumber_DefaultValue [get, set]
 
virtual double ZIndex [get, set]
 Define the visual z index of the series. More...
 
virtual double ZIndex_DefaultValue [get, set]
 
Hashtable CustomFields [get, set]
 

Property Documentation

◆ Accessibility

VariablepieSeriesAccessibility Highsoft.Web.Mvc.Charts.VariablepieSeries.Accessibility
getset

Accessibility options for a series.

◆ AllowPointSelect

bool Highsoft.Web.Mvc.Charts.VariablepieSeries.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.

◆ Animation

Animation Highsoft.Web.Mvc.Charts.VariablepieSeries.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.VariablepieSeries.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.VariablepieSeries.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.VariablepieSeries.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.VariablepieSeries.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.VariablepieSeries.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.VariablepieSeries.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.

◆ Center

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

The center of the pie chart relative to the plot area. Can bepercentages or pixel values. The default behaviour (as of 3.0) is tocenter the pie so that all slices and data labels are within the plotarea. As a consequence, the pie may actually jump around in a chartwith dynamic values, as the data labels move. In that case, thecenter should be explicitly set, for example to ["50%", "50%"].

◆ ClassName

string Highsoft.Web.Mvc.Charts.VariablepieSeries.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.VariablepieSeries.Clip
getset

Disable this option to allow series rendering in the whole plottingarea.**Note:** Clipping should be always enabled whenchart.zoomType is set

◆ Color

string Highsoft.Web.Mvc.Charts.VariablepieSeries.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.

◆ ColorAxis

string Highsoft.Web.Mvc.Charts.VariablepieSeries.ColorAxis
getset

When using dual or multiple color axes, this number defines whichcolorAxis the particular series is connected to. It refers toeither theidor the index of the axis in the colorAxis array, with 0 being thefirst. Set this option to false to prevent a series from connectingto the default color axis.Since v7.2.0 the option can also be an axis id or an axis indexinstead of a boolean flag.

◆ ColorAxisBool

bool Highsoft.Web.Mvc.Charts.VariablepieSeries.ColorAxisBool
getset

When using dual or multiple color axes, this number defines whichcolorAxis the particular series is connected to. It refers toeither theidor the index of the axis in the colorAxis array, with 0 being thefirst. Set this option to false to prevent a series from connectingto the default color axis.Since v7.2.0 the option can also be an axis id or an axis indexinstead of a boolean flag.

◆ ColorAxisNumber

double Highsoft.Web.Mvc.Charts.VariablepieSeries.ColorAxisNumber
getset

When using dual or multiple color axes, this number defines whichcolorAxis the particular series is connected to. It refers toeither theidor the index of the axis in the colorAxis array, with 0 being thefirst. Set this option to false to prevent a series from connectingto the default color axis.Since v7.2.0 the option can also be an axis id or an axis indexinstead of a boolean flag.

◆ ColorIndex

double Highsoft.Web.Mvc.Charts.VariablepieSeries.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.

◆ ColorKey

string Highsoft.Web.Mvc.Charts.VariablepieSeries.ColorKey
getset

Determines what data value should be used to calculate point colorif colorAxis is used. Requires to set min and max if somecustom point property is used or if approximation for data groupingis set to ‘'sum’`.

◆ Colors

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

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

◆ Crisp

bool Highsoft.Web.Mvc.Charts.VariablepieSeries.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

VariablepieSeriesCursor Highsoft.Web.Mvc.Charts.VariablepieSeries.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.VariablepieSeries.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.

◆ Data

List<VariablepieSeriesData> Highsoft.Web.Mvc.Charts.VariablepieSeries.Data
getset

An array of data points for the series. For the variablepie series type,points can be given in the following ways:1. An array of arrays with 2 values. In this case, the numerical values will be interpreted as y, z options. Example: js data: [ [40, 75], [50, 50], [60, 40] ]2. An array of objects with named values. The following snippet shows only a few settings, see the complete options set below. If the total number of data points exceeds the series' turboThreshold, this option is not available. js data: [{ y: 1, z: 4, name: "Point2", color: "#00FF00" }, { y: 7, z: 10, name: "Point1", color: "#FF00FF" }]

◆ DataLabels

VariablepieSeriesDataLabels Highsoft.Web.Mvc.Charts.VariablepieSeries.DataLabels
getset

Options for the series data labels, appearing next to each datapoint.Since v6.2.0, multiple data labels can be applied to each singlepoint by defining them as an array of configs.In styled mode, the data labels can be styled with the<tt>.highcharts-data-label-box and .highcharts-data-label class names(see example).

◆ Depth

double Highsoft.Web.Mvc.Charts.VariablepieSeries.Depth
getset

The thickness of a 3D pie.

◆ Description

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

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

◆ EnableMouseTracking

bool Highsoft.Web.Mvc.Charts.VariablepieSeries.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.

◆ EndAngle

double Highsoft.Web.Mvc.Charts.VariablepieSeries.EndAngle
getset

The end angle of the pie in degrees where 0 is top and 90 is right.Defaults to startAngle plus 360.

◆ Events

VariablepieSeriesEvents Highsoft.Web.Mvc.Charts.VariablepieSeries.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.VariablepieSeries.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.

◆ Id

override string Highsoft.Web.Mvc.Charts.VariablepieSeries.Id
getset

An id for the series. This can be used after render time to get a pointerto the series object through chart.get().

◆ IgnoreHiddenPoint

bool Highsoft.Web.Mvc.Charts.VariablepieSeries.IgnoreHiddenPoint
getset

Equivalent to chart.ignoreHiddenSeries,this option tells whether the series shall be redrawn as if thehidden point were null.The default value changed from false to true with Highcharts3.0.

◆ InactiveOtherPoints

bool Highsoft.Web.Mvc.Charts.VariablepieSeries.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.VariablepieSeries.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.

◆ Index

override double Highsoft.Web.Mvc.Charts.VariablepieSeries.Index
getset

The index of the series in the chart, affecting the internal index in thechart.series array, the visible Z index as well as the order in thelegend.

◆ InnerSize

string Highsoft.Web.Mvc.Charts.VariablepieSeries.InnerSize
getset

The size of the inner diameter for the pie. A size greater than 0renders a donut chart. Can be a percentage or pixel value.Percentages are relative to the pie size. Pixel values are given asintegers. Setting overridden by thickness.Note: in Highcharts < 4.1.2, the percentage was relative to the plotarea, not the pie size.

◆ InnerSizeNumber

double Highsoft.Web.Mvc.Charts.VariablepieSeries.InnerSizeNumber
getset

The size of the inner diameter for the pie. A size greater than 0renders a donut chart. Can be a percentage or pixel value.Percentages are relative to the pie size. Pixel values are given asintegers. Setting overridden by thickness.Note: in Highcharts < 4.1.2, the percentage was relative to the plotarea, not the pie size.

◆ Keys

List<string> Highsoft.Web.Mvc.Charts.VariablepieSeries.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.

◆ LegendIndex

override double Highsoft.Web.Mvc.Charts.VariablepieSeries.LegendIndex
getset

The sequential index of the series in the legend.

◆ LegendSymbol

VariablepieSeriesLegendSymbol Highsoft.Web.Mvc.Charts.VariablepieSeries.LegendSymbol
getset

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

◆ Linecap

VariablepieSeriesLinecap Highsoft.Web.Mvc.Charts.VariablepieSeries.Linecap
getset

The line cap used for line ends and line joins on the graph.

◆ MaxPointSize

string Highsoft.Web.Mvc.Charts.VariablepieSeries.MaxPointSize
getset

The maximum size of the points' radius related to chart's plotArea.If a number is set, it applies in pixels.

◆ MaxPointSizeNumber

double Highsoft.Web.Mvc.Charts.VariablepieSeries.MaxPointSizeNumber
getset

The maximum size of the points' radius related to chart's plotArea.If a number is set, it applies in pixels.

◆ MinPointSize

string Highsoft.Web.Mvc.Charts.VariablepieSeries.MinPointSize
getset

The minimum size of the points' radius related to chart's plotArea.If a number is set, it applies in pixels.

◆ MinPointSizeNumber

double Highsoft.Web.Mvc.Charts.VariablepieSeries.MinPointSizeNumber
getset

The minimum size of the points' radius related to chart's plotArea.If a number is set, it applies in pixels.

◆ MinSize

string Highsoft.Web.Mvc.Charts.VariablepieSeries.MinSize
getset

The minimum size for a pie in response to auto margins. The pie willtry to shrink to make room for data labels in side the plot area, but only to this size.

◆ MinSizeNumber

double Highsoft.Web.Mvc.Charts.VariablepieSeries.MinSizeNumber
getset

The minimum size for a pie in response to auto margins. The pie willtry to shrink to make room for data labels in side the plot area, but only to this size.

◆ Name

override string Highsoft.Web.Mvc.Charts.VariablepieSeries.Name
getset

The name of the series as shown in the legend, tooltip etc.

◆ OnPoint

VariablepieSeriesOnPoint Highsoft.Web.Mvc.Charts.VariablepieSeries.OnPoint
getset

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

◆ Opacity

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

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

◆ Point

VariablepieSeriesPoint Highsoft.Web.Mvc.Charts.VariablepieSeries.Point
getset

Properties for each single point.

◆ PointDescriptionFormat

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

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

◆ PointDescriptionFormatter

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

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

◆ RelativeXValue

bool Highsoft.Web.Mvc.Charts.VariablepieSeries.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.

◆ Selected

bool Highsoft.Web.Mvc.Charts.VariablepieSeries.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.VariablepieSeries.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.VariablepieSeries.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.VariablepieSeries.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.VariablepieSeries.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.VariablepieSeries.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%".

◆ SizeBy

string Highsoft.Web.Mvc.Charts.VariablepieSeries.SizeBy
getset

Whether the pie slice's value should be represented by the area orthe radius of the slice. Can be either area or radius. Thedefault, area, corresponds best to the human perception of the sizeof each pie slice.

◆ SizeNumber

double Highsoft.Web.Mvc.Charts.VariablepieSeries.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.VariablepieSeries.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.VariablepieSeries.SlicedOffset
getset

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

◆ Sonification

VariablepieSeriesSonification Highsoft.Web.Mvc.Charts.VariablepieSeries.Sonification
getset

Sonification/audio chart options for a series.

◆ StartAngle

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

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

◆ States

VariablepieSeriesStates Highsoft.Web.Mvc.Charts.VariablepieSeries.States
getset

◆ StickyTracking

bool Highsoft.Web.Mvc.Charts.VariablepieSeries.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.VariablepieSeries.Thickness
getset

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

◆ Tooltip

VariablepieSeriesTooltip Highsoft.Web.Mvc.Charts.VariablepieSeries.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.

◆ UseOhlcData

bool Highsoft.Web.Mvc.Charts.VariablepieSeries.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.VariablepieSeries.Visible
getset

Set the initial visibility of the series.

◆ ZIndex

override double Highsoft.Web.Mvc.Charts.VariablepieSeries.ZIndex
getset

Define the visual z index of the series.

◆ ZMax

double Highsoft.Web.Mvc.Charts.VariablepieSeries.ZMax
getset

The maximum possible z value for the point's radius calculation. Ifthe point's Z value is bigger than zMax, the slice will be drawnaccording to the zMax value

◆ ZMin

double Highsoft.Web.Mvc.Charts.VariablepieSeries.ZMin
getset

The minimum possible z value for the point's radius calculation. Ifthe point's Z value is smaller than zMin, the slice will be drawnaccording to the zMin value.


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