Style topic
Visit the Style Layers chapter in the documentation to learn more.
Classes
- BackgroundStyleLayer
- The background color or pattern of the map.
-
Call<
T> - An Expression in the JSON form of the style spec. Every expression other than a Literal is one.
- CircleStyleLayer
- A filled circle.
- Collator
- The type of Expression.collator.
- ColorReliefStyleLayer
- Client-side elevation coloring based on DEM data. The implementation supports Mapbox Terrain RGB, Mapzen Terrarium tiles and custom encodings.
-
Expression<
T> - A value of a style property or an argument of another expression: either a constant (Expression.literal) or a style expression that the map evaluates.
- FillExtrusionStyleLayer
- An extruded (3D) polygon.
- FillStyleLayer
- A filled polygon with an optional stroked border.
- FormatSection
- A section of Expression.format.
- GeoJsonSource
- A GeoJSON source, from a URL (GeoJsonSource.url) or a GeoJSON string (GeoJsonSource.data). When using in a browser, GeoJSON from a URL must be on the same domain as the map or served with CORS headers.
- GeoJsonSourceData
- A GeoJsonSource of a GeoJSON string.
- GeoJsonSourceUrl
- A GeoJsonSource that loads its data from a URL.
- HeatmapStyleLayer
- A heatmap.
- HillshadeStyleLayer
- Client-side hillshading visualization based on DEM data. The implementation supports Mapbox Terrain RGB, Mapzen Terrarium tiles and custom encodings.
- ImageSource
- An image source that drapes an image over the four coordinates of a quadrilateral. The image comes from a URL (ImageSource.url), encoded image bytes (ImageSource.bytes) or a Flutter ImageProvider (ImageSource.provider).
- ImageSourceBytes
- An ImageSource from encoded image bytes.
- ImageSourceProvider
- An ImageSource from a Flutter ImageProvider.
- ImageSourceUrl
- An ImageSource that loads its image from a URL.
- Interpolation
- How Expression.interpolate interpolates between its stops.
- LineStyleLayer
- A stroked line.
-
Literal<
T> -
A constant Expression. Read a value back with a pattern:
if (layer.radius case Literal(:final value)). - RasterDemCustomEncoding
- Decodes tiles using the redFactor, blueFactor, greenFactor, baseShift parameters.
- RasterDemEncoding
- The encoding used by this source. Mapbox Terrain RGB is used by default.
- RasterDemMapboxEncoding
- Mapbox Terrain RGB tiles. See https://www.mapbox.com/help/access-elevation-data/#mapbox-terrain-rgb for more info.
- RasterDemSource
- A raster DEM source. Only supports Mapbox Terrain RGB and Mapzen Terrarium tiles.
- RasterDemSourceTiles
- A RasterDemSource that loads its tiles from tile URLs.
- RasterDemSourceUrl
- A RasterDemSource whose tiles are described by a TileJSON resource.
- RasterDemTerrariumEncoding
- Terrarium format PNG tiles. See https://aws.amazon.com/es/public-datasets/terrain/ for more info.
- RasterSource
- A raster tile source.
- RasterSourceTiles
- A RasterSource that loads its tiles from tile URLs.
- RasterSourceUrl
- A RasterSource whose tiles are described by a TileJSON resource.
- RasterStyleLayer
- Raster map textures such as satellite imagery.
-
RawValue<
T> -
A value that a style holds and that is neither a Literal of
Tnor an expression: a legacy function object such as{"stops": […]}, or a value that this package can't read, such as an extended CSS color name. It only comes from reading a style, and is written back as it was. - Source
- The base Source class that can't be used directly.
- StyleEnum
- An enum of the style spec, which carries its string in the spec.
- StyleLayer
- A layer of a map style.
- StyleLayers
- The layers of a map style, from bottom to top.
- StyleLayerWithSource
- A StyleLayer that pulls its data from a Source. Basically every layer except BackgroundStyleLayer.
- StyleSources
- The sources of a map style.
- StyleTransition
- How a paint property changes to a new value.
- SymbolStyleLayer
- An icon or a text label.
- UnknownStyleLayer
- A layer of a type that this version of the package doesn't know. It has no typed properties, and toJson writes back the JSON it came from.
-
Variable<
T> - A typed variable of Expression.withVariable.
- VectorSource
- A vector tile source. Tiles must be in Mapbox Vector Tile format. All geometric coordinates in vector tiles must be between -1 * extent and (extent * 2) - 1 inclusive. All layers that use a vector source must specify a source-layer value.
- VectorSourceTiles
- A VectorSource that loads its tiles from tile URLs.
- VectorSourceUrl
- A VectorSource whose tiles are described by a TileJSON resource.
- VideoSource
- A video source, from URLs (VideoSource.urls), encoded video bytes (VideoSource.bytes) or a Flutter asset (VideoSource.asset).
- VideoSourceAsset
- A VideoSource from a Flutter asset.
- VideoSourceBytes
- A VideoSource from encoded video bytes.
- VideoSourceUrls
- A VideoSource from URLs.
Extensions
-
BoolExpression
on Expression<
bool> - Expressions on booleans.
-
CollatorExpression
on Expression<
Collator> - Expressions on collators.
-
ColorExpression
on Expression<
Color> - Expressions on colors.
-
ListExpression
on Expression<
List< E> > - Expressions on lists.
-
NumExpression
on Expression<
num> - Expressions on numbers.
-
StringExpression
on Expression<
String> - Expressions on strings.
Enums
- 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. - ColorReliefResampling
-
The resampling/interpolation method to use for overscaling, also known as
texture magnification filter.
- FillExtrusionTranslateAnchor
-
Controls the frame of reference for
fill-extrusion-translate. - FillLayerBlend
-
Controls how the layer is composited with the content already rendered
beneath it. Unlike per-feature opacity properties such as
fill-opacity, this property affects the final composited layer output and determines how it interacts with the existing map contents. - FillTranslateAnchor
-
Controls the frame of reference for
fill-translate. - HillshadeIlluminationAnchor
- Direction of light source when map is rotated.
- HillshadeMethod
-
The hillshade algorithm to use, one of
standard,basic,combined,igor, ormultidirectional.
- HillshadeResampling
-
The resampling/interpolation method to use for overscaling, also known as
texture magnification filter.
- IconAnchor
- Part of the icon placed closest to the anchor.
- IconOverlap
-
Allows for control over whether to show an icon when it overlaps other
symbols on the map. If
icon-overlapis not set,icon-allow-overlapis used instead. - 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.
- LineLayerBlend
-
Controls how the layer is composited with the content already rendered
beneath it. Unlike per-feature opacity properties such as
line-opacity, this property affects the final composited layer output and determines how it interacts with the existing map contents. - LineTranslateAnchor
-
Controls the frame of reference for
line-translate. - RasterResampling
-
The resampling/interpolation method to use for overscaling, also known as
texture magnification filter.
- SymbolHeightAnchor
-
Defines what
symbol-height-offsetis measured from. - 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.
- TextOverlap
-
Allows for control over whether to show symbol text when it overlaps other
symbols on the map. If
text-overlapis not set,text-allow-overlapis used instead - 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-transformproperty. - 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-anchorlocations: the renderer will attempt to place the label at each location, in order, before moving onto the next label. Usetext-justify: autoto choose justification based on anchor position. To apply an offset, use thetext-radial-offsetor the two-dimensionaltext-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.
- TileScheme
- Influences the y direction of the tile coordinates.
Typedefs
- StyleLoadedCallback = void Function(StyleController style)
- Callback that fires once the map style has successfully loaded. It provides the StyleController to the user.