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

Inherits BaseObject.

Properties

PlotOptionsSankeyAccessibility 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 column or bar.In styled mode, the border stroke can be set with the<tt>.highcharts-point rule. More...
 
double BorderWidth [get, set]
 
bool CenterInCategory [get, set]
 When true, the columns will center in the category, ignoring nullor missing points. When false, space will be reserved for null ormissing points. 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...
 
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 apply insteadof the global colors when colorByPoint is true. More...
 
PlotOptionsSankeyCursor 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...
 
double CurveFactor [get, set]
 Higher numbers makes the links in a sankey diagram or dependencywheelrender more curved. A curveFactor of 0 makes the linesstraight. 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...
 
PlotOptionsSankeyDashStyle DashStyle [get, set]
 Name of the dash style to use for the graph, or for some series typesthe outline of each shape.In styled mode, thestroke dash-arraycan be set with the same classes as listed underseries.color. More...
 
PlotOptionsSankeyDataLabels DataLabels [get, set]
 Options for the data labels appearing on top of the nodes and links.For sankey charts, data labels are visible for the nodes by default,but hidden for links. This is controlled by modifying thenodeFormat, and the format that applies to links and is an emptystring by default. 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...
 
PlotOptionsSankeyEvents 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...
 
bool GetExtremesFromAll [get, set]
 Whether to use the Y extremes of the total chart width or only thezoomed area when zooming in on parts of the X axis. By default, theY axis adjusts to the min and max of the visible data. Cartesianseries only. More...
 
PlotOptionsSankeyInactiveOtherPoints InactiveOtherPoints [get, set]
 
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...
 
PlotOptionsSankeyLabel Label [get, set]
 Series labels are placed as close to the series as possible in anatural way, seeking to avoid other series. The goal of thisfeature is to make the chart more easily readable, like if ahuman designer placed the labels in the optimal position.The series labels currently work with series types having agraph or an area. More...
 
PlotOptionsSankeyLegendSymbol LegendSymbol [get, set]
 What type of legend symbol to render for this series. Can be one ofareaMarker, lineMarker or rectangle. More...
 
PlotOptionsSankeyLevels Levels [get, set]
 Set options on specific levels. Takes precedence over series options,but not node and link options. More...
 
PlotOptionsSankeyLinkColorMode LinkColorMode [get, set]
 Determines color mode for sankey links. Available options:- from color of the sankey link will be the same as the 'from node'- gradient color of the sankey link will be set to gradient betweencolors of 'from node' and 'to node'- to color of the sankey link will be same as the 'to node'. More...
 
string LinkedTo [get, set]
 The id of another series to link to. Additionally,the value can be ":previous" to link to the previous series. Whentwo series are linked, only the first one appears in the legend.Toggling the visibility of this also toggles the linked series.If master series uses data sorting and linked series does not haveits own sorting definition, the linked series will be sorted in thesame order as the master one. More...
 
double LinkOpacity [get, set]
 Opacity for the links between nodes in the sankey diagram. More...
 
double MinLinkWidth [get, set]
 The minimal width for a line of a sankey. By default,0 values are not shown. More...
 
PlotOptionsSankeyNodeAlignment NodeAlignment [get, set]
 Determines which side of the chart the nodes are to be aligned to. Whenthe chart is inverted, top aligns to the left and bottom to theright. More...
 
double NodePadding [get, set]
 The padding between nodes in a sankey diagram or dependency wheel, inpixels.If the number of nodes is so great that it is possible to lay themout within the plot area with the given nodePadding, they will berendered with a smaller padding as a strategy to avoid overflow. More...
 
double NodeWidth [get, set]
 The pixel width of each node in a sankey diagram or dependency wheel,or the height in case the chart is inverted. More...
 
PlotOptionsSankeyOnPoint 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 for the nodes in the sankey diagram. More...
 
PlotOptionsSankeyPoint 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...
 
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]
 
bool SkipKeyboardNavigation [get, set]
 If set to true, the accessibility module will skip past the pointsin this series for keyboard navigation. More...
 
PlotOptionsSankeySonification Sonification [get, set]
 Sonification/audio chart options for a series. More...
 
PlotOptionsSankeyStates 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...
 
