Class: D3PHeatmapRenderer ​

Defined in: core/renderers/heatmap.ts:52

A grid of cells colored by a value. The series has the columns x and y (both categories, on band or point axes) and value; the primary column is value: new D3PSeries({ columns: ['x', 'y', 'value'], primary: 'value', data }). Link its axes with a named auto domain mapping ({ x: dx, y: dy }). It draws cells in any coordinate system, so a polar heatmap is a heatmap on polar axes.

Extends ​

Accessors ​

color ​

Get Signature ​

ts
get color(): string;

Defined in: core/renderers/base.ts:194

The color of the renderer: the one in its style, or the one its name gives.

Returns ​

string

Inherited from ​

D3PSeriesRenderer.color

marker ​

Get Signature ​

ts
get marker(): D3PMarker | undefined;

Defined in: core/renderers/base.ts:140

What shows the point under the pointer; undefined for none.

Returns ​

D3PMarker | undefined

Set Signature ​

ts
set marker(m): void;

Defined in: core/renderers/base.ts:144

Replaces the marker, or removes it with undefined.

Parameters ​
m ​

D3PMarker | undefined

Returns ​

void

Inherited from ​

D3PSeriesRenderer.marker

props ​

Get Signature ​

ts
get props(): D3PProps<P & object>;

Defined in: core/renderers/base.ts:159

The props of the renderer: its style, what its type adds, and visible.

Returns ​

D3PProps<P & object>

Set Signature ​

ts
set props(v): void;

Defined in: core/renderers/base.ts:163

Merges props into those of the renderer; it is drawn again, with a transition.

Parameters ​
v ​

DeepPartial<P & object>

Returns ​

void

Inherited from ​

D3PSeriesRenderer.props

series ​

Get Signature ​

ts
get series(): D3PSeries;

Defined in: core/renderers/base.ts:168

The series the renderer draws.

Returns ​

D3PSeries

Set Signature ​

ts
set series(s): void;

Defined in: core/renderers/base.ts:172

Changes the series: the renderer is drawn again.

Parameters ​
s ​

D3PSeries

Returns ​

void

Inherited from ​

D3PSeriesRenderer.series

visible ​

Get Signature ​

ts
get visible(): boolean;

Defined in: core/renderers/base.ts:183

Whether the renderer is shown.

Returns ​

boolean

Set Signature ​

ts
set visible(v): void;

Defined in: core/renderers/base.ts:187

Shows or hides the renderer, with a transition.

Parameters ​
v ​

boolean

Returns ​

void

Inherited from ​

D3PSeriesRenderer.visible

Constructors ​

Constructor ​

ts
new D3PHeatmapRenderer(opts): D3PHeatmapRenderer;

Defined in: core/renderers/heatmap.ts:58

Parameters ​

opts ​

D3PHeatmapOptions

Returns ​

D3PHeatmapRenderer

Overrides ​

D3PSeriesRenderer.constructor

Methods ​

addToChart() ​

ts
addToChart(chart): void;

Defined in: core/object.ts:77

Attaches the object to a chart; nothing happens if it already is attached to it.

Parameters ​

chart ​

D3PChart

Returns ​

void

Inherited from ​

D3PSeriesRenderer.addToChart

attached() ​

ts
protected attached(
   chart, 
   data, 
   subs
): void;

Defined in: core/renderers/heatmap.ts:94

Subscribe / create DOM. Subscriptions added to subs are released on detach.

Parameters ​

chart ​

D3PChart

data ​

D3PRendererChartData<HeatmapData>

subs ​

D3PSubscriptions

Returns ​

void

Overrides ​

D3PSeriesRenderer.attached

chartAdded() ​

ts
protected chartAdded(chart, data): void;

Defined in: core/renderers/heatmap.ts:87

Called when the renderer is attached to a chart, to create what it draws with.

Parameters ​

chart ​

D3PChart

data ​

HeatmapData

Returns ​

void

Overrides ​

D3PSeriesRenderer.chartAdded

chartRemoved() ​

ts
protected chartRemoved(_chart, data): void;

Defined in: core/renderers/heatmap.ts:90

Called when the renderer leaves a chart, to remove what it created.

Parameters ​

_chart ​

D3PChart

data ​

HeatmapData

Returns ​

void

Overrides ​

