MapLibre for Flutter

https://pub.dev/documentation/maplibre/latest/
Admin
MapLibre for Flutter provides cross-platform Flutter bindings for MapLibre SDKs, enabling...
Tokens:235,476
Snippets:2,969
Trust Score:9.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### Interval.openEnd(DateTime start)

Source: https://pub.dev/documentation/maplibre/latest/maplibre/Interval-class.html

Creates an open ended interval starting from the start instant (inclusive).

```APIDOC
## Interval.openEnd(DateTime start)

### Description
An open ended interval starting from the `start` instant (inclusive).

### Factory Constructor
`factory Interval.openEnd(DateTime start)`

### Parameters
- **start** (DateTime) - Required - The start instant (inclusive).

### Usage
```dart
final interval = Interval.openEnd(start);
```
```

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

### Interval.openStart(DateTime end)

Source: https://pub.dev/documentation/maplibre/latest/maplibre/Interval-class.html

Creates an open started interval ending to the end instant (exclusive).

```APIDOC
## Interval.openStart(DateTime end)

### Description
Creates an open started interval ending to the `end` instant (exclusive).

### Factory Constructor
`factory Interval.openStart(DateTime end)`

### Parameters
- **end** (DateTime) - Required - The end instant (exclusive).

### Usage
```dart
final interval = Interval.openStart(end);
```
```

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

### Interval(Instant? start, Instant? end)

Source: https://pub.dev/documentation/maplibre/latest/maplibre/Interval-class.html

Constructs an interval between optional start (inclusive) and end (exclusive) instants.

```APIDOC
## Interval(Instant? start, Instant? end)

### Description
An interval between optional `start` (inclusive) and `end` (exclusive).

### Constructor
`const Interval(Instant? start, Instant? end)`

### Parameters
- **start** (Instant?) - Optional - The start instant (inclusive).
- **end** (Instant?) - Optional - The end instant (exclusive).

### Usage
```dart
final interval = Interval(start, end);
```
```

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

### Interval.open()

Source: https://pub.dev/documentation/maplibre/latest/maplibre/Interval-class.html

Creates a fully open interval with start and end set to null.

```APIDOC
## Interval.open()

### Description
A fully open interval with `start` and `end` set to null.

### Constructor
`const Interval.open()`

### Usage
```dart
final interval = Interval.open();
```
```

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

### buildBox

Source: https://pub.dev/documentation/maplibre/latest/maplibre/Box-class.html

Builds a bounding box of type R from a list of coordinates starting at an offset.

```APIDOC
## buildBox<R extends Box>(Iterable<num> coords, {required CreateBox<R> to, int offset = 0, Coords? type, bool swapXY = false}) → R

### Description
Builds a bounding box of `R` from `coords` starting from `offset`.

### Parameters
- **coords** (Iterable<num>) - Required - The coordinate values.
- **to** (CreateBox<R>) - Required - A factory function to create the box.
- **offset** (int) - Optional - The starting index in `coords` (default 0).
- **type** (Coords?) - Optional - The coordinate type.
- **swapXY** (bool) - Optional - Whether to swap X and Y coordinates (default false).

### Returns
R - A new bounding box of type R.
```

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

### Implement equality and hashCode for Box subclasses

Source: https://pub.dev/documentation/maplibre/latest/maplibre/Box-class.html

Example implementation of equality and hashCode methods that subclasses of Box should override, using Box.testEquals and Box.hash.

```dart
content_copy@override
bool operator ==(Object other) =>
     other is Box && Box.testEquals(this, other);

@override
int get hashCode => Box.hash(this);

```

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

### PositionScheme.box property

Source: https://pub.dev/documentation/maplibre/latest/maplibre/PositionScheme-class.html

Gets the factory to create bounding boxes.

```APIDOC
## box → CreateBox<Box>

### Description
The factory to create bounding boxes.

### Returns
- **CreateBox<Box>** - The factory to create bounding boxes.

### Example
```dart
final boxFactory = scheme.box;
```
```

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

### DownloadProgress constructor

Source: https://pub.dev/documentation/maplibre/latest/maplibre/DownloadProgress-class.html

Creates a new DownloadProgress instance with required parameters for tracking download progress.

```APIDOC
## DownloadProgress({required int loadedBytes, required int loadedTiles, required bool totalTilesEstimated, required int totalTiles, required OfflineRegion region, required bool downloadCompleted})

### Description
Creates a new DownloadProgress instance. This constructor is used to instantiate a DownloadProgress object with the given parameters.

### Parameters
- **loadedBytes** (int) - Required - The amount of bytes that are already downloaded.
- **loadedTiles** (int) - Required - The amount of tiles that are already downloaded.
- **totalTilesEstimated** (bool) - Required - Whether the totalTiles value is an estimated or precise value.
- **totalTiles** (int) - Required - The total amount of tiles in this region.
- **region** (OfflineRegion) - Required - The OfflineRegion object.
- **downloadCompleted** (bool) - Required - Set to true once the download has completed successfully.

### Example
```dart
const DownloadProgress(
  loadedBytes: 1024,
  loadedTiles: 10,
  totalTilesEstimated: false,
  totalTiles: 100,
  region: offlineRegion,
  downloadCompleted: false,
);
```
```

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

