@urban-toolkit/autk-db

---

@urban-toolkit/autk-db / BuildHeatmapParams

Interface: BuildHeatmapParams

Defined in: use-cases/build-heatmap/interfaces.ts:23

Parameters for building a heatmap from spatially joined data.

Remarks

Requires a valid bounding box and source table to be passed at execution time.

Properties

grid

grid: object

Defined in: use-cases/build-heatmap/interfaces.ts:33

Grid dimensions for the heatmap overlay.

columns

columns: number

Number of columns in the output grid.

rows

rows: number

Number of rows in the output grid.

---

groupBy?

optional groupBy?: HeatmapGroupBy[]

Defined in: use-cases/build-heatmap/interfaces.ts:31

Optional group-by columns to aggregate into separate raster bands.

---

near

near: NearConfig

Defined in: use-cases/build-heatmap/interfaces.ts:27

NEAR predicate configuration for heatmap generation.

---

outputTableName

outputTableName: string

Defined in: use-cases/build-heatmap/interfaces.ts:29

Name of the output table that will hold the heatmap result.

---

tableJoinName

tableJoinName: string

Defined in: use-cases/build-heatmap/interfaces.ts:25

Name of the source table to join against the grid.