heatmap

Method of Figure.

Overloads

Name	Description
heatmap(const Object points) -> Figure	Adds a heatmap series from point data.
heatmap(const Map options) -> Figure	Adds a heatmap series defined by options only.
heatmap(const Object points, const Map options) -> Figure	Adds a heatmap series from point data.

heatmap(const Object points) -> Figure

Adds a heatmap series from point data.

Parameters

• points: List or array of points, typically [x,y,value].

heatmap(const Map options) -> Figure

Adds a heatmap series defined by options only.

Parameters

• options: Series option map, commonly used with dataset/encode.
  • id (string): Component ID.
  • name (string): Series name for legend and tooltip.
  • coordinate_system (string): Coordinate system: cartesian2d/geo/calendar/matrix.
  • coordinate_system_usage (string): Layout usage: 'data'.
  • coord (List|number|string): Coord input for coordinate system (when usage is 'box').
  • x_axis_index (number): xAxis index.
  • x_axis_id (number): xAxis id.
  • y_axis_index (number): yAxis index.
  • y_axis_id (number): yAxis id.
  • geo_index (number): Geo index.
  • geo_id (number): Geo id.
  • calendar_index (number): Calendar index.
  • calendar_id (number): Calendar id.
  • matrix_index (number): Matrix index.
  • matrix_id (number): Matrix id.
  • point_size (number): Point size for geo heatmap.
  • blur_size (number): Blur size for geo heatmap.
  • min_opacity (number): Minimum opacity for geo heatmap.
  • max_opacity (number): Maximum opacity for geo heatmap.
  • progressive (number): Progressive rendering amount.
  • progressive_threshold (number): Progressive rendering threshold.
  • label (Map): Label options (cartesian only).
  • label.show (boolean): Show label.
  • label.position (string|List): Label position.
  • label.distance (number): Label distance.
  • label.rotate (number): Label rotation.
  • label.offset (List): Label offset.
  • label.text_margin (number|List): Label margin around text.
  • label.min_margin (number): Minimum margin between labels.
  • label.color (Color): Label color.
  • label.font_style (string): Label font style.
  • label.font_weight (string|number): Label font weight.
  • label.font_family (string): Label font family.
  • label.font_size (number): Label font size.
  • label.align (string): Label horizontal alignment.
  • label.vertical_align (string): Label vertical alignment.
  • label.line_height (number): Label line height.
  • label.background_color (string|Map): Label background.
  • label.border_color (Color): Label border color.
  • label.border_width (number): Label border width.
  • label.border_type (string|number|List): Label border type.
  • label.border_dash_offset (number): Label border dash offset.
  • label.border_radius (number): Label border radius.
  • label.padding (number|List): Label padding.
  • label.shadow_color (Color): Label shadow color.
  • label.shadow_blur (number): Label shadow blur.
  • label.shadow_offset_x (number): Label shadow offset X.
  • label.shadow_offset_y (number): Label shadow offset Y.
  • label.width (number): Label width.
  • label.height (number): Label height.
  • label.text_border_color (Color): Label text stroke color.
  • label.text_border_width (number): Label text stroke width.
  • label.text_border_type (string|number|List): Label text stroke type.
  • label.text_border_dash_offset (number): Label text stroke dash offset.
  • label.text_shadow_color (Color): Label text shadow color.
  • label.text_shadow_blur (number): Label text shadow blur.
  • label.text_shadow_offset_x (number): Label text shadow offset X.
  • label.text_shadow_offset_y (number): Label text shadow offset Y.
  • label.overflow (string): Label overflow handling.
  • label.ellipsis (string): Label ellipsis.
  • label.rich (Map): Label rich text styles.
  • label.rich_inherit_plain_label (boolean): Rich text inherits plain styles.
  • label_layout (Map): Label layout options.
  • label_layout.hide_overlap (boolean): Hide overlapped labels.
  • label_layout.move_overlap (string): Move overlapped labels.
  • label_layout.x (number|string): Label x position.
  • label_layout.y (number|string): Label y position.
  • label_layout.dx (number): Label x offset.
  • label_layout.dy (number): Label y offset.
  • label_layout.rotate (number): Label rotation.
  • label_layout.width (number): Label width.
  • label_layout.height (number): Label height.
  • label_layout.align (string): Label horizontal alignment.
  • label_layout.vertical_align (string): Label vertical alignment.
  • label_layout.font_size (number): Label font size.
  • label_layout.draggable (boolean): Allow dragging labels.
  • label_layout.label_line_points (List): Label line points.
  • item_style (Map): Item style options (cartesian only).
  • item_style.color (Color): Item color.
  • item_style.border_color (Color): Item border color.
  • item_style.border_width (number): Item border width.
  • item_style.border_type (string|number|List): Item border type.
  • item_style.border_dash_offset (number): Item border dash offset.
  • item_style.border_cap (string): Item border cap.
  • item_style.border_join (string): Item border join.
  • item_style.border_miter_limit (number): Item border miter limit.
  • item_style.shadow_blur (number): Item shadow blur.
  • item_style.shadow_color (Color): Item shadow color.
  • item_style.shadow_offset_x (number): Item shadow offset X.
  • item_style.shadow_offset_y (number): Item shadow offset Y.
  • item_style.opacity (number): Item opacity.
  • item_style.border_radius (number|List): Item border radius.
  • emphasis.disabled (boolean): Disable emphasis state.
  • emphasis.focus (string): Focus mode: none/self/series.
  • emphasis.blur_scope (string): Blur scope: coordinateSystem/series/global.
  • emphasis (Map): Emphasis state options.
  • emphasis.item_style (Map): Emphasis item style options.
  • emphasis.label (Map): Emphasis label options.
  • blur (Map): Blur state options.
  • blur.item_style (Map): Blur item style options.
  • blur.label (Map): Blur label options.
  • select (Map): Select state options.
  • select.item_style (Map): Select item style options.
  • select.label (Map): Select label options.
  • select.disabled (boolean): Disable selection.
  • selected_mode (boolean|string): Selection mode: true/false/'single'/'multiple'/'series'.
  • encode (Map): Encode mapping.
  • series_layout_by (string): Dataset layout: 'column' or 'row'.
  • dataset_index (number): Dataset index to use.
  • data_group_id (string): Group ID for data items.
  • data (List): Series data.
  • mark_point (Map): Mark point options.
  • mark_line (Map): Mark line options.
  • mark_area (Map): Mark area options.
  • zlevel (number): Canvas layer.
  • z (number): Z order.
  • silent (boolean): Ignore mouse events.
  • tooltip (Map): Series tooltip options.