PlotOptionsSankeyTooltip Tooltip [get, set]
 
double TurboThreshold [get, set]
 When a series contains a data array that is longer than this, onlyone dimensional arrays of numbers, or two dimensional arrays withx and y values are allowed. Also, only the first point is tested,and the rest are assumed to be the same format. This saves expensivedata checking and indexing in long series. Set it to 0 disable.Note:In boost mode turbo threshold is forced. Only array of numbers ortwo dimensional arrays are allowed. More...
 
bool Visible [get, set]
 Set the initial visibility of the series. More...
 
Hashtable CustomFields [get, set]
 

Property Documentation

◆ Accessibility

PlotOptionsSankeyAccessibility Highsoft.Web.Mvc.Charts.PlotOptionsSankey.Accessibility
getset

Accessibility options for a series.

◆ AllowPointSelect

bool Highsoft.Web.Mvc.Charts.PlotOptionsSankey.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.PlotOptionsSankey.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.PlotOptionsSankey.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.PlotOptionsSankey.BorderColor
getset

The color of the border surrounding each column or bar.In styled mode, the border stroke can be set with the<tt>.highcharts-point rule.

◆ BorderWidth

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

◆ CenterInCategory

bool Highsoft.Web.Mvc.Charts.PlotOptionsSankey.CenterInCategory
getset

When true, the columns will center in the category, ignoring nullor missing points. When false, space will be reserved for null ormissing points.

◆ ClassName

string Highsoft.Web.Mvc.Charts.PlotOptionsSankey.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.PlotOptionsSankey.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.PlotOptionsSankey.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.PlotOptionsSankey.ColorByPoint
getset

◆ ColorIndex

double Highsoft.Web.Mvc.Charts.PlotOptionsSankey.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.PlotOptionsSankey.Colors
getset

A series specific or series type specific color set to apply insteadof the global colors when colorByPoint is true.

◆ Cursor

PlotOptionsSankeyCursor Highsoft.Web.Mvc.Charts.PlotOptionsSankey.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.

◆ CurveFactor

double Highsoft.Web.Mvc.Charts.PlotOptionsSankey.CurveFactor
getset

Higher numbers makes the links in a sankey diagram or dependencywheelrender more curved. A curveFactor of 0 makes the linesstraight.

◆ Custom

Hashtable Highsoft.Web.Mvc.Charts.PlotOptionsSankey.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.

◆ DashStyle

PlotOptionsSankeyDashStyle Highsoft.Web.Mvc.Charts.PlotOptionsSankey.DashStyle
getset

Name of the dash style to use for the graph, or for some series typesthe outline of each shape.In styled mode, thestroke dash-arraycan be set with the same classes as listed underseries.color.

◆ DataLabels

PlotOptionsSankeyDataLabels Highsoft.Web.Mvc.Charts.PlotOptionsSankey.DataLabels
getset

Options for the data labels appearing on top of the nodes and links.For sankey charts, data labels are visible for the nodes by default,but hidden for links. This is controlled by modifying thenodeFormat, and the format that applies to links and is an emptystring by default.

◆ Description

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

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

◆ EnableMouseTracking

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

PlotOptionsSankeyEvents Highsoft.Web.Mvc.Charts.PlotOptionsSankey.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.

◆ GetExtremesFromAll

bool Highsoft.Web.Mvc.Charts.PlotOptionsSankey.GetExtremesFromAll
getset

Whether to use the Y extremes of the total chart width or only thezoomed area when zooming in on parts of the X axis. By default, theY axis adjusts to the min and max of the visible data. Cartesianseries only.

◆ InactiveOtherPoints

PlotOptionsSankeyInactiveOtherPoints Highsoft.Web.Mvc.Charts.PlotOptionsSankey.InactiveOtherPoints
getset

◆ IncludeInDataExport

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

◆ Label

PlotOptionsSankeyLabel Highsoft.Web.Mvc.Charts.PlotOptionsSankey.Label
getset

Series labels are placed as close to the series as possible in anatural way, seeking to avoid other series. The goal of thisfeature is to make the chart more easily readable, like if ahuman designer placed the labels in the optimal position.The series labels currently work with series types having agraph or an area.

◆ LegendSymbol

