Flutter MapLibre GL

https://pub.dev/documentation/maplibre_gl/latest/
Admin
Flutter MapLibre GL is a Flutter plugin that enables embedding interactive, vector-tile based, fully...
Tokens:117,847
Snippets:1,322
Trust Score:9.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### preWarm() → Future<void>

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/MapLibreMap-class.html

Starts up the map engine early, so its initialization overlaps app start-up instead of delaying the first map.

```APIDOC
## preWarm() → Future<void>

### Description
Starts up the map engine early, so its initialization overlaps app start-up instead of delaying the first map.

### Method
preWarm

### Parameters
None

### Returns
- **Future<void>** - A future that completes when the map engine has been pre-warmed.
```

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

### Future<void> installOfflineMapTiles(String tilesDb)

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/installOfflineMapTiles.html

Installs offline map tiles by copying the provided tiles database file to the tiles cache directory.

```APIDOC
## installOfflineMapTiles

### Description
Copies the tiles database file passed in to the tiles cache directory (sideloaded) to make tiles available offline.

### Method
installOfflineMapTiles

### Parameters
#### Required Parameters
- **tilesDb** (String) - Required - Path to the tiles database file to copy.

### Request Example
```dart
Future<void> installOfflineMapTiles(String tilesDb) async {
  await _globalChannel.invokeMethod('installOfflineMapTiles', <String, dynamic>{
    'tilesdb': tilesDb,
  });
}
```

### Response
No return value. Returns a Future that completes when installation is done.
```

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

### downloadOfflineRegion implementation

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/downloadOfflineRegion.html

Implementation of the downloadOfflineRegion function. It sets up an EventChannel to receive download status events, handles errors and progress updates, and invokes the platform channel to start the download. The function returns an OfflineRegion after decoding the result.

```dart
Future<OfflineRegion> downloadOfflineRegion(
  OfflineRegionDefinition definition, {
  Map<String, dynamic> metadata = const {},
  Function(DownloadRegionStatus event)? onEvent,
}) async {
  final channelName =
      'downloadOfflineRegion_${DateTime.now().microsecondsSinceEpoch}';

  await _globalChannel.invokeMethod(
    'downloadOfflineRegion#setup',
    <String, dynamic>{'channelName': channelName},
  );

  if (onEvent != null) {
    void cleanup() {
      final sub = _offlineDownloadSubscriptions.remove(channelName);
      if (sub != null) unawaited(sub.cancel());
    }

    // Subscription is retained in _offlineDownloadSubscriptions and cancelled
    // in cleanup() on the terminal Success/Error event.
    // ignore: cancel_subscriptions
    final subscription = EventChannel(channelName)
        .receiveBroadcastStream()
        .handleError((error) {
          if (error is PlatformException) {
            onEvent(Error(error));
            cleanup();
            return Error(error);
          }
          final unknownError = Error(
            PlatformException(
              code: 'UnknowException',
              message:
                  'This error is unhandled by plugin. Please contact us if needed.',
              details: error,
            ),
          );
          onEvent(unknownError);
          cleanup();
          return unknownError;
        })
        .listen((data) {
          final Map<String, Object?> jsonData = json.decode(data);
          final status = switch (jsonData['status']) {
            'start' => InProgress(0.0),
            'progress' => InProgress(
              (jsonData['progress']! as num).toDouble(),
              completedResourceCount:
                  (jsonData['completedResourceCount'] as num?)?.toInt() ?? 0,
              requiredResourceCount:
                  (jsonData['requiredResourceCount'] as num?)?.toInt() ?? 0,
              completedResourceSize:
                  (jsonData['completedResourceSize'] as num?)?.toInt() ?? 0,
            ),
            'success' => Success(),
            _ => throw Exception('Invalid event status ${jsonData['status']}'),
          };
          onEvent(status);
          if (status is Success) cleanup();
        });

    _offlineDownloadSubscriptions[channelName] = subscription;
  }

  final result = await _globalChannel.invokeMethod(
    'downloadOfflineRegion',
    <String, dynamic>{'definition': definition.toMap(), 'metadata': metadata},
  );

  return OfflineRegion.fromMap(json.decode(result));
}
```

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

### slice

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/Expressions-class.html

Returns a subarray from an array or a substring from a string from a specified start index, or between a start index and an end index if set. The return value is inclusive of the start index but not of the end index. In a string, a UTF-16 surrogate pair counts as a single position.

```APIDOC
## Constant: slice

### Description
Returns a subarray from an array or a substring from a string from a specified start index, or between a start index and an end index if set. The return value is inclusive of the start index but not of the end index. In a string, a UTF-16 surrogate pair counts as a single position.

### Type
String constant

### Value
`slice`
```

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

### initialize() → Future<void>

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/CircleManager-class.html

Initializes the manager and its layers.

```APIDOC
## initialize() → Future<void>

### Description
Initializes the manager and its layers.

### Returns
A Future that completes when initialization is done.
```

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

### getFeatureState

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/MapLibreMapController-class.html

Gets the state of a feature.

