MapLibre Compose

https://maplibre.org/maplibre-compose/api
Admin
MapLibre Compose is a Kotlin multiplatform library that provides composable APIs for building...
Tokens:414,396
Snippets:5,030
Trust Score:10
Update:4 days ago
Show doc for...
Tokens:
Raw
### start

Source: https://maplibre.org/maplibre-compose/api/lib/location-runtime-linux/org.maplibre.compose.location.desktop.linux.portal/-location-portal/index.html

Starts a location session using the given session handle, parent window, and options.

```APIDOC
## start

### Description
Starts a location session using the given session handle, parent window, and options.

### Method
start

### Parameters
- **sessionHandle** (DBusPath) - Required - The D-Bus path of the session to start.
- **parentWindow** (String) - Required - The parent window identifier.
- **options** (Map<String, Variant<out Any>>) - Required - Options for starting the session.

### Returns
- **DBusPath** - The D-Bus path of the started session.
```

--------------------------------

### start(sessionHandle: DBusPath, parentWindow: String, options: Map<String, Variant<out Any>>): DBusPath

Source: https://maplibre.org/maplibre-compose/api/lib/location-runtime-linux/org.maplibre.compose.location.desktop.linux.portal/-location-portal/start.html

Starts a location portal session with the given DBus session handle, parent window, and options. Returns a DBusPath representing the session.

```APIDOC
## start(sessionHandle: DBusPath, parentWindow: String, options: Map<String, Variant<out Any>>): DBusPath

### Description
Starts a location portal session with the given DBus session handle, parent window, and options. Returns a DBusPath representing the session.

### Method
start

### Parameters
- **sessionHandle** (DBusPath) - Required - The DBus session handle.
- **parentWindow** (String) - Required - The parent window identifier.
- **options** (Map<String, Variant<out Any>>) - Required - A map of options for the location portal.

### Returns
- **DBusPath** - The DBus path of the started session.
```

--------------------------------

### installMaplibreCompose(workerUrl: String = DefaultWorkerUrl)

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.browser/install-maplibre-compose.html

Installs the browser graphics integration and sets the MapLibre GL JS worker URL. Call this inside onWasmReady, before Compose starts. Later calls are ignored.

```APIDOC
## installMaplibreCompose(workerUrl: String = DefaultWorkerUrl)

### Description
Installs the browser graphics integration and sets the MapLibre GL JS worker URL. Call this inside onWasmReady, before Compose starts. Later calls are ignored.

### Function Signature
installMaplibreCompose(workerUrl: String = DefaultWorkerUrl)

### Parameters
- **workerUrl** (String) - Optional - The URL for the MapLibre GL JS worker. Defaults to the bundled patched MapLibre GL JS worker.

### Throws
- **IllegalStateException** - if skiko has not published its exports yet.

### Usage Notes
- Must be called inside onWasmReady, before Compose starts.
- Later calls are ignored.
```

--------------------------------

### onStart

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.interaction/-rotate-camera-builder/index.html

Registers a callback that is invoked when the rotation interaction starts.

```APIDOC
## Function: onStart

### Description
Registers a callback that is invoked when the rotation interaction starts.

### Signature
```kotlin
fun onStart(block: () -> Unit?)
```

### Parameters
- **block** (() -> Unit?) - Required - A lambda to be called when the interaction starts.
```

--------------------------------

### ProvideMapPresentationHost usage

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.desktop/-provide-map-presentation-host.html

Example showing how to wrap MaplibreMap with a ProvideMapPresentationHost using a custom host.

```kotlin
ProvideMapPresentationHost(
  host = rememberMyComposeMapPresentationHost(),
) {
  MaplibreMap()
}
```

--------------------------------

### onStart(block: () -> Unit?)

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.interaction/-pan-camera-builder/on-start.html

Sets a callback to be invoked before the component starts responding to input, including restarts within a gesture.

```APIDOC
## onStart(block: () -> Unit?)

### Description
Runs before this component begins responding to input, including restarts within a gesture.

### Method
Function call

### Signature
fun onStart(block: () -> Unit?)

### Parameters
- **block** (() -> Unit?) - Required - The callback to run before the component starts responding to input.

### Return Value
Unit
```

--------------------------------

### onStart(block: () -> Unit?)

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.interaction/-velocity-camera-builder/on-start.html

Sets a callback to be invoked before the component starts responding to input, including restarts within a gesture.

```APIDOC
## onStart(block: () -> Unit?)

### Description
Runs before this component begins responding to input, including restarts within a gesture.

### Method
onStart

### Parameters
- **block** (() -> Unit?) - Required - The callback to run before the component starts responding to input.

### Return
Unit
```

--------------------------------

### RenderOptions.Companion.Standard

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.map/-render-options/-companion/index.html

The Standard property provides the default RenderOptions for the platform. Use this to get the standard rendering configuration.

```APIDOC
## RenderOptions.Companion.Standard

### Description
Returns the platform defaults for rendering options.

### Property
`val Standard: RenderOptions`

### Return Value
- **RenderOptions** - The default rendering options for the platform.

### Usage Example
```kotlin
val options = RenderOptions.Standard
```
```

--------------------------------

### SystemSettingsLauncher()

Source: https://maplibre.org/maplibre-compose/api/lib/location/org.maplibre.compose.location/-system-settings-launcher/-system-settings-launcher.html

Creates a SystemSettingsLauncher with no parameters. Multiple overloads exist.

```APIDOC
## SystemSettingsLauncher()

### Description
Creates a SystemSettingsLauncher instance with no parameters. Multiple overloads are available.

### Constructor
SystemSettingsLauncher()
```

--------------------------------

### get(source: Source): SourceHandle?

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.map/-style-sources/index.html

Returns the current handle with source's ID, or null while absent or no style is ready. A remembered source is installed only while a declared layer references it. Look up a new handle after a base-style reload or source replacement.

