Skip to content
pyautark (soon)

@urban-toolkit/autk-map


@urban-toolkit/autk-map / LoadCollectionParams

Interface: LoadCollectionParams

Defined in: autk-map/src/api.ts:57

Parameter types for the main AutkMap loading and update APIs.

Properties

collection

collection: FeatureCollection<Geometry | null>

Defined in: autk-map/src/api.ts:65

Source feature collection to load.

Raster-derived collections may contain null geometries because values are provided as flat band arrays on the feature properties rather than as per-cell vector geometries.


loadConfig?

optional loadConfig?: LoadCollectionConfig

Defined in: autk-map/src/api.ts:77

Optional geometry-building configuration applied while loading.


property?

optional property?: string

Defined in: autk-map/src/api.ts:89

Property accessor used to derive layer values.

Use a dot-path string accessor such as properties.shape_area.

For vector layers, the path is resolved from each feature and is applied immediately as the initial thematic mapping when provided.

For raster layers, the path is resolved from the feature properties and must point to a flat band array such as band_1.


type?

optional type?: LayerType | null

Defined in: autk-map/src/api.ts:73

Optional explicit layer type override.

Provide this when geometry-based inference is ambiguous, such as for mixed-geometry collections, or when the intended semantic layer type should not be derived automatically.

Released under the MIT License.