Inherits BaseObject.
|
PlotOptionsScatterAccessibility | 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...
|
|
PlotOptionsScatterBoostBlending | 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...
|
|
PlotOptionsScatterCluster | Cluster [get, set] |
| Options for marker clusters, the concept of sampling the datavalues into larger blocks in order to ease readability andincrease performance of the JavaScript charts.Note: marker clusters module is not working with boost and draggable-points modules.The marker clusters feature requires the marker-clusters.jsfile to be loaded, found in the modules directory of the downloadpackage, or online at code.highcharts.com/modules/marker-clusters.js. 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...
|
|
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...
|
|
PlotOptionsScatterCursor | 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...
|
|
PlotOptionsScatterDashStyle | 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...
|
|
PlotOptionsScatterDataLabels | 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...
|
|
PlotOptionsScatterDataSorting | 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...
|
|
PlotOptionsScatterDragDrop | DragDrop [get, set] |
| The draggable-points module allows points to be moved around or modified inthe chart. In addition to the options mentioned under the dragDrop APIstructure, the module fires three events,point.dragStart,point.drag andpoint.drop. 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...
|
|
PlotOptionsScatterEvents | 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...
|
|
string | FindNearestPointBy [get, set] |
|
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...
|
|
PlotOptionsScatterJitter | Jitter [get, set] |
| Apply a jitter effect for the rendered markers. When plottingdiscrete values, a little random noise may help telling the pointsapart. The jitter setting applies a random displacement of up to n axis units in either direction. So for example on a horizontal Xaxis, setting the jitter.x to 0.24 will render the point in arandom position between 0.24 units to the left and 0.24 units to theright of the true axis position. On a category axis, setting it to0.5 will fill up the bin and make the data appear continuous.When rendered on top of a box plot or a column series, a jitter valueof 0.24 will correspond to the underlying series' defaultgroupPaddingand pointPaddingsettings.**Note:** With boost mode enabled, the jitter effect is not supported. 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...
|
|
PlotOptionsScatterLabel | 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...
|
|
PlotOptionsScatterLegendSymbol | LegendSymbol [get, set] |
| What type of legend symbol to render for this series. Can be one ofareaMarker , lineMarker or rectangle . More...
|
|
PlotOptionsScatterLinecap | Linecap [get, set] |
| The line cap used for line ends and line joins on the graph. More...
|
|
double | LineWidth [get, set] |
| The width of the line connecting the data points. 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...
|
|
PlotOptionsScatterMarker | Marker [get, set] |
|
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...
|
|
PlotOptionsScatterOnPoint | 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...
|
|
PlotOptionsScatterPoint | 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, pointInterval defines 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 pointInterval is 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 pointStart setting.Please note that this options applies to the series data, not theinterval of the axis ticks, which is independent. More...
|
|
PlotOptionsScatterPointIntervalUnit | 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...
|
|
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...
|
|
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...
|
|
PlotOptionsScatterSonification | Sonification [get, set] |
| Sonification/audio chart options for a series. More...
|
|
PlotOptionsScatterStacking | Stacking [get, set] |
| Whether to stack the values of each series on top of each other.Possible values are undefined to disable, "normal" to stack byvalue or "percent" .When stacking is enabled, data must be sortedin ascending X order.Some stacking options are related to specific series types. In thestreamgraph series type, the stacking option is set to "stream" .The second one is "overlap" , which only applies to waterfallseries. More...
|
|
PlotOptionsScatterStates | States [get, set] |
|
PlotOptionsScatterStep | 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 eventon a series isn't triggered until the mouse moves over anotherseries, or out of the plot area. When false, the mouseOut event ona series is triggered when the mouse leaves the area around theseries' graph or markers. This also implies the tooltip. WhenstickyTracking is false and tooltip.shared is false, the tooltipwill be hidden when moving the mouse between series. More...
|
|
double | Threshold [get, set] |
| The threshold, also called zero level or base level. For line typeseries this is only used in conjunction withnegativeColor. 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< PlotOptionsScatterZone > | Zones [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 zoneAxis option. 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 className option(view live demo). More...
|
|
Hashtable | CustomFields [get, set] |
|