D3PSeriesRenderer.chartRemoved

checkColumns() ​

ts
protected checkColumns(series?): void;

Defined in: core/renderers/base.ts:255

Throws when the series lacks a column this renderer reads.

Parameters ​

series? ​

D3PSeries = ...

Returns ​

void

Inherited from ​

D3PSeriesRenderer.checkColumns

createData() ​

ts
protected createData(chart): D3PRendererChartData<HeatmapData>;

Defined in: core/renderers/base.ts:291

Build the per-chart record. Must not rely on other objects of the chart.

Parameters ​

chart ​

D3PChart

Returns ​

D3PRendererChartData<HeatmapData>

Inherited from ​

D3PSeriesRenderer.createData

createGroup() ​

ts
protected createGroup(chart): Group;

Defined in: core/renderers/base.ts:420

Create the renderer's own group in the middle data layer.

Parameters ​

chart ​

D3PChart

Returns ​

Group

Inherited from ​

D3PSeriesRenderer.createGroup

createMarker() ​

ts
createMarker(): D3PMarker;

Defined in: core/renderers/heatmap.ts:180

The marker this kind of renderer has by default (none unless overridden).

Returns ​

D3PMarker

Overrides ​

D3PSeriesRenderer.createMarker

createRendererData() ​

ts
protected createRendererData(): HeatmapData;

Defined in: core/renderers/heatmap.ts:84

Creates what the renderer keeps for a chart.

Returns ​

HeatmapData

Overrides ​

D3PSeriesRenderer.createRendererData

destroy() ​

ts
destroy(): void;

Defined in: core/object.ts:51

Detaches the object from all its charts, announces destroyed and releases its subscriptions. The object cannot be used afterwards.

Returns ​

void

Inherited from ​

D3PSeriesRenderer.destroy

detached() ​

ts
protected detached(chart, data): void;

Defined in: core/renderers/base.ts:306

DOM / registry cleanup (subscriptions are released afterwards).

Parameters ​

chart ​

D3PChart

data ​

D3PRendererChartData<HeatmapData>

Returns ​

void

Inherited from ​

D3PSeriesRenderer.detached

entriesChanged() ​

ts
protected entriesChanged(): void;

Defined in: core/renderers/base.ts:210

Announce that legendEntries() changed (the legend refreshes).

Returns ​

void

Inherited from ​

D3PSeriesRenderer.entriesChanged

fire() ​

ts
protected fire<P>(event, ...args): void;

Defined in: core/object.ts:41

Emits one of its own events on the bus.

Type Parameters ​

P ​

P

Parameters ​

event ​

D3PEvent<P>

args ​

...P extends void ? [] : [payload: P]

Returns ​

void

Inherited from ​

D3PSeriesRenderer.fire

getAxes() ​

ts
getAxes(chart): object;

Defined in: core/renderers/base.ts:320

Axes this renderer draws against on chart: the one the series' x is plotted on, and the one for its y. By default the first X-component axis and the first Y-component axis of the same coordinate system; a horizontal renderer swaps them.

Parameters ​

chart ​

D3PChart

Returns ​

object

x? ​
ts
x?: D3PAxis;
y? ​
ts
y?: D3PAxis;

Inherited from ​

D3PSeriesRenderer.getAxes

getCharts() ​

ts
getCharts(): D3PChart[];

Defined in: core/object.ts:105

The charts the object is attached to.

Returns ​

D3PChart[]

Inherited from ​

D3PSeriesRenderer.getCharts

hasChart() ​

ts
hasChart(chart): boolean;

Defined in: core/object.ts:110

Whether the object is attached to this chart.

Parameters ​

chart ​

D3PChart

Returns ​

boolean

Inherited from ​

D3PSeriesRenderer.hasChart

legendEntries() ​

ts
legendEntries(): D3PLegendItem[];

Defined in: core/renderers/heatmap.ts:79

The color legend is a D3PColorLegend of the scale: no line per series here.

Returns ​

D3PLegendItem[]

Overrides ​

D3PSeriesRenderer.legendEntries

onDestroy() ​

ts
protected onDestroy(): void;

Defined in: core/renderers/heatmap.ts:99

Hook run first on destroy (detach from partners, release DOM...).

Returns ​

void

Overrides ​

D3PSeriesRenderer.onDestroy

