Class MapHandleDiscarding

The commands of a MapHandle that discard their outcomes: each returns once native code accepts it and allocates no completion. A later completion on the same map fences them.

Index

Methods

addCustomGeometrySource addCustomMvtVectorSource addGeojsonSourceData addGeojsonSourceUrl addImageSourceImage addImageSourceUrl addStyleLayerJson addStyleSourceJson applyCameraDelta beginCommandGroup cancelCameraTransition cancelTransitions dumpDebugLogs endCommandGroup invalidateCustomGeometrySourceRegion invalidateCustomGeometrySourceTile invalidateCustomMvtVectorSourceTile moveStyleLayer removeFeatureState removeStyleImage removeStyleLayer removeStyleSource requestRepaint resize setBounds setCustomGeometrySourceTileData setCustomGeometrySourceTileError setCustomMvtVectorSourceTileData setCustomMvtVectorSourceTileError setDebugOptions setEventMask setFeatureState setFreeCameraOptions setGeojsonSourceData setGeojsonSourceSynchronousTiling setGeojsonSourceUrl setGlobalStateProperty setImageSourceCoordinates setImageSourceImage setImageSourceUrl setProjectionMode setRenderingStatsViewEnabled setStyleImage setStyleJson setStyleLayerProperty setStyleLightJson setStyleLightProperty setStyleSourceVolatile setStyleTransitionOptions setStyleUrl setTileOptions setViewportOptions updateCamera

Methods

addCustomGeometrySource

addCustomGeometrySource(
sourceId: string,
options?: CustomGeometrySourceOptions,
): void
Adds a custom geometry source.

See mln_map_add_custom_geometry_source in the C API reference.
Parameters
- sourceId: string
- Optionaloptions: CustomGeometrySourceOptions
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2618

addCustomMvtVectorSource

addCustomMvtVectorSource(
sourceId: string,
options?: CustomMvtVectorSourceOptions,
): void
Adds a custom MVT vector source.

See mln_map_add_custom_mvt_vector_source in the C API reference.
Parameters
- sourceId: string
- Optionaloptions: CustomMvtVectorSourceOptions
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2639

addGeojsonSourceData

addGeojsonSourceData(sourceId: string, data: GeojsonSourceDataHandle): void
Adds a GeoJSON source with prepared inline data.

See mln_map_add_geojson_source_data in the C API reference.
Parameters
- sourceId: string
- data: GeojsonSourceDataHandle
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2660

addGeojsonSourceUrl

addGeojsonSourceUrl(
    sourceId: string,
    url: string,
    options?: GeojsonSourceOptions,
): void
Adds a GeoJSON source with URL data.

See mln_map_add_geojson_source_url in the C API reference.
Parameters
- sourceId: string
- url: string
- Optionaloptions: GeojsonSourceOptions
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2675

addImageSourceImage

addImageSourceImage(
    sourceId: string,
    coordinates: readonly LatLng[],
    image?: PremultipliedRgba8Image,
): void
Adds an image source with inline image pixels.

See mln_map_add_image_source_image in the C API reference.
Parameters
- sourceId: string
- coordinates: readonly LatLng[]
- image: PremultipliedRgba8Image = {}
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2695

addImageSourceUrl

addImageSourceUrl(
    sourceId: string,
    coordinates: readonly LatLng[],
    url: string,
): void
Adds an image source that loads its image from a URL.

See mln_map_add_image_source_url in the C API reference.
Parameters
- sourceId: string
- coordinates: readonly LatLng[]
- url: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2715

addStyleLayerJson

addStyleLayerJson(layerJson: string, beforeLayerId?: string): void
Adds one style layer from a full style-spec layer JSON object.

See mln_map_add_style_layer_json in the C API reference.
Parameters
- layerJson: string
- OptionalbeforeLayerId: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2735

addStyleSourceJson

addStyleSourceJson(sourceId: string, sourceJson: string): void
Adds one style source from a style-spec source JSON object.

See mln_map_add_style_source_json in the C API reference.
Parameters
- sourceId: string
- sourceJson: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2750

applyCameraDelta

applyCameraDelta(delta?: CameraDelta): void
Submits one atomic relative camera update.

See mln_map_apply_camera_delta in the C API reference.
Parameters
- delta: CameraDelta = {}
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2765

beginCommandGroup

beginCommandGroup(): void
Begins a command group, which holds this map's render updates until the group ends.

See mln_map_begin_command_group in the C API reference.

Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2779

cancelCameraTransition

cancelCameraTransition(transitionId: bigint): void
Cancels the camera transitions of the commands whose animation carried transition_id, and leaves every other transition running.

See mln_map_cancel_camera_transition in the C API reference.
Parameters
- transitionId: bigint
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2790

cancelTransitions

cancelTransitions(): void
Cancels the camera transitions running when this command commits.

See mln_map_cancel_transitions in the C API reference.

Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2804

dumpDebugLogs

dumpDebugLogs(): void
Submits an ordered debug-log command.

See mln_map_dump_debug_logs in the C API reference.

Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2814

endCommandGroup

endCommandGroup(): void
Ends the innermost command group that mln_map_begin_command_group() began.

