Packages

class SeriesHeatmap extends Object

Annotations
@RawJSType() @ScalaJSDefined()
Note

JavaScript name: series<heatmap>

Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SeriesHeatmap
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SeriesHeatmap()

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

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

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

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

  19. val data: UndefOr[Array[|[CleanJsObject[SeriesHeatmapData], Array[Any]]]]

    An array of data points for the series.

    An array of data points for the series. For the heatmap series type, points can be given in the following ways:

    -

    An array of arrays with 3 or 2 values. In this case, the values correspond to x,y,value. If the first value is a string, it is applied as the name of the point, and the x value is inferred. The x value can also be omitted, in which case the inner arrays should be of length 2. Then the x value is automatically calculated, either starting at 0 and incremented by 1, or from pointStart and pointInterval given in the series options. 

    data: [
    [0, 9, 7],
    [1, 10, 4],
    [2, 6, 3]
]

    -

    An array of objects with named values. The objects are point configuration objects as seen below. If the total number of data points exceeds the series' turboThreshold, this option is not available.

    data: [{
    x: 1,
    y: 3,
    value: 10,
    name: "Point2",
    color: "#00FF00"
}, {
    x: 1,
    y: 7,
    value: 10,
    name: "Point1",
    color: "#FF00FF"
}]

    Example:

    1. The demos use a line series, but the principle is the same for all types.

  20. val dataLabels: UndefOr[CleanJsObject[SeriesHeatmapDataLabels]]

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

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

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

  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  25. val events: UndefOr[CleanJsObject[SeriesHeatmapEvents]]
  26. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  27. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  28. 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

  29. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  30. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  31. val id: UndefOr[String]

    An id for the series.

    An id for the series. This can be used after render time to get a pointer to the series object through chart.get().

    Example:

    1. Get series by id

    Since

    1.2.0

  32. val index: UndefOr[Double]

    The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.

    The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.

    Since

    2.3.0

  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  35. 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

  36. val legendIndex: UndefOr[Double]

    The sequential index of the series in the legend.

    The sequential index of the series in the legend.

    Try it: Legend in opposite order .

  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. val name: UndefOr[String]

    The name of the series as shown in the legend, tooltip etc.

    The name of the series as shown in the legend, tooltip etc.

    Example:

    1. Series name

  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. final def notify(): Unit
    Definition Classes
    AnyRef
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  43. val point: UndefOr[CleanJsObject[SeriesHeatmapPoint]]

    Properties for each single point

  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 states: UndefOr[CleanJsObject[PlotOptionsSeriesStates]]

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

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

  52. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  53. def toLocaleString(): String
    Definition Classes
    Object
  54. def toString(): String
    Definition Classes
    AnyRef → Any
  55. val tooltip: UndefOr[CleanJsObject[SeriesHeatmapTooltip]]

    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

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

  57. val type: String

    The type of series.

    The type of series. Can be one of area, areaspline, bar, column, line, pie, scatter or spline. From version 2.3, arearange, areasplinerange and columnrange are supported with the highcharts-more.js component.

    Example:

    1. Line and column in the same chart

  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 xAxis: UndefOr[|[Double, String]]

    When using dual or multiple x axes, this number defines which xAxis the particular series is connected to.

    When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first.

  64. val yAxis: UndefOr[|[Double, String]]

    When using dual or multiple y axes, this number defines which yAxis the particular series is connected to.

    When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first.

    Example:

    1. Apply the column series to the secondary Y axis

  65. val zIndex: UndefOr[Double]

    Define the visual z index of the series.

    Define the visual z index of the series.

    Example:

    1. With no z index, the series defined last are on top, with a z index, the series with the highest z index is on top.

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

  67. val zones: UndefOr[Array[CleanJsObject[SeriesHeatmapZones]]]

    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

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped