@urban-toolkit/autk-map

---

@urban-toolkit/autk-map / AutkMap

Class: AutkMap

Defined in: autk-map/src/map.ts:93

Main map controller for rendering, interaction, and layer lifecycle.

AutkMap initializes the renderer, camera, layer manager, and interaction controllers, and exposes high-level APIs for loading and updating layers.

Example

const canvas = document.getElementById('map-canvas') as HTMLCanvasElement;

const map = new AutkMap(canvas);
await map.init();

const geojsonData = { /* GeoJSON data */ };
map.loadCollection('my_data', { collection: geojsonData });

Constructors

Constructor

new AutkMap(canvas): AutkMap

Defined in: autk-map/src/map.ts:127

Creates an AutkMap instance bound to a canvas element.

Parameters

canvas

HTMLCanvasElement

Canvas element used as the WebGPU drawing surface.

Returns

AutkMap

Throws

Never throws.

Accessors

activePickingLayer

Get Signature

get activePickingLayer(): Layer | null

Defined in: autk-map/src/map.ts:173

Currently active pick-enabled layer, if any.

Returns

Layer | null

---

camera

Get Signature

get camera(): Camera

Defined in: autk-map/src/map.ts:143

View and projection camera.

Returns

Camera

---

canvas

Get Signature

get canvas(): HTMLCanvasElement

Defined in: autk-map/src/map.ts:158

Backing WebGPU canvas element.

Returns

HTMLCanvasElement

---

events

Get Signature

get events(): EventEmitter<MapEventRecord>

Defined in: autk-map/src/map.ts:168

Public typed map-event bus (e.g., picking).

Returns

EventEmitter<MapEventRecord>

---

layerManager

Get Signature

get layerManager(): LayerManager

Defined in: autk-map/src/map.ts:153

Ordered layer stack manager.

Returns

LayerManager

---

renderer

Get Signature

get renderer(): Renderer

Defined in: autk-map/src/map.ts:148

WebGPU renderer.

Returns

Renderer

---

ui

Get Signature

get ui(): AutkMapUi

Defined in: autk-map/src/map.ts:163

Map UI controller.

Returns

AutkMapUi

Methods

clearHighlightedIds()

clearHighlightedIds(id): void

Defined in: autk-map/src/map.ts:666

Clears the highlighted selection of a pickable layer.

Parameters

id

string

Layer identifier.

Returns

void

Nothing. Unsupported layers are ignored.

Throws

Never throws.

---

clearSkippedIds()

clearSkippedIds(id): void

Defined in: autk-map/src/map.ts:699

Clears skipped rendering state for a vector layer.

Parameters

id

string

Layer identifier.

Returns

void

Nothing. Non-vector layers are ignored.

Throws

Never throws.

---

destroy()

destroy(): void

Defined in: autk-map/src/map.ts:757

Tears down map resources, event bindings, and GPU allocations.

Returns

void

Nothing. Repeated calls after destruction are ignored.

Throws

Never throws.

Example

map.destroy();

---

draw()

draw(fps?): void

Defined in: autk-map/src/map.ts:717

Starts the continuous render loop at the target frame rate.

Parameters

fps?

number = 60

Target frames per second (default 60). Pass 0 to render as fast as possible.

Returns

void

Nothing. Rendering is scheduled via requestAnimationFrame.

Throws

Never throws.

Example

map.draw(30);  // render at 30 fps

---

init()

init(): Promise<void>

Defined in: autk-map/src/map.ts:185

Initializes renderer resources, event bindings, and UI.

Returns

Promise<void>

Promise that resolves when renderer initialization completes.

Throws

If WebGPU is not available or device acquisition fails.

Example

await map.init();

---

loadCollection()

loadCollection(id, params): void

Defined in: autk-map/src/map.ts:223

Loads a GeoJSON feature collection as a map layer.

When type is omitted the layer type is inferred from all non-null geometries in the collection. Implicit inference only works for collections that resolve to a single geometry family (Point → 'points', LineString → 'polylines', Polygon → 'polygons'). Mixed-geometry collections must pass an explicit type.

Supported layer types: 'surface', 'water', 'parks', 'roads', 'buildings', 'points', 'polylines', 'polygons', 'raster'.

Parameters

id

string

Unique layer identifier.

params

LoadCollectionParams

Load parameters.

Returns

void

Throws

Never throws. Errors are logged to the console.

---

loadMesh()

loadMesh(id, params): void

Defined in: autk-map/src/map.ts:292

Loads a prebuilt 3D triangle mesh directly into the map.

Mesh coordinates must already be expressed in the map's local coordinate space, relative to the current shared origin.

Parameters

id

string

Layer identifier.

params

LoadMeshParams

Mesh loading parameters.

Returns

void

Nothing. The mesh layer is created and registered with the map.

Throws

If the map origin has not been initialized.

---

removeLayer()

removeLayer(id): void

Defined in: autk-map/src/map.ts:636

Removes all layers matching the provided id.

Parameters

id

string

Layer identifier.

Returns

void

Nothing. Matching layers are removed from the map.

Throws

Never throws. Unknown ids are silently ignored.

---

setHighlightedIds()

setHighlightedIds(id, selection): void

Defined in: autk-map/src/map.ts:650

Replaces the highlighted selection of a pickable layer.

Parameters

id

string

Layer identifier.

selection

number[]

Component ids to highlight.

Returns

void

Nothing. Unsupported layers are ignored.

Throws

Never throws.

---

setSkippedIds()

setSkippedIds(id, selection): void

Defined in: autk-map/src/map.ts:683

Toggles skipped rendering for the provided component ids of a vector layer.

Parameters

id

string

Layer identifier.

selection

number[]

Component ids to skip/unskip.

Returns

void

Nothing. Non-vector layers are ignored.

Throws

Never throws.

---

updateColorMap()

updateColorMap(id, params): void

Defined in: autk-map/src/map.ts:539

Updates color-map configuration for a layer.

Parameters

id

string

Layer identifier.

params

UpdateColorMapParams

Color-map update parameters.

Returns

void

Nothing. The target layer render configuration is updated in place.

Throws

Never throws. Unknown layers are silently ignored.

---

updateRaster()

updateRaster(id, params): void

Defined in: autk-map/src/map.ts:493

Updates raster layer values and color domain.

Parameters

id

string

Layer identifier.

params

UpdateRasterParams

Update parameters.

Returns

void

Throws

Never throws. Errors are logged to the console.

---

updateRenderInfo()

updateRenderInfo(id, params): void

Defined in: autk-map/src/map.ts:596

Updates one or more render properties of a layer.

Parameters

id

string

Layer identifier.

params

UpdateRenderInfoParams | Partial<LayerRenderInfo>

Render update parameters.

UpdateRenderInfoParams

---

Partial<LayerRenderInfo>

Returns

void

Nothing. The target layer render state is updated in place.

Throws

Never throws. Unknown layers are silently ignored.

---

updateThematic()

updateThematic(id, params): void

Defined in: autk-map/src/map.ts:339

Updates the thematic (color-mapped) values of a layer from a feature collection.

Normalization to [0, 1] (required by the GPU shader) and legend label generation are delegated to ColorMap based on the active layer colorMap configuration.

Thematic values are aligned to rendered components through source feature metadata captured during triangulation. When both the layer and the input collection expose feature ids, matching is done by feature.id; otherwise the update falls back to the original feature index order.

For raster layers the raster texture is rebuilt from property.

Parameters

id

string

Layer identifier.

params

UpdateThematicParams

Update parameters.

Returns

void

Throws

Never throws. Errors are logged to the console.