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

Inherits BaseObject.

Properties

PlotOptionsArearangeAccessibility 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...
 
double AnimationLimit [get, set]
 For some series, there is a limit that shuts down animationby default when the total number of points in the chart is too high.For example, for a column chart and its derivatives, animation doesnot run if there is more than 250 points totally. To disable thiscap, set animationLimit to Infinity. This option works if animationis fired on individual points, not on a group of points like e.g. duringthe initial animation. More...
 
PlotOptionsArearangeBoostBlending BoostBlending [get, set]
 Sets the color blending in the boost module. More...
 
double BoostThreshold [get, set]
 Set the point threshold for when a series should enter boost mode.Setting it to e.g. 2000 will cause the series to enter boost mode when thereare 2000 or more points in the series.To disable boosting on the series, set the boostThreshold to 0. Setting itto 1 will force boosting.Note that the cropThreshold also affectsthis setting. When zooming in on a series that has fewer points than thecropThreshold, all points are rendered although outside the visible plotarea, and the boostThreshold won't take effect. 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]
 
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]
 
bool ConnectEnds [get, set]
 Polar charts only. Whether to connect the ends of a line seriesplot across the extremes. More...
 
bool ConnectNulls [get, set]
 Whether to connect a graph line across null points, or render a gapbetween the two points on either side of the null.In stacked area chart, if connectNulls is set to true,null points are interpreted as 0. 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...
 
double CropThreshold [get, set]
 When the series contains less points than the crop threshold, allpoints are drawn, even if the points fall outside the visible plotarea at the current zoom. The advantage of drawing all points(including markers and columns), is that animation is performed onupdates. On the other hand, when the series contains more points thanthe crop threshold, the series data is cropped to only contain pointsthat fall within the plot area. The advantage of cropping awayinvisible points is to increase performance on large series. More...
 
PlotOptionsArearangeCursor 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...
 
PlotOptionsArearangeDashStyle 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...
 
PlotOptionsArearangeDataLabels DataLabels [get, set]
 Extended data labels for range series types. Range series datalabels use no x and y options. Instead, they have xLow,xHigh, yLow and yHigh options to allow the higher and lowerdata label sets individually. More...
 
PlotOptionsArearangeDataSorting DataSorting [get, set]
 Options for the series data sorting. More...
 
string Description [get, set]
 A description of the series to add to the screen reader informationabout the series. More...
 
PlotOptionsArearangeDragDrop DragDrop [get, set]
 
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...
 
PlotOptionsArearangeEvents 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]
 
double FillOpacity [get, set]
 
PlotOptionsArearangeFindNearestPointBy FindNearestPointBy [get, set]
 Determines whether the series should look for the nearest pointin both dimensions or just the x-dimension when hovering the series.Defaults to ‘'xy’for scatter series and'x'for most otherseries. If the data has duplicate x-values, it is recommended toset this to'xy'` to allow hovering over all points.Applies only to series types using nearest neighbor search (notdirect hover) for tooltip. 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...
 
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...
 
PlotOptionsArearangeLabel 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...
 
PlotOptionsArearangeLegendSymbol LegendSymbol [get, set]
 What type of legend symbol to render for this series. Can be one ofareaMarker, lineMarker or rectangle. More...
 
PlotOptionsArearangeLinecap Linecap [get, set]
 The line cap used for line ends and line joins on the graph. More...
 
string LineColor [get, set]
 A separate color for the graph line. By default the line takes thecolor of the series, but the lineColor setting allows setting aseparate color for the line without altering the fillColor.In styled mode, the line stroke can be set with the<tt>.highcharts-graph class name. More...
 
double LineWidth [get, set]
 Pixel width of the arearange graph line. 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...
 
PlotOptionsArearangeLowMarker LowMarker [get, set]
 Options for the lower markers of the arearange-like series. When lowMarkeris not defined, options inherit form the marker. More...
 
PlotOptionsArearangeMarker Marker [get, set]
 Options for the point markers of line and scatter-like series. Propertieslike fillColor, lineColor and lineWidth define the visualappearance of the markers. The symbol option defines the shape. Otherseries types, like column series, don't have markers, but have visualoptions on the series level instead.In styled mode, the markers can be styled with the .highcharts-point,.highcharts-point-hover and .highcharts-point-select class names. More...
 
