mapbox_maps library

Classes

ArgumentCallbacks<T>: Mutable collection of ArgumentCallback instances, itself an ArgumentCallback.
AttributionSettings: Shows the attribution icon on the map.
AttributionSettingsInterface
BackgroundLayer: The background color or pattern of the map.
BaseAnnotationManager: The super class for all AnnotationManagers.
CameraBounds: Holds information about camera bounds.
CameraBoundsOptions: Holds options to be used for setting camera bounds.
CameraChangedEventData: The class for camera-changed event in Observer
CameraOptions: Various options for describing the viewpoint of a camera. All fields are optional.
CameraState: Describes the viewpoint of a camera.
Cancelable
CanonicalTileID: Represents a tile coordinate.
CircleAnnotation
CircleAnnotationManager: The CircleAnnotationManager to add/update/delete CircleAnnotationAnnotations on the map.
CircleAnnotationOptions
CircleLayer: A filled circle.
CompassSettings: Shows the compass on the map.
CompassSettingsInterface
CoordinateBounds: A rectangular area as measured on a two-dimensional map projection.
CoordinateBoundsZoom: A coordinate bounds and zoom.
Error: The data class for error in Observer
Event: Generic Event type used to notify an observer.
FeatureExtensionValue: A value or a collection of a feature extension.
FillExtrusionLayer: An extruded (3D) polygon.
FillLayer: A filled polygon with an optional stroked border.
GeoJsonSource: A GeoJSON data source. @see The online documentation
GestureListener
GesturesSettings: Gesture configuration allows to control the user touch interaction.
GesturesSettingsInterface
GlyphsRasterizationOptions: Describes the glyphs rasterization option values.
HeatmapLayer: A heatmap.
HillshadeLayer: Client-side hillshading visualization based on DEM data. Currently, the implementation only supports Mapbox Terrain RGB and Mapzen Terrarium tiles.
ImageContent: Describes the image content, e.g. where text can be fit into an image.
ImageSource: An image data source. @see The online documentation
ImageStretches: Describes the image stretch areas.
Layer: Super class for all different types of layers.
LayerPosition: Specifies position of a layer that is added via addStyleLayer method.
Light: The global light source. Check the online documentation.
LineLayer: A stroked line.
LocationComponentSettings: Shows a location puck on the map.
LocationComponentSettingsInterface
LocationIndicatorLayer: Location Indicator layer.
LocationPuck: Defines what the customised look of the location puck.
LocationPuck2D
LocationPuck3D
LogoSettings: Shows the Mapbox logo on the map.
LogoSettingsInterface
MapAnimationOptions
MapboxMap: Controller for a single MapboxMap instance running on the host platform.
MapboxStyles: A convenience object to access the style ID strings of the professionally-designed map styles made by Mapbox.
MapDebugOptions: Options for enabling debugging features in a map.
MapEvents: List of supported event types by the map and map snapshotter objects, and event data format specification for each event.
MapIdleEventData: The class for map-idle event in Observer
MapLoadedEventData: The class for map-loaded event in Observer
MapLoadingErrorEventData: The class for map-loading-error event in Observer
MapMemoryBudgetInMegabytes: Map memory budget in megabytes.
MapMemoryBudgetInTiles: Map memory budget in tiles.
MapOptions: Describes the map option values.
MapSnapshot
MapSnapshotter
MapWidget: A MapWidget provides an embeddable map interface. You use this class to display map information and to manipulate the map contents from your application. You can center the map on a given coordinate, specify the size of the area you want to display, and style the features of the map to fit your application's use case.
MbxEdgeInsets: The distance on each side between rectangles, when one is contained into other.
MbxImage: Image type.
MercatorCoordinate: Describes a point on the map in Mercator projection.
OfflineRegion
OfflineRegionGeometryDefinition: An offline region definition is a geographic region defined by a style URL, a geometry, zoom range, and device pixel ratio. Both minZoom and maxZoom must be ≥ 0, and maxZoom must be ≥ minZoom. The maxZoom may be ∞, in which case for each tile source, the region will include tiles from minZoom up to the maximum zoom level provided by that source. The pixelRatio must be ≥ 0 and should typically be 1.0 or 2.0.
OfflineRegionManager
OfflineRegionTilePyramidDefinition: An offline region definition is a geographic region defined by a style URL, geographic bounding box, zoom range, and device pixel ratio. Both minZoom and maxZoom must be ≥ 0, and maxZoom must be ≥ minZoom. The maxZoom may be ∞, in which case for each tile source, the region will include tiles from minZoom up to the maximum zoom level provided by that source. The pixelRatio must be ≥ 0 and should typically be 1.0 or 2.0.
OfflineSwitch
OnCircleAnnotationClickListener
OnPointAnnotationClickListener
OnPolygonAnnotationClickListener
OnPolylineAnnotationClickListener
PointAnnotation
PointAnnotationManager: The PointAnnotationManager to add/update/delete PointAnnotationAnnotations on the map.
PointAnnotationOptions
PolygonAnnotation
PolygonAnnotationManager: The PolygonAnnotationManager to add/update/delete PolygonAnnotationAnnotations on the map.
PolygonAnnotationOptions
PolylineAnnotation
PolylineAnnotationManager: The PolylineAnnotationManager to add/update/delete PolylineAnnotationAnnotations on the map.
PolylineAnnotationOptions
ProjectedMeters: ProjectedMeters is a coordinate in a specific Spherical Mercator projection.
Projection
QueriedFeature: Represents query result that is returned in QueryFeaturesCallback. @see queryRenderedFeatures or querySourceFeatures
RasterDemSource: A RGB-encoded raster DEM source @see The online documentation
RasterLayer: Raster map textures such as satellite imagery.
RasterSource: A raster tile source. @see The online documentation
RenderedQueryGeometry: Geometry for querying rendered features. */
RenderedQueryOptions: Options for querying rendered features.
RenderFrameFinishedEventData: The class for render-frame-finished event in Observer
RenderFrameStartedEventData: The class for render-frame-started event in Observer
Request: The request data class that included in EventData
ResourceEventData: The class for event in Observer
ResourceOptions: Options to configure a resource
Response: The response data class that included in EventData
ScaleBarSettings: Shows the scale bar on the map.
ScaleBarSettingsInterface
ScreenBox: Describes the coordinate box on the screen, measured in platform pixels from top to bottom and from left to right.
ScreenCoordinate: Describes the coordinate on the screen, measured from top to bottom and from left to right. Note: the map uses screen coordinate units measured in platform pixels.
Settings
Size: Size type.
SkyLayer: A spherical dome around the map that is always rendered behind all other layers.
Source: Super class for all different types of sources.
SourceAddedEventData: The class for source-added event in Observer
SourceDataLoadedEventData: The class for source-data-loaded event in Observer
SourceQueryOptions: Options for querying source features.
SourceRemovedEventData: The class for source-removed event in Observer
StyleDataLoadedEventData: The class for style-data-loaded event in Observer
StyleImageMissingEventData: The class for style-image-missing event in Observer
StyleImageUnusedEventData: The class for style-image-remove-unused event in Observer
StyleLoadedEventData: The class for style-loaded event in Observer
StyleManager
StyleObjectInfo: The information about style object (source or layer).
StylePropertyValue: Holds a style property value with meta data.
StyleTransition: Define the duration and delay for a style transition.
SymbolLayer: An icon or a text label.
TileID: Defines the tile id in a source-data-loaded event.
TilesetDescriptor
TransitionOptions: The transition options controls timing for the interpolation between a transitionable style property's previous value and new value. These can be used to define the style default property transition behavior. Also, any transitionable style property may also have its own -transition property that defines specific transition timing for that specific layer property, overriding the global transition values.
VectorSource: A vector tile source. @see The online documentation