```APIDOC
## getFeatureState(String sourceId, String featureId, {String? sourceLayer}) → Future<Map<String, dynamic>?>

### Description
Gets the state of a feature.

### Method
getFeatureState

### Parameters
- **sourceId** (String) - Required - The ID of the source containing the feature.
- **featureId** (String) - Required - The ID of the feature.
- **sourceLayer** (String?) - Optional - The source layer of the feature.

### Returns
Future<Map<String, dynamic>?> - A future that resolves to the feature state, or null if not found.
```

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

### getLayerIds

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/MapLibreMapController-class.html

Gets the IDs of all layers on the map.

```APIDOC
## getLayerIds() → Future<List>

### Description
Gets the IDs of all layers on the map.

### Method
getLayerIds

### Returns
Future<List> - A future that resolves to a list of layer IDs.
```

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

### MapLibreMapController Constructor

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/MapLibreMapController-class.html

Creates a MapLibreMapController with the specified platform, initial camera position, annotation settings, and interaction callbacks.

```APIDOC
## MapLibreMapController Constructor

### Description
Creates a new MapLibreMapController instance.

### Constructor
MapLibreMapController({required MapLibrePlatform maplibrePlatform, CameraPosition? initialCameraPosition, required Iterable<AnnotationType> annotationOrder, required Iterable<AnnotationType> annotationConsumeTapEvents, OnStyleLoadedCallback? onStyleLoadedCallback, OnMapClickCallback? onMapClick, OnMapLongClickCallback? onMapLongClick, OnCameraTrackingDismissedCallback? onCameraTrackingDismissed, OnCameraTrackingChangedCallback? onCameraTrackingChanged, OnMapIdleCallback? onMapIdle, OnUserLocationUpdated? onUserLocationUpdated, OnCameraIdleCallback? onCameraIdle, OnCameraMoveCallback? onCameraMove})

### Parameters
- **maplibrePlatform** (MapLibrePlatform) - Required - The platform-specific implementation.
- **initialCameraPosition** (CameraPosition?) - Optional - The initial camera position.
- **annotationOrder** (Iterable<AnnotationType>) - Required - The order of annotation types.
- **annotationConsumeTapEvents** (Iterable<AnnotationType>) - Required - Annotation types that consume tap events.
- **onStyleLoadedCallback** (OnStyleLoadedCallback?) - Optional - Callback when style is loaded.
- **onMapClick** (OnMapClickCallback?) - Optional - Callback when map is clicked.
- **onMapLongClick** (OnMapLongClickCallback?) - Optional - Callback when map is long-clicked.
- **onCameraTrackingDismissed** (OnCameraTrackingDismissedCallback?) - Optional - Callback when camera tracking is dismissed.
- **onCameraTrackingChanged** (OnCameraTrackingChangedCallback?) - Optional - Callback when camera tracking changes.
- **onMapIdle** (OnMapIdleCallback?) - Optional - Callback when map becomes idle.
- **onUserLocationUpdated** (OnUserLocationUpdated?) - Optional - Callback when user location updates.
- **onCameraIdle** (OnCameraIdleCallback?) - Optional - Callback when camera becomes idle.
- **onCameraMove** (OnCameraMoveCallback?) - Optional - Callback when camera moves.
```

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

### getClusterExpansionZoom

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/MapLibreMapController-class.html

Gets the zoom at which a cluster splits into its children.

```APIDOC
## getClusterExpansionZoom(String sourceId, int clusterId) → Future<int>

### Description
The zoom at which a cluster splits into its children, for a "tap a cluster to zoom to where it splits" gesture.

### Method
getClusterExpansionZoom

### Parameters
- **sourceId** (String) - Required - The ID of the source containing the cluster.
- **clusterId** (int) - Required - The ID of the cluster.

### Returns
Future<int> - A future that resolves to the zoom level at which the cluster splits.
```

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

### LightProperties

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/LightProperties-class.html

Documentation for the LightProperties class, including its constructor, properties, and toJson method.

```APIDOC
## LightProperties

### Description
Properties of the style's `light` root object.

### Constructors

#### LightProperties({dynamic anchor, dynamic position, dynamic color, dynamic intensity})

Creates a LightProperties instance with optional parameters.

### Properties

- **anchor** (dynamic) - `anchor`: whether extruded geometries are lit relative to the map or viewport. One of "map" or "viewport".
- **color** (dynamic) - `color`: color tint for lighting extruded geometries.
- **intensity** (dynamic) - `intensity`: intensity of lighting, on a scale from 0 to 1. Higher numbers present as more extreme contrast.
- **position** (dynamic) - `position`: position of the light source relative to lit (extruded) geometries, as `[r radial coordinate, a azimuthal angle, p polar angle]`.

### Methods

#### toJson() → Map<String, dynamic>

Converts the LightProperties object to a JSON map.

```

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

### id

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/Expressions-class.html

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

```APIDOC
## id

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

### Usage
`["id"]`

### Returns
- The feature's id, or `null` if it does not have one.
```

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

### animateCamera

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/MapLibreMapController-class.html

Starts an animated change of the map camera position.

```APIDOC
## animateCamera(CameraUpdate cameraUpdate, {Duration? duration}) → Future<bool?>

### Description
Starts an animated change of the map camera position.

### Method
animateCamera

### Parameters
- **cameraUpdate** (CameraUpdate) - Required - The camera update to animate to.
- **duration** (Duration?) - Optional - The duration of the animation.

### Returns
Future<bool?> - A future that resolves to a boolean indicating success or null.
```

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

### UserHeading class

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/UserHeading-class.html

Documentation for the UserHeading class, including its constructor, properties, methods, and operators.

```APIDOC
## UserHeading

### Description
Type represents a geomagnetic value, measured in microteslas, relative to a device axis in three dimensional space.

### Constructors

#### UserHeading({required double? magneticHeading, required double? trueHeading, required double? headingAccuracy, required double? x, required double? y, required double? z, required DateTime timestamp})

const

### Properties

- **hashCode** → int - The hash code for this object. (no setter, inherited)
- **headingAccuracy** → double? - Represents the maximum deviation of where the magnetic heading may differ from the actual geomagnetic heading in degrees. A negative value indicates an invalid heading. (final)
- **magneticHeading** → double? - Represents the direction in degrees, where 0 degrees is magnetic North. The direction is referenced from the top of the device regardless of device orientation as well as the orientation of the user interface. (final)
- **runtimeType** → Type - A representation of the runtime type of the object. (no setter, inherited)
- **timestamp** → DateTime - Returns a timestamp for when the magnetic heading was determined. (final)
- **trueHeading** → double? - Represents the direction in degrees, where 0 degrees is true North. The direction is referenced from the top of the device regardless of device orientation as well as the orientation of the user interface. (final)
- **x** → double? - Returns a raw value for the geomagnetism measured in the x-axis. (final)
- **y** → double? - Returns a raw value for the geomagnetism measured in the y-axis. (final)
- **z** → double? - Returns a raw value for the geomagnetism measured in the z-axis. (final)

### Methods

- **noSuchMethod(Invocation invocation)** → dynamic - Invoked when a nonexistent method or property is accessed. (inherited)
- **toString()** → String - A string representation of this object. (inherited)

### Operators

- **operator ==(Object other)** → bool - The equality operator. (inherited)
```

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

### getClusterChildren

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/MapLibreMapController-class.html

Gets the immediate children of a cluster as GeoJSON features.

```APIDOC
## getClusterChildren(String sourceId, int clusterId) → Future<List<Map<String, dynamic>>>

### Description
The immediate children of a cluster, one zoom level in, as GeoJSON features.

### Method
getClusterChildren

### Parameters
- **sourceId** (String) - Required - The ID of the source containing the cluster.
- **clusterId** (int) - Required - The ID of the cluster.

### Returns
Future<List<Map<String, dynamic>>> - A future that resolves to a list of GeoJSON features representing the cluster's children.
```

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

### LocationEnginePlatforms.web

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/LocationEnginePlatforms-class.html

Web-specific constructor for LocationEnginePlatforms.

```APIDOC
## LocationEnginePlatforms.web

### Description
Web-specific constructor for LocationEnginePlatforms. Sets properties relevant to web location engine configuration.

### Constructor
```dart
LocationEnginePlatforms.web({
  bool enableHighAccuracy = false,
  int? maximumAge = 0,
  int? timeout = 0
})
```

### Parameters
- **enableHighAccuracy** (bool) - Optional - Whether to use high accuracy (GPS) mode. Defaults to false.
- **maximumAge** (int?) - Optional - Maximum age in milliseconds of a cached position that is acceptable to return. Defaults to 0 (must return fresh position).
- **timeout** (int?) - Optional - Maximum time in milliseconds the device is allowed to take to return a position. Defaults to 0 (no timeout).

### Usage Example
```dart
const engine = LocationEnginePlatforms.web(
  enableHighAccuracy: true,
  maximumAge: 5000,
  timeout: 10000,
);
```
```

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

### getClusterLeaves

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/MapLibreMapController-class.html

Gets the original points belonging to a cluster as GeoJSON features.

```APIDOC
## getClusterLeaves(String sourceId, int clusterId, {int limit = 10, int offset = 0}) → Future<List<Map<String, dynamic>>>

### Description
The original points belonging to a cluster, as GeoJSON features.

### Method
getClusterLeaves

### Parameters
- **sourceId** (String) - Required - The ID of the source containing the cluster.
- **clusterId** (int) - Required - The ID of the cluster.
- **limit** (int) - Optional - The maximum number of leaves to return. Defaults to 10.
- **offset** (int) - Optional - The offset from which to start returning leaves. Defaults to 0.

### Returns
Future<List<Map<String, dynamic>>> - A future that resolves to a list of GeoJSON features representing the cluster's leaves.
```

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

### fromMap(dynamic json)

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/CameraPosition-class.html

Static method to create a CameraPosition from a map.

```APIDOC
## fromMap(dynamic json) → CameraPosition?

### Description
Creates a CameraPosition from a map representation.

### Parameters
- **json** (dynamic) - Required - The map representation of the CameraPosition.

### Returns
- **CameraPosition?** - A CameraPosition instance, or null if the conversion fails.
```

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

### installOfflineMapTiles function implementation

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/installOfflineMapTiles.html

Copies a tiles database file to the tiles cache directory for offline use. Invokes the 'installOfflineMapTiles' method on the global channel with the tilesdb parameter.

