yandex-mapkit-kmp-compose/ru.sulgik.mapkit.compose

Package-level declarations

Types

CameraPositionState

class CameraPositionState

A state object that can be hoisted to control and observe the map's camera state. A CameraPositionState may only be used by a single YandexMap composable at a time as it reflects instance state for a single view of a map.

class CircleState(geometry: Circle)

data class ClusterGroup(val placemarks: ImmutableList<ClusterItem>, val icon: ImageProvider, val iconStyle: IconStyle = IconStyle(), val text: String? = null, val textStyle: TextStyle = TextStyle())

ClusterImageProvider

@YandexMapsComposeExperimentalApi

actual class ClusterImageProvider

@YandexMapsComposeExperimentalApi

expect class ClusterImageProvider

actual class ClusterImageProvider(size: <Error class: unknown class>, renderer: ComposeMapObjectRenderer, content: (<Error class: unknown class>) -> Unit)

data class ClusterItem(val geometry: Point, val data: Any? = null)

ClusterizingConfig

data class ClusterizingConfig(val clusterRadius: Double = DefaultClusterRadius, val minZoom: Int = DefaultMinZoom)

ComposeMapObjectRenderer

@YandexMapsComposeExperimentalApi

actual class ComposeMapObjectRenderer

@YandexMapsComposeExperimentalApi

expect class ComposeMapObjectRenderer

actual class ComposeMapObjectRenderer(density: <Error class: unknown class>)

data class MapConfig(val isNightModeEnabled: Boolean? = null, val poiLimit: Int? = null, val isFastTapEnabled: Boolean? = null, val isRotateGesturesEnabled: Boolean? = null, val isTiltGesturesEnabled: Boolean? = null, val isScrollGesturesEnabled: Boolean? = null, val isZoomGesturesEnabled: Boolean? = null, val mapType: MapType? = null, val use2dMode: Boolean? = null, val logo: MapLogoConfig = MapLogoConfig())

Config for Map that uses default configuration

data class MapLogoConfig(val alignment: LogoAlignment? = null, val padding: LogoPadding? = null)

Config to control Yandex logo object with Map.getLogo

class PlacemarkState(geometry: Point, direction: Float = 0.0f)

class PolygonState(geometry: Polygon)

class PolylineState(geometry: Polyline)

YandexMapComposable

@Target(allowedTargets = [AnnotationTarget.FILE, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER, AnnotationTarget.TYPE, AnnotationTarget.TYPE_PARAMETER])

annotation class YandexMapComposable

Marks declarations that runs in custom MapComposition, outside compose-ui composition context.

YandexMapController

class YandexMapController

Contains common implementation of MapWindow, that uses for controlling YandexMap

YandexMapsComposeExperimentalApi

annotation class YandexMapsComposeExperimentalApi

Marks declarations that are still experimental.

Properties

currentCameraPositionState

@get:ReadOnlyComposable

@get:Composable

val currentCameraPositionState: CameraPositionState

The current CameraPositionState used by the map.

Functions

bindToLifecycleOwner

fun MapKit.bindToLifecycleOwner(lifecycleOwner: LifecycleOwner = LocalLifecycleOwner.current)

Bind calling MapKit.onStart and MapKit.onStop to LifecycleOwner and composition

fun Circle(state: CircleState, color: Color = DefaultFillColor, strokeColor: Color = DefaultStrokeColor, strokeWidth: Float = DefaultStrokeWidth, geodesic: Boolean = DefaultGeodesic, visible: Boolean = true, zIndex: Float = 0.0f, onTap: (Point) -> Boolean? = null)

fun ClusterGroup(points: List<Point>, icon: ImageProvider, iconStyle: IconStyle = IconStyle(), text: String? = null, textStyle: TextStyle = TextStyle()): ClusterGroup

clusterImageProvider

@YandexMapsComposeExperimentalApi

actual fun clusterImageProvider(size: DpSize, content: (Cluster) -> Unit): ClusterImageProvider

@YandexMapsComposeExperimentalApi

actual fun clusterImageProvider(size: DpSize, key1: Any?, content: (Cluster) -> Unit): ClusterImageProvider

@YandexMapsComposeExperimentalApi

