Class HonuaMap

A protocol-aware map that separates data sources from rendering layers.

Example

const map = new HonuaMap({ client });

map.addSource("parcels", {
  type: "honua-feature-service",
  url: "https://gis.example.com/rest/services/parcels/FeatureServer/0",
  definitionExpression: "status = 'active'",
});

map.addLayer({
  id: "parcel-fill",
  source: "parcels",
  type: "fill",
  paint: { "fill-color": "#088", "fill-opacity": 0.5 },
});

map.addLayer({
  id: "parcel-labels",
  source: "parcels",
  type: "symbol",
  layout: { "text-field": ["get", "parcel_id"] },
});

// Access the underlying surface for queries
const parcels = map.getSource("parcels"); // HonuaFeatureLayer
const count = await (parcels as HonuaFeatureLayer).queryFeatureCount();

Index

Constructors

constructor

new HonuaMap(options: HonuaMapOptions): HonuaMap
Parameters
- options: HonuaMapOptions
Returns HonuaMap
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:125

Accessors

layerCount

get layerCount(): number
Number of registered layers.

Returns number
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:383

layerIds

get layerIds(): string[]
Get all layer IDs in render order.

Returns string[]
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:326

layers

get layers(): readonly HonuaLayerSpecification[]
Get all layers in render order.

Returns readonly HonuaLayerSpecification[]
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:331

sourceCount

get sourceCount(): number
Number of registered sources.

Returns number
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:378

sourceIds

get sourceIds(): string[]
Get all registered source names.

Returns string[]
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:222

Methods

addLayer

addLayer(spec: HonuaLayerSpecification, beforeId?: string): void
Add a rendering layer.

Layers reference a source by name. Multiple layers can reference the same source (e.g. a fill layer and a symbol layer over the same Feature Service).
Parameters
- spec: HonuaLayerSpecification
  Layer specification (must include id, source, type).
- OptionalbeforeId: string
  Insert this layer before the layer with this ID. If omitted, appends to the end.
Returns void
Throws
If the referenced source does not exist.

Throws
If a layer with the same ID already exists.
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:241

addSource

addSource(
name: string,
spec: HonuaSourceSpecification | { type: string; [key: string]: unknown },
): void
Register a named data source.

Honua sources (honua-feature-service, honua-map-service, honua-ogc-features) are resolved into SDK surface instances. Native MapLibre sources (vector, raster, geojson) are stored as-is and resolve to null.
Parameters
- name: string
- spec: HonuaSourceSpecification | { type: string; [key: string]: unknown }
Returns void
Throws
If a source with the same name already exists.
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:145

clear

clear(): void
Remove all sources and layers.

Returns void
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:388

getLayer

getLayer(id: string): HonuaLayerSpecification | undefined
Get a layer specification by ID.
Parameters
- id: string
Returns HonuaLayerSpecification | undefined
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:273

getLayersForSource

getLayersForSource(sourceId: string): HonuaLayerSpecification[]
Get all layers that reference a given source.
Parameters
- sourceId: string
Returns HonuaLayerSpecification[]
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:336

getSource

getSource(name: string): ResolvedMapSource | undefined
Get the resolved SDK surface for a source.

Returns null for native MapLibre sources (they should be handled by MapLibre directly). Returns undefined if the source does not exist.
Parameters
- name: string
Returns ResolvedMapSource | undefined
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:189

getSourceSpec

getSourceSpec(
    name: string,
):
    | HonuaSourceSpecification
    | { type: string; [key: string]: unknown }
    | undefined
Get the raw specification for a source.
Parameters
- name: string
Returns HonuaSourceSpecification | { type: string; [key: string]: unknown } | undefined
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:194

hasLayer

hasLayer(id: string): boolean
Check whether a layer with the given ID exists.
Parameters
- id: string
Returns boolean
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:298

hasSource

hasSource(name: string): boolean
Check whether a source with the given name exists.
Parameters
- name: string
Returns boolean
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:217

moveLayer

moveLayer(id: string, beforeId?: string): void
Move a layer to a new position in the render order.
Parameters
- id: string
  The layer to move.
- OptionalbeforeId: string
  Place it before this layer. If omitted, moves to end.
Returns void
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:308

on

on(listener: HonuaMapEventListener): { remove(): void }
Subscribe to map structure changes. Returns a remove handle.
Parameters
- listener: HonuaMapEventListener
Returns { remove(): void }
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:366

removeLayer

removeLayer(id: string): boolean
Remove a layer by ID. Returns true if the layer was found and removed.
Parameters
- id: string
Returns boolean
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:264

removeSource

removeSource(name: string): string[]
Remove a named data source and all layers that reference it.
Parameters
- name: string
Returns string[]
The IDs of layers that were removed.
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:159

toStyle

toStyle(options?: { name?: string }): HonuaStyleSpecification
Produce a MapLibre-compatible style specification.

Honua sources are included with their original custom type values. Use this to feed into a MapLibre map via map.setStyle(honuaMap.toStyle()) alongside a MapLibre source-type plugin that handles the Honua types.
Parameters
- Optionaloptions: { name?: string }
Returns HonuaStyleSpecification
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:349

updateLayer

updateLayer(
id: string,
patch: Partial<Omit<HonuaLayerSpecification, "id">>,
): HonuaLayerSpecification
Patch a layer specification by ID. The layer ID remains stable.
Parameters
- id: string
- patch: Partial<Omit<HonuaLayerSpecification, "id">>
Returns HonuaLayerSpecification
Throws
If the layer does not exist.

Throws
If the patched source does not exist.
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:283

updateSource

updateSource(
name: string,
spec: HonuaSourceSpecification | { type: string; [key: string]: unknown },
): void
Replace a source specification while preserving layers that reference it.

This updates the resolved SDK surface for Honua custom source types and leaves render layers in place so callers can decide how to patch the renderer.
Parameters
- name: string
- spec: HonuaSourceSpecification | { type: string; [key: string]: unknown }
Returns void
Throws
If the source does not exist.
- Defined in work/honua-sdk-js/honua-sdk-js/src/map/honua-map.ts:207

Class HonuaMap

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns HonuaMap

Accessors

layerCount

Returns number

layerIds

Returns string[]

layers

Returns readonly HonuaLayerSpecification[]

sourceCount

Returns number

sourceIds

Returns string[]

Methods

addLayer

Parameters

Returns void

Throws

Throws

addSource

Parameters

Returns void

Throws

clear

Returns void

getLayer

Parameters

Returns HonuaLayerSpecification | undefined

getLayersForSource

Parameters

Returns HonuaLayerSpecification[]

getSource

Parameters

Returns ResolvedMapSource | undefined

getSourceSpec

Parameters

Returns HonuaSourceSpecification | { type: string; [key: string]: unknown } | undefined

hasLayer

Parameters

Returns boolean

hasSource

Parameters

Returns boolean

moveLayer

Parameters

Returns void

on

Parameters

Returns { remove(): void }

removeLayer

Parameters

Returns boolean

removeSource

Parameters

Returns string[]

toStyle

Parameters

Returns HonuaStyleSpecification

updateLayer

Parameters

Returns HonuaLayerSpecification

Throws

Throws

updateSource

Parameters

Returns void

Throws

Settings

On This Page