```APIDOC
## get(source: Source): SourceHandle?

### Description
Returns the current handle with source's ID, or null while absent or no style is ready. A remembered source is installed only while a declared layer references it. Look up a new handle after a base-style reload or source replacement.

### Method
operator fun get(source: Source): SourceHandle?

### Parameters
- **source** (Source) - Required - The source whose handle to retrieve.

### Returns
- **SourceHandle?** - The handle for the source, or null if absent or no style is ready.
```

--------------------------------

### SystemSettingsLauncher(context: Context)

Source: https://maplibre.org/maplibre-compose/api/lib/location/org.maplibre.compose.location/-system-settings-launcher/-system-settings-launcher.html

Creates a SystemSettingsLauncher with a given Context. If the context cannot reach an activity, the settings screen is launched in a new task.

```APIDOC
## SystemSettingsLauncher(context: Context)

### Description
Creates a SystemSettingsLauncher instance with the provided Context. The context is used to launch the system settings screen; if the context cannot reach an activity, the screen is launched in a new task.

### Parameters
- **context** (Context) - Required - Any Context; a context that cannot reach an activity launches the screen in a new task.

### Constructor
SystemSettingsLauncher(context: Context)
```

--------------------------------

### actual constructor(from: TileLodOptions, block: TileLodOptions.Builder.() -> Unit)

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.map/-tile-lod-options/-tile-lod-options.html

Actual implementation of the constructor for a specific platform. Edits from the provided source; omitted settings inherit.

```APIDOC
## Constructor

### Description
Actual implementation of the constructor for a specific platform. Edits from the provided source; omitted settings inherit.

### Signature
actual constructor(from: TileLodOptions, block: TileLodOptions.Builder.() -> Unit)

### Parameters
- **from** (TileLodOptions) - Required - The source TileLodOptions to edit.
- **block** (TileLodOptions.Builder.() -> Unit) - Required - A builder lambda that modifies the settings.

### Notes
Omitted settings inherit from the source.
```

--------------------------------

### properties()

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.expressions.dsl/-feature/index.html

Gets the feature properties object. Note that in some cases, it may be more efficient to use get("property_name") directly.

```APIDOC
## properties()

### Description
Gets the feature properties object. Note that in some cases, it may be more efficient to use get("property_name") directly.

### Method
Function

### Signature
fun properties(): Expression<MapValue<AnyValue>>

### Parameters
None

### Returns
Expression<MapValue<AnyValue>> - The feature properties.
```

--------------------------------

### onStart(block: () -> Unit?)

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.interaction/-pitch-camera-builder/on-start.html

Sets a callback to run before the component begins responding to input, including restarts within a gesture.

```APIDOC
## onStart(block: () -> Unit?)

### Description
Runs the provided block before this component begins responding to input, including restarts within a gesture.

### Function Signature
fun onStart(block: () -> Unit?)

### Parameters
- **block** (() -> Unit?) - Required - A lambda that is executed before the component starts responding to input.

### Return Value
This function does not return a value (Unit).
```

--------------------------------

### get (Map)

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.expressions.dsl/get.html

Operator function to get a value from a map expression by key. Two overloads accept an Expression<StringValue> or a String key.

```APIDOC
## get (Map)

### Description
Returns the value corresponding to the given key, or null if the key is not present in the map expression.

### Method
operator fun <T : ExpressionValue?> Expression<MapValue<T>>.get(key: Expression<StringValue>): Expression<T?>
operator fun <T : ExpressionValue?> Expression<MapValue<T>>.get(key: String): Expression<T?>

### Parameters
- **key** (Expression<StringValue> or String) - Required - The key whose associated value is to be returned.

### Returns
- **Expression<T?>** - The expression representing the value for the given key, or null if the key is not present.
```

--------------------------------

### properties()

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.expressions.dsl/-feature/properties.html

Gets the feature properties object. Returns an Expression<MapValue<AnyValue>>. In some cases, using get("property_name") directly may be more efficient.

```APIDOC
## properties()

### Description
Gets the feature properties object. Note that in some cases, it may be more efficient to use get("property_name") directly.

### Method
properties()

### Return Type
Expression<MapValue<AnyValue>>

### Usage
This function is part of the MapLibre Compose expressions DSL and can be called to access the properties of a feature.
```

--------------------------------

### Fly constructor

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.camera/-camera-animation/-fly/-fly.html

Creates a Fly camera animation. The constructor takes a starting state and a builder block to configure the animation. Omitted settings inherit from the starting state.

```APIDOC
## Fly constructor

### Description
Creates a Fly camera animation. The constructor takes a starting state and a builder block to configure the animation. Omitted settings inherit from the starting state.

### Method
Constructor

### Signature
`expect constructor(from: CameraAnimation.Fly = Standard, block: CameraAnimation.Fly.Builder.() -> Unit)`

### Parameters
- **from** (CameraAnimation.Fly) - Optional - The starting state of the animation. Defaults to Standard.
- **block** (CameraAnimation.Fly.Builder.() -> Unit) - Required - A builder lambda to configure the animation.

### Platform Variants
- **common**: `expect constructor(from: CameraAnimation.Fly = Standard, block: CameraAnimation.Fly.Builder.() -> Unit)`
- **js**: `actual constructor(from: CameraAnimation.Fly, block: CameraAnimation.Fly.Builder.() -> Unit)`
- **native**: `actual constructor(from: CameraAnimation.Fly, block: CameraAnimation.Fly.Builder.() -> Unit)`

### Description
Edits from; omitted settings inherit.
```

--------------------------------

### constructor

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.map/-apple-map-presentation/index.html

Creates a standalone presentation with the given state and configuration options.