### GeoJSON MultiPoint, LineString, MultiLineString examples

Source: https://pub.dev/documentation/maplibre/latest/maplibre/GeoJSON-class.html

Examples of GeoJSON MultiPoint, LineString, and MultiLineString objects with 2D points. The MultiLineString example is shown in a code block with a content_copy label.

```json
{"type":"MultiPoint","coordinates":[[10.1,10.1],[20.2,20.2],[30.3,30.3]]}
```

```json
{"type":"LineString","coordinates":[[10.1,10.1],[20.2,20.2],[30.3,30.3]]}
```

```json
content_copy  {"type":"MultiLineString",
   "coordinates":[[[10.1,10.1],[20.2,20.2],[30.3,30.3]]]}

```

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

### WktLikeFormat()

Source: https://pub.dev/documentation/maplibre/latest/maplibre/WktLikeFormat-class.html

Constructs a WktLikeFormat instance.

```APIDOC
## WktLikeFormat()

### Description
Constructs a new WktLikeFormat object.

### Constructor
WktLikeFormat()

```

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

### Interval.closed(DateTime start, DateTime end)

Source: https://pub.dev/documentation/maplibre/latest/maplibre/Interval-class.html

Creates a closed interval between start (inclusive) and end (exclusive).

```APIDOC
## Interval.closed(DateTime start, DateTime end)

### Description
A closed interval between `start` (inclusive) and `end` (exclusive).

### Factory Constructor
`factory Interval.closed(DateTime start, DateTime end)`

### Parameters
- **start** (DateTime) - Required - The start instant (inclusive).
- **end** (DateTime) - Required - The end instant (exclusive).

### Usage
```dart
final interval = Interval.closed(start, end);
```
```

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

### packDatabase()

Source: https://pub.dev/documentation/maplibre/latest/maplibre/OfflineManager-class.html

Packs the existing database file into a minimal amount of disk space.

```APIDOC
## packDatabase()

### Description
Packs the existing database file into a minimal amount of disk space.

### Method
packDatabase

### Return Type
Future<void>
```

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

### createInstance()

Source: https://pub.dev/documentation/maplibre/latest/maplibre/OfflineManager-class.html

Create a new OfflineManager.

```APIDOC
## createInstance()

### Description
Create a new OfflineManager.

### Method
createInstance

### Return Type
Future<OfflineManager>
```

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

### copyWith({Instant? start, Instant? end})

Source: https://pub.dev/documentation/maplibre/latest/maplibre/Interval-class.html

Copies this interval with optional start and/or end instants changed.

```APIDOC
## copyWith({Instant? start, Instant? end})

### Description
Copy this inteval with optional `start` and/or `end` instants changed.

### Method
`Interval copyWith({Instant? start, Instant? end})`

### Parameters
- **start** (Instant?) - Optional - The new start instant.
- **end** (Instant?) - Optional - The new end instant.

### Returns
- **Interval** - A new Interval with the specified changes.

### Usage
```dart
final newInterval = interval.copyWith(start: newStart, end: newEnd);
```
```

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

### build<T extends Geometry>(WriteGeometries geometries, {required AddGeometry<T> to}) → void

Source: https://pub.dev/documentation/maplibre/latest/maplibre/GeometryBuilder-class.html

Builds geometries from the content provided by the geometries callback.

```APIDOC
## build<T extends Geometry>(WriteGeometries geometries, {required AddGeometry<T> to}) → void

### Description
Builds geometries from the content provided by the geometries callback.

### Method
build

### Parameters
- **geometries** (WriteGeometries) - Required - The callback that provides the geometries.
- **to** (AddGeometry<T>) - Required - The callback to add each built geometry.

### Returns
void
```

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

### GeoJSON Polygon example

Source: https://pub.dev/documentation/maplibre/latest/maplibre/GeoJSON-class.html

Example of a GeoJSON Polygon object with 2D points, shown in a code block with a content_copy label.

```json
content_copy  {"type":"Polygon",
   "coordinates":[[[35,10],[45,45],[15,40],[10,20],[35,10]]]}

```

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

### GeoJSON Feature example

Source: https://pub.dev/documentation/maplibre/latest/maplibre/GeoJSON-class.html

Example of a GeoJSON Feature object with an id, properties, and a Point geometry, shown in a code block with a content_copy label.

```json
content_copy  {"type": "Feature",
   "id":1,
   "properties": {"prop1": 100},
   "geometry": {"type":"Point","coordinates":[10.1,20.2]}}

```

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

### VideoSource constructor

Source: https://pub.dev/documentation/maplibre/latest/maplibre/VideoSource-class.html

Creates a VideoSource object with the required id, urls, and coordinates.