probeHit() ​

ts
probeHit(
   chart, 
   event, 
   _joins?
): D3PProbeHit | undefined;

Defined in: core/renderers/heatmap.ts:184

What this renderer finds for event on chart: by default the data point whose X is closest to the value under the pointer (read through the probe, so joins apply). Renderers that do not map data through axes (a pie) test the pixel instead. Ask the probe (d3pProbe(chart).hit) rather than this method: it computes once per event.

Parameters ​

chart ​

D3PChart

event ​

D3PPointerEvent

_joins? ​

readonly D3PJoinGroup[] = []

Returns ​

D3PProbeHit | undefined

Overrides ​

D3PSeriesRenderer.probeHit

projectFrom() ​

ts
projectFrom(point, cache?): 
  | [D3PDomainValue, D3PDomainValue]
  | undefined;

Defined in: core/renderers/base.ts:358

Data values [x, y] under a viewport point; undefined outside of the system.

Parameters ​

point ​

D3PViewportPoint

cache? ​

D3PProjectionCache

Returns ​

| [D3PDomainValue, D3PDomainValue] | undefined

Inherited from ​

D3PSeriesRenderer.projectFrom

projectTo() ​

ts
projectTo(
   chart, 
   x, 
   y, 
   cache?
): D3PViewportPoint | undefined;

Defined in: core/renderers/base.ts:351

Viewport point of the data point (x, y).

Parameters ​

chart ​

D3PChart

x ​

D3PDomainValue

y ​

D3PDomainValue

cache? ​

D3PProjectionCache

Returns ​

D3PViewportPoint | undefined

Inherited from ​

D3PSeriesRenderer.projectTo

projectToRange() ​

ts
projectToRange(
   chart, 
   x, 
   y, 
   cache?
): [number, number] | undefined;

Defined in: core/renderers/base.ts:341