actual fun clusterImageProvider(size: DpSize, vararg keys: Any?, content: (Cluster) -> Unit): ClusterImageProvider

@YandexMapsComposeExperimentalApi

actual fun clusterImageProvider(size: DpSize, key1: Any?, key2: Any?, content: (Cluster) -> Unit): ClusterImageProvider

@YandexMapsComposeExperimentalApi

actual fun clusterImageProvider(size: DpSize, key1: Any?, key2: Any?, key3: Any?, content: (Cluster) -> Unit): ClusterImageProvider

@YandexMapsComposeExperimentalApi

expect fun clusterImageProvider(size: DpSize, content: @Composable (Cluster) -> Unit): ClusterImageProvider

@YandexMapsComposeExperimentalApi

expect fun clusterImageProvider(size: DpSize, key1: Any?, content: @Composable (Cluster) -> Unit): ClusterImageProvider

@YandexMapsComposeExperimentalApi

expect fun clusterImageProvider(size: DpSize, vararg keys: Any?, content: @Composable (Cluster) -> Unit): ClusterImageProvider

@YandexMapsComposeExperimentalApi

expect fun clusterImageProvider(size: DpSize, key1: Any?, key2: Any?, content: @Composable (Cluster) -> Unit): ClusterImageProvider

@YandexMapsComposeExperimentalApi

expect fun clusterImageProvider(size: DpSize, key1: Any?, key2: Any?, key3: Any?, content: @Composable (Cluster) -> Unit): ClusterImageProvider

@YandexMapsComposeExperimentalApi

fun Clustering(groups: ImmutableList<ClusterGroup>, icon: ClusterImageProvider, iconStyle: IconStyle = IconStyle(), config: ClusterizingConfig = ClusterizingConfig(), onItemTap: (ClusterItem) -> Boolean? = null, onClusterTap: (Cluster) -> Boolean? = null, visible: Boolean = true, zIndex: Float = 0.0f)

fun Clustering(groups: ImmutableList<ClusterGroup>, icon: ImageProvider, iconStyle: IconStyle = IconStyle(), config: ClusterizingConfig = ClusterizingConfig(), onItemTap: (ClusterItem) -> Boolean? = null, onClusterTap: (Cluster) -> Boolean? = null, visible: Boolean = true, zIndex: Float = 0.0f)

@YandexMapsComposeExperimentalApi

fun Clustering(group: ClusterGroup, icon: ClusterImageProvider, iconStyle: IconStyle = IconStyle(), config: ClusterizingConfig = ClusterizingConfig(), onItemTap: (ClusterItem) -> Boolean? = null, onClusterTap: (Cluster) -> Boolean? = null, visible: Boolean = true, zIndex: Float = 0.0f)

fun Clustering(group: ClusterGroup, icon: ImageProvider, iconStyle: IconStyle = IconStyle(), config: ClusterizingConfig = ClusterizingConfig(), onItemTap: (ClusterItem) -> Boolean? = null, onClusterTap: (Cluster) -> Boolean? = null, visible: Boolean = true, zIndex: Float = 0.0f)

@YandexMapsComposeExperimentalApi

fun Clustering(groups: ImmutableList<ClusterGroup>, contentSize: DpSize, iconStyle: IconStyle = IconStyle(), config: ClusterizingConfig = ClusterizingConfig(), onItemTap: (ClusterItem) -> Boolean? = null, onClusterTap: (Cluster) -> Boolean? = null, visible: Boolean = true, zIndex: Float = 0.0f, content: @Composable (Cluster) -> Unit)

@YandexMapsComposeExperimentalApi

fun Clustering(group: ClusterGroup, contentSize: DpSize, iconStyle: IconStyle = IconStyle(), config: ClusterizingConfig = ClusterizingConfig(), onItemTap: (ClusterItem) -> Boolean? = null, onClusterTap: (Cluster) -> Boolean? = null, visible: Boolean = true, zIndex: Float = 0.0f, content: @Composable (Cluster) -> Unit)

@YandexMapsComposeExperimentalApi

actual fun imageProvider(size: DpSize, content: () -> Unit): ImageProvider

@YandexMapsComposeExperimentalApi

actual fun imageProvider(size: DpSize, key1: Any?, content: () -> Unit): ImageProvider