```dart
Future<void> installOfflineMapTiles(String tilesDb) async {
  await _globalChannel.invokeMethod('installOfflineMapTiles', <String, dynamic>{
    'tilesdb': tilesDb,
  });
}
```

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

### getLayerIds() → Future<List>

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/MapLibreMethodChannel-class.html

Gets the list of layer IDs.

```APIDOC
## getLayerIds

### Description
Gets the list of layer IDs.

### Method
`Future<List> getLayerIds()`

### Parameters
None.

### Returns
`Future<List>` - A list of layer IDs.
```

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

### getFilter(String layerId) → Future

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/MapLibreMethodChannel-class.html

Gets the filter for a layer.

```APIDOC
## getFilter

### Description
Gets the filter for a layer.

### Method
`Future getFilter(String layerId)`

### Parameters
- **layerId** (String) - Required - The identifier of the layer.

### Returns
`Future` - The filter expression.
```

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

### BackgroundLayerProperties class

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/BackgroundLayerProperties-class.html

Documentation for the BackgroundLayerProperties class, including constructors, properties, and methods.

```APIDOC
## BackgroundLayerProperties

### Description
Represents the properties for a background layer in MapLibre GL. It implements LayerProperties and provides constructors, properties, and methods to manage background layer styling.

### Constructors

#### BackgroundLayerProperties({dynamic backgroundColor, dynamic backgroundPattern, dynamic backgroundOpacity, dynamic visibility})
- **const** - Creates a new BackgroundLayerProperties instance with optional parameters.

#### BackgroundLayerProperties.fromJson(Map<String, dynamic> json)
- **factory** - Creates a BackgroundLayerProperties instance from a JSON map.

### Properties

- **backgroundColor** (dynamic) - The color with which the background will be drawn.
- **backgroundPattern** (dynamic) - Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.
- **backgroundOpacity** (dynamic) - The opacity at which the background will be drawn.
- **visibility** (dynamic) - Whether this layer is displayed.

### Methods

#### copyWith(BackgroundLayerProperties changes) → BackgroundLayerProperties
Creates a copy of this BackgroundLayerProperties with the given changes applied.

#### toJson({bool skipNulls = true}) → Map<String, dynamic>
Converts this BackgroundLayerProperties to a JSON map. If skipNulls is true (default), null values are omitted.

### Inherited Members

- **hashCode** (int) - The hash code for this object.
- **runtimeType** (Type) - A representation of the runtime type of the object.
- **noSuchMethod(Invocation invocation)** (dynamic) - Invoked when a nonexistent method or property is accessed.
- **toString()** (String) - A string representation of this object.
- **operator ==(Object other)** (bool) - The equality operator.
```

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

### getLayerProperties(String layerId) → Future<Map<String, dynamic>?>

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/MapLibreMethodChannel-class.html

Gets the properties of a layer.

```APIDOC
## getLayerProperties

### Description
Gets the properties of a layer.

### Method
`Future<Map<String, dynamic>?> getLayerProperties(String layerId)`

### Parameters
- **layerId** (String) - Required - The identifier of the layer.

### Returns
`Future<Map<String, dynamic>?>` - The layer properties as a map, or null if not found.
```

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

### MinMaxZoomPreference class

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/MinMaxZoomPreference-class.html

Documentation for the MinMaxZoomPreference class, including its constructor, properties, methods, operators, and constants.

```APIDOC
## MinMaxZoomPreference

### Description
Preferred bounds for map camera zoom level. Used with MapLibreMapOptions to wrap min and max zoom. This allows distinguishing between specifying unbounded zooming (null minZoom and maxZoom) from not specifying anything (null MinMaxZoomPreference).

### Constructors

#### MinMaxZoomPreference(double? minZoom, double? maxZoom)
- **minZoom** (double?) - The preferred minimum zoom level or null, if unbounded from below.
- **maxZoom** (double?) - The preferred maximum zoom level or null, if unbounded from above.

### Properties

- **hashCode** (int) - The hash code for this object. (override)
- **maxZoom** (double?) - The preferred maximum zoom level or null, if unbounded from above.
- **minZoom** (double?) - The preferred minimum zoom level or null, if unbounded from below.
- **runtimeType** (Type) - A representation of the runtime type of the object. (inherited)

### Methods

- **noSuchMethod(Invocation invocation)** (dynamic) - Invoked when a nonexistent method or property is accessed. (inherited)
- **toJson()** (dynamic) - Converts the object to a JSON representation.
- **toString()** (String) - A string representation of this object. (override)

### Operators

- **operator ==(Object other)** (bool) - The equality operator. (override)

### Constants

- **unbounded** (const MinMaxZoomPreference) - Unbounded zooming.
```

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

### forceResizeWebMap() → void

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/MapLibreMethodChannel-class.html

Forces a resize of the web map.

```APIDOC
## forceResizeWebMap

### Description
Forces a resize of the web map.

### Method
`void forceResizeWebMap()`

### Parameters
None.

### Returns
`void`
```

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

### getOfflineRegionStatus(int id)

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/getOfflineRegionStatus.html

Gets the current download status of an offline region. The function takes an integer ID and returns a Future<OfflineRegionStatus>.