Position of the data point (x, y) in range units, in the order of the dimensions of the system (the series' x goes on the first dimension unless the renderer is horizontal).

Parameters ​

chart ​

D3PChart

x ​

D3PDomainValue

y ​

D3PDomainValue

cache? ​

D3PProjectionCache

Returns ​

[number, number] | undefined

Inherited from ​

D3PSeriesRenderer.projectToRange

removeFromChart() ​

ts
removeFromChart(chart): void;

Defined in: core/object.ts:95

Detaches the object from a chart; nothing happens if it is not attached to it.

Parameters ​

chart ​

D3PChart

Returns ​

void

Inherited from ​

D3PSeriesRenderer.removeFromChart

render() ​

ts
render(chart): Promise<void>;

Defined in: core/renderers/base.ts:387

Draws the object on a chart. The render manager calls it, once per frame, for the objects that asked for it.

Parameters ​

chart ​

D3PChart

Returns ​

Promise<void>

Inherited from ​

D3PSeriesRenderer.render

renderData() ​

ts
protected renderData(
   chart, 
   data, 
   x?, 
   y?
): void;

Defined in: core/renderers/heatmap.ts:163

Draws the series at once, with no transition.

Parameters ​

chart ​

D3PChart

data ​

HeatmapData

x? ​

D3PAxis

y? ​

D3PAxis

Returns ​

void

Overrides ​

D3PSeriesRenderer.renderData

renderDataHidden() ​

ts
protected renderDataHidden(_chart, data): void;

Defined in: core/renderers/heatmap.ts:170

Draws the series going away: the renderer was hidden.

Parameters ​

_chart ​

D3PChart

data ​

HeatmapData

Returns ​

void

Overrides ​

D3PSeriesRenderer.renderDataHidden

renderDataWithTransition() ​

ts
protected renderDataWithTransition(
   chart, 
   data, 
   x?, 
   y?
): void;

Defined in: core/renderers/heatmap.ts:166

Draws the series moving from what is on screen to what the data and the scales say now.

Parameters ​

chart ​

D3PChart

data ​

HeatmapData

x? ​

D3PAxis

y? ​

D3PAxis

Returns ​

void

Overrides ​

D3PSeriesRenderer.renderDataWithTransition

scalesOf() ​

ts
protected scalesOf(
   chart, 
   x?, 
   y?
): 
  | {
  sx: D3PScale;
  sy: D3PScale;
  system: D3PCoordinateSystem;
}
  | undefined;

Defined in: core/renderers/base.ts:430

Scales and coordinate system to draw with; throws if the system is not one the renderer supports.

Parameters ​

chart ​

D3PChart

x? ​

D3PAxis

y? ​

D3PAxis

Returns ​

| { sx: D3PScale; sy: D3PScale; system: D3PCoordinateSystem; } | undefined

Inherited from ​

D3PSeriesRenderer.scalesOf

seriesChanged() ​

ts
protected seriesChanged(): void;

Defined in: core/renderers/heatmap.ts:74

The series, or its data, changed. Renderers whose legend depends on the data announce it here.

Returns ​

void

Overrides ​

D3PSeriesRenderer.seriesChanged

tagDirty() ​

ts
tagDirty(chart?): void;

Defined in: core/renderers/base.ts:276

Schedule a redraw on one chart (or all attached charts).

Parameters ​

chart? ​

D3PChart

Returns ​

void

Inherited from ​

D3PSeriesRenderer.tagDirty

tagDirtyWithTransition() ​

ts
tagDirtyWithTransition(chart?): void;

Defined in: core/renderers/base.ts:272

Asks to draw again, with a transition: on one chart, or on all of them.

Parameters ​

chart? ​

D3PChart

Returns ​

void

Inherited from ​

D3PSeriesRenderer.tagDirtyWithTransition

Properties ​

axes ​

ts
readonly axes: D3PAxisFilter | undefined;

Defined in: core/renderers/base.ts:109

The axes the renderer is restricted to (objects or names), if any.

Inherited from ​

D3PSeriesRenderer.axes

bus ​

ts
readonly bus: D3PBus;

Defined in: core/object.ts:27

The bus the object uses for its events.

Inherited from ​

D3PSeriesRenderer.bus

chartData ​

ts
protected readonly chartData: Map<D3PChart, D3PRendererChartData<HeatmapData>>;

Defined in: core/object.ts:66

What the object keeps for each chart it is attached to.

Inherited from ​

D3PSeriesRenderer.chartData

colors ​

ts
readonly colors: D3PColorScale;

Defined in: core/renderers/heatmap.ts:55

The color scale the cells are colored by.

e ​

ts
readonly e: D3PEventTable<M & object>;

Defined in: core/object.ts:29

The events of the object, by name: destroyed for all, and its own (axis.e.scaleChanged).

Inherited from ​

D3PSeriesRenderer.e

id ​

ts
readonly id: number = ++D3PSeriesRenderer.counter;

Defined in: core/renderers/base.ts:105

A number that identifies the renderer: 1 for the first one created.

Inherited from ​

D3PSeriesRenderer.id

isDestroying ​

ts
isDestroying: boolean = false;

Defined in: core/object.ts:31

Set when destroy starts: the object is not drawn after that.

Inherited from ​

D3PSeriesRenderer.isDestroying

name ​

ts
readonly name: string;

Defined in: core/renderers/base.ts:107

The name of the renderer: the series name unless given.

Inherited from ​

D3PSeriesRenderer.name

propsHandle ​

ts
protected readonly propsHandle: D3PPropsHandle<D3PHeatmapProps & object>;

Defined in: core/renderers/base.ts:117

The props and their change hooks.

Inherited from ​

D3PSeriesRenderer.propsHandle

requiredColumns ​

ts
protected readonly requiredColumns: readonly ["y", "value"];

Defined in: core/renderers/heatmap.ts:53

Columns the series must have (['open', 'high', 'low', 'close']); checked when attaching.

Overrides ​

D3PSeriesRenderer.requiredColumns

subs ​

ts
protected readonly subs: D3PSubscriptions;

Defined in: core/object.ts:33

The subscriptions of the object, released when it is destroyed.

Inherited from ​

D3PSeriesRenderer.subs

system ​

ts
readonly system: string | undefined;

Defined in: core/renderers/base.ts:111

The name of the coordinate system the renderer draws in, if it was given one.

Inherited from ​

D3PSeriesRenderer.system

systemKinds ​

ts
protected readonly systemKinds: readonly string[] | undefined = undefined;

Defined in: core/renderers/base.ts:113

Kinds of coordinate system the renderer can draw in (undefined: any).

Inherited from ​

D3PSeriesRenderer.systemKinds