@YandexMapsComposeExperimentalApi

actual fun imageProvider(size: DpSize, vararg keys: Any?, content: () -> Unit): ImageProvider

@YandexMapsComposeExperimentalApi

actual fun imageProvider(size: DpSize, key1: Any?, key2: Any?, content: () -> Unit): ImageProvider

@YandexMapsComposeExperimentalApi

actual fun imageProvider(size: DpSize, key1: Any?, key2: Any?, key3: Any?, content: () -> Unit): ImageProvider

fun imageProvider(resource: DrawableResource): ImageProvider

@YandexMapsComposeExperimentalApi

expect fun imageProvider(size: DpSize, content: @Composable () -> Unit): ImageProvider

@YandexMapsComposeExperimentalApi

expect fun imageProvider(size: DpSize, key1: Any?, content: @Composable () -> Unit): ImageProvider

@YandexMapsComposeExperimentalApi

expect fun imageProvider(size: DpSize, vararg keys: Any?, content: @Composable () -> Unit): ImageProvider

@YandexMapsComposeExperimentalApi

expect fun imageProvider(size: DpSize, key1: Any?, key2: Any?, content: @Composable () -> Unit): ImageProvider

@YandexMapsComposeExperimentalApi

expect fun imageProvider(size: DpSize, key1: Any?, key2: Any?, key3: Any?, content: @Composable () -> Unit): ImageProvider

MapControllerEffect

fun MapControllerEffect(controller: YandexMapController, dispose: (MapWindow) -> Unit = {}, block: (MapWindow) -> Unit)

fun MapControllerEffect(controller: YandexMapController, key1: Any?, dispose: (MapWindow) -> Unit = {}, block: (MapWindow) -> Unit)

fun MapControllerEffect(controller: YandexMapController, vararg keys: Any?, dispose: (MapWindow) -> Unit = {}, block: (MapWindow) -> Unit)

fun MapControllerEffect(controller: YandexMapController, key1: Any?, key2: Any?, dispose: (MapWindow) -> Unit = {}, block: (MapWindow) -> Unit)

fun MapControllerEffect(controller: YandexMapController, key1: Any?, key2: Any?, key3: Any?, dispose: (MapWindow) -> Unit = {}, block: (MapWindow) -> Unit)

fun MapEffect(key1: Any?, block: suspend CoroutineScope.(Map) -> Unit)

A side-effect backed by a LaunchedEffect which will launch block and provide the underlying managed YandexMap object into the composition's CoroutineContext. This effect will be re-launched when a different key1 is provided.

fun MapEffect(vararg keys: Any?, block: suspend CoroutineScope.(Map) -> Unit)

A side-effect backed by a LaunchedEffect which will launch block and provide the underlying managed YandexMap object into the composition's CoroutineContext. This effect will be re-launched when a different keys is provided.

fun MapEffect(key1: Any?, key2: Any?, block: suspend CoroutineScope.(Map) -> Unit)

A side-effect backed by a LaunchedEffect which will launch block and provide the underlying managed YandexMap object into the composition's CoroutineContext. This effect will be re-launched when a different key1 or key2 is provided.

fun MapEffect(key1: Any?, key2: Any?, key3: Any?, block: suspend CoroutineScope.(Map) -> Unit)

A side-effect backed by a LaunchedEffect which will launch block and provide the underlying managed YandexMap object into the composition's CoroutineContext. This effect will be re-launched when a different key1, key2 or key3 is provided.

fun Placemark(state: PlacemarkState, icon: ImageProvider, iconStyle: IconStyle = IconStyle(), onTap: (Point) -> Boolean? = null, visible: Boolean = true, draggable: Boolean = false, zIndex: Float = 0.0f, opacity: Float = 1.0f)

@YandexMapsComposeExperimentalApi

fun Placemark(state: PlacemarkState, contentSize: DpSize, iconStyle: IconStyle = IconStyle(), visible: Boolean = true, draggable: Boolean = false, zIndex: Float = 0.0f, opacity: Float = 1.0f, onTap: (Point) -> Boolean? = null, content: @Composable () -> Unit)