```APIDOC
## VideoSource({required String id, required List<String> urls, required List<Geographic> coordinates})

### Description
The default constructor for a VideoSource object. It initializes a video source with the given id, URLs, and coordinates.

### Parameters
- **id** (String) - Required - The id of the source.
- **urls** (List<String>) - Required - URLs to video content in order of preferred format.
- **coordinates** (List<Geographic>) - Required - Corners of video specified in longitude, latitude pairs.

### Example
```dart
VideoSource(
  id: 'my-video-source',
  urls: ['https://example.com/video.mp4', 'https://example.com/video.webm'],
  coordinates: [
    Geographic(lon: -122.4194, lat: 37.7749),
    Geographic(lon: -122.4194, lat: 37.8044),
    Geographic(lon: -122.3894, lat: 37.8044),
    Geographic(lon: -122.3894, lat: 37.7749),
  ],
)
```
```

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

### distanceToLineSegment2D(Position start, Position end) → double

Source: https://pub.dev/documentation/maplibre/latest/maplibre/Geographic-class.html

Returns a distance from this to a line segment formed by `start` and `end` positions calculated in a cartesian 2D plane.

```APIDOC
## distanceToLineSegment2D(Position start, Position end) → double

### Description
Returns a distance from this to a line segment formed by `start` and `end` positions calculated in a cartesian 2D plane.

### Method
distanceToLineSegment2D

### Parameters
- **start** (Position) - Required - The start of the line segment.
- **end** (Position) - Required - The end of the line segment.

### Returns
double - The distance.
```

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

### WKT()

Source: https://pub.dev/documentation/maplibre/latest/maplibre/WKT-class.html

Constructs a new WKT instance. This is the default constructor for the WKT class.

```APIDOC
## WKT()

### Description
Constructs a new WKT instance.

### Constructor
WKT()

### Parameters
None.

### Returns
A new WKT object.
```

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

### ProjBox.create({required double minX, required double minY, double? minZ, double? minM, required double maxX, required double maxY, double? maxZ, double? maxM})

Source: https://pub.dev/documentation/maplibre/latest/maplibre/ProjBox-class.html

Creates a bounding box from parameters compatible with the CreateBox function type. This constructor is const.

```APIDOC
## ProjBox.create({required double minX, required double minY, double? minZ, double? minM, required double maxX, required double maxY, double? maxZ, double? maxM})

### Description
Creates a bounding box from parameters compatible with the CreateBox function type. This constructor is const.

### Parameters
- **minX** (double) - Required - Minimum X coordinate.
- **minY** (double) - Required - Minimum Y coordinate.
- **minZ** (double?) - Optional - Minimum Z coordinate for 3D boxes.
- **minM** (double?) - Optional - Minimum M coordinate for measured boxes.
- **maxX** (double) - Required - Maximum X coordinate.
- **maxY** (double) - Required - Maximum Y coordinate.
- **maxZ** (double?) - Optional - Maximum Z coordinate for 3D boxes.
- **maxM** (double?) - Optional - Maximum M coordinate for measured boxes.

### Example
```dart
ProjBox.create(minX: 0.0, minY: 0.0, maxX: 10.0, maxY: 10.0)
```
```

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

### Position.subview(List<double> source, {required int start, Coords type = Coords.xy})

Source: https://pub.dev/documentation/maplibre/latest/maplibre/Position-class.html

Factory constructor that creates a Position as a subview of a source list starting at a given index.

```APIDOC
## Position.subview(List<double> source, {required int start, Coords type = Coords.xy})

### Description
A position with coordinate values as a sub view backed by `source`, starting at `start`.

### Constructor
`factory Position.subview(List<double> source, {required int start, Coords type = Coords.xy})`

### Parameters
- **source** (List<double>) - Required - The source list of coordinate values.
- **start** (int) - Required - The starting index in the source list.
- **type** (Coords) - Optional - The coordinate type. Defaults to `Coords.xy`.

```

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

### GeoJSON MultiPolygon example

Source: https://pub.dev/documentation/maplibre/latest/maplibre/GeoJSON-class.html

Example of a GeoJSON MultiPolygon object with 2D points, shown in a code block with a content_copy label. Note the type is incorrectly labeled as Polygon in the source.

```json
content_copy  {"type":"Polygon",
   "coordinates":[[[[35,10],[45,45],[15,40],[10,20],[35,10]]]]}

```

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

### resetDatabase()

Source: https://pub.dev/documentation/maplibre/latest/maplibre/OfflineManager-class.html

Delete existing database and re-initialize.

```APIDOC
## resetDatabase()

### Description
Delete existing database and re-initialize.

### Method
resetDatabase

### Return Type
Future<void>
```

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

### position property

Source: https://pub.dev/documentation/maplibre/latest/maplibre/DistancedPosition-class.html

Gets the reference position.

```APIDOC
## T get position

### Description
The reference position.

### Returns
- **T** - The position object.
```

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

### ProjBox({required double minX, required double minY, double? minZ, double? minM, required double maxX, required double maxY, double? maxZ, double? maxM})

Source: https://pub.dev/documentation/maplibre/latest/maplibre/ProjBox-class.html

Creates a bounding box with the given minimum and maximum coordinates. This constructor is const and immutable.