```APIDOC
## Constructor

### Description
Creates a standalone presentation. density also supplies the initial detached map scale.

### Signature
constructor(state: MapState, viewportInsets: PaddingValues = PaddingValues(0.dp), cameraConstraints: CameraConstraints = CameraConstraints.Standard, renderOptions: RenderOptions = RenderOptions.Standard, interactions: MapInteractions = MapInteractions.Standard, density: Density = Density(1f), layoutDirection: LayoutDirection = LayoutDirection.Ltr, isActive: Boolean = true)

### Parameters
- **state** (MapState) - Required - The map state to present.
- **viewportInsets** (PaddingValues) - Optional - Insets added to camera padding for camera moves and fitting.
- **cameraConstraints** (CameraConstraints) - Optional - Camera constraints for the presentation.
- **renderOptions** (RenderOptions) - Optional - Render options for the presentation.
- **interactions** (MapInteractions) - Optional - Map interactions configuration.
- **density** (Density) - Optional - Density and font scale for standalone style content.
- **layoutDirection** (LayoutDirection) - Optional - Layout direction for standalone style content.
- **isActive** (Boolean) - Optional - Whether rendering is enabled.
```

--------------------------------

### length

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.expressions.dsl/index.html

Gets the length of a list or string.

```APIDOC
## length

### Description
Gets the length of a list or string.

### Function Signatures
- `@JvmName(name = "lengthOfList") fun Expression<ListValue<*>>.length(): Expression<IntValue>`
- `@JvmName(name = "lengthOfString") fun Expression<StringValue>.length(): Expression<IntValue>`

### Returns
- `Expression<IntValue>` - The length of the list or string.
```

--------------------------------

### PanCameraBuilder.onStart

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.interaction/-pan-camera-builder/index.html

Function that sets a callback to run before the component begins responding to input.

```APIDOC
## Function: onStart

### Description
Runs before this component begins responding to input, including restarts within a gesture.

### Signature
`fun onStart(block: () -> Unit?)`

### Parameters
- **block** (() -> Unit?) - Required - A lambda that is executed before the component starts responding to input.
```

--------------------------------

### priority property

Source: https://maplibre.org/maplibre-compose/api/lib/location-runtime-gms/org.maplibre.compose.gms/-gms-location-backend/index.html

Gets the priority of this backend.

```APIDOC
## priority

### Description
Returns the priority of this backend.

### Property
open val priority: Int

### Type
Int
```

--------------------------------

### constructor(window: XdgPortalWindow? = null)

Source: https://maplibre.org/maplibre-compose/api/lib/location-runtime-linux/org.maplibre.compose.location.desktop.linux/-linux-portal-location-provider/index.html

Creates a LinuxPortalLocationProvider instance with an optional XdgPortalWindow.

```APIDOC
## Constructor: LinuxPortalLocationProvider

### Description
Creates a new LinuxPortalLocationProvider instance.

### Parameters
- **window** (XdgPortalWindow?) - Optional - The XDG portal window to use for the portal session.
```

--------------------------------

### length (String)

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.expressions.ast/-expression/index.html

Gets the length of a string expression.

```APIDOC
## length (String)

### Description
Gets the length of this string.

### Function Signature
@JvmName(name = "lengthOfString")
fun Expression<StringValue>.length(): Expression<IntValue>

### Returns
Expression<IntValue> - The length of the string.
```

--------------------------------

### SystemSettingsLauncher constructor

Source: https://maplibre.org/maplibre-compose/api/lib/location/org.maplibre.compose.location/-system-settings-launcher/index.html

Constructs a SystemSettingsLauncher instance. On Android, it requires a Context; on other platforms, it takes no parameters.

```APIDOC
## SystemSettingsLauncher constructor

### Description
Constructs a SystemSettingsLauncher instance. On Android, it requires a Context; on other platforms, it takes no parameters.

### Constructors
- `constructor(context: Context)` (Android) - Creates a launcher with the given context.
- `constructor()` (iOS, JS, JVM, macOS) - Creates a launcher with no parameters.

### Parameters
- `context` (Context) - Required on Android. A context that cannot reach an activity launches the screen in a new task.
```

--------------------------------

### length (List)

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.expressions.ast/-expression/index.html

Gets the length of a list expression.

```APIDOC
## length (List)

### Description
Gets the length of a this list.

### Function Signature
@JvmName(name = "lengthOfList")
fun Expression<ListValue<*>>.length(): Expression<IntValue>

### Returns
Expression<IntValue> - The length of the list.
```

--------------------------------

### linuxOpenGl

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.desktop/-compose-map-presentation-host/-companion/index.html

Creates a host for a window that draws Compose with OpenGL on Linux.

```APIDOC
## Function: linuxOpenGl

### Description
Creates a host for a window that draws Compose with OpenGL on Linux.

### Signature
fun linuxOpenGl(description: String, gpuContext: () -> OpenGlComposeGpuContext?, runOnGpuThread: (Runnable) -> Unit, xdgPortalWindow: () -> XdgPortalWindow? = { null }): ComposeMapPresentationHost

### Parameters
- **description** (String) - Required - Description of the host.
- **gpuContext** (() -> OpenGlComposeGpuContext?) - Required - A function that returns the OpenGL Compose GPU context.
- **runOnGpuThread** ((Runnable) -> Unit) - Required - A function to run a Runnable on the GPU thread.
- **xdgPortalWindow** (() -> XdgPortalWindow?) - Optional - A function that returns the XDG portal window, defaults to { null }.

### Return Value
ComposeMapPresentationHost - The created host.
```

--------------------------------

### id()

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.expressions.dsl/-feature/index.html

Gets the feature's id, if it has one.

```APIDOC
## id()

### Description
Gets the feature's id, if it has one.

### Method
Function

### Signature
fun id(): Expression<AnyValue?>

### Parameters
None

### Returns
Expression<AnyValue?> - The feature's id or null.
```

--------------------------------

