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: 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: 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, easing "easeOutBounce" through jQuery UI.

6. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

7. val borderColor: String

   

   The color of the border surrounding each column or bar.

   The color of the border surrounding each column or bar.

   Example:

   1. Dark gray border

8. val borderRadius: 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

9. val borderWidth: Double

   

   The width of the border surrounding each column or bar.

   The width of the border surrounding each column or bar.

   Example:

   1. 2px black border

10. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

11. val color: String

    

    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

12. val colorByPoint: 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

13. val colors: Array[String]

    

    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

14. val colsize: 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

15. val cropThreshold: 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. .

16. val cursor: 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

17. val dataLabels: PlotOptionsHeatmapDataLabels

    

18. val enableMouseTracking: 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

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

    

    Definition Classes

    AnyRef

20. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

21. val events: PlotOptionsHeatmapEvents

    

22. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

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

    

    Definition Classes

    AnyRef → Any

24. val getExtremesFromAll: 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

25. def hasOwnProperty(v: String): Boolean

    

    Definition Classes

    Object

26. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

27. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

28. def isPrototypeOf(v: Object): Boolean

    

    Definition Classes

    Object

29. val keys: 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

30. val linkedTo: 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

31. val maxPointWidth: 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

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

    

    Definition Classes

    AnyRef

33. final def notify(): Unit

    

    Definition Classes

    AnyRef

34. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

35. val point: PlotOptionsHeatmapPoint

    

    Properties for each single point

36. def propertyIsEnumerable(v: String): Boolean

    

    Definition Classes

    Object

37. val rowsize: 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

38. val selected: 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

39. val shadow: Any

    

    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

40. val showCheckbox: 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

41. val showInLegend: 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

42. val states: PlotOptionsSeriesStates

    

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

43. val stickyTracking: 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

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

    

    Definition Classes

    AnyRef

45. def toLocaleString(): String

    

    Definition Classes

    Object

46. def toString(): String

    

    Definition Classes

    AnyRef → Any

47. val tooltip: Object

    

    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

48. val turboThreshold: 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

49. def valueOf(): Any

    

    Definition Classes

    Object

50. val visible: Boolean

    

    Set the initial visibility of the series.

    Set the initial visibility of the series.

    Example:

    1. Two series, one hidden and one visible

51. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

54. val zoneAxis: 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

55. val zones: Array[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.

    Example:

    1. Color zones

    Since

    4.1.0