```APIDOC
## ProjBox({required double minX, required double minY, double? minZ, double? minM, required double maxX, required double maxY, double? maxZ, double? maxM})

### Description
Creates a bounding box with the given minimum and maximum coordinates. This constructor is const and immutable.

### Parameters
- **minX** (double) - Required - Minimum X coordinate.
- **minY** (double) - Required - Minimum Y coordinate.
- **minZ** (double?) - Optional - Minimum Z coordinate for 3D boxes.
- **minM** (double?) - Optional - Minimum M coordinate for measured boxes.
- **maxX** (double) - Required - Maximum X coordinate.
- **maxY** (double) - Required - Maximum Y coordinate.
- **maxZ** (double?) - Optional - Maximum Z coordinate for 3D boxes.
- **maxM** (double?) - Optional - Maximum M coordinate for measured boxes.

### Example
```dart
ProjBox(minX: 0.0, minY: 0.0, maxX: 10.0, maxY: 10.0)
```
```

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

### PositionScheme.position property

Source: https://pub.dev/documentation/maplibre/latest/maplibre/PositionScheme-class.html

Gets the factory to create positions.

```APIDOC
## position → CreatePosition<Position>

### Description
The factory to create positions.

### Returns
- **CreatePosition<Position>** - The factory to create positions.

### Example
```dart
final positionFactory = scheme.position;
```
```

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

### getCamera

Source: https://pub.dev/documentation/maplibre/latest/maplibre/MapController-class.html

Gets the current camera position on the map.

```APIDOC
## getCamera

### Description
Get the current camera position on the map.

### Method
getCamera

### Parameters
None

### Returns
MapCamera
```

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

### MapEventStartMoveCamera constructor

Source: https://pub.dev/documentation/maplibre/latest/maplibre/MapEventStartMoveCamera-class.html

Creates a new MapEventStartMoveCamera object with the specified reason for the camera change.

```APIDOC
## MapEventStartMoveCamera({required CameraChangeReason reason})

### Description
Creates a new MapEventStartMoveCamera object.

### Constructor
MapEventStartMoveCamera({required CameraChangeReason reason})

### Parameters
- **reason** (CameraChangeReason) - Required - The reason the camera is changed.

### Properties
- **reason** (CameraChangeReason) - final - The reason the camera is changed.

### Inherited Properties
- **hashCode** (int) - no setter, inherited - The hash code for this object.
- **runtimeType** (Type) - no setter, inherited - A representation of the runtime type of the object.

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

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

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

### GeoJSON point and bbox examples

Source: https://pub.dev/documentation/maplibre/latest/maplibre/GeoJSON-class.html

Examples of GeoJSON point and bounding box objects as they appear in the documentation. The first two show point coordinates with 2D and 3D values, and the last two show bbox properties with 4 and 6 values.

```json
{"type":"Point","coordinates":[10.1,20.2]}
```

```json
{"type":"Point","coordinates":[10.1,20.2,30.3]}
```

```json
"bbox": [10.1,10.1,20.2,20.2]
```

```json
"bbox": [10.1,10.1,10.1,20.2,20.2,20.2]
```

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

### CircleStyleLayer({required String id, required String sourceId, Map<String, Object> layout = const {}, Map<String, Object> paint = const {}, double minZoom = 0, double maxZoom = 24, List<Object>? filter, String? sourceLayerId})

Source: https://pub.dev/documentation/maplibre/latest/maplibre/CircleStyleLayer-class.html

Default constructor for a CircleStyleLayer instance. Creates a circle layer with the specified id and source, and optional layout, paint, zoom range, filter, and source layer.

```APIDOC
## CircleStyleLayer({required String id, required String sourceId, Map<String, Object> layout = const {}, Map<String, Object> paint = const {}, double minZoom = 0, double maxZoom = 24, List<Object>? filter, String? sourceLayerId})

### Description
Default constructor for a CircleStyleLayer instance. Creates a circle layer with the specified id and source, and optional layout, paint, zoom range, filter, and source layer.

### Parameters
- **id** (String) - Required - Unique layer name.
- **sourceId** (String) - Required - Name of a source description to be used for this layer.
- **layout** (Map<String, Object>) - Optional - Layout properties for the layer. Defaults to const {}.
- **paint** (Map<String, Object>) - Optional - Default paint properties for this layer. Defaults to const {}.
- **minZoom** (double) - Optional - The minimum zoom level for the layer. Defaults to 0.
- **maxZoom** (double) - Optional - The maximum zoom level for the layer. Defaults to 24.
- **filter** (List<Object>?) - Optional - A expression specifying conditions on source features. Only features that match the filter are displayed.
- **sourceLayerId** (String?) - Optional - Layer to use from a vector tile source. Required for vector tile sources; prohibited for other source types.