### geometryType()

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.expressions.dsl/-feature/index.html

Gets the feature's geometry type.

```APIDOC
## geometryType()

### Description
Gets the feature's geometry type.

### Method
Function

### Signature
fun geometryType(): Expression<GeometryType>

### Parameters
None

### Returns
Expression<GeometryType> - The geometry type.
```

--------------------------------

### id property

Source: https://maplibre.org/maplibre-compose/api/lib/location-runtime-gms/org.maplibre.compose.gms/-gms-location-backend/index.html

Gets the unique identifier for this backend.

```APIDOC
## id

### Description
Returns the unique identifier for this backend.

### Property
open override val id: String

### Type
String
```

--------------------------------

### Using the step expression

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.expressions.dsl/step.html

This example demonstrates how to use the step function to map zoom levels to specific values, providing a fallback for values below the first stop.

```kotlin
step(zoom(), const(0), 10 to const(2.5), 20 to const(10.5))
```

--------------------------------

### id property

Source: https://maplibre.org/maplibre-compose/api/lib/location-runtime-linux/org.maplibre.compose.location.desktop.linux/-linux-portal-location-backend/index.html

Gets the unique identifier for this location backend.

```APIDOC
## id: String

### Description
Returns the unique identifier for this location backend.

### Property
open override val id: String

### Returns
String - The unique identifier.
```

--------------------------------

### fun Expression<StringValue>.substring(startIndex: Int, endIndex: Int? = null): Expression<StringValue>

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.expressions.dsl/substring.html

Returns a substring from this string expression starting at startIndex (inclusive) to endIndex (exclusive) if endIndex is provided, otherwise to the end of the string. The start and end indices are given as integer literals.

```APIDOC
## substring(startIndex: Int, endIndex: Int? = null)

### Description
Returns a substring from this string expression starting at startIndex (inclusive) to endIndex (exclusive) if endIndex is provided, otherwise to the end of the string. The start and end indices are given as integer literals.

### Method
Extension function

### Signature
fun Expression<StringValue>.substring(startIndex: Int, endIndex: Int? = null): Expression<StringValue>

### Parameters
- **startIndex** (Int) - Required - The starting index (inclusive) of the substring.
- **endIndex** (Int?) - Optional - The ending index (exclusive) of the substring. If null or not provided, the substring extends to the end of the string.

### Return Value
Expression<StringValue> - The substring expression.

### Notes
A UTF-16 surrogate pair counts as a single position.
```

--------------------------------

### Light constructor

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.style/-light/-light.html

Creates a Light instance with specified anchor, position, color, intensity, and optional transition options.

```APIDOC
## Light constructor

### Description
Creates a Light instance for configuring lighting of extruded geometries in MapLibre Compose.

### Parameters
- **anchor** (Expression<IlluminationAnchor>?) - Optional - Whether extruded geometries are lit relative to the map or viewport. Defaults to const(IlluminationAnchor.Viewport).
- **position** (Expression<VectorValue<Number>>?) - Optional - Position of the light source relative to lit geometries, as [r, a, p]: r is the distance from the center of the base of an object to its light, a is the azimuthal angle of the light in degrees clockwise from 0° (the top of the viewport when anchor is IlluminationAnchor.Viewport, or due north when it is IlluminationAnchor.Map), and p is the polar angle of the light from 0° (directly above) to 180° (directly below). Defaults to const(listOf(1.15f, 210f, 30f)).
- **color** (Expression<ColorValue>?) - Optional - Color tint for lighting extruded geometries. Defaults to const(Color.White).
- **intensity** (Expression<FloatValue>?) - Optional - Intensity of lighting. A value in the range of [0..1]; higher numbers present as more extreme contrast. Defaults to const(0.5f).
- **positionTransition** (TransitionOptions?) - Optional - Timing for changes to position. Null uses the style's global transition. Defaults to null.
- **colorTransition** (TransitionOptions?) - Optional - Timing for changes to color. Null uses the style's global transition. Defaults to null.
- **intensityTransition** (TransitionOptions?) - Optional - Timing for changes to intensity. Null uses the style's global transition. Defaults to null.

### Example
```kotlin
Light(
    anchor = const(IlluminationAnchor.Viewport),
    position = const(listOf(1.15f, 210f, 30f)),
    color = const(Color.White),
    intensity = const(0.5f),
    positionTransition = null,
    colorTransition = null,
    intensityTransition = null
)
```
```

--------------------------------

### close()

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.map/-map-runtime/close.html

Marks this runtime as closed and starts child and shared-resource cleanup.

```APIDOC
## close()

### Description
Marks this runtime as closed and starts child and shared-resource cleanup.

### Method
close()

### Signature
fun close()

### Parameters
None

### Return Type
Unit

### Usage
Call this function when the runtime is no longer needed to release resources.
```

--------------------------------

### actual constructor(from: RenderOptions, block: RenderOptions.Builder.() -> Unit)

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.map/-render-options/-render-options.html

Actual implementation of the RenderOptions constructor for a specific platform. Edits from the provided RenderOptions, with omitted settings inheriting.

```APIDOC
## Constructor

### Description
Actual platform-specific constructor that creates a RenderOptions instance by editing from an existing RenderOptions. Omitted settings inherit from the source.

### Signature
actual constructor(from: RenderOptions, block: RenderOptions.Builder.() -> Unit)

### Parameters
- **from** (RenderOptions) - Required - The source RenderOptions to edit.
- **block** (RenderOptions.Builder.() -> Unit) - Required - A lambda that modifies the builder to customize the RenderOptions.

### Usage Example
```kotlin
val options = RenderOptions(from = existingOptions) {
    // customize settings
}
```
```

--------------------------------

### CameraMoveReason

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.camera/index.html

A sealed interface indicating what started the most recent camera movement.

