LocationMarkerLayerOptions class

Describes the needed properties to create a location marker layer. Location marker layer is a compose layer, containing 3 widgets which are

  1. an accuracy circle (in a circle layer)
  2. a heading sector (in a marker layer) and
  3. a marker (in the same marker layer).

Constructors

LocationMarkerLayerOptions({Key? key, Stream<LocationMarkerPosition>? positionStream, Stream<LocationMarkerHeading>? headingStream, Widget marker = const DefaultLocationMarker(), Size markerSize = const Size(20, 20), MarkerDirection markerDirection = MarkerDirection.top, bool showAccuracyCircle = true, Color accuracyCircleColor = const Color.fromARGB(0x18, 0x21, 0x96, 0xF3), bool showHeadingSector = true, double headingSectorRadius = 60, Color headingSectorColor = const Color.fromARGB(0xCC, 0x21, 0x96, 0xF3), @Deprecated('`markerAnimationDuration` is split into `moveAnimationDuration` and `rotateAnimationDuration`') Duration markerAnimationDuration = const Duration(milliseconds: 200), Duration? moveAnimationDuration, Duration? rotateAnimationDuration, Curve moveAnimationCurve = Curves.fastOutSlowIn, Curve rotateAnimationCurve = Curves.easeInOut, Stream<void>? rebuild})
Create a LocationMarkerLayerOptions.

Properties

accuracyCircleColor Color
The color of the accuracy circle. Default to ARGB(0x182196F3).
final
hashCode int
The hash code for this object.
no setterinherited
headingSectorColor Color
The color of the heading sector. Default to ARGB(0xCC2196F3).
final
headingSectorRadius double
The radius of the heading sector in pixels. Default to 60.
final
headingStream Stream<LocationMarkerHeading>
A Stream that provide heading data for this marker. Default to LocationMarkerDataStreamFactory.compassHeadingStream.
final
key Key?
finalinherited
marker Widget
The main marker widget. Default to DefaultLocationMarker
final
markerAnimationDuration Duration
The duration of the animation of location update.
no setter
markerDirection MarkerDirection
The direction of the marker. Default to MarkerDirection.top.
final
markerSize Size
The size of main marker widget. Default to 20px * 20px.
final
moveAnimationCurve Curve
The curve of the marker's move animation. Default to Curves.fastOutSlowIn.
final
moveAnimationDuration Duration
The duration of the marker's move animation. Default to 200ms.
final
positionStream Stream<LocationMarkerPosition>
A Stream that provide position data for this marker. Default to LocationMarkerDataStreamFactory.geolocatorPositionStream.
final
rebuild Stream<void>?
finalinherited
rotateAnimationCurve Curve
The curve of the heading sector rotate animation. Default to Curves.easeInOut.
final
rotateAnimationDuration Duration
The duration of the heading sector rotate animation. Default to 200ms.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
showAccuracyCircle bool
Whether to show accuracy circle. Android define accuracy as the radius of 68% confidence so there is a 68% probability that the true location is inside the circle. Default to true.
final
showHeadingSector bool
Whether to show the heading sector. Default to true.
final

Methods

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