heatmap(const Object points, const Map options) -> Figure

Adds a heatmap series from point data.

Parameters

• points: List or array of points, typically [x,y,value].
• options: Series option map merged into the series.
  • id (string): Component ID.
  • name (string): Series name for legend and tooltip.
  • coordinate_system (string): Coordinate system: cartesian2d/geo/calendar/matrix.
  • coordinate_system_usage (string): Layout usage: 'data'.
  • coord (List|number|string): Coord input for coordinate system (when usage is 'box').
  • x_axis_index (number): xAxis index.
  • x_axis_id (number): xAxis id.
  • y_axis_index (number): yAxis index.
  • y_axis_id (number): yAxis id.
  • geo_index (number): Geo index.
  • geo_id (number): Geo id.
  • calendar_index (number): Calendar index.
  • calendar_id (number): Calendar id.
  • matrix_index (number): Matrix index.
  • matrix_id (number): Matrix id.
  • point_size (number): Point size for geo heatmap.
  • blur_size (number): Blur size for geo heatmap.
  • min_opacity (number): Minimum opacity for geo heatmap.
  • max_opacity (number): Maximum opacity for geo heatmap.
  • progressive (number): Progressive rendering amount.
  • progressive_threshold (number): Progressive rendering threshold.
  • label (Map): Label options (cartesian only).
  • label.show (boolean): Show label.
  • label.position (string|List): Label position.
  • label.distance (number): Label distance.
  • label.rotate (number): Label rotation.
  • label.offset (List): Label offset.
  • label.text_margin (number|List): Label margin around text.
  • label.min_margin (number): Minimum margin between labels.
  • label.color (Color): Label color.
  • label.font_style (string): Label font style.
  • label.font_weight (string|number): Label font weight.
  • label.font_family (string): Label font family.
  • label.font_size (number): Label font size.
  • label.align (string): Label horizontal alignment.
  • label.vertical_align (string): Label vertical alignment.
  • label.line_height (number): Label line height.
  • label.background_color (string|Map): Label background.
  • label.border_color (Color): Label border color.
  • label.border_width (number): Label border width.
  • label.border_type (string|number|List): Label border type.
  • label.border_dash_offset (number): Label border dash offset.
  • label.border_radius (number): Label border radius.
  • label.padding (number|List): Label padding.
  • label.shadow_color (Color): Label shadow color.
  • label.shadow_blur (number): Label shadow blur.
  • label.shadow_offset_x (number): Label shadow offset X.
  • label.shadow_offset_y (number): Label shadow offset Y.
  • label.width (number): Label width.
  • label.height (number): Label height.
  • label.text_border_color (Color): Label text stroke color.
  • label.text_border_width (number): Label text stroke width.
  • label.text_border_type (string|number|List): Label text stroke type.
  • label.text_border_dash_offset (number): Label text stroke dash offset.
  • label.text_shadow_color (Color): Label text shadow color.
  • label.text_shadow_blur (number): Label text shadow blur.
  • label.text_shadow_offset_x (number): Label text shadow offset X.
  • label.text_shadow_offset_y (number): Label text shadow offset Y.
  • label.overflow (string): Label overflow handling.
  • label.ellipsis (string): Label ellipsis.
  • label.rich (Map): Label rich text styles.
  • label.rich_inherit_plain_label (boolean): Rich text inherits plain styles.
  • label_layout (Map): Label layout options.
  • label_layout.hide_overlap (boolean): Hide overlapped labels.
  • label_layout.move_overlap (string): Move overlapped labels.
  • label_layout.x (number|string): Label x position.
  • label_layout.y (number|string): Label y position.
  • label_layout.dx (number): Label x offset.
  • label_layout.dy (number): Label y offset.
  • label_layout.rotate (number): Label rotation.
  • label_layout.width (number): Label width.
  • label_layout.height (number): Label height.
  • label_layout.align (string): Label horizontal alignment.
  • label_layout.vertical_align (string): Label vertical alignment.
  • label_layout.font_size (number): Label font size.
  • label_layout.draggable (boolean): Allow dragging labels.
  • label_layout.label_line_points (List): Label line points.
  • item_style (Map): Item style options (cartesian only).
  • item_style.color (Color): Item color.
  • item_style.border_color (Color): Item border color.
  • item_style.border_width (number): Item border width.
  • item_style.border_type (string|number|List): Item border type.
  • item_style.border_dash_offset (number): Item border dash offset.
  • item_style.border_cap (string): Item border cap.
  • item_style.border_join (string): Item border join.
  • item_style.border_miter_limit (number): Item border miter limit.
  • item_style.shadow_blur (number): Item shadow blur.
  • item_style.shadow_color (Color): Item shadow color.
  • item_style.shadow_offset_x (number): Item shadow offset X.
  • item_style.shadow_offset_y (number): Item shadow offset Y.
  • item_style.opacity (number): Item opacity.
  • item_style.border_radius (number|List): Item border radius.
  • emphasis.disabled (boolean): Disable emphasis state.
  • emphasis.focus (string): Focus mode: none/self/series.
  • emphasis.blur_scope (string): Blur scope: coordinateSystem/series/global.
  • emphasis (Map): Emphasis state options.
  • emphasis.item_style (Map): Emphasis item style options.
  • emphasis.label (Map): Emphasis label options.
  • blur (Map): Blur state options.
  • blur.item_style (Map): Blur item style options.
  • blur.label (Map): Blur label options.
  • select (Map): Select state options.
  • select.item_style (Map): Select item style options.
  • select.label (Map): Select label options.
  • select.disabled (boolean): Disable selection.
  • selected_mode (boolean|string): Selection mode: true/false/'single'/'multiple'/'series'.
  • encode (Map): Encode mapping.
  • series_layout_by (string): Dataset layout: 'column' or 'row'.
  • dataset_index (number): Dataset index to use.
  • data_group_id (string): Group ID for data items.
  • data (List): Series data.
  • mark_point (Map): Mark point options.
  • mark_line (Map): Mark line options.
  • mark_area (Map): Mark area options.
  • zlevel (number): Canvas layer.
  • z (number): Z order.
  • silent (boolean): Ignore mouse events.
  • tooltip (Map): Series tooltip options.