```APIDOC
## CameraMoveReason

### Description
What started the most recent camera movement.

### Type
sealed interface

### Annotations
@Immutable

### Usage
Implementations define reasons such as user gesture, programmatic animation, or API call.
```

--------------------------------

### Ease Constructor

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.camera/-camera-animation/-ease/index.html

Creates an Ease camera animation. Edits from an existing Ease; omitted settings inherit.

```APIDOC
## Ease Constructor

### Description
Creates an Ease camera animation. Edits from an existing Ease; omitted settings inherit.

### Signature
```kotlin
expect constructor(from: CameraAnimation.Ease = Standard, block: CameraAnimation.Ease.Builder.() -> Unit)
```

### Parameters
- **from** (CameraAnimation.Ease) - Optional - The base Ease to edit; defaults to Standard.
- **block** (CameraAnimation.Ease.Builder.() -> Unit) - Required - A builder lambda to configure the animation.
```

--------------------------------

### openApplicationSettings()

Source: https://maplibre.org/maplibre-compose/api/lib/location/org.maplibre.compose.location/-system-settings-launcher/index.html

Opens the application's details screen in the system settings, where the user manages its permissions. Returns whether the screen opened.

```APIDOC
## openApplicationSettings()

### Description
Opens the application's details screen in the system settings, where the user manages its permissions. Returns whether the screen opened.

### Method
`fun openApplicationSettings(): Boolean`

### Return Value
- `Boolean` - `true` if the screen opened successfully, `false` otherwise.
```

--------------------------------

### PortalRequest.getObjectPath()

Source: https://maplibre.org/maplibre-compose/api/lib/location-runtime-linux/org.maplibre.compose.location.desktop.linux.portal/-portal-request/index.html

Abstract function to get the object path of the portal request.

```APIDOC
## PortalRequest.getObjectPath()

### Description
Abstract function to get the object path of the portal request.

### Method
getObjectPath

### Signature
abstract fun getObjectPath(): String

### Parameters
None

### Returns
String - The object path.
```

--------------------------------

### backendAvailability property

Source: https://maplibre.org/maplibre-compose/api/lib/location-runtime-linux/org.maplibre.compose.location.desktop.linux/-linux-portal-location-permission-requester/index.html

Indicates whether the XDG Location portal is installed.

```APIDOC
## Property

### backendAvailability

val backendAvailability: LocationBackendAvailability

Whether the XDG Location portal is installed.
```

--------------------------------

### constructor(from: TileLodOptions = Standard, block: TileLodOptions.Builder.() -> Unit)

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.map/-tile-lod-options/-tile-lod-options.html

Creates a TileLodOptions instance by editing from a default or provided source. Omitted settings inherit from the source.

```APIDOC
## Constructor

### Description
Creates a TileLodOptions instance by applying a builder block to a source TileLodOptions. Omitted settings inherit from the source.

### Signature
constructor(from: TileLodOptions = Standard, block: TileLodOptions.Builder.() -> Unit)

### Parameters
- **from** (TileLodOptions) - Optional - The source TileLodOptions to edit. Defaults to Standard.
- **block** (TileLodOptions.Builder.() -> Unit) - Required - A builder lambda that modifies the settings.

### Notes
Omitted settings inherit from the source.
```

--------------------------------

### fun Expression<StringValue>.substring(startIndex: Expression<IntValue>, endIndex: Expression<IntValue>? = null): Expression<StringValue>

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.expressions.dsl/substring.html

Returns a substring from this string expression starting at startIndex (inclusive) to endIndex (exclusive) if endIndex is provided, otherwise to the end of the string. The start and end indices are given as expressions.

```APIDOC
## substring(startIndex: Expression<IntValue>, endIndex: Expression<IntValue>? = null)

### Description
Returns a substring from this string expression starting at startIndex (inclusive) to endIndex (exclusive) if endIndex is provided, otherwise to the end of the string. The start and end indices are given as expressions.

### Method
Extension function

### Signature
fun Expression<StringValue>.substring(startIndex: Expression<IntValue>, endIndex: Expression<IntValue>? = null): Expression<StringValue>

### Parameters
- **startIndex** (Expression<IntValue>) - Required - The starting index (inclusive) of the substring.
- **endIndex** (Expression<IntValue>?) - Optional - The ending index (exclusive) of the substring. If null or not provided, the substring extends to the end of the string.

### Return Value
Expression<StringValue> - The substring expression.

### Notes
A UTF-16 surrogate pair counts as a single position.
```

--------------------------------

### Ready

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.offline/-offline-storage-state/-ready/index.html

Data class representing the successful initialization state of offline storage, with a property for the current offline packs.

```APIDOC
## Ready

### Description
Data class representing the successful initialization state of offline storage. It contains the current offline packs and can remain after the runtime closes.

### Properties
- **packs** (Set<OfflinePack>) - The set of offline packs available after initialization.

```

--------------------------------

### LinuxPortalLocationBackend constructor

Source: https://maplibre.org/maplibre-compose/api/lib/location-runtime-linux/org.maplibre.compose.location.desktop.linux/-linux-portal-location-backend/index.html

Creates a new instance of the LinuxPortalLocationBackend class.

```APIDOC
## LinuxPortalLocationBackend()

### Description
Creates a new instance of the LinuxPortalLocationBackend class.

### Constructor
LinuxPortalLocationBackend()

### Parameters
None.
```

--------------------------------

### close()

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.map/-map-state/close.html

Marks this state as closed and starts cleanup of the current map surface.

```APIDOC
## close()

### Description
Marks this state as closed and starts cleanup of the current map surface.

### Method
close()

### Signature
fun close()

### Parameters
None

### Return Value
Unit

### Usage Example
```kotlin
mapState.close()
```
```

--------------------------------

