heatmap

#heatmap.addfunction

Adds a heatmap.column (from liq.heat or book.heat) at its own time and span.

heatmap.add(id: heatmap, column: heatmap.column, { width?: int = na })

Example

const hm = heatmap.new()
const col = liq.heat()
if (!na(col)) {
    hm.add(col)
}

Since ChartScript 1

#heatmap.cellfunction

Adds one cell from low to high.

heatmap.cell(id: heatmap, x: int, low: float, high: float, value: float, { width?: int = na })

Example

const hm = heatmap.new()
hm.cell(time, low, high, volume)

Since ChartScript 1

#heatmap.clearfunction

Removes every column of the heatmap.

heatmap.clear(id: heatmap)

Example

const hm = heatmap.new()
hm.clear()

Since ChartScript 1

#heatmap.columnfunction

Adds a column of equal cells. The non-empty cells count toward the 500,000-cell budget (CS5120).

heatmap.column

Example

const hm = heatmap.new()
hm.column(time, low, (high - low) / 4, array.from(1.0, 3.0, 2.0, 1.0))

Since ChartScript 1

#heatmap.deletefunction

Deletes the heatmap.

heatmap.delete(id: heatmap)

Example

const hm = heatmap.new()
hm.delete()

Since ChartScript 1

#heatmap.newfunction

A new heatmap. Columns are added with column, add or cell; the chart paints all of them as one image per pane, coloured by value on the palette.

heatmap.new({ palette?: string = heatmap.palette_heat, min?: float = na, max?: float = na, scale?: string = heatmap.scale_linear, floor?: float = 0.05, gamma?: float = 0.9, reference?: float = 92, opacity?: int = 100, color?: color = na, xloc?: simple string = xloc.bar_time, smooth?: bool = false, intensity?: float = 1 }): heatmap

Returns heatmap.

Example

const hm = heatmap.new({ palette: heatmap.palette_viridis, scale: heatmap.scale_sqrt })

Since ChartScript 1

#heatmap.set_intensityfunction

Sets the intensity (brightness multiplier).

heatmap.set_intensity(id: heatmap, intensity: float)

Example

const hm = heatmap.new()
hm.set_intensity(1.5)

Since ChartScript 1

#heatmap.set_opacityfunction

Sets the opacity, 0 to 100.

heatmap.set_opacity(id: heatmap, opacity: int)

Example

const hm = heatmap.new()
hm.set_opacity(60)

Since ChartScript 1

#heatmap.set_rangefunction

Sets the values at the bottom and the top of the palette (na = automatic).

heatmap.set_range(id: heatmap, min: float, max: float)

Example

const hm = heatmap.new()
hm.set_range(0, 1000000)

Since ChartScript 1

#heatmap.sizefunction

The number of non-empty cells the heatmap holds.

heatmap.size(id: heatmap): int

Returns int.

Example

const hm = heatmap.new()
const cells = hm.size()

Since ChartScript 1

#heatmap.allvariable

The script's heatmaps, oldest first.

heatmap.all: array<heatmap>

Type series array<heatmap>.

Example

const n = heatmap.all.size()

Since ChartScript 1