```APIDOC
## getOfflineRegionStatus(int id)

### Description
Gets the current download status of an offline region.

### Method
Function

### Signature
Future<OfflineRegionStatus> getOfflineRegionStatus(int id)

### Parameters
- **id** (int) - Required - The ID of the offline region.

### Returns
Future<OfflineRegionStatus> - The current download status of the offline region.

### Implementation
```dart
Future<OfflineRegionStatus> getOfflineRegionStatus(int id) async {
  final String result = await _globalChannel.invokeMethod(
    'getOfflineRegionStatus',
    <String, dynamic>{'id': id},
  );
  return OfflineRegionStatus.fromMap(
    Map<String, dynamic>.from(json.decode(result)),
  );
}
```
```

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

### MapLibrePlatform()

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/MapLibrePlatform-class.html

Constructor for the MapLibrePlatform class.

```APIDOC
## MapLibrePlatform()

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

### Constructor
MapLibrePlatform()

```

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

### getFeatureState(String sourceId, String featureId, {String? sourceLayer}) → Future<Map<String, dynamic>?>

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/MapLibreMethodChannel-class.html

Gets the feature state for a given feature.

```APIDOC
## getFeatureState

### Description
Gets the feature state for a given feature.

### Method
`Future<Map<String, dynamic>?> getFeatureState(String sourceId, String featureId, {String? sourceLayer})`

### Parameters
- **sourceId** (String) - Required - The identifier of the source.
- **featureId** (String) - Required - The identifier of the feature.
- **sourceLayer** (String?) - Optional - The source layer to use.

### Returns
`Future<Map<String, dynamic>?>` - The feature state as a map, or null if not found.
```

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

### SkyProperties()

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/SkyProperties-class.html

Constructor for creating a SkyProperties object with optional parameters for sky style configuration.

```APIDOC
## SkyProperties

### Description
Constructs a SkyProperties object with optional parameters for configuring the sky style properties.

### Constructor
`SkyProperties({dynamic skyColor, dynamic horizonColor, dynamic fogColor, dynamic fogGroundBlend, dynamic horizonFogBlend, dynamic skyHorizonBlend, dynamic atmosphereBlend})`

### Parameters
- **skyColor** (dynamic) - Optional - The base color for the sky.
- **horizonColor** (dynamic) - Optional - The base color at the horizon.
- **fogColor** (dynamic) - Optional - The base color for the fog. Requires 3D terrain.
- **fogGroundBlend** (dynamic) - Optional - How to blend the fog over the 3D terrain, where 0 is the map center and 1 is the horizon.
- **horizonFogBlend** (dynamic) - Optional - How to blend the fog color and the horizon color, where 0 uses the horizon color only and 1 the fog color only.
- **skyHorizonBlend** (dynamic) - Optional - How to blend the sky color and the horizon color, where 1 blends the color at the middle of the sky and 0 does not blend at all and uses the sky color only.
- **atmosphereBlend** (dynamic) - Optional - How to blend the atmosphere, where 1 is a visible atmosphere and 0 a hidden one. Best interpolated by zoom when using the globe projection.

### Returns
A SkyProperties instance.

### Example
```dart
final skyProperties = SkyProperties(
  skyColor: '#0d0d0d',
  horizonColor: '#0d0d0d',
  fogColor: '#0d0d0d',
  fogGroundBlend: 0.5,
  horizonFogBlend: 0.5,
  skyHorizonBlend: 0.5,
  atmosphereBlend: 0.5,
);
```
```

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

### LocationEnginePlatforms.iOS

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/LocationEnginePlatforms-class.html

iOS-specific constructor for LocationEnginePlatforms.

```APIDOC
## LocationEnginePlatforms.iOS

### Description
iOS-specific constructor for LocationEnginePlatforms. Sets properties relevant to iOS location engine configuration.

### Constructor
```dart
LocationEnginePlatforms.iOS({
  bool enableHighAccuracy = false,
  int? displacement = 0,
  int? intervalMs = 0,
  int? pulseWindowMs = 5000
})
```

### Parameters
- **enableHighAccuracy** (bool) - Optional - Whether to use high accuracy (GPS) mode. Defaults to false.
- **displacement** (int?) - Optional - The minimum displacement in meters for location updates. Defaults to 0.
- **intervalMs** (int?) - Optional - Interval in milliseconds for pulsed location updates. Defaults to 0 (continuous).
- **pulseWindowMs** (int?) - Optional - Duration in milliseconds that GPS stays active during each pulse. Defaults to 5000.

### Usage Example
```dart
const engine = LocationEnginePlatforms.iOS(
  enableHighAccuracy: true,
  displacement: 5,
  intervalMs: 10000,
  pulseWindowMs: 3000,
);
```
```

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

### zoom

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/Expressions-class.html

A constant that gets the current zoom level. In style layout and paint properties, it may only appear as the input to a top-level 'step' or 'interpolate' expression.

```APIDOC
## zoom

### Description
Gets the current zoom level. Note that in style layout and paint properties, `["zoom"]` may only appear as the input to a top-level `"step"` or `"interpolate"` expression.

### Type
String constant

### Usage
Use `["zoom"]` in style expressions to access the current zoom level.

### Constraints
- In style layout and paint properties, `["zoom"]` may only appear as the input to a top-level `"step"` or `"interpolate"` expression.
```

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