### fun macosMetal(description: String, gpuContext: () -> MetalComposeGpuContext?, runOnGpuThread: (Runnable) -> Unit): ComposeMapPresentationHost

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.desktop/-compose-map-presentation-host/-companion/macos-metal.html

Creates a host for a window that draws Compose with Metal on macOS. Works with Metal, Vulkan, and OpenGL MapLibre runtimes. Throws IllegalStateException if the current operating system isn't macOS.

```APIDOC
## Function: macosMetal

### Description
Creates a host for a window that draws Compose with Metal on macOS. Works with the Metal, Vulkan, and OpenGL MapLibre runtimes.

### Signature
fun macosMetal(description: String, gpuContext: () -> MetalComposeGpuContext?, runOnGpuThread: (Runnable) -> Unit): ComposeMapPresentationHost

### Parameters
- **description** (String) - A short description of the window, shown in logs and error messages.
- **gpuContext** (() -> MetalComposeGpuContext?) - Returns the window's current Metal context. It is called only inside runOnGpuThread. Return null while the window has no context, such as before its first frame; maps skip frames until it returns one. Return a new context after the window replaces its device or Skia context; maps then recreate their GPU resources.
- **runOnGpuThread** ((Runnable) -> Unit) - Runs the given action with exclusive access to the window's Skia context, on the thread that owns that context, while Compose isn't drawing with it. It may be called from any thread. It must run the action before it returns, run the action directly when called from inside an action it is running, and rethrow anything the action throws. It must run actions even when gpuContext returns null, because maps release their resources this way.

### Returns
ComposeMapPresentationHost - The created host for the window.

### Throws
- **IllegalStateException** - if the current operating system isn't macOS.
```

--------------------------------

### get

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.map/-style-transition/index.html

Returns the loaded style's transition, or null while no style is ready.

```APIDOC
## get

### Description
Returns the loaded style's transition, or null while no style is ready.

### Method
suspend fun get(): TransitionOptions?

### Parameters
None

### Returns
TransitionOptions? - The loaded style's transition, or null while no style is ready.
```

--------------------------------

### PortalSession.getObjectPath()

Source: https://maplibre.org/maplibre-compose/api/lib/location-runtime-linux/org.maplibre.compose.location.desktop.linux.portal/-portal-session/index.html

Abstract method to get the D-Bus object path of the portal session.

```APIDOC
## PortalSession.getObjectPath()

### Description
Returns the D-Bus object path associated with this portal session.

### Method
getObjectPath()

### Parameters
None

### Returns
String - The D-Bus object path.
```

--------------------------------

### Light constructor

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.style/-light/index.html

Creates a Light instance with configurable anchor, position, color, intensity, and transition options. All parameters have default values matching the style spec's light object.

```APIDOC
## Light constructor

### Description
Creates a Light instance with configurable anchor, position, color, intensity, and transition options. All parameters have default values matching the style spec's light object.

### Parameters
- **anchor** (Expression<IlluminationAnchor>?) - Optional - Whether extruded geometries are lit relative to the map or viewport. Default: const(IlluminationAnchor.Viewport)
- **position** (Expression<VectorValue<Number>>?) - Optional - Position of the light source relative to lit geometries, as [r, a, p]: r is the distance from the center of the base of an object to its light, a is the azimuthal angle of the light in degrees clockwise from 0° (the top of the viewport when anchor is IlluminationAnchor.Viewport, or due north when it is IlluminationAnchor.Map), and p is the polar angle of the light from 0° (directly above) to 180° (directly below). Default: const(listOf(1.15f, 210f, 30f))
- **color** (Expression<ColorValue>?) - Optional - Color tint for lighting extruded geometries. Default: const(Color.White)
- **intensity** (Expression<FloatValue>?) - Optional - Intensity of lighting. A value in the range of [0..1]; higher numbers present as more extreme contrast. Default: const(0.5f)
- **positionTransition** (TransitionOptions?) - Optional - Timing for changes to position. Null uses the style's global transition. Default: null
- **colorTransition** (TransitionOptions?) - Optional - Timing for changes to color. Null uses the style's global transition. Default: null
- **intensityTransition** (TransitionOptions?) - Optional - Timing for changes to intensity. Null uses the style's global transition. Default: null

### Example
```kotlin
val light = Light(
    anchor = const(IlluminationAnchor.Viewport),
    position = const(listOf(1.15f, 210f, 30f)),
    color = const(Color.White),
    intensity = const(0.5f),
    positionTransition = null,
    colorTransition = null,
    intensityTransition = null
)
```
```

--------------------------------

### slice

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.expressions.dsl/index.html

Returns a sublist of a list expression from a start index to an optional end index.

```APIDOC
## slice

### Description
Returns the items in this list from the startIndex (inclusive) to the end of this list if endIndex is not specified or `null`, otherwise to endIndex (exclusive).

### Function Signatures
fun <T : ExpressionValue?> Expression<ListValue<T>>.slice(startIndex: Int, endIndex: Int? = null): Expression<ListValue<T>>
fun <T : ExpressionValue?> Expression<ListValue<T>>.slice(startIndex: Expression<IntValue>, endIndex: Expression<IntValue>? = null): Expression<ListValue<T>>

### Parameters
- **startIndex** (Int or Expression<IntValue>) - Required - The starting index (inclusive)
- **endIndex** (Int? or Expression<IntValue>?) - Optional - The ending index (exclusive), defaults to null

### Return Value
Expression<ListValue<T>>
```

--------------------------------

### MacosLocationProvider constructor

Source: https://maplibre.org/maplibre-compose/api/lib/location-runtime-macos/org.maplibre.compose.location.desktop.macos/-macos-location-provider/index.html

Creates a new MacosLocationProvider instance.

```APIDOC
## MacosLocationProvider()

### Description
Creates a new MacosLocationProvider instance.

### Constructor
`MacosLocationProvider()`
```

--------------------------------

### isAvailable()