Extensions

StyleColorInt: Extension to convert color format
StyleColorList: Extension to convert color format
StyleLayer: Extension for StyleManager to add/update/get layers from the current style.
StyleLight: Extension for StyleManager to set light in the current style.
StyleSource: Extension for StyleManager to add/get sources from the current style.

Enums

Anchor: Whether extruded geometries are lit relative to the map or viewport.
CirclePitchAlignment: Orientation of circle when map is pitched.
CirclePitchScale: Controls the scaling behavior of the circle when the map is pitched.
CircleTranslateAnchor: Controls the frame of reference for circle-translate.
ConstrainMode: Describes whether to constrain the map in both axes or only vertically e.g. while panning.
ContextMode: Describes the map context mode. We can make some optimizations if we know that the drawing context is not shared with other code.
DataSourceType: Describes data source of request for resource-request event. @param value String value of this enum
DownloadErrorCode: Enum which represents different error cases which could happen during download session.
DownloadState: Enum representing state of download session.
Encoding: The encoding used by this source. Mapbox Terrain RGB is used by default
FillExtrusionTranslateAnchor: Controls the frame of reference for fill-extrusion-translate.
FillTranslateAnchor: Controls the frame of reference for fill-translate.
GlyphsRasterizationMode: Describes glyphs rasterization modes.
HillshadeIlluminationAnchor: Direction of light source when map is rotated.
HttpMethod: HTTP defines a set of request methods to indicate the desired action to be performed for a given resource.
HttpRequestErrorType: Enum which describes possible error types which could happen during HTTP request/download calls.
IconAnchor: Part of the icon placed closest to the anchor.
IconPitchAlignment: Orientation of icon when map is pitched.
IconRotationAlignment: In combination with symbol-placement, determines the rotation behavior of icons.
IconTextFit: Scales the icon to fit around the associated text.
IconTranslateAnchor: Controls the frame of reference for icon-translate.
LineCap: The display of line endings.
LineJoin: The display of lines when joining.
LineTranslateAnchor: Controls the frame of reference for line-translate.
MapDebugOptionsData: Options for enabling debugging features in a map.
MapLoadErrorType: Describes an error type while loading the map. Defines what resource could not be loaded. @param finalue String finalue of this enum
ModelType
NetworkRestriction: Classify network types based on cost.
NorthOrientation: Describes the map orientation.
OfflineRegionDownloadState: Describes the download state of a region.
OrnamentPosition
PuckBearingSource: The enum controls how the puck is oriented
RasterResampling: The resampling/interpolation method to use for overscaling, also known as texture magnification filter
RenderMode: Describes whether a map or frame has been fully rendered or not. @param value String value of this enum
RequestPriorit: Describes priority for request object. @param finalue String finalue of this enum
RequestPriority: Describes priority for request object. @param value String value of this enum
RequestType: Describes type for request object. @param value String value of this enum
ResponseErrorReason: Describes the reason for an offline request response error.
ResponseSourceType: Describes source data type for response in resource-request event. @param value String value of this enum
Scheme: Influences the y direction of the tile coordinates. The global-mercator (aka Spherical Mercator) profile is assumed.
ScrollMode: Configures the directions in which the map is allowed to move during a scroll gesture.
SkyType: The type of the sky
SourceDataType: Defines what kind of source data has been loaded in a source-data-loaded event. @param finalue String finalue of this enum
StyleDataType: Defines what kind of style data has been loaded in a style-data-loaded event. @param finalue String finalue of this enum
StylePackErrorType: Describes the reason for a style package download request failure.
StylePropertyValueKind: Describes the kind of a style property value.
SymbolPlacement: Label placement relative to its geometry.
SymbolZOrder: Determines whether overlapping symbols in the same layer are rendered in the order that they appear in the data source or by their y-position relative to the viewport. To control the order and prioritization of symbols otherwise, use symbol-sort-key.
TextAnchor: Part of the text placed closest to the anchor.
TextJustify: Text justification options.
TextPitchAlignment: Orientation of text when map is pitched.
TextRotationAlignment: In combination with symbol-placement, determines the rotation behavior of the individual glyphs forming the text.
TextTransform: Specifies how to capitalize text, similar to the CSS text-transform property.
TextTranslateAnchor: Controls the frame of reference for text-translate.
TextVariableAnchor: To increase the chance of placing high-priority labels on the map, you can provide an array of text-anchor locations: the renderer will attempt to place the label at each location, in order, before moving onto the next label. Use text-justify: auto to choose justification based on anchor position. To apply an offset, use the text-radial-offset or the two-dimensional text-offset.
TextWritingMode: The property allows control over a symbol's orientation. Note that the property values act as a hint, so that a symbol whose language doesn’t support the provided orientation will be laid out in its natural orientation. Example: English point symbol will be rendered horizontally even if array value contains single 'vertical' enum value. The order of elements in an array define priority order for the placement of an orientation variant.
TileDataDomain: Describes the tiles data domain.
TileRegionErrorType: Describes the reason for a tile region download request failure.
TileStoreUsageMode: Describes tile store usage modes.
Type
ViewAnnotationAnchor: Enum describing how to place view annotation relatively to geometry.
ViewportMode: Satisfies embedding platforms that requires the viewport coordinate systems to be set according to its standards.
Visibility: The visibility of a layer.