### Properties
- **filter** (List<Object>?) - A expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The feature-state expression is not supported in filter expressions.
- **id** (String) - Unique layer name.
- **layout** (Map<String, Object>) - Layout properties for the layer.
- **maxZoom** (double) - The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.
- **minZoom** (double) - The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.
- **paint** (Map<String, Object>) - Default paint properties for this layer.
- **sourceId** (String) - Name of a source description to be used for this layer. Required for all layer types except background.
- **sourceLayerId** (String?) - Layer to use from a vector tile source. Required for vector tile sources; prohibited for all other source types, including GeoJSON sources.

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

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

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

### WebMercatorQuad.epsg3857({int maxZoom = 22, int tileSize = 256, CanvasOrigin origin = CanvasOrigin.topLeft})

Source: https://pub.dev/documentation/maplibre/latest/maplibre/WebMercatorQuad-class.html

Creates a Web Mercator Quad tile matrix set with the given tile size and origin. The constructor is const and allows specifying the maximum zoom level, tile size, and canvas origin.

```APIDOC
## WebMercatorQuad.epsg3857({int maxZoom = 22, int tileSize = 256, CanvasOrigin origin = CanvasOrigin.topLeft})

### Description
Creates a Web Mercator Quad tile matrix set with the specified tile size and origin. The constructor is const and allows specifying the maximum zoom level, tile size, and canvas origin.

### Method
Constructor

### Signature
WebMercatorQuad.epsg3857({int maxZoom = 22, int tileSize = 256, CanvasOrigin origin = CanvasOrigin.topLeft})

### Parameters
- **maxZoom** (int) - Optional - The maximum (suggested) zoom level for this tile matrix set. Defaults to 22.
- **tileSize** (int) - Optional - The number of pixels for one tile in one axis (normally 256 or 512). Defaults to 256.
- **origin** (CanvasOrigin) - Optional - The position of the origin in a tile matrix and map pixel "canvas". Defaults to CanvasOrigin.topLeft.

### Return Value
A new WebMercatorQuad instance.
```

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

### distance property

Source: https://pub.dev/documentation/maplibre/latest/maplibre/DistancedPosition-class.html

Gets the distance between the reference position and something.

```APIDOC
## double get distance

### Description
The distance between the reference position and something.

### Returns
- **double** - The distance value.
```

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

### createBoxFrom

Source: https://pub.dev/documentation/maplibre/latest/maplibre/Box-class.html

Creates a minimum bounding box from a list of positions.

```APIDOC
## createBoxFrom<R extends Box>(Iterable<Position> positions, CreateBox<R> factory) → R

### Description
A minimum bounding box created by `factory`, calculated from `positions`.

### Parameters
- **positions** (Iterable<Position>) - Required - The positions to enclose.
- **factory** (CreateBox<R>) - Required - A factory function to create the box.

### Returns
R - A minimum bounding box.
```

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

### range

Source: https://pub.dev/documentation/maplibre/latest/maplibre/PositionSeries-class.html

Returns a subseries with positions from start (inclusive) to end (exclusive).

```APIDOC
## range

### Description
Returns a subseries with positions from `start` (inclusive) to `end` (exclusive).

### Method
range

### Signature
PositionSeries range(int start, [int? end])

### Parameters
- **start** (int) - Required - The start index (inclusive).
- **end** (int?) - Optional - The end index (exclusive). If omitted, goes to the end.

### Returns
PositionSeries - A subseries.
```

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

### Dms.narrowSpace({DmsType type = DmsType.deg, int? decimals, bool signedDegrees = false, bool zeroPadDegrees = false, bool zeroPadMinSec = true, String degree = '°', String prime = '′', String doublePrime = '″'})

Source: https://pub.dev/documentation/maplibre/latest/maplibre/Dms-class.html

Creates a new formatter for parsing and formatting degrees/minutes/seconds on latitude, longitude and bearing.

```APIDOC
## Constructor: Dms.narrowSpace

### Description
Creates a new formatter for parsing and formatting degrees/minutes/seconds on latitude, longitude and bearing.

### Parameters
- **type** (DmsType) - Optional - The type of DMS formatting (default: DmsType.deg).
- **decimals** (int?) - Optional - Number of decimal places for seconds.
- **signedDegrees** (bool) - Optional - Whether to include sign for degrees (default: false).
- **zeroPadDegrees** (bool) - Optional - Whether to zero-pad degrees (default: false).
- **zeroPadMinSec** (bool) - Optional - Whether to zero-pad minutes and seconds (default: true).
- **degree** (String) - Optional - Degree symbol (default: '°').
- **prime** (String) - Optional - Prime symbol (default: '′').
- **doublePrime** (String) - Optional - Double prime symbol (default: '″').

### Example
```dart
Dms formatter = Dms.narrowSpace();
```
```

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

### MapEventCallback

Source: https://pub.dev/documentation/maplibre/latest/maplibre

Callback that fires every time a MapEvent gets emitted by the map.

```APIDOC
## MapEventCallback

### Description
Callback that fires every time a MapEvent gets emitted by the map.

### Signature
`void Function(MapEvent event)`

### Parameters
- **event** (MapEvent) - Required - The emitted map event.

```

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

### BackgroundStyleLayer constructor

Source: https://pub.dev/documentation/maplibre/latest/maplibre/BackgroundStyleLayer-class.html

Creates a new BackgroundStyleLayer with specified id, visibility, color, opacity, layout, paint, and zoom range.

```APIDOC
## BackgroundStyleLayer({required String id, bool visible = true, Color color = const Color(0x00000000), double opacity = 1, Map<String, Object> layout = const {}, Map<String, Object> paint = const {}, double minZoom = 0, double maxZoom = 24})

### Description
Creates a new BackgroundStyleLayer with the given parameters.

### Parameters
- **id** (String) - Required - Unique layer name.
- **visible** (bool) - Optional - Whether this layer is displayed. Defaults to true.
- **color** (Color) - Optional - The color with which the background will be drawn. Defaults to const Color(0x00000000).
- **opacity** (double) - Optional - The opacity at which the background will be drawn. Defaults to 1.
- **layout** (Map<String, Object>) - Optional - Layout properties for the layer. Defaults to const {}.
- **paint** (Map<String, Object>) - Optional - Default paint properties for this layer. Defaults to const {}.
- **minZoom** (double) - Optional - The minimum zoom level for the layer. Defaults to 0.
- **maxZoom** (double) - Optional - The maximum zoom level for the layer. Defaults to 24.

### Returns
A new BackgroundStyleLayer instance.
```

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

### getSourceId(int index) → String

Source: https://pub.dev/documentation/maplibre/latest/maplibre/Layer-class.html

Gets a unique source id.

```APIDOC
## getSourceId(int index) → String

### Description
Gets a unique source id.

### Parameters
- **index** (int) - Required - The index of the source.

### Returns
- **String** - The unique source id.
```

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

### runPackDatabaseAutomatically({required bool enabled})

Source: https://pub.dev/documentation/maplibre/latest/maplibre/OfflineManager-class.html

Sets whether database file packing occurs automatically. By default, the automatic database file packing is enabled.

```APIDOC
## runPackDatabaseAutomatically({required bool enabled})

### Description
Sets whether database file packing occurs automatically. By default, the automatic database file packing is enabled.

### Method
runPackDatabaseAutomatically

### Parameters
- **enabled** (bool) - Required - Whether automatic packing should be enabled.

### Return Type
void
```

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

### getLayerId(int index) → String

Source: https://pub.dev/documentation/maplibre/latest/maplibre/Layer-class.html

Gets a unique layer id.

```APIDOC
## getLayerId(int index) → String

### Description
Gets a unique layer id.

### Parameters
- **index** (int) - Required - The index of the layer.

### Returns
- **String** - The unique layer id.
```

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

### TextWriterFormat()

Source: https://pub.dev/documentation/maplibre/latest/maplibre/TextWriterFormat-class.html

Constructs a TextWriterFormat instance.

```APIDOC
## TextWriterFormat()

### Description
Constructs a TextWriterFormat instance.

### Constructor
TextWriterFormat()

```

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

### static fromBox(Box source) → ProjBox

Source: https://pub.dev/documentation/maplibre/latest/maplibre/ProjBox-class.html

Creates a projected bounding box by copying coordinates from the given Box source.

```APIDOC
## static fromBox(Box source) → ProjBox

### Description
Creates a projected bounding box by copying coordinates from `source`.

### Method
static fromBox

### Parameters
- **source** (Box) - Required - The source Box to copy coordinates from.

### Returns
- **ProjBox** - A new ProjBox with coordinates copied from `source`.
```

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

### rangeRemoved

Source: https://pub.dev/documentation/maplibre/latest/maplibre/PositionSeries-class.html

Returns a position series with positions from start (inclusive) to end (exclusive) removed.

```APIDOC
## rangeRemoved

### Description
Returns a position series with positions from `start` (inclusive) to `end` (exclusive) removed.

### Method
rangeRemoved

### Signature
PositionSeries rangeRemoved(int start, [int? end])

### Parameters
- **start** (int) - Required - The start index (inclusive).
- **end** (int?) - Optional - The end index (exclusive). If omitted, removes to the end.

### Returns
PositionSeries - A new series with the range removed.
```

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

### GeoBox.build

Source: https://pub.dev/documentation/maplibre/latest/maplibre/GeoBox-class.html

Builds a geographic bounding box from a list of coordinates starting at a given offset.

```APIDOC
## GeoBox.build(Iterable<num> coords, {int offset = 0, Coords? type})

### Description
Builds a geographic bounding box from `coords` starting from `offset`. The `type` parameter specifies the coordinate type (e.g., xy, xyz, xym, xyzm).

### Parameters
- **coords** (Iterable<num>) - Required - List of coordinate values.
- **offset** (int) - Optional - Starting index in `coords` (default 0).
- **type** (Coords?) - Optional - Coordinate type determining the number and order of values.

### Example
```dart
GeoBox.build([-180, -90, 180, 90])
```
```

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

### StyleLayerWithSource constructor

Source: https://pub.dev/documentation/maplibre/latest/maplibre/StyleLayerWithSource-class.html