See mln_map_end_command_group in the C API reference.

Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2825

invalidateCustomGeometrySourceRegion

invalidateCustomGeometrySourceRegion(
sourceId: string,
bounds?: LatLngBounds,
): void
Invalidates custom geometry source data inside one geographic region.

See mln_map_invalidate_custom_geometry_source_region in the C API reference.
Parameters
- sourceId: string
- bounds: LatLngBounds = {}
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2835

invalidateCustomGeometrySourceTile

invalidateCustomGeometrySourceTile(
sourceId: string,
tileId?: CanonicalTileId,
): void
Invalidates custom geometry source data for one canonical tile.

See mln_map_invalidate_custom_geometry_source_tile in the C API reference.
Parameters
- sourceId: string
- tileId: CanonicalTileId = {}
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2853

invalidateCustomMvtVectorSourceTile

invalidateCustomMvtVectorSourceTile(
sourceId: string,
tileId?: CanonicalTileId,
): void
Invalidates custom MVT vector source data for one canonical tile.

See mln_map_invalidate_custom_mvt_vector_source_tile in the C API reference.
Parameters
- sourceId: string
- tileId: CanonicalTileId = {}
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2871

moveStyleLayer

moveStyleLayer(layerId: string, beforeLayerId?: string): void
Moves one style layer before another layer or to the top.

See mln_map_move_style_layer in the C API reference.
Parameters
- layerId: string
- OptionalbeforeLayerId: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2889

removeFeatureState

removeFeatureState(selector: FeatureStateSelector): void
Removes per-feature state from this map.

See mln_map_remove_feature_state in the C API reference.
Parameters
- selector: FeatureStateSelector
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2904

removeStyleImage

removeStyleImage(imageId: string): void
Removes one runtime style image by ID.

See mln_map_remove_style_image in the C API reference.
Parameters
- imageId: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2914

removeStyleLayer

removeStyleLayer(layerId: string): void
Removes one style layer by ID.

See mln_map_remove_style_layer in the C API reference.
Parameters
- layerId: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2924

removeStyleSource

removeStyleSource(sourceId: string): void
Removes one style source by ID.

See mln_map_remove_style_source in the C API reference.
Parameters
- sourceId: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2934

requestRepaint

requestRepaint(): void
Requests a repaint for a continuous map.

See mln_map_request_repaint in the C API reference.

Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2944

resize

resize(extent?: LogicalExtent): void
Submits the sole post-creation logical extent update.

See mln_map_resize in the C API reference.
Parameters
- extent: LogicalExtent = {}
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2954

setBounds

setBounds(options?: BoundOptions): void
Submits a copied camera-constraint command.

See mln_map_set_bounds in the C API reference.
Parameters
- options: BoundOptions = {}
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2964

setCustomGeometrySourceTileData

setCustomGeometrySourceTileData(
    sourceId: string,
    tileId: CanonicalTileId,
    data: string,
): void
Sets custom geometry source data for one canonical tile.

See mln_map_set_custom_geometry_source_tile_data in the C API reference.
Parameters
- sourceId: string
- tileId: CanonicalTileId
- data: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2974

setCustomGeometrySourceTileError

setCustomGeometrySourceTileError(
    sourceId: string,
    tileId: CanonicalTileId,
    message: string,
): void
Reports a custom geometry source error for one canonical tile.

See mln_map_set_custom_geometry_source_tile_error in the C API reference.
Parameters
- sourceId: string
- tileId: CanonicalTileId
- message: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:2994

setCustomMvtVectorSourceTileData

setCustomMvtVectorSourceTileData(
    sourceId: string,
    tileId: CanonicalTileId,
    data: Uint8Array,
): void
Sets custom MVT vector source data for one canonical tile.

See mln_map_set_custom_mvt_vector_source_tile_data in the C API reference.
Parameters
- sourceId: string
- tileId: CanonicalTileId
- data: Uint8Array
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3014

setCustomMvtVectorSourceTileError

setCustomMvtVectorSourceTileError(
    sourceId: string,
    tileId: CanonicalTileId,
    message: string,
): void
Reports a custom MVT vector source error for one canonical tile.

See mln_map_set_custom_mvt_vector_source_tile_error in the C API reference.
Parameters
- sourceId: string
- tileId: CanonicalTileId
- message: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3034

setDebugOptions

setDebugOptions(options: number): void
Submits a debug-overlay command.

See mln_map_set_debug_options in the C API reference.
Parameters
- options: number
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3054

setEventMask

setEventMask(mask: bigint): void
Selects which map-originated event types this map queues.

See mln_map_set_event_mask in the C API reference.
Parameters
- mask: bigint
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3064

setFeatureState

setFeatureState(selector: FeatureStateSelector, state: string): void
Submits a copied per-feature-state command.

See mln_map_set_feature_state in the C API reference.
Parameters
- selector: FeatureStateSelector
- state: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3074

setFreeCameraOptions

setFreeCameraOptions(options?: FreeCameraOptions): void
Submits a copied free-camera command.

See mln_map_set_free_camera_options in the C API reference.
Parameters
- options: FreeCameraOptions = {}
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3089