string NegativeColor [get, set]
 The color for the parts of the graph or points that are below thethreshold. Note that zones takesprecedence over the negative color. Using negativeColor isequivalent to applying a zone with value of 0. More...
 
string NegativeFillColor [get, set]
 A separate color for the negative part of the area.In styled mode, a negative color is set with the<tt>.highcharts-negative class name. More...
 
PlotOptionsArearangeOnPoint 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...
 
PlotOptionsArearangePoint 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...
 
double PointInterval [get, set]
 If no x values are given for the points in a series, pointIntervaldefines the interval of the x values. For example, if a seriescontains one value every decade starting from year 0, setpointInterval to 10. In true datetime axes, the pointIntervalis set in milliseconds.It can be also be combined with pointIntervalUnit to draw irregulartime intervals.If combined with relativeXValue, an x value can be set on eachpoint, and the pointInterval is added x times to the pointStartsetting.Please note that this options applies to the series data, not theinterval of the axis ticks, which is independent. More...
 
PlotOptionsArearangePointIntervalUnit PointIntervalUnit [get, set]
 On datetime series, this allows for setting thepointInterval to irregular timeunits, day, month and year. A day is usually the same as 24hours, but pointIntervalUnit also takes the DST crossover intoconsideration when dealing with local time. Combine this option withpointInterval to draw weeks, quarters, 6 months, 10 years etc.Please note that this options applies to the series data, not theinterval of the axis ticks, which is independent. More...
 
PointPlacement PointPlacement [get, set]
 Possible values: "on", "between", number.In a column chart, when pointPlacement is "on", the point will notcreate any padding of the X axis. In a polar column chart this meansthat the first column points directly north. If the pointPlacement is"between", the columns will be laid out between ticks. This isuseful for example for visualising an amount between two points intime or in a certain sector of a polar chart.Since Highcharts 3.0.2, the point placement can also be numeric,where 0 is on the axis value, -0.5 is between this value and theprevious, and 0.5 is between this value and the next. Unlike thetextual options, numeric point placement options won't affect axispadding.Note that pointPlacement needs a pointRange to work. For column series this iscomputed, but for line-type series it needs to be set.For the xrange series type and gantt charts, if the Y axis is acategory axis, the pointPlacement applies to the Y axis rather thanthe (typically datetime) X axis.Defaults to undefined in cartesian charts, "between" in polarcharts. More...
 
double PointStart [get, set]
 If no x values are given for the points in a series, pointStartdefines on what value to start. For example, if a series contains oneyearly value starting from 1945, set pointStart to 1945.If combined with relativeXValue, an x value can be set on eachpoint. The x value from the point options is multiplied bypointInterval and added to pointStart to produce a modified xvalue. 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. 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. 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...
 
bool SoftThreshold [get, set]
 When this is true, the series will not cause the Y axis to crossthe zero plane (or threshold option)unless the data actually crosses the plane.For example, if softThreshold is false, a series of 0, 1, 2,3 will make the Y axis show negative values according to theminPadding option. If softThreshold is true, the Y axis startsat 0. More...
 
PlotOptionsArearangeSonification Sonification [get, set]
 Sonification/audio chart options for a series. More...
 
PlotOptionsArearangeStates States [get, set]
 
PlotOptionsArearangeStep Step [get, set]
 Whether to apply steps to the line. Possible values are left,center and right. More...
 
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 Threshold [get, set]
 
PlotOptionsArearangeTooltip Tooltip [get, set]
 
bool TrackByArea [get, set]
 Whether the whole area or just the line should respond to mouseovertooltips and other mouse or touch events. 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...
 
string ZoneAxis [get, set]
 Defines the Axis on which the zones are applied. More...
 
List< PlotOptionsArearangeZoneZones [get, set]
 An array defining zones within a series. Zones can be applied to theX axis, Y axis or Z axis for bubbles, according to the zoneAxisoption. The zone definitions have to be in ascending order regardingto the value.In styled mode, the color zones are styled with the<tt>.highcharts-zone-{n} class, or custom classed from the classNameoption(view live demo). More...
 