Creates a StyleLayerWithSource instance with required id and sourceId, and optional paint, layout, minZoom, maxZoom, filter, and sourceLayerId.

```APIDOC
## StyleLayerWithSource({required String id, required String sourceId, Map<String, Object> paint = const {}, Map<String, Object> layout = const {}, double minZoom = 0, double maxZoom = 24, List<Object>? filter, String? sourceLayerId})

### Description
Creates a StyleLayerWithSource instance. The constructor is const.

### Parameters
- **id** (String) - Required - Unique layer name.
- **sourceId** (String) - Required - Name of a source description to be used for this layer.
- **paint** (Map<String, Object>) - Optional - Default paint properties for this layer.
- **layout** (Map<String, Object>) - Optional - Layout properties for the layer.
- **minZoom** (double) - Optional - The minimum zoom level for the layer.
- **maxZoom** (double) - Optional - The maximum zoom level for the layer.
- **filter** (List<Object>?) - Optional - A expression specifying conditions on source features.
- **sourceLayerId** (String?) - Optional - Layer to use from a vector tile source.

### Return Value
A new StyleLayerWithSource instance.
```

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

### DefaultFormat()

Source: https://pub.dev/documentation/maplibre/latest/maplibre/DefaultFormat-class.html

Constructs a DefaultFormat instance.

```APIDOC
## DefaultFormat()

### Description
Constructs a DefaultFormat instance.

### Constructor
`DefaultFormat()`

```

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

### getLayout() → Map<String, Object>

Source: https://pub.dev/documentation/maplibre/latest/maplibre/Layer-class.html

Builds the layout properties.

```APIDOC
## getLayout() → Map<String, Object>

### Description
Builds the layout properties.

### Returns
- **Map<String, Object>** - The layout properties.
```

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

### getAttributionsSync() → List<String>

Source: https://pub.dev/documentation/maplibre/latest/maplibre/StyleController-class.html

Gets a list of all attributions from the map style synchronously.

```APIDOC
## getAttributionsSync() → List<String>

### Description
Get a list of all attributions from the map style.

### Method
getAttributionsSync

### Parameters
None

### Returns
List<String>
```

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

### getAttributions() → Future<List<String>>

Source: https://pub.dev/documentation/maplibre/latest/maplibre/StyleController-class.html

Gets a list of all attributions from the map style.

```APIDOC
## getAttributions() → Future<List<String>>

### Description
Get a list of all attributions from the map style.

### Method
getAttributions

### Parameters
None

### Returns
Future<List<String>>
```

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

### Marker({required Geographic point, required Size size, required Widget child, Alignment alignment = Alignment.center, bool rotate = false, bool flat = false})

Source: https://pub.dev/documentation/maplibre/latest/maplibre/Marker-class.html

Creates a new Marker instance with the specified geographic point, size, child widget, alignment, rotation, and flat rendering options.

```APIDOC
## Marker Constructor

### Description
Creates a new Marker instance.

### Constructor
`Marker({required Geographic point, required Size size, required Widget child, Alignment alignment = Alignment.center, bool rotate = false, bool flat = false})`

### Parameters
- **point** (Geographic) - Required - The geographic position of the marker.
- **size** (Size) - Required - The size of the marker, must match the child widget dimensions.
- **child** (Widget) - Required - The widget to display as the marker. Can be any widget; use a Builder to access the MapLibreMap context.
- **alignment** (Alignment) - Optional - Alignment of the marker. Defaults to Alignment.center.
- **rotate** (bool) - Optional - Whether the marker rotates with the map. Defaults to false.
- **flat** (bool) - Optional - Whether the marker is rendered flat on the map when the camera is tilted. Defaults to false.

### Properties
- **alignment** (Alignment) - final - The alignment of the marker.
- **child** (Widget) - final - The child widget.
- **flat** (bool) - final - Whether the marker is rendered flat.
- **point** (Geographic) - final - The geographic position.
- **rotate** (bool) - final - Whether the marker rotates with the map.
- **size** (Size) - final - The size of the marker.

### 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)
```

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

### get

Source: https://pub.dev/documentation/maplibre/latest/maplibre/PositionSeries-class.html

Returns the position at the given index as an object of type R using the provided factory.

```APIDOC
## get

### Description
The position at the given index as an object of `R` using `to` factory.

### Method
get

### Signature
R get<R extends Position>(int index, {required CreatePosition<R> to})

### Parameters
- **index** (int) - Required - The index of the position.
- **to** (CreatePosition<R>) - Required - Factory to create the position object.

### Returns
R - The position at the index.
```

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

### rangeReplaced

Source: https://pub.dev/documentation/maplibre/latest/maplibre/PositionSeries-class.html

Returns a position series with positions from start (inclusive) to end (exclusive) replaced with the given replacements.

```APIDOC
## rangeReplaced

### Description
Returns a position series with positions from `start` (inclusive) to `end` (exclusive) replaced with `replacements`.

### Method
rangeReplaced

### Signature
PositionSeries rangeReplaced(int start, int end, Iterable<Position> replacements)

### Parameters
- **start** (int) - Required - The start index (inclusive).
- **end** (int) - Required - The end index (exclusive).
- **replacements** (Iterable<Position>) - Required - The replacement positions.

### Returns
PositionSeries - A new series with the range replaced.
```

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

