12.4.0

compose-map/ru.dgis.sdk.compose.map/MapComposableState

MapComposableState

class MapComposableState(mapOptions: MapOptions)

State that allows control over various map-related parameters and behaviors, such as theme, copyright configuration, FPS settings, touch events, screenshot functionality, and gestures.

Notes:

Main Thread Requirement: All interactions with this class, including setting properties or invoking methods, must be performed on the main thread to ensure thread safety and proper UI behavior.
MapOptions.mapTheme is not used. Use the setTheme method instead to update the theme.
Some functionalities, such as taking snapshots or gesture management, are only available when the map is ready (map is not null).

Constructors

MapComposableState

constructor(mapOptions: MapOptions)

Properties

copyrightGravity

val copyrightGravity: StateFlow<Int>

copyrightMargins

val copyrightMargins: StateFlow<CopyrightMargins>

fpsCounterCallback

var fpsCounterCallback: (Fps) -> Unit?

val map: StateFlow<Map?>

val maxFps: StateFlow<Fps?>

objectLongTouchCallback

var objectLongTouchCallback: MapObjectTappedCallback?

objectTappedCallback

var objectTappedCallback: MapObjectTappedCallback?

powerSavingMaxFps

val powerSavingMaxFps: StateFlow<Fps?>

showApiVersionInCopyright

val showApiVersionInCopyright: StateFlow<Boolean>

val theme: StateFlow<MapTheme>

touchEventsObserver

var touchEventsObserver: TouchEventsObserver?

Functions

fun gestureManager(): GestureManager?

setCopyrightGravity

fun setCopyrightGravity(value: Int)

setCopyrightMargins

fun setCopyrightMargins(value: CopyrightMargins)

setCopyrightUriOpener

fun setCopyrightUriOpener(opener: (String) -> Unit)

Updates the URI opener for copyright clicks.

fun setMaxFps(value: Fps?)

setPowerSavingMaxFps

fun setPowerSavingMaxFps(value: Fps?)

setShowApiVersionInCopyright

fun setShowApiVersionInCopyright(value: Boolean)

Hides or displays the SDK version next to the copyright text.

fun setTheme(value: MapTheme)

fun takeSnapshot(alignment: Alignment = Alignment.BOTTOM_RIGHT): Future<ImageData>?

Takes a snapshot of the map at the specified alignment.