Class MapHandle

[asyncDispose]

[dispose]

discarding

• get discarding(): MapHandleDiscarding

  The commands of this owner that discard their outcomes.

  Returns MapHandleDiscarding

addCustomGeometrySource

• addCustomGeometrySource(
      sourceId: string,
      options?: CustomGeometrySourceOptions,
  ): Promise<CommandCompletion>

  Adds a custom geometry source.

  See mln_map_add_custom_geometry_source in the C API reference.

  Parameters

  • sourceId: string
  • Optionaloptions: CustomGeometrySourceOptions

  Returns Promise<CommandCompletion>

addCustomMvtVectorSource

• addCustomMvtVectorSource(
      sourceId: string,
      options?: CustomMvtVectorSourceOptions,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

addGeojsonSourceData

• addGeojsonSourceData(
      sourceId: string,
      data: GeojsonSourceDataHandle,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

addGeojsonSourceUrl

• addGeojsonSourceUrl(
      sourceId: string,
      url: string,
      options?: GeojsonSourceOptions,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

addImageSourceImage

• addImageSourceImage(
      sourceId: string,
      coordinates: readonly LatLng[],
      image?: PremultipliedRgba8Image,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

addImageSourceUrl

• addImageSourceUrl(
      sourceId: string,
      coordinates: readonly LatLng[],
      url: string,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

addStyleLayerJson

• addStyleLayerJson(
      layerJson: string,
      beforeLayerId?: string,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

addStyleSourceJson

• addStyleSourceJson(
      sourceId: string,
      sourceJson: string,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

applyCameraDelta

• applyCameraDelta(delta?: CameraDelta): Promise<CommandCompletion>

  Submits one atomic relative camera update.

  See mln_map_apply_camera_delta in the C API reference.

  Parameters

  • delta: CameraDelta = {}

  Returns Promise<CommandCompletion>

attachMetalBorrowedTexture

• attachMetalBorrowedTexture(
      descriptor?: MetalBorrowedTextureDescriptor,
      options?: RenderSessionAttachOptions,
  ): RenderSessionAttachment

  Starts attachment of a ring of caller-owned Metal textures.

  See mln_map_attach_metal_borrowed_texture in the C API reference.

  Parameters

  • descriptor: MetalBorrowedTextureDescriptor = {}
  • options: RenderSessionAttachOptions = {}

  Returns RenderSessionAttachment

attachMetalOwnedTexture

• attachMetalOwnedTexture(
      descriptor?: MetalOwnedTextureDescriptor,
      options?: RenderSessionAttachOptions,
  ): RenderSessionAttachment

  Starts attachment of a session-owned Metal texture ring.

  See mln_map_attach_metal_owned_texture in the C API reference.

  Parameters

  • descriptor: MetalOwnedTextureDescriptor = {}
  • options: RenderSessionAttachOptions = {}

  Returns RenderSessionAttachment

attachMetalSurface

• attachMetalSurface(
      descriptor?: MetalSurfaceDescriptor,
      options?: RenderSessionAttachOptions,
  ): RenderSessionAttachment

  Starts attachment of a Metal surface target.

  See mln_map_attach_metal_surface in the C API reference.

  Parameters

  • descriptor: MetalSurfaceDescriptor = {}
  • options: RenderSessionAttachOptions = {}

  Returns RenderSessionAttachment

attachOpenglBorrowedTexture

• attachOpenglBorrowedTexture(
      descriptor?: OpenglBorrowedTextureDescriptor,
      options?: RenderSessionAttachOptions,
  ): RenderSessionAttachment

  Starts attachment of a ring of caller-owned OpenGL textures.

  See mln_map_attach_opengl_borrowed_texture in the C API reference.

  Parameters

  • descriptor: OpenglBorrowedTextureDescriptor = {}
  • options: RenderSessionAttachOptions = {}

  Returns RenderSessionAttachment

attachOpenglOwnedTexture

• attachOpenglOwnedTexture(
      descriptor?: OpenglOwnedTextureDescriptor,
      options?: RenderSessionAttachOptions,
  ): RenderSessionAttachment

  Starts attachment of a session-owned OpenGL texture ring.

  See mln_map_attach_opengl_owned_texture in the C API reference.

  Parameters

  • descriptor: OpenglOwnedTextureDescriptor = {}
  • options: RenderSessionAttachOptions = {}

  Returns RenderSessionAttachment

attachOpenglSurface

• attachOpenglSurface(
      descriptor?: OpenglSurfaceDescriptor,
      options?: RenderSessionAttachOptions,
  ): RenderSessionAttachment

  Starts attachment of an OpenGL surface target.

  See mln_map_attach_opengl_surface in the C API reference.

  Parameters

  • descriptor: OpenglSurfaceDescriptor = {}
  • options: RenderSessionAttachOptions = {}

  Returns RenderSessionAttachment

attachVulkanBorrowedTexture

• attachVulkanBorrowedTexture(
      descriptor?: VulkanBorrowedTextureDescriptor,
      options?: RenderSessionAttachOptions,
  ): RenderSessionAttachment

  Starts attachment of a ring of caller-owned Vulkan images.

  See mln_map_attach_vulkan_borrowed_texture in the C API reference.

  Parameters

  • descriptor: VulkanBorrowedTextureDescriptor = {}
  • options: RenderSessionAttachOptions = {}

  Returns RenderSessionAttachment

attachVulkanOwnedTexture

• attachVulkanOwnedTexture(
      descriptor?: VulkanOwnedTextureDescriptor,
      options?: RenderSessionAttachOptions,
  ): RenderSessionAttachment

  Starts attachment of a session-owned Vulkan texture ring.

  See mln_map_attach_vulkan_owned_texture in the C API reference.

  Parameters

  • descriptor: VulkanOwnedTextureDescriptor = {}
  • options: RenderSessionAttachOptions = {}

  Returns RenderSessionAttachment

attachVulkanSurface

• attachVulkanSurface(
      descriptor?: VulkanSurfaceDescriptor,
      options?: RenderSessionAttachOptions,
  ): RenderSessionAttachment

  Starts attachment of a Vulkan surface target.

  See mln_map_attach_vulkan_surface in the C API reference.

  Parameters

  • descriptor: VulkanSurfaceDescriptor = {}
  • options: RenderSessionAttachOptions = {}

  Returns RenderSessionAttachment

attachWebgpuBorrowedTexture

• attachWebgpuBorrowedTexture(
      descriptor?: WebgpuBorrowedTextureDescriptor,
      options?: RenderSessionAttachOptions,
  ): RenderSessionAttachment

  Starts attachment of a ring of caller-owned WebGPU textures.

  See mln_map_attach_webgpu_borrowed_texture in the C API reference.

  Parameters

  • descriptor: WebgpuBorrowedTextureDescriptor = {}
  • options: RenderSessionAttachOptions = {}

  Returns RenderSessionAttachment

attachWebgpuOwnedTexture

• attachWebgpuOwnedTexture(
      descriptor?: WebgpuOwnedTextureDescriptor,
      options?: RenderSessionAttachOptions,
  ): RenderSessionAttachment

  Starts attachment of a session-owned WebGPU texture ring.

  See mln_map_attach_webgpu_owned_texture in the C API reference.

  Parameters

  • descriptor: WebgpuOwnedTextureDescriptor = {}
  • options: RenderSessionAttachOptions = {}

  Returns RenderSessionAttachment

attachWebgpuSurface

• attachWebgpuSurface(
      descriptor?: WebgpuSurfaceDescriptor,
      options?: RenderSessionAttachOptions,
  ): RenderSessionAttachment

  Starts attachment of a WebGPU surface target.

  See mln_map_attach_webgpu_surface in the C API reference.

  Parameters

  • descriptor: WebgpuSurfaceDescriptor = {}
  • options: RenderSessionAttachOptions = {}

  Returns RenderSessionAttachment

beginCommandGroup

• beginCommandGroup(): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

cameraForGeometry

• cameraForGeometry(
      geometry: string,
      fitOptions?: CameraFitOptions,
  ): Promise<CameraOptions>

  Starts an ordered query for a camera that fits a GeoJSON geometry.

  See mln_map_camera_for_geometry in the C API reference.

  Parameters

  • geometry: string
  • OptionalfitOptions: CameraFitOptions

  Returns Promise<CameraOptions>

cameraForLatLngBounds

• cameraForLatLngBounds(
      bounds?: LatLngBounds,
      fitOptions?: CameraFitOptions,
  ): Promise<CameraOptions>

  Starts an ordered query for a camera that fits geographic bounds.

  See mln_map_camera_for_lat_lng_bounds in the C API reference.

  Parameters

  • bounds: LatLngBounds = {}
  • OptionalfitOptions: CameraFitOptions

  Returns Promise<CameraOptions>

cameraForLatLngs

• cameraForLatLngs(
      coordinates: readonly LatLng[],
      fitOptions?: CameraFitOptions,
  ): Promise<CameraOptions>

  Starts an ordered query for a camera that fits geographic coordinates.

  See mln_map_camera_for_lat_lngs in the C API reference.

  Parameters

  • coordinates: readonly LatLng[]
  • OptionalfitOptions: CameraFitOptions

  Returns Promise<CameraOptions>

cancelCameraTransition

• cancelCameraTransition(transitionId: bigint): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

cancelTransitions

• cancelTransitions(): Promise<CommandCompletion>

  Cancels the camera transitions running when this command commits.

  See mln_map_cancel_transitions in the C API reference.

  Returns Promise<CommandCompletion>

close

• close(): Promise<void>

  Releases a map asynchronously.

  See mln_map_release in the C API reference.

  Returns Promise<void>

dispose

• dispose(): void

  Consumes a map handle without observing its asynchronous retirement.

  See mln_map_dispose in the C API reference.

  Returns void

dumpDebugLogs

• dumpDebugLogs(): Promise<CommandCompletion>

  Submits an ordered debug-log command.

  See mln_map_dump_debug_logs in the C API reference.

  Returns Promise<CommandCompletion>

endCommandGroup

• endCommandGroup(): Promise<CommandCompletion>

  Ends the innermost command group that mln_map_begin_command_group() began.

  See mln_map_end_command_group in the C API reference.

  Returns Promise<CommandCompletion>

getCamera

• getCamera(): Promise<CameraQueryResult>

  Starts an ordered camera read.

  See mln_map_get_camera in the C API reference.

  Returns Promise<CameraQueryResult>

getFeatureState

• getFeatureState(selector: FeatureStateSelector): Promise<string>

  Starts an ordered read of per-feature state from this map.

  See mln_map_get_feature_state in the C API reference.

  Parameters

  • selector: FeatureStateSelector

  Returns Promise<string>

getGlobalState

• getGlobalState(): Promise<string>

  Queries the global-state JSON object, including style defaults. Completion borrows one mln_buffer_view for the duration of the callback.

  See mln_map_get_global_state in the C API reference.

  Returns Promise<string>

getImageSourceCoordinates

• getImageSourceCoordinates(sourceId: string): Promise<readonly LatLng[]>

  Copies image source coordinates.

  See mln_map_get_image_source_coordinates in the C API reference.

  Parameters

  • sourceId: string

  Returns Promise<readonly LatLng[]>

getLoadedStyleJson

• getLoadedStyleJson(): Promise<string>

  Starts an ordered copy of the last successfully parsed style document.

  See mln_map_get_loaded_style_json in the C API reference.

  Returns Promise<string>

getSnapshot

• getSnapshot(): MapSnapshot

  Copies the map's latest published snapshot.

  See mln_map_get_snapshot in the C API reference.

  Returns MapSnapshot

getStyleImage

• getStyleImage(imageId: string): Promise<StyleImageInfo | undefined>

  Copies one complete runtime style image.

  See mln_map_get_style_image in the C API reference.

  Parameters

  • imageId: string

  Returns Promise<StyleImageInfo | undefined>

getStyleLayer

• getStyleLayer(layerId: string): Promise<StyleLayerInfo | undefined>

  Copies the complete metadata of one style layer.

  See mln_map_get_style_layer in the C API reference.

  Parameters

  • layerId: string

  Returns Promise<StyleLayerInfo | undefined>

getStyleLayerJson

• getStyleLayerJson(layerId: string): Promise<string | undefined>

  Serializes one style layer as a full style-spec layer JSON object.

  See mln_map_get_style_layer_json in the C API reference.

  Parameters

  • layerId: string

  Returns Promise<string | undefined>

getStyleLayerProperty

• getStyleLayerProperty(
      layerId: string,
      propertyName: string,
  ): Promise<string | undefined>

  Serializes one layer property as a style-spec JSON value.

  See mln_map_get_style_layer_property in the C API reference.

  Parameters

  • layerId: string
  • propertyName: string

  Returns Promise<string | undefined>

getStyleLightProperty

• getStyleLightProperty(propertyName: string): Promise<string | undefined>

  Serializes one style light property as a style-spec JSON value.

  See mln_map_get_style_light_property in the C API reference.

  Parameters

  • propertyName: string

  Returns Promise<string | undefined>

getStyleSource

• getStyleSource(sourceId: string): Promise<StyleSourceInfo | undefined>

  Copies the complete metadata of one style source.

  See mln_map_get_style_source in the C API reference.

  Parameters

  • sourceId: string

  Returns Promise<StyleSourceInfo | undefined>

getStyleTransitionOptions

• getStyleTransitionOptions(): Promise<StyleTransitionOptions>

  Reads the style's global transition options.

  See mln_map_get_style_transition_options in the C API reference.

  Returns Promise<StyleTransitionOptions>

getStyleUrl

• getStyleUrl(): Promise<string>

  Starts an ordered copy of the last requested style URL.

  See mln_map_get_style_url in the C API reference.

  Returns Promise<string>

invalidateCustomGeometrySourceRegion

• invalidateCustomGeometrySourceRegion(
      sourceId: string,
      bounds?: LatLngBounds,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

invalidateCustomGeometrySourceTile

• invalidateCustomGeometrySourceTile(
      sourceId: string,
      tileId?: CanonicalTileId,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

invalidateCustomMvtVectorSourceTile

• invalidateCustomMvtVectorSourceTile(
      sourceId: string,
      tileId?: CanonicalTileId,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

latLngBoundsForCamera

• latLngBoundsForCamera(camera?: CameraOptions): Promise<LatLngBounds>

  Starts an ordered wrapped-bounds query for a copied camera.

  See mln_map_lat_lng_bounds_for_camera in the C API reference.

  Parameters

  • camera: CameraOptions = {}

  Returns Promise<LatLngBounds>

latLngBoundsForCameraUnwrapped

• latLngBoundsForCameraUnwrapped(camera?: CameraOptions): Promise<LatLngBounds>

  Starts an ordered unwrapped-bounds query for a copied camera.

  See mln_map_lat_lng_bounds_for_camera_unwrapped in the C API reference.

  Parameters

  • camera: CameraOptions = {}

  Returns Promise<LatLngBounds>

listStyleLayers

• listStyleLayers(): Promise<readonly StyleLayerInfo[]>

  Starts an ordered query of every style layer in style order.

  See mln_map_list_style_layers in the C API reference.

  Returns Promise<readonly StyleLayerInfo[]>

listStyleSources

• listStyleSources(): Promise<readonly StyleSourceInfo[]>

  Lists every style source in style order.

  See mln_map_list_style_sources in the C API reference.

  Returns Promise<readonly StyleSourceInfo[]>

moveStyleLayer

• moveStyleLayer(
      layerId: string,
      beforeLayerId?: string,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

removeFeatureState

• removeFeatureState(selector: FeatureStateSelector): Promise<CommandCompletion>

  Removes per-feature state from this map.

  See mln_map_remove_feature_state in the C API reference.

  Parameters

  • selector: FeatureStateSelector

  Returns Promise<CommandCompletion>

removeStyleImage

• removeStyleImage(imageId: string): Promise<CommandCompletion>

  Removes one runtime style image by ID.

  See mln_map_remove_style_image in the C API reference.

  Parameters

  • imageId: string

  Returns Promise<CommandCompletion>

removeStyleLayer

• removeStyleLayer(layerId: string): Promise<CommandCompletion>

  Removes one style layer by ID.

  See mln_map_remove_style_layer in the C API reference.

  Parameters

  • layerId: string

  Returns Promise<CommandCompletion>

removeStyleSource

• removeStyleSource(sourceId: string): Promise<CommandCompletion>

  Removes one style source by ID.

  See mln_map_remove_style_source in the C API reference.

  Parameters

  • sourceId: string

  Returns Promise<CommandCompletion>

requestRepaint

• requestRepaint(): Promise<CommandCompletion>

  Requests a repaint for a continuous map.

  See mln_map_request_repaint in the C API reference.

  Returns Promise<CommandCompletion>

requestStillImage

• requestStillImage(): Promise<void>

  Requests one still image for a static or tile map.

  See mln_map_request_still_image in the C API reference.

  Returns Promise<void>

resize

• resize(extent?: LogicalExtent): Promise<CommandCompletion>

  Submits the sole post-creation logical extent update.

  See mln_map_resize in the C API reference.

  Parameters

  • extent: LogicalExtent = {}

  Returns Promise<CommandCompletion>

setBounds

• setBounds(options?: BoundOptions): Promise<CommandCompletion>

  Submits a copied camera-constraint command.

  See mln_map_set_bounds in the C API reference.

  Parameters

  • options: BoundOptions = {}

  Returns Promise<CommandCompletion>

setCustomGeometrySourceTileData

• setCustomGeometrySourceTileData(
      sourceId: string,
      tileId: CanonicalTileId,
      data: string,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

setCustomGeometrySourceTileError

• setCustomGeometrySourceTileError(
      sourceId: string,
      tileId: CanonicalTileId,
      message: string,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

setCustomMvtVectorSourceTileData

• setCustomMvtVectorSourceTileData(
      sourceId: string,
      tileId: CanonicalTileId,
      data: Uint8Array,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

setCustomMvtVectorSourceTileError

• setCustomMvtVectorSourceTileError(
      sourceId: string,
      tileId: CanonicalTileId,
      message: string,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

setDebugOptions

• setDebugOptions(options: number): Promise<CommandCompletion>

  Submits a debug-overlay command.

  See mln_map_set_debug_options in the C API reference.

  Parameters

  • options: number

  Returns Promise<CommandCompletion>

setEventMask

• setEventMask(mask: bigint): Promise<CommandCompletion>

  Selects which map-originated event types this map queues.

  See mln_map_set_event_mask in the C API reference.

  Parameters

  • mask: bigint

  Returns Promise<CommandCompletion>

setFeatureState

• setFeatureState(
      selector: FeatureStateSelector,
      state: string,
  ): Promise<CommandCompletion>

  Submits a copied per-feature-state command.

  See mln_map_set_feature_state in the C API reference.

  Parameters

  • selector: FeatureStateSelector
  • state: string

  Returns Promise<CommandCompletion>

setFreeCameraOptions

• setFreeCameraOptions(options?: FreeCameraOptions): Promise<CommandCompletion>

  Submits a copied free-camera command.

  See mln_map_set_free_camera_options in the C API reference.

  Parameters

  • options: FreeCameraOptions = {}

  Returns Promise<CommandCompletion>

setGeojsonSourceData

• setGeojsonSourceData(
      sourceId: string,
      data: GeojsonSourceDataHandle,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

setGeojsonSourceSynchronousTiling

• setGeojsonSourceSynchronousTiling(
      sourceId: string,
      enabled: boolean,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

setGeojsonSourceUrl

• setGeojsonSourceUrl(sourceId: string, url: string): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

setGlobalStateProperty

• setGlobalStateProperty(
      propertyName: string,
      value: string,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

setImageSourceCoordinates

• setImageSourceCoordinates(
      sourceId: string,
      coordinates: readonly LatLng[],
  ): Promise<CommandCompletion>

  Updates image source coordinates.

  See mln_map_set_image_source_coordinates in the C API reference.

  Parameters

  • sourceId: string
  • coordinates: readonly LatLng[]

  Returns Promise<CommandCompletion>

setImageSourceImage

• setImageSourceImage(
      sourceId: string,
      image?: PremultipliedRgba8Image,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

setImageSourceUrl

• setImageSourceUrl(sourceId: string, url: string): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

setProjectionMode

• setProjectionMode(mode?: ProjectionMode): Promise<CommandCompletion>

  Submits copied axonometric rendering option fields.

  See mln_map_set_projection_mode in the C API reference.

  Parameters

  • mode: ProjectionMode = {}

  Returns Promise<CommandCompletion>

setRenderingStatsViewEnabled

• setRenderingStatsViewEnabled(enabled: boolean): Promise<CommandCompletion>

  Submits a rendering-stats visibility command.

  See mln_map_set_rendering_stats_view_enabled in the C API reference.

  Parameters

  • enabled: boolean

  Returns Promise<CommandCompletion>

setStyleImage

• setStyleImage(
      imageId: string,
      image?: PremultipliedRgba8Image,
      options?: StyleImageOptions,
  ): Promise<CommandCompletion>

  Sets one runtime style image.

  See mln_map_set_style_image in the C API reference.

  Parameters

  • imageId: string
  • image: PremultipliedRgba8Image = {}
  • Optionaloptions: StyleImageOptions

  Returns Promise<CommandCompletion>

setStyleJson

• setStyleJson(json: string): Promise<CommandCompletion>

  Queues an inline style JSON command.

  See mln_map_set_style_json in the C API reference.

  Parameters

  • json: string

  Returns Promise<CommandCompletion>

setStyleLayerProperty

• setStyleLayerProperty(
      layerId: string,
      propertyName: string,
      value: string,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

setStyleLightJson

• setStyleLightJson(lightJson: string): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

setStyleLightProperty

• setStyleLightProperty(
      propertyName: string,
      value: string,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

setStyleSourceVolatile

• setStyleSourceVolatile(
      sourceId: string,
      isVolatile: boolean,
  ): Promise<CommandCompletion>

  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 Promise<CommandCompletion>

setStyleTransitionOptions

• setStyleTransitionOptions(
      options?: StyleTransitionOptions,
  ): Promise<CommandCompletion>

  Sets the style's global transition options.

  See mln_map_set_style_transition_options in the C API reference.

  Parameters

  • options: StyleTransitionOptions = {}

  Returns Promise<CommandCompletion>

setStyleUrl

• setStyleUrl(url: string): Promise<CommandCompletion>

  Queues a style URL command.

  See mln_map_set_style_url in the C API reference.

  Parameters

  • url: string

  Returns Promise<CommandCompletion>

setTileOptions

• setTileOptions(options?: MapTileOptions): Promise<CommandCompletion>

  Submits a copied tile-options command.

  See mln_map_set_tile_options in the C API reference.

  Parameters

  • options: MapTileOptions = {}

  Returns Promise<CommandCompletion>

setViewportOptions

• setViewportOptions(options?: MapViewportOptions): Promise<CommandCompletion>

  Submits a copied viewport-options command.

  See mln_map_set_viewport_options in the C API reference.

  Parameters

  • options: MapViewportOptions = {}

  Returns Promise<CommandCompletion>

updateCamera

• updateCamera(update?: CameraUpdate): Promise<CommandCompletion>

  Submits one atomic camera update.

  See mln_map_update_camera in the C API reference.

  Parameters

  • update: CameraUpdate = {}

  Returns Promise<CommandCompletion>