MapOptions class

Describes the map option values.

Constructors

MapOptions({ContextMode? contextMode, ConstrainMode? constrainMode, ViewportMode? viewportMode, NorthOrientation? orientation, bool? crossSourceCollisions, bool? optimizeForTerrain, Size? size, required double pixelRatio, GlyphsRasterizationOptions? glyphsRasterizationOptions})

Properties

constrainMode ↔ ConstrainMode?

The map constrain mode. This can be used to limit the map to wrap around the globe horizontally. By default, it is set to HeightOnly.

getter/setter pair

contextMode ↔ ContextMode?

The map context mode. This can be used to optimizations if we know that the drawing context is not shared with other code.

getter/setter pair

crossSourceCollisions ↔ bool?

Specify whether to enable cross-source symbol collision detection or not. By default, it is set to true.

getter/setter pair

glyphsRasterizationOptions ↔ GlyphsRasterizationOptions?

Glyphs rasterization options to use for client-side text rendering.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

optimizeForTerrain ↔ bool?

With terrain on, if true, the map will render for performance priority, which may lead to layer reordering allowing to maximize performance (layers that are draped over terrain will be drawn first, including fill, line, background, hillshade and raster). Any layers that are positioned after symbols are draped last, over symbols. Otherwise, if set to false, the map will always be drawn for layer order priority. By default, it is set to true.

getter/setter pair

orientation ↔ NorthOrientation?

The orientation of the Map. By default, it is set to Upwards.

getter/setter pair

pixelRatio ↔ double

The custom pixel ratio. By default, it is set to 1.0

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

size ↔ Size?

The size to resize the map object and renderer backend. The size is given in logical pixel units. macOS and iOS platforms use device-independent pixel units, while other platforms, such as Android, use screen pixel units.

getter/setter pair

viewportMode ↔ ViewportMode?

The viewport mode. This can be used to flip the vertical orientation of the map as some devices may use inverted orientation.

getter/setter pair

Methods

encode() → Object

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

Static Methods

decode(Object result) → MapOptions