setGeojsonSourceData

setGeojsonSourceData(sourceId: string, data: GeojsonSourceDataHandle): void
Updates one GeoJSON source with prepared inline data.

See mln_map_set_geojson_source_data in the C API reference.
Parameters
- sourceId: string
- data: GeojsonSourceDataHandle
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3099

setGeojsonSourceSynchronousTiling

setGeojsonSourceSynchronousTiling(sourceId: string, enabled: boolean): void
Overrides one GeoJSON source's synchronous tiling at runtime.

See mln_map_set_geojson_source_synchronous_tiling in the C API reference.
Parameters
- sourceId: string
- enabled: boolean
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3114

setGeojsonSourceUrl

setGeojsonSourceUrl(sourceId: string, url: string): void
Updates one GeoJSON source to load data from a URL.

See mln_map_set_geojson_source_url in the C API reference.
Parameters
- sourceId: string
- url: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3129

setGlobalStateProperty

setGlobalStateProperty(propertyName: string, value: string): void
Submits a global-state JSON value. JSON null restores the style default.

See mln_map_set_global_state_property in the C API reference.
Parameters
- propertyName: string
- value: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3144

setImageSourceCoordinates

setImageSourceCoordinates(
sourceId: string,
coordinates: readonly LatLng[],
): void
Updates image source coordinates.

See mln_map_set_image_source_coordinates in the C API reference.
Parameters
- sourceId: string
- coordinates: readonly LatLng[]
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3159

setImageSourceImage

setImageSourceImage(sourceId: string, image?: PremultipliedRgba8Image): void
Updates an image source with inline image pixels.

See mln_map_set_image_source_image in the C API reference.
Parameters
- sourceId: string
- image: PremultipliedRgba8Image = {}
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3177

setImageSourceUrl

setImageSourceUrl(sourceId: string, url: string): void
Updates an image source to load its image from a URL.

See mln_map_set_image_source_url in the C API reference.
Parameters
- sourceId: string
- url: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3195

setProjectionMode

setProjectionMode(mode?: ProjectionMode): void
Submits copied axonometric rendering option fields.

See mln_map_set_projection_mode in the C API reference.
Parameters
- mode: ProjectionMode = {}
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3210

setRenderingStatsViewEnabled

setRenderingStatsViewEnabled(enabled: boolean): void
Submits a rendering-stats visibility command.

See mln_map_set_rendering_stats_view_enabled in the C API reference.
Parameters
- enabled: boolean
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3220

setStyleImage

setStyleImage(
    imageId: string,
    image?: PremultipliedRgba8Image,
    options?: StyleImageOptions,
): void
Sets one runtime style image.

See mln_map_set_style_image in the C API reference.
Parameters
- imageId: string
- image: PremultipliedRgba8Image = {}
- Optionaloptions: StyleImageOptions
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3234

setStyleJson

setStyleJson(json: string): void
Queues an inline style JSON command.

See mln_map_set_style_json in the C API reference.
Parameters
- json: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3254

setStyleLayerProperty

setStyleLayerProperty(
    layerId: string,
    propertyName: string,
    value: string,
): void
Sets one layer property using its MapLibre style-spec property name.

See mln_map_set_style_layer_property in the C API reference.
Parameters
- layerId: string
- propertyName: string
- value: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3264

setStyleLightJson

setStyleLightJson(lightJson: string): void
Sets the style light from a style-spec light JSON object.

See mln_map_set_style_light_json in the C API reference.
Parameters
- lightJson: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3284

setStyleLightProperty

setStyleLightProperty(propertyName: string, value: string): void
Sets one style light property using its MapLibre style-spec property name.

See mln_map_set_style_light_property in the C API reference.
Parameters
- propertyName: string
- value: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3294

setStyleSourceVolatile

setStyleSourceVolatile(sourceId: string, isVolatile: boolean): void
Sets whether one style source stores fetched tiles in the persistent cache.

See mln_map_set_style_source_volatile in the C API reference.
Parameters
- sourceId: string
- isVolatile: boolean
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3309

setStyleTransitionOptions

setStyleTransitionOptions(options?: StyleTransitionOptions): void
Sets the style's global transition options.

See mln_map_set_style_transition_options in the C API reference.
Parameters
- options: StyleTransitionOptions = {}
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3324

setStyleUrl

setStyleUrl(url: string): void
Queues a style URL command.

See mln_map_set_style_url in the C API reference.
Parameters
- url: string
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3338

setTileOptions

setTileOptions(options?: MapTileOptions): void
Submits a copied tile-options command.

See mln_map_set_tile_options in the C API reference.
Parameters
- options: MapTileOptions = {}
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3348

setViewportOptions

setViewportOptions(options?: MapViewportOptions): void
Submits a copied viewport-options command.

See mln_map_set_viewport_options in the C API reference.
Parameters
- options: MapViewportOptions = {}
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3358

updateCamera

updateCamera(update?: CameraUpdate): void
Submits one atomic camera update.

See mln_map_update_camera in the C API reference.
Parameters
- update: CameraUpdate = {}
Returns void
- Defined in bindings/typescript/src/generated_operations.ts:3368