Skip to content
pyautark (soon)

@urban-toolkit/autk-map


@urban-toolkit/autk-map / LoadCollectionParams

Interface: LoadCollectionParams

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

Parameter types for the main AutkMap loading and update APIs.

Properties

collection

collection: FeatureCollection<Geometry | null>

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

Source feature collection to load.

Raster-derived collections may contain null geometries because values are resolved from raster cell payloads rather than vector geometry.


loadConfig?

optional loadConfig?: LoadCollectionConfig

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

Optional geometry-building configuration applied while loading.


property?

optional property?: string

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

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 each raster cell object and is required to populate the raster value texture.


type?

optional type?: LayerType | null

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

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.