MTEvent

@Serializable
enum MTEvent : Enum<MTEvent>

Events triggered by the SDK.

Entries

@SerialName(value = "boxzoomcancel")
ON_BOX_ZOOM_CANCEL

Triggered when the user cancels a "box zoom" interaction, or when the bounding box does not meet the minimum size threshold.

@SerialName(value = "boxzoomend")
ON_BOX_ZOOM_END

Triggered when a "box zoom" interaction ends.

@SerialName(value = "boxzoomstart")
ON_BOX_ZOOM_START

Triggered when a "box zoom" interaction starts.

@SerialName(value = "click")
ON_TAP

Triggered when user taps and releases at the same point on the map.

@SerialName(value = "cooperativegestureprevented")
ON_COOPERATIVE_GESTURE_PREVENTED

Triggered whenever the cooperativeGestures option prevents a gesture from being handled by the map.

@SerialName(value = "data")
ON_DATA_UPDATE

Triggered when any map data loads or changes.

@SerialName(value = "dataabort")
ON_DATA_UPDATE_ABORT

Triggered when a request for one of the map's sources' tiles is aborted. Triggered when a request for one of the map's sources' data is aborted.

@SerialName(value = "dataloading")
ON_DATA_UPDATE_START

Triggered when any map data (style, source, tile, etc) begins loading or changing asynchronously. All dataloading events are followed by a dataDidUpdate, dataUpdateDidAbort or error events.

@SerialName(value = "dblclick")
ON_DOUBLE_TAP

Triggered when a user taps and releases twice at the same point on the map in rapid succession.

@SerialName(value = "drag")
ON_DRAG

Triggered repeatedly during a "drag to pan" interaction.

@SerialName(value = "dragend")
ON_DRAG_END

Triggered when a "drag to pan" interaction ends.

@SerialName(value = "dragstart")
ON_DRAG_START

Triggered when a "drag to pan" interaction starts.

@SerialName(value = "idle")
ON_IDLE

Triggered after the last frame rendered before the map enters an "idle" state. Idle state means that no camera transitions are in progress, all currently requested tiles have loaded, and all fade/transition animations have completed.

@SerialName(value = "load")
ON_LOAD

Triggered immediately after all necessary resources have been downloaded and the first visually complete rendering of the map has occurred.

@SerialName(value = "loadWithTerrain")
ON_LOAD_WITH_TERRAIN

Triggered only once in a Map instance lifecycle, when both the load event and the terrain event with non-null terrain are triggered.

@SerialName(value = "move")
ON_MOVE

Triggered repeatedly during an animated transition from one view to another, as the result of either user interaction or methods such as flyTo.

@SerialName(value = "moveend")
ON_MOVE_END

Triggered just after the map completes a transition from one view to another, as the result of either user interaction or methods such as jumpTo.

@SerialName(value = "movestart")
ON_MOVE_START

Triggered just before the map begins a transition from one view to another, as the result of either user interaction or methods such as jumpTo.

@SerialName(value = "pitch")
ON_PITCH_UPDATE

Triggered repeatedly during the map's pitch (tilt) animation between one state and another as the result of either user interaction or methods such as flyTo.

@SerialName(value = "pitchend")
ON_PITCH_UPDATE_END

Triggered immediately after the map's pitch (tilt) finishes changing as the result of either user interaction or methods such as flyTo.

@SerialName(value = "pitchstart")
ON_PITCH_UPDATE_START

Triggered whenever the map's pitch (tilt) begins a change as the result of either user interaction or methods such as flyTo.

@SerialName(value = "projectiontransition")
ON_PROJECTION_MODIFY

Triggered when map's projection is modified in other ways than by map being moved.

@SerialName(value = "ready")
ON_READY

Triggered only once after load and wait for all the controls managed by the Map constructor to be dealt with. Since the ready event waits that all the basic controls are nicely positioned, it is safer to use ready than load if you plan to add other custom controls.

@SerialName(value = "remove")
ON_REMOVE

Triggered immediately after the map has been removed.

@SerialName(value = "render")
ON_RENDER

Triggered whenever the map is drawn to the screen. Drawing occurs with a change to the map's position, zoom, pitch, or bearing, a change to the map's style, a change to a GeoJSON source, or the loading of a vector tile, GeoJSON file, glyph, or sprite.

@SerialName(value = "resize")
ON_RESIZE

Triggered immediately after the map has been resized.

@SerialName(value = "rotate")
ON_ROTATE

Triggered repeatedly during a "drag to rotate" interaction.

@SerialName(value = "rotateend")
ON_ROTATE_END

Triggered when a "drag to rotate" interaction ends.

@SerialName(value = "rotatestart")
ON_ROTATE_START

Triggered when a "drag to rotate" interaction starts.

@SerialName(value = "sourcedata")
ON_SOURCE_UPDATE

Triggered when one of the map's sources loads or changes, including if a tile belonging to a source loads or changes.

@SerialName(value = "sourcedataabort")
ON_SOURCE_UPDATE_ABORT

Triggered when a request for one of the map's sources' data is aborted.

@SerialName(value = "sourcedataloading")
ON_SOURCE_UPDATE_START

Triggered when one of the map's sources begins loading or changing asynchronously. All sourceUpdateDidStart events are followed by a sourceDidUpdate, sourceUpdateDidAbort or error events.

@SerialName(value = "styledata")
ON_STYLE_UPDATE

Triggered when the map's style loads or changes.

@SerialName(value = "styledataloading")
ON_STYLE_UPDATE_START

Triggered when the map's style begins loading or changing asynchronously. All styleUpdateDidStart events are followed by a styleDidUpdate or error events.

@SerialName(value = "styleimagemissing")
ON_STYLE_IMAGE_MISSING

Triggered when an icon or pattern needed by the style is missing.

@SerialName(value = "terrain")
ON_TERRAIN_CHANGE

Triggered when a terrain event occurs within the map.

@SerialName(value = "terrainAnimationStart")
ON_TERRAIN_ANIMATION_START

The terrainAnimationDidStart event is triggered when the animation begins transitioning between terrain and non-terrain states.

@SerialName(value = "terrainAnimationStop")
ON_TERRAIN_ANIMATION_STOP

The terrainAnimationDidStop event is triggered when the animation between terrain and non-terrain states ends.

@SerialName(value = "touchcancel")
ON_TOUCH_CANCEL

Triggered when a touch is cancelled within the map.

@SerialName(value = "touchend")
ON_TOUCH_END

Triggered when a touch ends within the map.

@SerialName(value = "touchmove")
ON_TOUCH_MOVE

Triggered when a touch moves within the map.

@SerialName(value = "touchstart")
ON_TOUCH_START

Triggered when a touch starts within the map.

@SerialName(value = "zoom")
ON_ZOOM

Triggered repeatedly during an animated transition from one zoom level to another, as the result of either user interaction or methods such as flyTo.

@SerialName(value = "zoomend")
ON_ZOOM_END

Triggered just after the map completes a transition from one zoom level to another, as the result of either user interaction or methods such as flyTo.

@SerialName(value = "zoomstart")
ON_ZOOM_START

Triggered just before the map begins a transition from one zoom level to another, as the result of either user interaction or methods such as flyTo.

Properties

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Functions

fun valueOf(value: String): MTEvent

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Returns an array containing the constants of this enum type, in the order they're declared.