### Interval.fromJson(Iterable data)

Source: https://pub.dev/documentation/maplibre/latest/maplibre/Interval-class.html

Creates an interval from data containing two String? items (start, end).

```APIDOC
## Interval.fromJson(Iterable data)

### Description
Creates an interval from `data` containing two String? items (start, end).

### Factory Constructor
`factory Interval.fromJson(Iterable data)`

### Parameters
- **data** (Iterable) - Required - An iterable containing two String? items representing start and end.

### Usage
```dart
final interval = Interval.fromJson(data);
```
```

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

### DownloadProgress methods

Source: https://pub.dev/documentation/maplibre/latest/maplibre/DownloadProgress-class.html

Methods available on DownloadProgress instances.

```APIDOC
## Methods

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

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

### Methods

Source: https://pub.dev/documentation/maplibre/latest/maplibre/UtmZone-class.html

Methods of the UtmZone class.

```APIDOC
## Methods

### toString() → String
- **override** - A string representation of this object.

### noSuchMethod(Invocation invocation) → dynamic
- **inherited** - Invoked when a nonexistent method or property is accessed.
```

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

### AngleUnit conversion example

Source: https://pub.dev/documentation/maplibre/latest/maplibre/AngleUnit.html

Shows how to convert between radians and degrees, and between degrees and gradians using the AngleUnit enum.

```dart
// Convert directly from and to radians.
final radians = 3.14159; // ~pi
final degrees = AngleUnit.degree.fromRadians(radians); // ~180.0
final radians2 = AngleUnit.degree.toRadians(degrees); // ~3.14159

// You can also convert between units without using radians.
final gradians =
    AngleUnit.degree.toUnit(degrees, AngleUnit.gradian); // ~200.0
```

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

### TimeUnit.toSeconds(double value) → double

Source: https://pub.dev/documentation/maplibre/latest/maplibre/TimeUnit.html

Converts a value from this unit to seconds. For example, TimeUnit.hour.toSeconds(1.0) returns 3600.0.

```APIDOC
## TimeUnit.toSeconds(double value) → double

### Description
Converts a value from this unit to seconds.

### Method
toSeconds

### Parameters
- **value** (double) - Required - The value in this unit to convert.

### Returns
double - The value in seconds.

### Example
```dart
final hours = 1.0;
final seconds = TimeUnit.hour.toSeconds(hours); // 3600.0
```
```

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

### buildList<T extends Geometry>(WriteGeometries geometries, {int? count}) → List<T>

Source: https://pub.dev/documentation/maplibre/latest/maplibre/GeometryBuilder-class.html

Builds a geometry list from the content provided by the geometries callback.

```APIDOC
## buildList<T extends Geometry>(WriteGeometries geometries, {int? count}) → List<T>

### Description
Builds a geometry list from the content provided by the geometries callback.

### Method
buildList

### Parameters
- **geometries** (WriteGeometries) - Required - The callback that provides the geometries.
- **count** (int?) - Optional - The expected number of geometries.

### Returns
List<T>
```

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

### LineStyleLayer constructor

Source: https://pub.dev/documentation/maplibre/latest/maplibre/LineStyleLayer-class.html

Creates a new LineStyleLayer instance with the required id and sourceId, and optional layout, paint, zoom, filter, and sourceLayerId parameters.

```APIDOC
## LineStyleLayer({required String id, required String sourceId, Map<String, Object> layout = const {}, Map<String, Object> paint = const {}, double minZoom = 0, double maxZoom = 24, List<Object>? filter, String? sourceLayerId})

### Description
Default constructor for a LineStyleLayer instance. Creates a line layer with the given id and sourceId, and optional layout and paint properties, zoom range, filter, and source layer id.

### Parameters
- **id** (String) - Required - Unique layer name.
- **sourceId** (String) - Required - Name of a source description to be used for this layer.
- **layout** (Map<String, Object>) - Optional - Layout properties for the layer. Defaults to const {}.
- **paint** (Map<String, Object>) - Optional - Default paint properties for this layer. Defaults to const {}.
- **minZoom** (double) - Optional - The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden. Defaults to 0.
- **maxZoom** (double) - Optional - The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden. Defaults to 24.
- **filter** (List<Object>?) - Optional - A expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The feature-state expression is not supported in filter expressions.
- **sourceLayerId** (String?) - Optional - Layer to use from a vector tile source. Required for vector tile sources; prohibited for all other source types, including GeoJSON sources.

### Example
```dart
LineStyleLayer(
  id: 'line-layer',
  sourceId: 'source-id',
  layout: {'line-cap': 'round'},
  paint: {'line-color': '#ff0000'},
  minZoom: 0,
  maxZoom: 24,
  filter: ['==', 'type', 'road'],
  sourceLayerId: 'roads',
)
```
```
Tokens:
Raw