SnapshotterPlatformInterface class abstract interface

Abstract interface for capturing styled map snapshots.

Use a snapshotter to capture a static image of a map without a live MapWidget. Configure the result via MapSnapshotOptions at construction time, set the style, adjust the camera, and then call start to capture the image.

Properties

hashCode int
The hash code for this object.
no setterinherited
onMapLoadErrorListener OnMapLoadErrorListener?
no setter
onStyleDataLoadedListener OnStyleDataLoadedListener?
no setter
onStyleImageMissingListener OnStyleImageMissingListener?
no setter
onStyleLoadedListener OnStyleLoadedListener?
Event listeners wired at construction time.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
style StylePlatformInterface
Style manager for setting the snapshot's style URI/JSON and runtime style properties (import configs, layers, sources).
no setter

Methods

camera({required List<Point> coordinates, MbxEdgeInsets? padding, double? bearing, double? pitch}) Future<CameraOptions>
Returns camera options that fit the given list of coordinates.
cancel() Future<void>
Cancels any pending snapshot request.
clearData() Future<void>
Clears temporary map data from the snapshotter's data path.
coordinateBounds(CameraOptions camera) Future<CoordinateBounds>
Returns the coordinate bounds corresponding to the given camera options.
dispose() Future<void>
Releases resources held by this snapshotter instance.
getCameraState() Future<CameraState>
Returns the current snapshotter camera state.
getSize() Future<Size?>
Returns the current snapshot image size.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setCamera(CameraOptions cameraOptions) Future<void>
Sets the camera to the given options.
setSize(Size size) Future<void>
Sets the snapshot image size.
start() Future<Uint8List?>
Captures a snapshot. If a pending request exists it is cancelled first.
tileCover(TileCoverOptions options) Future<List<CanonicalTileID?>>
Returns tile identifiers covering the current snapshotter camera.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited