EventKind

The Map’s style has been fully loaded, and the Map has rendered all visible tiles.

Describes an error that has occurred while loading the Map. The ‘type’ property defines what resource could not be loaded and the ‘message’ property will contain a descriptive error message.

Event data format (Object):

 .
 ├── type - String ("style" | "sprite" | "source" | "tile" | "glyphs")
 └── message - String

The Map has entered the idle state. The Map is in the idle state when there are no ongoing transitions and the Map has rendered all available tiles. The event will not be emitted if Map#setUserAnimationInProgress or Map#setGestureInProgress is true.

The requested style data has been loaded. The ‘type’ property defines what kind of style data has been loaded. Event may be emitted synchronously, for example, when StyleManager#setStyleJSON is used to load style.

Based on an event data ‘type’ property value, following use-cases may be implemented:

• ‘style’: Style is parsed, style layer properties could be read and modified, style layers and sources could be added or removed before rendering is started.
• ‘sprite’: Style’s sprite sheet is parsed and it is possible to add or update images.
• ‘sources’: All sources defined by the style are loaded and their properties could be read and updated if needed. * Event data format (Object): . └── type - String ("style" | "sprite" | "sources")

The requested style has been fully loaded, including the style, specified sprite and sources’ metadata.

A style has a missing image. This event is emitted when the Map renders visible tiles and one of the required images is missing in the sprite sheet. Subscriber has to provide the missing image by calling Style.setStyleImage method.

Event data format (Object):
.
└── id - String

An image added to the Style is no longer needed.

Event data format (Object):

 .
 └── id - String

Source data has been loaded. The ‘id’ property defines the source id. The ‘type’ property defines if source’s metadata (e.g., TileJSON) or tile has been loaded. The ‘loaded’ property will be set to ‘true’ if all source’s data required for Map’s visible viewport, are loaded. The ‘tile-id’ property defines the tile id if the ‘type’ field equals ‘tile’.

Event data format (Object):

 .
 ├── id - String
 ├── type - String ("metadata" | "tile")
 ├── loaded - optional Boolean
 └── tile-id optional Object
     ├── z Number (zoom level)
     ├── x Number (x coordinate)
     └── y Number (y coordinate)

Source has been added with Style.addSource runtime API.

Event data format (Object):

 .
 └── id - String

Source has been removed with StyleManager#removeStyleSource runtime API.

Event data format (Object):

 .
 └── id - String

The Map started rendering a frame.

The Map finished rendering a frame. The ‘render-mode’ property tells whether the Map has all data (“full”) required to render the visible viewport. The ‘needs-repaint’ property provides information about ongoing transitions that trigger Map repaint. The ‘placement-changed’ property tells if the symbol placement has been changed in the visible viewport.

Event data format (Object):

 .
 ├── render-mode - String ("partial" | "full")
 ├── needs-repaint - Boolean
 └── placement-changed - Boolean

Camera has changed. This event is emitted whenever the visible viewport changes due to MapView.layoutSubviews being called or when the camera is modified by calling Map camera methods.

ResourceRequest event allows client to observe resource requests made by a MapView or Snapshotter.

Event data format (Object):

 .
 ├── data-source - String ("resource-loader" | "network" | "database" | "asset" | "file-system")
 ├── request - Object
 │   ├── url - String
 │   ├── kind - String ("unknown" | "style" | "source" | "tile" | "glyphs" | "sprite-image" | "sprite-json" | "image")
 │   ├── priority - String ("regular" | "low")
 │   └── loading-method - Array ["cache" | "network"]
 ├── response - optional Object
 │   ├── no-content - Boolean
 │   ├── not-modified - Boolean
 │   ├── must-revalidate - Boolean
 │   ├── offline-data - Boolean
 │   ├── size - Number (size in bytes)
 │   ├── modified - optional String, rfc1123 timestamp
 │   ├── expires - optional String, rfc1123 timestamp
 │   ├── etag - optional String
 │   └── error - optional Object
 │       ├── reason - String ("success" | "not-found" | "server" | "connection" | "rate-limit" | "other")
 │       └── message - String
 └── cancelled - Boolean