PlotOptionsHeatmap

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. val allowPointSelect: UndefOr[Boolean]

   

   Allow this series' points to be selected by clicking on the markers, bars or pie slices.

   Allow this series' points to be selected by clicking on the markers, bars or pie slices.

   Example:

   1. Line, column, pie

   Since

   1.2.0

5. 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 Math object. See the easing demo.

   </dl>

   Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.

   Example:

   1. Animation disabled, slower animation, custom easing function.

6. 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 animationLimit to Infinity.

7. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

8. 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-point rule.

   Example:

   1. Dark gray border

9. 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:

   1. Rounded columns

10. 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-point rule.

    Example:

    1. 2px black border

11. 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

12. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

13. 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

14. val colorByPoint: UndefOr[Boolean]

    

    When using automatic point colors pulled from the options.colors collection, 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.colors collection, this option determines whether the chart should receive one color per series or one color per point.

    Example:

    1. False by default, true

    Since

    2.0

15. val colorIndex: UndefOr[Double]

    

    Styled mode only.

    Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.

    Since

    5.0.0

16. 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

17. 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.

    Example:

    1. One day

    Since

    4.0

18. val crisp: UndefOr[Boolean]

    

    When true, each column edge is rounded to its nearest pixel in order to render sharp on screen.

    When true, each column edge is rounded to its nearest pixel in order to render sharp on screen. In some cases, when there are a lot of densely packed columns, this leads to visible difference in column widths or distance between columns. In these cases, setting crisp to false may look better, even though each column is rendered blurry.

    Example:

    1. Crisp is false.

    Since

    5.0.10

19. 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. .

20. 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.

    Example:

    1. Pointer cursor on line graph, on columns, on scatter markers

21. 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-box and .highcharts-data-label class names (see example).

22. 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.

    Example:

    1. Accessible stock chart

    Since

    5.0.0

23. 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:

    1. No mouse tracking

24. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

25. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

26. val events: UndefOr[CleanJsObject[PlotOptionsHeatmapEvents]]

    

27. val exposeElementToA11y: UndefOr[Boolean]

    

    By default, series are exposed to screen readers as regions.

    By default, series are exposed to screen readers as regions. By enabling this option, the series element itself will be exposed in the same way as the data points. This is useful if the series is not used as a grouping entity in the chart, but you still want to attach a description to the series.

    Requires the Accessibility module.

    Example:

    1. Accessible data visualization

    Since

    5.0.12

28. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

29. val findNearestPointBy: UndefOr[String]

    

    Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.

    Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to 'xy' for scatter series and 'x' for most other series. If the data has duplicate x-values, it is recommended to set this to 'xy' to allow hovering over all points.

    Applies only to series types using nearest neighbor search (not direct hover) for tooltip.

    Example:

    1. Different hover behaviors

    Since

    5.0.10

30. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

31. 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

32. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

33. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

34. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

35. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

36. 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.

    Example:

    1. An extended data array with keys

    Since

    4.1.6

37. 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.

    Example:

    1. Linked series

    Since

    3.0

38. 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.

    Example:

    1. Limited to 50

    Since

    4.1.8

39. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

40. final def notify(): Unit

    

    Definition Classes

    AnyRef

41. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

42. val point: UndefOr[CleanJsObject[PlotOptionsHeatmapPoint]]

    

    Properties for each single point

43. val pointDescriptionFormatter: UndefOr[Function]

    

    Same as accessibility.pointDescriptionFormatter, but for an individual series.

    Same as accessibility.pointDescriptionFormatter, but for an individual series. Overrides the chart wide configuration.

    Since

    5.0.12

44. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

45. 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.

    Example:

    1. 1 by default

    Since

    4.0

46. val selected: UndefOr[Boolean]

    

    Whether to select the series initially.

    Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.

    Example:

    1. One out of two series selected

    Since

    1.2.0

47. 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, opacity and width.

    Example:

    1. Shadow enabled

48. 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 selected option.

    Example:

    1. Show select box

    Since

    1.2.0

49. 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 true for standalone series, false for linked series.

    Example:

    1. One series in the legend, one hidden

50. val skipKeyboardNavigation: UndefOr[Boolean]

    

    If set to True, the accessibility module will skip past the points in this series for keyboard navigation.

    If set to True, the accessibility module will skip past the points in this series for keyboard navigation.

    Since

    5.0.12

51. val states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]]

    

    A wrapper object for all the series options in specific states.

52. val stickyTracking: UndefOr[Boolean]

    

    Sticky tracking of mouse events.

    Sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. When stickyTracking is false and tooltip.shared is 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.

    Example:

    1. True by default, false

    Since

    2.0

53. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

54. def toLocaleString(): String

    

    Definition Classes

    Object

55. def toString(): String

    

    Definition Classes

    AnyRef → Any

56. 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

57. 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 0 disable.

    Since

    2.2

58. def valueOf(): Any

    

    Definition Classes

    Object

59. val visible: UndefOr[Boolean]

    

    Set the initial visibility of the series.

    Set the initial visibility of the series.

    Example:

    1. Two series, one hidden and one visible

60. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

61. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

62. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

63. val zoneAxis: UndefOr[String]

    

    Defines the Axis on which the zones are applied.

    Defines the Axis on which the zones are applied.

    Example:

    1. Zones on the X-Axis

    Since

    4.1.0

64. 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 zoneAxis option.

    In styled mode, the color zones are styled with the .highcharts-zone-{n} class, or custom classed from the className option (view live demo).

    Example:

    1. Color zones

    Since

    4.1.0