CompassSettings class

Shows the compass on the map.

On web the compass is the compass button of the Mapbox GL JS NavigationControl, added without its zoom buttons. Fields it cannot represent are marked below. Each one is still stored and returned by getSettings, so a value written with updateSettings survives a round-trip through the API.

Constructors

CompassSettings({bool? enabled, OrnamentPosition? position, double? marginLeft, double? marginTop, double? marginRight, double? marginBottom, double? opacity, double? rotation, bool? visibility, bool? fadeWhenFacingNorth, bool? clickable, Uint8List? image})

Properties

clickable ↔ bool?: Whether the compass can be clicked and click events can be registered. Default value: true.
getter/setter pair
enabled ↔ bool?: Whether the compass is visible on the map. Default value: true.
getter/setter pair
fadeWhenFacingNorth ↔ bool?: Whether the compass fades out to invisible when facing north direction. Default value: true.
getter/setter pair
hashCode → int: The hash code for this object.
no setteroverride
image ↔ Uint8List?: The compass image, the visual representation of the compass.
getter/setter pair
marginBottom ↔ double?: Defines the margin to the bottom that the compass icon honors. Default value: 4.
getter/setter pair
marginLeft ↔ double?: Defines the margin to the left that the compass icon honors. Default value: 4.
getter/setter pair
marginRight ↔ double?: Defines the margin to the right that the compass icon honors. Default value: 4.
getter/setter pair
marginTop ↔ double?: Defines the margin to the top that the compass icon honors. Default value: 4.
getter/setter pair
opacity ↔ double?: The alpha channel value of the compass image. Default value: 1.
getter/setter pair
position ↔ OrnamentPosition?: Defines where the compass is positioned on the map. Default value: "top-right".
getter/setter pair
rotation ↔ double?: The clockwise rotation value in degrees of the compass. Default value: 0.
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
visibility ↔ bool?: Whether the compass is displayed. Default value: true.
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.
override

Static Methods

decode(Object result) → CompassSettings