Typedefs

ArgumentCallback<T> = void Function(T argument): Callback function taking a single argument.
MapCreatedCallback = void Function(MapboxMap controller): Definition for listener invoked when the map is created.
Observer = void Function(Event event): An observer interface used to subscribe for an observable events. */
OnCameraChangeListener = void Function(CameraChangedEventData cameraChangedEventData): Definition for listener invoked whenever the camera position changes.
OnMapIdleListener = void Function(MapIdleEventData mapIdleEventData): Definition for listener invoked whenever the Map has entered the idle state.
OnMapLoadedListener = void Function(MapLoadedEventData mapLoadedEventData): Definition for listener invoked when the map loading finishes.
OnMapLoadErrorListener = void Function(MapLoadingErrorEventData mapLoadingErrorEventData): Definition for listener invoked whenever the map load errors out.
OnMapLongTapListener = void Function(ScreenCoordinate coordinate): Gesture listener called on map double tap.
OnMapScrollListener = void Function(ScreenCoordinate coordinate): Gesture listener called on map scroll.
OnMapTapListener = void Function(ScreenCoordinate coordinate): Gesture listener called on map tap.
OnPlatformViewCreatedCallback = void Function(int)
OnRenderFrameFinishedListener = void Function(RenderFrameFinishedEventData renderFrameFinishedEventData): Definition for listener invoked whenever the Map finished rendering a frame.
OnRenderFrameStartedListener = void Function(RenderFrameStartedEventData renderFrameStartedEventData): Definition for listener invoked whenever the Map started rendering a frame.
OnSourceAddedListener = void Function(SourceAddedEventData sourceAddedEventData): Definition for listener invoked whenever a source is added.
OnSourceDataLoadedListener = void Function(SourceDataLoadedEventData sourceDataLoadedEventData): Definition for listener invoked when the requested source data has been loaded.
OnSourceRemovedListener = void Function(SourceRemovedEventData sourceRemovedEventData): Definition for listener invoked whenever a source is removed.
OnStyleDataLoadedListener = void Function(StyleDataLoadedEventData styleDataLoadedEventData): Definition for listener invoked when the requested style data has been loaded.
OnStyleImageMissingListener = void Function(StyleImageMissingEventData styleImageMissingEventData): Definition for listener invoked when the style has a missing image.
OnStyleImageUnusedListener = void Function(StyleImageUnusedEventData styleImageUnusedEventData): Definition for listener invoked when an image added to the Style is no longer needed.
OnStyleLoadedListener = void Function(StyleLoadedEventData styleLoadedEventData): Definition for listener invoked when the style is fully loaded.

mapbox_maps library Null safety

Classes

Extensions

Enums

Typedefs

mapbox_maps package

mapbox_maps library