Source: https://maplibre.org/maplibre-compose/api/lib/location/org.maplibre.compose.location/-desktop-location-backend/is-available.html

Abstract method that checks whether this backend can run on the current operating system and architecture. Returns true if the backend is available, false otherwise.

```APIDOC
## isAvailable()

### Description
Whether this backend can run on the current operating system and architecture.

### Method
isAvailable

### Signature
abstract fun isAvailable(): Boolean

### Return Type
Boolean

### Returns
true if the backend is available on the current platform, false otherwise.
```

--------------------------------

### requestForegroundPermission()

Source: https://maplibre.org/maplibre-compose/api/lib/location/org.maplibre.compose.location/-android-location-permission-requester/index.html

Starts a foreground permission request and returns immediately. The result is published to status.

```APIDOC
## requestForegroundPermission()

### Description
Starts a foreground permission request and returns immediately. The result is published to status.

### Method
requestForegroundPermission()

### Parameters
None

### Returns
void
```

--------------------------------

### getText(stop: Length): String

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.overlay/-scale-bar-measure/-default/index.html

Get the formatted text to show for a given stop.

```APIDOC
## Function

### Signature
@Composable
override fun getText(stop: Length): String

### Parameters
- **stop** (Length) - Required - The stop for which to get the formatted text.

### Returns
String - The formatted text to show for the given stop.
```

--------------------------------

### MacosLocationBackend constructor

Source: https://maplibre.org/maplibre-compose/api/lib/location-runtime-macos/org.maplibre.compose.location.desktop.macos/-macos-location-backend/index.html

Creates a new instance of MacosLocationBackend.

```APIDOC
## MacosLocationBackend()

### Description
Creates a new instance of MacosLocationBackend.

### Constructor
`MacosLocationBackend()`

### Parameters
None.
```

--------------------------------

### elevation()

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.expressions.dsl/elevation.html

Gets the elevation of a pixel in meters. Can only be used in the expression for the color parameter in a ColorReliefLayer.

```APIDOC
## elevation()

### Description
Gets the elevation of a pixel in meters. Can only be used in the expression for the `color` parameter in a ColorReliefLayer.

### Function Signature
`fun elevation(): Expression<FloatValue>`

### Return Value
- **Expression<FloatValue>** - An expression representing the elevation value in meters.

### Usage Constraints
- This function can only be used within the expression for the `color` parameter of a `ColorReliefLayer`.

```

--------------------------------

### linuxOpenGl

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.desktop/-compose-map-presentation-host/-companion/linux-open-gl.html

Creates a host for a window that draws Compose with OpenGL on Linux. Works with the Vulkan and OpenGL MapLibre runtimes.

```APIDOC
## Function: linuxOpenGl

### Description
Creates a host for a window that draws Compose with OpenGL on Linux. Works with the Vulkan and OpenGL MapLibre runtimes.

### Signature
fun linuxOpenGl(description: String, gpuContext: () -> OpenGlComposeGpuContext?, runOnGpuThread: (Runnable) -> Unit, xdgPortalWindow: () -> XdgPortalWindow? = { null }): ComposeMapPresentationHost

### Parameters
- **description** (String) - Required - A short description of the window, shown in logs and error messages.
- **gpuContext** (() -> OpenGlComposeGpuContext?) - Required - Returns the window's current OpenGL context. It is called only inside runOnGpuThread. Return null while the window has no context, such as before its first frame; maps skip frames until it returns one. Return a new context after the window replaces its Skia context; maps then recreate their GPU resources.
- **runOnGpuThread** ((Runnable) -> Unit) - Required - Runs the given action with exclusive access to the window's Skia context, on the thread that owns that context, while Compose isn't drawing with it. It may be called from any thread. It must run the action before it returns, run the action directly when called from inside an action it is running, and rethrow anything the action throws. It must run actions even when gpuContext returns null, because maps release their resources this way.
- **xdgPortalWindow** (() -> XdgPortalWindow?) - Optional (default: { null }) - Returns the window that XDG portals use as the parent of system dialogs, such as the location permission prompt. It is called on the composition thread each time ProvideMapPresentationHost composes. Return null when the window has no X11 or Wayland handle; portals then show their dialogs without a parent.

### Returns
- **ComposeMapPresentationHost** - The created host for the window.

### Throws
- **IllegalStateException** - if the current operating system isn't Linux.
```

--------------------------------

### requestForegroundPermission()

Source: https://maplibre.org/maplibre-compose/api/lib/location/org.maplibre.compose.location/-android-location-permission-requester/request-foreground-permission.html

Starts a foreground permission request and returns immediately. The result is published to status. The launcher registers on the activity's result registry at request time, so a directly constructed requester works when the supplied context can reach a ComponentActivity. With a context that cannot, such as a service context, this call does nothing and status stays accurate.

```APIDOC
## requestForegroundPermission()

### Description
Starts a foreground permission request and returns immediately. The result is published to status.

### Method
Function

### Signature
fun requestForegroundPermission()

### Parameters
None

### Return Value
Unit (returns immediately)

### Throws
- **IllegalStateException** - if the requester is closed.

### Notes
- The launcher registers on the activity's result registry at request time, so a directly constructed requester works when the supplied context can reach a ComponentActivity.
- With a context that cannot, such as a service context, this call does nothing and status stays accurate.
- Android's rationale check returns `false` both before the first request and after a permanent denial. This requester tells the two apart by recording a denial that arrives while the check stays `false`. The record lives only in memory and clears once permission is granted or the check returns `true`, so the first request in a fresh process may silently return a denial before status reports `canRequest = false` again.
```

--------------------------------

### lineProgress()

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.expressions.dsl/-feature/index.html

Gets the progress along a gradient line. Can only be used in the gradient property of a line layer.