### copyWith

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/CircleOptions-class.html

Creates a copy of the CircleOptions with the provided changes applied.

```APIDOC
## copyWith(CircleOptions changes) → CircleOptions

### Description
Returns a new CircleOptions instance with the specified changes applied. The changes parameter contains the new values for the properties to update.

### Parameters
- **changes** (CircleOptions) - Required - The CircleOptions containing the new values to apply.

### Returns
- **CircleOptions** - A new CircleOptions instance with the updated properties.
```

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

### FillOptions constructor

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/FillOptions-class.html

Constructor for creating a set of fill configuration options.

```APIDOC
## FillOptions({double? fillOpacity, String? fillColor, String? fillOutlineColor, String? fillPattern, List<List<LatLng>>? geometry, bool? draggable})

### Description
Creates a set of fill configuration options. When used to change configuration, null values will be interpreted as "do not change this configuration option".

### Constructor Parameters
- **fillOpacity** (double?) - Optional - The opacity of the fill.
- **fillColor** (String?) - Optional - The color of the fill.
- **fillOutlineColor** (String?) - Optional - The color of the fill outline.
- **fillPattern** (String?) - Optional - The pattern of the fill.
- **geometry** (List<List<LatLng>>?) - Optional - The geometry of the fill.
- **draggable** (bool?) - Optional - Whether the fill is draggable.

### Example
```dart
FillOptions(
  fillOpacity: 0.5,
  fillColor: '#ff0000',
  fillOutlineColor: '#000000',
  fillPattern: 'pattern',
  geometry: [[LatLng(0, 0), LatLng(1, 1)]],
  draggable: true,
);
```
```

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

### get

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/Expressions-class.html

Retrieves a property value from the current feature's properties, or from another object if a second argument is provided. Returns null if the requested property is missing.

```APIDOC
## get

### Description
Retrieves a property value from the current feature's properties, or from another object if a second argument is provided. Returns null if the requested property is missing.

### Usage
`["get", propertyName, object]`

### Parameters
- **propertyName** (string) - Required - The name of the property to retrieve.
- **object** (object) - Optional - The object from which to retrieve the property. If not provided, the current feature's properties are used.

### Returns
- The value of the property, or `null` if missing.
```

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

### heatmapDensity

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/Expressions-class.html

Gets the kernel density estimation of a pixel in a heatmap layer, which is a relative measure of how many data points are crowded around a particular pixel. Can only be used in the `heatmap-color` property.

```APIDOC
## heatmapDensity

### Description
Gets the kernel density estimation of a pixel in a heatmap layer, which is a relative measure of how many data points are crowded around a particular pixel. Can only be used in the `heatmap-color` property.

### Usage
`["heatmap-density"]`

### Returns
- A number representing the kernel density estimation.
```

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

### ColorReliefLayerProperties

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/ColorReliefLayerProperties-class.html

Documentation for the ColorReliefLayerProperties class, including constructors, properties, and methods.

```APIDOC
## ColorReliefLayerProperties

### Description
Represents the properties for a color-relief layer in MapLibre GL. It implements the LayerProperties interface and provides constructors, properties, and methods to manage the layer's configuration.

### Constructors

#### ColorReliefLayerProperties({dynamic colorReliefOpacity, dynamic colorReliefColor, dynamic resampling, dynamic visibility})
- **const**
- Creates a new instance of ColorReliefLayerProperties with optional parameters.

#### ColorReliefLayerProperties.fromJson(Map<String, dynamic> json)
- **factory**
- Creates a ColorReliefLayerProperties instance from a JSON map.

### Properties

- **colorReliefColor** (dynamic) - final - Defines the color of each pixel based on its elevation. Should be an expression that uses `["elevation"]` as input.
- **colorReliefOpacity** (dynamic) - final - The opacity at which the color-relief will be drawn.
- **resampling** (dynamic) - final - The resampling/interpolation method to use for overscaling, also known as texture magnification filter.
- **visibility** (dynamic) - final - Whether this layer is displayed.

### Methods

#### copyWith(ColorReliefLayerProperties changes) → ColorReliefLayerProperties
- Returns a copy of this object with the specified changes applied.

#### toJson({bool skipNulls = true}) → Map<String, dynamic>
- Converts this object to a JSON map. If skipNulls is true (default), null values are omitted.

### Operators

- **operator ==(Object other)** → bool - The equality operator.
```

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

### copyWith

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/FillOptions-class.html

Creates a copy of this FillOptions with the given changes.

```APIDOC
## copyWith(FillOptions changes) → FillOptions

### Description
Returns a copy of this FillOptions with the specified changes applied.

### Parameters
- **changes** (FillOptions) - Required - The changes to apply.

### Returns
- **FillOptions** - A new FillOptions instance with the changes applied.
```

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

### interpolate

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/Expressions-class.html

Produces continuous, smooth results by interpolating between pairs of input and output values ("stops"). The `input` may be any numeric expression (e.g., `["get", "population"]`). Stop inputs must be numeric literals in strictly ascending order. The output type must be `number`, `array<number>`, `color`, `array<color>`, or `projection`.