Hashtable CustomFields [get, set]
 

Property Documentation

◆ Accessibility

PlotOptionsArearangeAccessibility Highsoft.Web.Mvc.Charts.PlotOptionsArearange.Accessibility
getset

Accessibility options for a series.

◆ AllowPointSelect

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

◆ AnimationLimit

double Highsoft.Web.Mvc.Charts.PlotOptionsArearange.AnimationLimit
getset

For some series, there is a limit that shuts down animationby default when the total number of points in the chart is too high.For example, for a column chart and its derivatives, animation doesnot run if there is more than 250 points totally. To disable thiscap, set animationLimit to Infinity. This option works if animationis fired on individual points, not on a group of points like e.g. duringthe initial animation.

◆ BoostBlending

PlotOptionsArearangeBoostBlending Highsoft.Web.Mvc.Charts.PlotOptionsArearange.BoostBlending
getset

Sets the color blending in the boost module.

◆ BoostThreshold

double Highsoft.Web.Mvc.Charts.PlotOptionsArearange.BoostThreshold
getset

Set the point threshold for when a series should enter boost mode.Setting it to e.g. 2000 will cause the series to enter boost mode when thereare 2000 or more points in the series.To disable boosting on the series, set the boostThreshold to 0. Setting itto 1 will force boosting.Note that the cropThreshold also affectsthis setting. When zooming in on a series that has fewer points than thecropThreshold, all points are rendered although outside the visible plotarea, and the boostThreshold won't take effect.

◆ ClassName

string Highsoft.Web.Mvc.Charts.PlotOptionsArearange.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.PlotOptionsArearange.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.PlotOptionsArearange.Color
getset

◆ ColorAxis

string Highsoft.Web.Mvc.Charts.PlotOptionsArearange.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.PlotOptionsArearange.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.PlotOptionsArearange.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.PlotOptionsArearange.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.PlotOptionsArearange.ColorKey
getset

◆ ConnectEnds

bool Highsoft.Web.Mvc.Charts.PlotOptionsArearange.ConnectEnds
getset

Polar charts only. Whether to connect the ends of a line seriesplot across the extremes.

◆ ConnectNulls

bool Highsoft.Web.Mvc.Charts.PlotOptionsArearange.ConnectNulls
getset

Whether to connect a graph line across null points, or render a gapbetween the two points on either side of the null.In stacked area chart, if connectNulls is set to true,null points are interpreted as 0.

◆ Crisp

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

◆ CropThreshold

double Highsoft.Web.Mvc.Charts.PlotOptionsArearange.CropThreshold
getset

When the series contains less points than the crop threshold, allpoints are drawn, even if the points fall outside the visible plotarea at the current zoom. The advantage of drawing all points(including markers and columns), is that animation is performed onupdates. On the other hand, when the series contains more points thanthe crop threshold, the series data is cropped to only contain pointsthat fall within the plot area. The advantage of cropping awayinvisible points is to increase performance on large series.

◆ Cursor

PlotOptionsArearangeCursor Highsoft.Web.Mvc.Charts.PlotOptionsArearange.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.PlotOptionsArearange.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

PlotOptionsArearangeDashStyle Highsoft.Web.Mvc.Charts.PlotOptionsArearange.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

PlotOptionsArearangeDataLabels Highsoft.Web.Mvc.Charts.PlotOptionsArearange.DataLabels
getset

Extended data labels for range series types. Range series datalabels use no x and y options. Instead, they have xLow,xHigh, yLow and yHigh options to allow the higher and lowerdata label sets individually.

◆ DataSorting

PlotOptionsArearangeDataSorting Highsoft.Web.Mvc.Charts.PlotOptionsArearange.DataSorting
getset

Options for the series data sorting.

◆ Description

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

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

◆ DragDrop

PlotOptionsArearangeDragDrop Highsoft.Web.Mvc.Charts.PlotOptionsArearange.DragDrop
getset

◆ EnableMouseTracking

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

PlotOptionsArearangeEvents Highsoft.Web.Mvc.Charts.PlotOptionsArearange.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.PlotOptionsArearange.FillColor
getset

◆ FillOpacity