```APIDOC
## lineProgress()

### Description
Gets the progress along a gradient line. Can only be used in the `gradient` property of a line layer, see LineLayer.

### Method
Function

### Signature
fun lineProgress(): Expression<FloatValue>

### Parameters
None

### Returns
Expression<FloatValue> - The progress value.
```

--------------------------------

### createHeadingProvider(context: Context): HeadingProvider?

Source: https://maplibre.org/maplibre-compose/api/lib/location/org.maplibre.compose.location/-android-location-backend/create-heading-provider.html

Creates this backend's heading provider, or returns null so the default framework heading provider is used.

```APIDOC
## createHeadingProvider(context: Context): HeadingProvider?

### Description
Creates this backend's heading provider, or returns null so the default framework heading provider is used.

### Method
Function

### Signature
open fun createHeadingProvider(context: Context): HeadingProvider?

### Parameters
- **context** (Context) - Required - The Android context used to create the heading provider.

### Return Value
- **HeadingProvider?** - The heading provider created by this backend, or null to use the default framework heading provider.

```

--------------------------------

### lineProgress()

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.expressions.dsl/-feature/line-progress.html

Gets the progress along a gradient line. Can only be used in the gradient property of a line layer.

```APIDOC
## lineProgress()

### Description
Gets the progress along a gradient line. Can only be used in the `gradient` property of a line layer.

### Method
lineProgress()

### Return Type
Expression<FloatValue>

### Usage
This function is used within the `gradient` property of a line layer.
```

--------------------------------

### IosHeadingProvider constructor

Source: https://maplibre.org/maplibre-compose/api/lib/location/org.maplibre.compose.location/-ios-heading-provider/index.html

Creates an instance of IosHeadingProvider.

```APIDOC
## IosHeadingProvider()

### Description
Creates a new IosHeadingProvider instance.

### Method
Constructor

### Parameters
None

### Returns
IosHeadingProvider instance
```

--------------------------------

### ProvideMapPresentationHost(window: NSWindow, content: @Composable () -> Unit)

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.macos/-provide-map-presentation-host.html

Composable function that installs Metal map views beneath the window's existing Compose content view. Call once around the content of a native macOS Compose Window.

```APIDOC
## ProvideMapPresentationHost(window: NSWindow, content: @Composable () -> Unit)

### Description
Installs Metal map views beneath window's existing Compose content view. Call once around the content of a native macOS Compose `Window`. The host preserves Compose's renderer and input view. Maps clear their drawing area to reveal the native view; draw overlays after the map. Use layout positioning and sizing to move and resize maps. Graphics-layer translation, scaling, rotation, overlapping maps, and ancestors that force offscreen composition or group opacity are not supported.

### Parameters
- **window** (NSWindow) - The native macOS window whose content view will host the map views.
- **content** (@Composable () -> Unit) - The composable content to be placed inside the window.

### Behavior
- The host detaches render surfaces when the window closes or this composition is disposed.
- The application remains responsible for disposing its Compose scene and map state.

### Constraints
- Graphics-layer translation, scaling, rotation, overlapping maps, and ancestors that force offscreen composition or group opacity are not supported.
```

--------------------------------

### get()

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.map/-style-transition/get.html

Suspend function that returns the loaded style's transition options, or null if no style is ready.

```APIDOC
## get()

### Description
Returns the loaded style's transition, or null while no style is ready. The reported timing is the engine's: a transition that set wrote is under the animator duration scale of the time it was written.

### Method
suspend fun get(): TransitionOptions?

### Parameters
None

### Returns
- **TransitionOptions?** - The loaded style's transition options, or null if no style is ready.
```

--------------------------------

### VectorTileSource constructor(id: String, tiles: List<String>, from: TileSetOptions = TileSetOptions.Standard, block: TileSetOptions.Builder.() -> Unit = {})

Source: https://maplibre.org/maplibre-compose/api/lib/maplibre-compose/org.maplibre.compose.sources/-vector-tile-source/index.html

Creates a VectorTileSource with a given id, a list of tile URLs, and optional TileSetOptions configuration.

```APIDOC
## VectorTileSource(id: String, tiles: List<String>, from: TileSetOptions = TileSetOptions.Standard, block: TileSetOptions.Builder.() -> Unit = {})

### Description
Creates a VectorTileSource with a given id, a list of tile URLs, and optional TileSetOptions configuration.

### Parameters
- **id** (String) - Required - The identifier for the source.
- **tiles** (List<String>) - Required - A list of tile URL templates.
- **from** (TileSetOptions) - Optional - The TileSetOptions to use, defaults to TileSetOptions.Standard.
- **block** (TileSetOptions.Builder.() -> Unit) - Optional - A lambda to configure the TileSetOptions builder.

### Usage
```kotlin
VectorTileSource(
    id = "my-source",
    tiles = listOf("https://example.com/tiles/{z}/{x}/{y}.pbf"),
    from = TileSetOptions.Standard,
    block = { minZoom = 0; maxZoom = 14 }
)
```
```

--------------------------------

### createDefaultLocationProvider(window: XdgPortalWindow?)

Source: https://maplibre.org/maplibre-compose/api/lib/location/org.maplibre.compose.location/index.html

Creates the default desktop location provider from the installed backend, parenting system dialogs to the given window and releasing process resources on close.

```APIDOC
## createDefaultLocationProvider(window: XdgPortalWindow?)

### Description
Creates the default desktop location provider from the installed backend. The provider's system dialogs are parented to window, and LocationProvider.close releases its process resources.

### Method
fun createDefaultLocationProvider(window: XdgPortalWindow? = null): LocationProvider

### Platforms
- Android
- JVM

### Parameters
- **window** (XdgPortalWindow?) - Optional. The XDG portal window to use as parent for system dialogs. Defaults to null.

### Returns
- **LocationProvider** - The default desktop location provider.
```
Tokens:
Raw