|
SankeySeriesAccessibility | 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...
|
|
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] |
| When using automatic point colors pulled from the global[colors](colors) or series-specificplotOptions.column.colors collections, this optiondetermines whether the chart should receive one color per series orone color per point.In styled mode, the colors or series.colors arrays are notsupported, and instead this option gives the points individual colorclass names on the form highcharts-color-{n} . 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...
|
|
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...
|
|
SankeySeriesCursor | 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...
|
|
SankeySeriesDashStyle | 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...
|
|
List< SankeySeriesData > | Data [get, set] |
| An array of data points for the series. For the sankey series type,points can be given in the following way:An array of objects with named values. The following snippet shows only afew settings, see the complete options set below. If the total number of datapoints exceeds the series' turboThreshold,this option is not available. js data: [{ from: 'Category1', to: 'Category2', weight: 2 }, { from: 'Category1', to: 'Category3', weight: 5 }] When you provide the data as tuples, the keys option has to be set as well. js keys: ['from', 'to', 'weight'], data: [ ['Category1', 'Category2', 2], ['Category1', 'Category3', 5] ] More...
|
|
SankeySeriesDataLabels | 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...
|
|
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...
|
|
SankeySeriesEvents | 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...
|
|
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 | 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] |
|
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] |
|
SankeySeriesLegendSymbol | LegendSymbol [get, set] |
| What type of legend symbol to render for this series. Can be one ofareaMarker , lineMarker or rectangle . More...
|
|
SankeySeriesLevels | Levels [get, set] |
| Set options on specific levels. Takes precedence over series options,but not node and link options. More...
|
|
SankeySeriesLinkColorMode | 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...
|
|
override string | Name [get, set] |
| The name of the series as shown in the legend, tooltip etc. More...
|
|
override string | Name_DefaultValue [get, set] |
|
SankeySeriesNodeAlignment | 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...
|
|
List< SankeySeriesNodes > | Nodes [get, set] |
| A collection of options for the individual nodes. The nodes in a sankeydiagram are auto-generated instances of Highcharts.Point , but options canbe applied here and linked by the id . 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...
|
|
SankeySeriesOnPoint | 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...
|
|
SankeySeriesPoint | 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] |
| 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...
|
|
bool | SkipKeyboardNavigation [get, set] |
| If set to true , the accessibility module will skip past the pointsin this series for keyboard navigation. More...
|
|
SankeySeriesSonification | Sonification [get, set] |
| Sonification/audio chart options for a series. More...
|
|
override 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...
|
|
override string | Stack_DefaultValue [get, set] |
|
override 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...
|
|
override double | StackNumber_DefaultValue [get, set] |
|
SankeySeriesStates | 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...
|
|
SankeySeriesTooltip | 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...
|
|
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...
|
|
override 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...
|
|
override string | XAxis_DefaultValue [get, set] |
|
override 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...
|
|
override double | XAxisNumber_DefaultValue [get, set] |
|
override 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...
|
|
override string | YAxis_DefaultValue [get, set] |
|
override 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...
|
|
override double | YAxisNumber_DefaultValue [get, set] |
|
override double | ZIndex [get, set] |
| Define the visual z index of the series. More...
|
|
override double | ZIndex_DefaultValue [get, set] |
|
Hashtable | CustomFields [get, set] |
|
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] |
|