class PlotOptionsHeatmap extends Object
- Annotations
- @RawJSType() @ScalaJSDefined()
- Note
JavaScript name:
plotOptions-heatmap
- Alphabetic
- By Inheritance
- PlotOptionsHeatmap
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new PlotOptionsHeatmap()
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
allowPointSelect: UndefOr[Boolean]
Allow this series' points to be selected by clicking on the markers, bars or pie slices.
-
val
animation: UndefOr[Boolean]
Enable or disable the initial animation when a series is displayed.
Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation of the series itself. For other animations, see chart.animation and the animation parameter under the API methods. The following properties are supported: <dl> <dt>duration</dt>
- The duration of the animation in milliseconds.
<dt>easing</dt>- A string reference to an easing function set on the
</dl>Mathobject. See the easing demo.Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.
Example: -
val
animationLimit: UndefOr[Double]
For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high.
For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation doesn't run if there is more than 250 points totally. To disable this cap, set
animationLimittoInfinity. -
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
val
borderColor: UndefOr[|[String, Object]]
The color of the border surrounding each column or bar.
The color of the border surrounding each column or bar.
In styled mode, the border stroke can be set with the
.highcharts-pointrule.Example: -
val
borderRadius: UndefOr[Double]
The corner radius of the border surrounding each column or bar.
The corner radius of the border surrounding each column or bar.
Example: -
val
borderWidth: UndefOr[Double]
The width of the border surrounding each column or bar.
The width of the border surrounding each column or bar.
In styled mode, the stroke width can be set with the
.highcharts-pointrule.Example: -
val
className: UndefOr[String]
A class name to apply to the series' graphical elements.
A class name to apply to the series' graphical elements.
- Since
5.0.0
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
val
color: UndefOr[|[String, Object]]
The main color of the series.
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. Unless options are set in the colorAxis, the default value is pulled from the options.colors array.
- Since
4.0
-
val
colorByPoint: UndefOr[Boolean]
When using automatic point colors pulled from the
options.colorscollection, this option determines whether the chart should receive one color per series or one color per point.When using automatic point colors pulled from the
options.colorscollection, this option determines whether the chart should receive one color per series or one color per point.- Since
2.0
Example: -
val
colors: UndefOr[Array[|[String, Object]]]
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
A series specific or series type specific color set to apply instead of the global colors when colorByPoint is true.
- Since
3.0
-
val
colsize: UndefOr[Double]
The column size - how many X axis units each column in the heatmap should span.
The column size - how many X axis units each column in the heatmap should span.
- Since
4.0
Example: -
val
cropThreshold: UndefOr[Double]
When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom.
When the series contains less points than the crop threshold, all points are drawn, event if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series. .
-
val
cursor: UndefOr[String]
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
Pointer cursor on line graph, on columns, on scatter markers
Example: -
val
dataLabels: UndefOr[CleanJsObject[PlotOptionsHeatmapDataLabels]]
Options for the series data labels, appearing next to each data point.
Options for the series data labels, appearing next to each data point.
In styled mode, the data labels can be styled wtih the
.highcharts-data-label-boxand.highcharts-data-labelclass names (see example). -
val
description: UndefOr[String]
Requires Accessibility module
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
- Since
5.0.0
Example: -
val
enableMouseTracking: UndefOr[Boolean]
Enable or disable the mouse tracking for a specific series.
Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.
Example: -
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val events: UndefOr[CleanJsObject[PlotOptionsHeatmapEvents]]
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
val
getExtremesFromAll: UndefOr[Boolean]
Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis.
Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.
- Since
4.1.6
-
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
-
val
keys: UndefOr[Array[String]]
An array specifying which option maps to which key in the data point array.
An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.
- Since
4.1.6
Example: -
val
linkedTo: UndefOr[String]
The id of another series to link to.
The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.
- Since
3.0
Example: -
val
maxPointWidth: UndefOr[Double]
The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart.
The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart.
- Since
4.1.8
Example: -
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
val
point: UndefOr[CleanJsObject[PlotOptionsHeatmapPoint]]
Properties for each single point
-
def
propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
-
val
rowsize: UndefOr[Double]
The row size - how many Y axis units each heatmap row should span.
The row size - how many Y axis units each heatmap row should span.
- Since
4.0
Example: -
val
selected: UndefOr[Boolean]
Whether to select the series initially.
Whether to select the series initially. If
showCheckboxis true, the checkbox next to the series name will be checked for a selected series.- Since
1.2.0
Example: -
val
shadow: UndefOr[|[Boolean, Object]]
Whether to apply a drop shadow to the graph line.
Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing
color,offsetX,offsetY,opacityandwidth.Example: -
val
showCheckbox: UndefOr[Boolean]
If true, a checkbox is displayed next to the legend item to allow selecting the series.
If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the
selectedoption.- Since
1.2.0
Example: -
val
showInLegend: UndefOr[Boolean]
Whether to display this particular series or series type in the legend.
Whether to display this particular series or series type in the legend. The default value is
truefor standalone series,falsefor linked series.Example: -
val
states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]]
A wrapper object for all the series options in specific states.
-
val
stickyTracking: UndefOr[Boolean]
Sticky tracking of mouse events.
Sticky tracking of mouse events. When true, the
mouseOutevent on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, themouseOutevent on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. WhenstickyTrackingis false andtooltip.sharedis false, the tooltip will be hidden when moving the mouse between series. Defaults to true for line and area type series, but to false for columns, pies etc.- Since
2.0
Example: -
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toLocaleString(): String
- Definition Classes
- Object
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
val
tooltip: UndefOr[CleanJsObject[PlotOptionsHeatmapTooltip]]
A configuration object for the tooltip rendering of each single series.
A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.
- Since
2.3
-
val
turboThreshold: UndefOr[Double]
When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed.
When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed. Also, only the first point is tested, and the rest are assumed to be the same format. This saves expensive data checking and indexing in long series. Set it to
0disable.- Since
2.2
-
def
valueOf(): Any
- Definition Classes
- Object
-
val
visible: UndefOr[Boolean]
Set the initial visibility of the series.
Set the initial visibility of the series.
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
val
zoneAxis: UndefOr[String]
Defines the Axis on which the zones are applied.
Defines the Axis on which the zones are applied.
- Since
4.1.0
Example: -
val
zones: UndefOr[Array[CleanJsObject[PlotOptionsHeatmapZones]]]
An array defining zones within a series.
An array defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles, according to the
zoneAxisoption.In styled mode, the color zones are styled with the
.highcharts-zone-{n}class, or custom classed from theclassNameoption (view live demo).- Since
4.1.0
Example: