Skip to contents

Heatmap Series

Source: R/series.R
HeatmapSeries.Rd

Configuration for a heatmap chart series on Cartesian coordinates. Each data point is a triple [col_index, row_index, value] and color encoding is driven by a VisualMap component.

Usage

HeatmapSeries(
  name = NULL,
  data = NULL,
  x_axis_index = NULL,
  y_axis_index = NULL,
  silent = NULL,
  legend_hover_link = NULL,
  z_level = NULL,
  z = NULL,
  label = NULL,
  item_style = NULL,
  emphasis = NULL
)

Arguments

name

Optional Character: Series name.

data

Optional list: Heatmap data. Each element is a length-3 list list(col_index, row_index, value).

x_axis_index

Optional Numeric [0, Inf): X-axis index.

y_axis_index

Optional Numeric [0, Inf): Y-axis index.

silent

Optional Logical: Whether the series is silent (no events).

Optional Logical: Whether to link hover with the legend.

z_level

Optional Numeric: Canvas layer index.

z

Optional Numeric: Front-back order within the same layer.

label

Optional LabelOption: Cell label configuration (e.g. show the value).

item_style

Optional ItemStyle: Cell styling (e.g. border color/width).

emphasis

Optional list: Emphasis (hover) styling. A plain list passed through to ECharts, e.g. list(itemStyle = list(shadowBlur = 10)).

Value

HeatmapSeries object.

Details

Corresponds to HeatmapSeriesOption in src/chart/heatmap/HeatmapSeries.ts. ECharts docs: https://echarts.apache.org/en/option.html#series-heatmap

Examples

# Each element is one cell, as c(column index, row index, value).
HeatmapSeries(name = "Density", data = list(c(0, 0, 5), c(1, 0, 3)))
#> <rtemis.draw::HeatmapSeries>
#>  @ name             : chr "Density"
#>  @ data             :List of 2
#>  .. $ : num [1:3] 0 0 5
#>  .. $ : num [1:3] 1 0 3
#>  @ x_axis_index     : NULL
#>  @ y_axis_index     : NULL
#>  @ silent           : NULL
#>  @ legend_hover_link: NULL
#>  @ z_level          : NULL
#>  @ z                : NULL
#>  @ label            : NULL
#>  @ item_style       : NULL
#>  @ emphasis         : NULL