```APIDOC
## interpolate

### Description
Produces continuous, smooth results by interpolating between pairs of input and output values ("stops"). The `input` may be any numeric expression (e.g., `["get", "population"]`). Stop inputs must be numeric literals in strictly ascending order. The output type must be `number`, `array<number>`, `color`, `array<color>`, or `projection`.

### Usage
`["interpolate", interpolation, input, stopInput1, stopOutput1, stopInput2, stopOutput2, ...]`

### Parameters
- **interpolation** (string) - Required - The interpolation method, e.g., `"linear"`, `"exponential"`, `"cubic-bezier"`.
- **input** (number) - Required - The input value to interpolate.
- **stopInputN** (number) - Required - Numeric literal stop inputs in strictly ascending order.
- **stopOutputN** (number | array<number> | color | array<color> | projection) - Required - The output values corresponding to each stop.

### Returns
- The interpolated output value.
```

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

### createInstance ↔ MapLibrePlatform Function()

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/MapLibrePlatform-class.html

Static property that holds the default instance of MapLibrePlatform to use. It is a getter/setter pair.

```APIDOC
## createInstance ↔ MapLibrePlatform Function()

### Description
Static property that holds the default instance of MapLibrePlatform to use. It is a getter/setter pair.

### Type
Static Property

### Getter
Returns the current default instance of MapLibrePlatform.

### Setter
Sets the default instance of MapLibrePlatform to use.
```

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

### step

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/Expressions-class.html

Produces discrete, stepped results by evaluating a piecewise-constant function defined by pairs of input and output values ("stops"). The `input` may be any numeric expression (e.g., `["get", "population"]`). Stop inputs must be numeric literals in strictly ascending order. Returns the output value of the stop just less than the input, or the first output if the input is less than the first stop.

```APIDOC
## Constant: step

### Description
Produces discrete, stepped results by evaluating a piecewise-constant function defined by pairs of input and output values ("stops"). The `input` may be any numeric expression (e.g., `["get", "population"]`). Stop inputs must be numeric literals in strictly ascending order. Returns the output value of the stop just less than the input, or the first output if the input is less than the first stop.

### Type
String constant

### Value
`step`
```

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

### Line Class

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/Line-class.html

Documentation for the Line class, including its constructor, properties, and methods.

```APIDOC
## Line Class

### Description
Represents a line annotation in MapLibre GL, implementing the Annotation interface. It provides methods to convert the annotation to GeoJSON and translate it by a geographic delta.

### Constructor
`Line(String _id, LineOptions options, [Map<String, dynamic>? _data])`

### Properties
- `data` → `Map<String, dynamic>?` - no setter
- `id` → `String` - Unique stable identifier within its manager. (override)
- `options` ↔ `LineOptions` - The line configuration options most recently applied programmatically via the map controller. (getter/setter pair)

### Methods
- `toGeoJson()` → `Map<String, dynamic>` - Converts this annotation into a GeoJSON Feature (WGS84 lon/lat) map understood by the underlying MapLibre style source. (override)
- `translate(LatLng delta)` → `void` - Moves the annotation by the given geographic delta. (override)

### Inherited Members
- `hashCode` → `int` - The hash code for this object. (inherited)
- `runtimeType` → `Type` - A representation of the runtime type of the object. (inherited)
- `noSuchMethod(Invocation invocation)` → `dynamic` - Invoked when a nonexistent method or property is accessed. (inherited)
- `toString()` → `String` - A string representation of this object. (inherited)
- `operator ==(Object other)` → `bool` - The equality operator. (inherited)
```

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

### Symbol constructor

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/Symbol-class.html

Creates a Symbol instance with a unique identifier, symbol options, and optional data.

```APIDOC
## Symbol(String _id, SymbolOptions options, [Map<String, dynamic>? _data])

### Description
Creates a new Symbol annotation with the given identifier, options, and optional data.

### Parameters
- **_id** (String) - Required - The unique identifier for the symbol.
- **options** (SymbolOptions) - Required - The symbol configuration options.
- **_data** (Map<String, dynamic>?) - Optional - Additional data associated with the symbol.

### Returns
A new Symbol instance.
```

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

### UserLocation class

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/UserLocation-class.html

Documentation for the UserLocation class, including its constructor, properties, methods, and operators.

```APIDOC
## UserLocation

### Description
Represents the user's observed location, including position, altitude, bearing, speed, accuracy, and heading.

### Constructor
`UserLocation({required LatLng position, required double? altitude, required double? bearing, required double? speed, required double? horizontalAccuracy, required double? verticalAccuracy, required DateTime timestamp, required UserHeading? heading})`

### Properties
- `position` (LatLng) - User's position in latitude and longitude.
- `altitude` (double?) - User's altitude in meters.
- `bearing` (double?) - Direction user is traveling, measured in degrees.
- `speed` (double?) - User's speed in meters per second.
- `horizontalAccuracy` (double?) - The radius of uncertainty for the location, measured in meters.
- `verticalAccuracy` (double?) - Accuracy of the altitude measurement, in meters.
- `timestamp` (DateTime) - Time the user's location was observed.
- `heading` (UserHeading?) - The heading of the user location, null if not available.

### Methods
- `toString()` → String - A string representation of this object.

### Operators
- `operator ==(Object other)` → bool - The equality operator.
```

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