double Highsoft.Web.Mvc.Charts.PlotOptionsArearange.FillOpacity
getset

◆ FindNearestPointBy

PlotOptionsArearangeFindNearestPointBy Highsoft.Web.Mvc.Charts.PlotOptionsArearange.FindNearestPointBy
getset

Determines whether the series should look for the nearest pointin both dimensions or just the x-dimension when hovering the series.Defaults to ‘'xy’for scatter series and'x'for most otherseries. If the data has duplicate x-values, it is recommended toset this to'xy'` to allow hovering over all points.Applies only to series types using nearest neighbor search (notdirect hover) for tooltip.

◆ GetExtremesFromAll

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

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

PlotOptionsArearangeLabel Highsoft.Web.Mvc.Charts.PlotOptionsArearange.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

PlotOptionsArearangeLegendSymbol Highsoft.Web.Mvc.Charts.PlotOptionsArearange.LegendSymbol
getset

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

◆ Linecap

PlotOptionsArearangeLinecap Highsoft.Web.Mvc.Charts.PlotOptionsArearange.Linecap
getset

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

◆ LineColor

string Highsoft.Web.Mvc.Charts.PlotOptionsArearange.LineColor
getset

A separate color for the graph line. By default the line takes thecolor of the series, but the lineColor setting allows setting aseparate color for the line without altering the fillColor.In styled mode, the line stroke can be set with the<tt>.highcharts-graph class name.

◆ LineWidth

double Highsoft.Web.Mvc.Charts.PlotOptionsArearange.LineWidth
getset

Pixel width of the arearange graph line.

◆ LinkedTo

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

◆ LowMarker

PlotOptionsArearangeLowMarker Highsoft.Web.Mvc.Charts.PlotOptionsArearange.LowMarker
getset

Options for the lower markers of the arearange-like series. When lowMarkeris not defined, options inherit form the marker.

◆ Marker

PlotOptionsArearangeMarker Highsoft.Web.Mvc.Charts.PlotOptionsArearange.Marker
getset

Options for the point markers of line and scatter-like series. Propertieslike fillColor, lineColor and lineWidth define the visualappearance of the markers. The symbol option defines the shape. Otherseries types, like column series, don't have markers, but have visualoptions on the series level instead.In styled mode, the markers can be styled with the .highcharts-point,.highcharts-point-hover and .highcharts-point-select class names.

◆ NegativeColor

string Highsoft.Web.Mvc.Charts.PlotOptionsArearange.NegativeColor
getset

The color for the parts of the graph or points that are below thethreshold. Note that zones takesprecedence over the negative color. Using negativeColor isequivalent to applying a zone with value of 0.

◆ NegativeFillColor

string Highsoft.Web.Mvc.Charts.PlotOptionsArearange.NegativeFillColor
getset

A separate color for the negative part of the area.In styled mode, a negative color is set with the<tt>.highcharts-negative class name.

◆ OnPoint

PlotOptionsArearangeOnPoint Highsoft.Web.Mvc.Charts.PlotOptionsArearange.OnPoint
getset

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

◆ Opacity

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

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

◆ Point

PlotOptionsArearangePoint Highsoft.Web.Mvc.Charts.PlotOptionsArearange.Point
getset

Properties for each single point.

◆ PointDescriptionFormat

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

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

◆ PointDescriptionFormatter

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

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

◆ PointInterval

double Highsoft.Web.Mvc.Charts.PlotOptionsArearange.PointInterval
getset

If no x values are given for the points in a series, pointIntervaldefines the interval of the x values. For example, if a seriescontains one value every decade starting from year 0, setpointInterval to 10. In true datetime axes, the pointIntervalis set in milliseconds.It can be also be combined with pointIntervalUnit to draw irregulartime intervals.If combined with relativeXValue, an x value can be set on eachpoint, and the pointInterval is added x times to the pointStartsetting.Please note that this options applies to the series data, not theinterval of the axis ticks, which is independent.

◆ PointIntervalUnit

PlotOptionsArearangePointIntervalUnit Highsoft.Web.Mvc.Charts.PlotOptionsArearange.PointIntervalUnit
getset