fun Polygon(state: PolygonState, color: Color = DefaultFillColor, strokeColor: Color = DefaultStrokeColor, strokeWidth: Float = DefaultStrokeWidth, geodesic: Boolean = DefaultGeodesic, pattern: ImageProvider? = null, patternScale: Float = 1.0f, visible: Boolean = true, zIndex: Float = 0.0f, onTap: (Point) -> Boolean? = null)

fun Polyline(state: PolylineState, strokeColor: Color = DefaultStrokeColor, strokeWidth: Float = DefaultStrokeWidth, gradientLength: Float = DefaultGradientLength, outlineWidth: Float = DefaulOutlineWidth, outlineColor: Color = DefaultOutlineColor, innerOutlineEnabled: Boolean = false, turnRadius: Float = DefaultTurnRadius, dashLength: Float = DefaultDashLength, gapLength: Float = DefaultGapLength, dashOffset: Float = DefaultDashOffset, visible: Boolean = true, zIndex: Float = 0.0f, onTap: (Point) -> Boolean? = null)

rememberAndInitializeMapKit

actual fun rememberAndInitializeMapKit(): MapKit

expect fun rememberAndInitializeMapKit(): MapKit

Remember global MapKit instance and initialize it on Android

actual fun rememberAndInitializeMapKit(): MapKit

rememberCameraPositionState

inline fun rememberCameraPositionState(key: String? = null, crossinline init: CameraPositionState.() -> Unit = {}): CameraPositionState

Create and rememberSaveable a CameraPositionState using CameraPositionState.Saver. init will be called when the CameraPositionState is first created to configure its initial state.

rememberCircleState

fun rememberCircleState(geometry: Circle, key: String? = null): CircleState

Uses rememberSaveable to retain CircleState.geometry across configuration changes, for simple use cases.

rememberComposeMapObjectRenderer

@YandexMapsComposeExperimentalApi

actual fun rememberComposeMapObjectRenderer(): ComposeMapObjectRenderer

@YandexMapsComposeExperimentalApi

expect fun rememberComposeMapObjectRenderer(): ComposeMapObjectRenderer

actual fun rememberComposeMapObjectRenderer(): ComposeMapObjectRenderer

fun rememberMapKit(): MapKit

Remember global MapKit instance

rememberPlacemarkState

fun rememberPlacemarkState(geometry: Point, direction: Float = 0.0f, key: String? = null): PlacemarkState

Uses rememberSaveable to retain PlacemarkState.geometry and PlacemarkState.direction across configuration changes, for simple use cases.

rememberPolygonState

fun rememberPolygonState(geometry: Polygon, key: String? = null): PolygonState

rememberPolylineState

fun rememberPolylineState(geometry: Polyline, key: String? = null): PolylineState

Uses rememberSaveable to retain PolylineState.geometry across configuration changes, for simple use cases.

rememberYandexMapController

fun rememberYandexMapController(): YandexMapController

Create and remember YandexMapController. Don't pass to multiple YandexMap. Don't save it anywhere, contains native references.

TitledPlacemark

fun TitledPlacemark(state: PlacemarkState, icon: ImageProvider, title: String, iconStyle: IconStyle = IconStyle(), titleStyle: TextStyle = TextStyle(), onTap: (Point) -> Boolean? = null, visible: Boolean = true, draggable: Boolean = false, zIndex: Float = 0.0f, opacity: Float = 1.0f)

toImageProvider

actual fun ImageBitmap.toImageProvider(): ImageProvider

expect fun ImageBitmap.toImageProvider(): ImageProvider

fun <Error class: unknown class>.toUIImage(): <Error class: unknown class>

fun YandexMap(controller: YandexMapController = rememberYandexMapController(), modifier: Modifier = Modifier)

fun YandexMap(cameraPositionState: CameraPositionState = rememberCameraPositionState(), modifier: Modifier = Modifier, config: MapConfig = MapConfig(isNightModeEnabled = isSystemInDarkTheme()), content: @Composable () -> Unit = {})

@YandexMapsComposeExperimentalApi

fun YandexMap(locationState: UserLocationState, modifier: Modifier = Modifier, cameraPositionState: CameraPositionState = rememberCameraPositionState(), locationConfig: UserLocationConfig = UserLocationConfig(), config: MapConfig = MapConfig(isNightModeEnabled = isSystemInDarkTheme()), content: @Composable () -> Unit = {})