PlotOptionsSankeyLegendSymbol Highsoft.Web.Mvc.Charts.PlotOptionsSankey.LegendSymbol
getset

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

◆ Levels

PlotOptionsSankeyLevels Highsoft.Web.Mvc.Charts.PlotOptionsSankey.Levels
getset

Set options on specific levels. Takes precedence over series options,but not node and link options.

◆ LinkColorMode

PlotOptionsSankeyLinkColorMode Highsoft.Web.Mvc.Charts.PlotOptionsSankey.LinkColorMode
getset

Determines color mode for sankey links. Available options:- from color of the sankey link will be the same as the 'from node'- gradient color of the sankey link will be set to gradient betweencolors of 'from node' and 'to node'- to color of the sankey link will be same as the 'to node'.

◆ LinkedTo

string Highsoft.Web.Mvc.Charts.PlotOptionsSankey.LinkedTo
getset

The id of another series to link to. Additionally,the value can be ":previous" to link to the previous series. Whentwo series are linked, only the first one appears in the legend.Toggling the visibility of this also toggles the linked series.If master series uses data sorting and linked series does not haveits own sorting definition, the linked series will be sorted in thesame order as the master one.

◆ LinkOpacity

double Highsoft.Web.Mvc.Charts.PlotOptionsSankey.LinkOpacity
getset

Opacity for the links between nodes in the sankey diagram.

◆ MinLinkWidth

double Highsoft.Web.Mvc.Charts.PlotOptionsSankey.MinLinkWidth
getset

The minimal width for a line of a sankey. By default,0 values are not shown.

◆ NodeAlignment

PlotOptionsSankeyNodeAlignment Highsoft.Web.Mvc.Charts.PlotOptionsSankey.NodeAlignment
getset

Determines which side of the chart the nodes are to be aligned to. Whenthe chart is inverted, top aligns to the left and bottom to theright.

◆ NodePadding

double Highsoft.Web.Mvc.Charts.PlotOptionsSankey.NodePadding
getset

The padding between nodes in a sankey diagram or dependency wheel, inpixels.If the number of nodes is so great that it is possible to lay themout within the plot area with the given nodePadding, they will berendered with a smaller padding as a strategy to avoid overflow.

◆ NodeWidth

double Highsoft.Web.Mvc.Charts.PlotOptionsSankey.NodeWidth
getset

The pixel width of each node in a sankey diagram or dependency wheel,or the height in case the chart is inverted.

◆ OnPoint

PlotOptionsSankeyOnPoint Highsoft.Web.Mvc.Charts.PlotOptionsSankey.OnPoint
getset

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

◆ Opacity

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

Opacity for the nodes in the sankey diagram.

◆ Point

PlotOptionsSankeyPoint Highsoft.Web.Mvc.Charts.PlotOptionsSankey.Point
getset

Properties for each single point.

◆ PointDescriptionFormat

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

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

◆ PointDescriptionFormatter

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

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

◆ RelativeXValue

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

◆ ShowCheckbox

bool Highsoft.Web.Mvc.Charts.PlotOptionsSankey.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.PlotOptionsSankey.ShowInLegend
getset

◆ SkipKeyboardNavigation

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

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

◆ Sonification

PlotOptionsSankeySonification Highsoft.Web.Mvc.Charts.PlotOptionsSankey.Sonification
getset

Sonification/audio chart options for a series.

◆ States

PlotOptionsSankeyStates Highsoft.Web.Mvc.Charts.PlotOptionsSankey.States
getset

◆ StickyTracking

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

◆ Tooltip

PlotOptionsSankeyTooltip Highsoft.Web.Mvc.Charts.PlotOptionsSankey.Tooltip
getset

◆ TurboThreshold

double Highsoft.Web.Mvc.Charts.PlotOptionsSankey.TurboThreshold
getset

When a series contains a data array that is longer than this, onlyone dimensional arrays of numbers, or two dimensional arrays withx and y values are allowed. Also, only the first point is tested,and the rest are assumed to be the same format. This saves expensivedata checking and indexing in long series. Set it to 0 disable.Note:In boost mode turbo threshold is forced. Only array of numbers ortwo dimensional arrays are allowed.

◆ Visible

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

Set the initial visibility of the series.


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