Inherits BaseObject.
|
| PlotOptionsHeatmapAccessibility | 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] |
| | Animation is disabled by default on the heatmap series. 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...
|
| |
| PlotOptionsHeatmapBoostBlending | 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...
|
| |
| double | BorderRadius [get, set] |
| | The border radius for each heatmap item. The border's color andwidth can be set in marker options. More...
|
| |
| double | BorderWidth [get, set] |
| | The border width for each heatmap item. 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] |
| |
| string | Color [get, set] |
| | The main color of the series. In heat maps this color is rarely used,as we mostly use the color to denote the value of each point. Unlessoptions are set in the colorAxis, the default valueis pulled from the options.colors array. 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] |
| |
| double | Colsize [get, set] |
| | The column size - how many X axis units each column in the heatmapshould span. 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...
|
| |
| PlotOptionsHeatmapCursor | 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...
|
| |
| PlotOptionsHeatmapDataLabels | DataLabels [get, set] |
| |
| PlotOptionsHeatmapDataSorting | 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...
|
| |
| 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...
|
| |
| PlotOptionsHeatmapEvents | 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 | 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...
|
| |
| bool | Interpolation [get, set] |
| | Make the heatmap render its data points as an interpolated image. 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...
|
| |
| PlotOptionsHeatmapLabel | 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...
|
| |
| string | LegendSymbol [get, set] |
| |
| 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...
|
| |
| PlotOptionsHeatmapMarker | 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...
|
| |
| string | NullColor [get, set] |
| | The color applied to null points. In styled mode, a general CSS classis applied instead. More...
|
| |
| PlotOptionsHeatmapOnPoint | 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...
|
| |
| PlotOptionsHeatmapPoint | 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 | PointPadding [get, set] |
| | Padding between the points in the heatmap. 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...
|
| |
| double | Rowsize [get, set] |
| | The row size - how many Y axis units each heatmap row should span. 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...
|
| |
| PlotOptionsHeatmapSonification | Sonification [get, set] |
| | Sonification/audio chart options for a series. More...
|
| |
| PlotOptionsHeatmapStates | 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...
|
| |
| PlotOptionsHeatmapTooltip | 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...
|
| |
| string | ZoneAxis [get, set] |
| | Defines the Axis on which the zones are applied. More...
|
| |
| List< PlotOptionsHeatmapZone > | 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 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] |
| |
1.8.14