On datetime series, this allows for setting thepointInterval to irregular timeunits, day, month and year. A day is usually the same as 24hours, but pointIntervalUnit also takes the DST crossover intoconsideration when dealing with local time. Combine this option withpointInterval to draw weeks, quarters, 6 months, 10 years etc.Please note that this options applies to the series data, not theinterval of the axis ticks, which is independent.

◆ PointPlacement

PointPlacement Highsoft.Web.Mvc.Charts.PlotOptionsArearange.PointPlacement
getset

Possible values: "on", "between", number.In a column chart, when pointPlacement is "on", the point will notcreate any padding of the X axis. In a polar column chart this meansthat the first column points directly north. If the pointPlacement is"between", the columns will be laid out between ticks. This isuseful for example for visualising an amount between two points intime or in a certain sector of a polar chart.Since Highcharts 3.0.2, the point placement can also be numeric,where 0 is on the axis value, -0.5 is between this value and theprevious, and 0.5 is between this value and the next. Unlike thetextual options, numeric point placement options won't affect axispadding.Note that pointPlacement needs a pointRange to work. For column series this iscomputed, but for line-type series it needs to be set.For the xrange series type and gantt charts, if the Y axis is acategory axis, the pointPlacement applies to the Y axis rather thanthe (typically datetime) X axis.Defaults to undefined in cartesian charts, "between" in polarcharts.

◆ PointStart

double Highsoft.Web.Mvc.Charts.PlotOptionsArearange.PointStart
getset

If no x values are given for the points in a series, pointStartdefines on what value to start. For example, if a series contains oneyearly value starting from 1945, set pointStart to 1945.If combined with relativeXValue, an x value can be set on eachpoint. The x value from the point options is multiplied bypointInterval and added to pointStart to produce a modified xvalue.

◆ RelativeXValue

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

◆ ShadowBool

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

◆ ShowCheckbox

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

◆ SkipKeyboardNavigation

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

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

◆ SoftThreshold

bool Highsoft.Web.Mvc.Charts.PlotOptionsArearange.SoftThreshold
getset

When this is true, the series will not cause the Y axis to crossthe zero plane (or threshold option)unless the data actually crosses the plane.For example, if softThreshold is false, a series of 0, 1, 2,3 will make the Y axis show negative values according to theminPadding option. If softThreshold is true, the Y axis startsat 0.

◆ Sonification

PlotOptionsArearangeSonification Highsoft.Web.Mvc.Charts.PlotOptionsArearange.Sonification
getset

Sonification/audio chart options for a series.

◆ States

PlotOptionsArearangeStates Highsoft.Web.Mvc.Charts.PlotOptionsArearange.States
getset

◆ Step

PlotOptionsArearangeStep Highsoft.Web.Mvc.Charts.PlotOptionsArearange.Step
getset

Whether to apply steps to the line. Possible values are left,center and right.

◆ StickyTracking

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

◆ Threshold

double Highsoft.Web.Mvc.Charts.PlotOptionsArearange.Threshold
getset

◆ Tooltip

PlotOptionsArearangeTooltip Highsoft.Web.Mvc.Charts.PlotOptionsArearange.Tooltip
getset

◆ TrackByArea

bool Highsoft.Web.Mvc.Charts.PlotOptionsArearange.TrackByArea
getset

Whether the whole area or just the line should respond to mouseovertooltips and other mouse or touch events.

◆ TurboThreshold

double Highsoft.Web.Mvc.Charts.PlotOptionsArearange.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.PlotOptionsArearange.Visible
getset

Set the initial visibility of the series.

◆ ZoneAxis

string Highsoft.Web.Mvc.Charts.PlotOptionsArearange.ZoneAxis
getset

Defines the Axis on which the zones are applied.

◆ Zones

List<PlotOptionsArearangeZone> Highsoft.Web.Mvc.Charts.PlotOptionsArearange.Zones
getset

An array defining zones within a series. Zones can be applied to theX axis, Y axis or Z axis for bubbles, according to the zoneAxisoption. The zone definitions have to be in ascending order regardingto the value.In styled mode, the color zones are styled with the<tt>.highcharts-zone-{n} class, or custom classed from the classNameoption(view live demo).


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