### FillLayerProperties

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/FillLayerProperties-class.html

Documentation for the FillLayerProperties class, including constructors, properties, and methods.

```APIDOC
## FillLayerProperties

### Description
Represents the properties of a fill layer in MapLibre GL. It implements `LayerProperties` and provides constructors, properties, and methods to manage fill layer styling.

### Constructors

#### FillLayerProperties({dynamic fillAntialias, dynamic fillOpacity, dynamic fillLayerOpacity, dynamic fillColor, dynamic fillOutlineColor, dynamic fillTranslate, dynamic fillTranslateAnchor, dynamic fillPattern, dynamic fillSortKey, dynamic visibility})
- **const** constructor that initializes all fill layer properties.

#### FillLayerProperties.fromJson(Map<String, dynamic> json)
- **factory** constructor that creates a `FillLayerProperties` instance from a JSON map.

### Properties

- **fillAntialias** (dynamic) - Whether or not the fill should be antialiased.
- **fillColor** (dynamic) - The color of the filled part of this layer. Can be specified as `rgba` with an alpha component. When used with an SDF fill pattern, serves as the foreground color.
- **fillLayerOpacity** (dynamic) - Opacity applied to the layer as a whole. Unlike `fill-opacity` and alpha values in `fill-color`, applied once so overlapping fills appear as a single surface.
- **fillOpacity** (dynamic) - The opacity of the entire fill layer. Affects the 1px stroke around the fill if used.
- **fillOutlineColor** (dynamic) - The outline color of the fill. Matches `fill-color` if unspecified.
- **fillPattern** (dynamic) - Name of image in sprite to use for drawing image fills. For seamless patterns, image width and height must be a factor of two.
- **fillSortKey** (dynamic) - Sorts features in ascending order based on this value. Features with a higher sort key appear above features with a lower sort key.
- **fillTranslate** (dynamic) - The geometry's offset. Values are `[x, y]` where negatives indicate left and up.
- **fillTranslateAnchor** (dynamic) - Controls the frame of reference for `fill-translate`.
- **visibility** (dynamic) - Whether this layer is displayed.

### Methods

#### copyWith(FillLayerProperties changes) → FillLayerProperties
- Returns a copy of this `FillLayerProperties` with the specified changes applied.

#### toJson({bool skipNulls = true}) → Map<String, dynamic>
- Converts this `FillLayerProperties` instance to a JSON map. If `skipNulls` is true (default), null values are omitted.

### Inherited Members
- `hashCode`, `runtimeType`, `noSuchMethod`, `toString`, `operator ==` are inherited from `Object`.
```

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

### HeatmapLayerProperties class

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/HeatmapLayerProperties-class.html

Documentation for the HeatmapLayerProperties class, including constructors, properties, and methods.

```APIDOC
## HeatmapLayerProperties

### Description
Represents the properties for a heatmap layer in MapLibre GL. It implements `LayerProperties` and provides configuration for heatmap rendering.

### Constructors

#### HeatmapLayerProperties({dynamic heatmapRadius, dynamic heatmapWeight, dynamic heatmapIntensity, dynamic heatmapColor, dynamic heatmapOpacity, dynamic visibility})
- **const**
- Creates a new `HeatmapLayerProperties` instance with optional parameters.

#### HeatmapLayerProperties.fromJson(Map<String, dynamic> json)
- **factory**
- Creates a `HeatmapLayerProperties` instance from a JSON map.

### Properties

- **heatmapColor** (dynamic) - final - Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses `["heatmap-density"]` as input.
- **heatmapIntensity** (dynamic) - final - Similar to `heatmap-weight` but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.
- **heatmapOpacity** (dynamic) - final - The global opacity at which the heatmap layer will be drawn.
- **heatmapRadius** (dynamic) - final - Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed.
- **heatmapWeight** (dynamic) - final - A measure of how much an individual point contributes to the heatmap. A value of 10 would be equivalent to having 10 points of weight 1 in the same spot. Especially useful when combined with clustering.
- **visibility** (dynamic) - final - Whether this layer is displayed.

### Methods

#### copyWith(HeatmapLayerProperties changes) → HeatmapLayerProperties
- Returns a copy of this `HeatmapLayerProperties` with the given changes applied.

#### toJson({bool skipNulls = true}) → Map<String, dynamic>
- Converts this object to a JSON map. If `skipNulls` is true (default), null values are omitted.

### Inherited Members
- **hashCode** (int) - The hash code for this object.
- **runtimeType** (Type) - A representation of the runtime type of the object.
- **noSuchMethod(Invocation invocation)** (dynamic) - Invoked when a nonexistent method or property is accessed.
- **toString()** (String) - A string representation of this object.
- **operator ==(Object other)** (bool) - The equality operator.
```

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

### resizeWebMap()

Source: https://pub.dev/documentation/maplibre_gl/latest/maplibre_gl/MapLibreMapController-class.html

Triggers a resize event on web platforms.

```APIDOC
## resizeWebMap()

### Description
Triggers a resize event for the map on web (ignored on Android or iOS).

### Method
void
```
Tokens:
Raw