RouteRenderSettings class Maps & 3D Scenes
Additional rendering settings used to customize how routes are displayed on the map.
A RouteRenderSettings object extends RenderSettings with route-specific options such as colors for the traveled portion of the route, turn arrow styling, waypoint text sizing and a fill color for the route polygon. Sizes are expressed in millimetres. Use an instance of this class when adding a route via MapViewRoutesCollection.add or when updating an existing route's appearance through MapViewRoute.renderSettings or MapViewRoutesCollection.setRenderSettings.
Example
final renderSettings = RouteRenderSettings(
innerColor: Colors.black,
fillColor: Colors.purple,
lineType: LineType.dashed,
);
controller.preferences.routes.getMapViewRoute(0)!.renderSettings = renderSettings;
See also:
- MapViewRoutesCollection.add — Add a route with custom render settings.
- MapViewRoute.renderSettings — Access or update a route's render settings.
- Inheritance
-
- Object
- RenderSettings<
RouteRenderOptions> - RouteRenderSettings
Constructors
-
RouteRenderSettings({Set<
RouteRenderOptions> options = const <RouteRenderOptions>{RouteRenderOptions.showTraffic, RouteRenderOptions.showTurnArrows, RouteRenderOptions.showWaypoints, RouteRenderOptions.showHighlights}, Color innerColor = RenderSettings.defaultInnerColor, Color outerColor = RenderSettings.defaultOuterColor, double innerSz = RenderSettings.defaultInnerSize, double outerSz = RenderSettings.defaultOuterSize, LineType lineType = RenderSettings.defaultLineType, double imgSz = RenderSettings.defaultImageSize, double textSz = RenderSettings.defaultTextSize, Color textColor = RenderSettings.defaultTextColor, Color traveledInnerColor = Colors.transparent, Color turnArrowInnerColor = Colors.transparent, Color turnArrowOuterColor = Colors.transparent, double turnArrowInnerSz = RenderSettings.defaultInnerSize, double turnArrowOuterSz = RenderSettings.defaultOuterSize, double waypointTextSz = RenderSettings.defaultTextSize, Color waypointTextInnerColor = Colors.transparent, Color waypointTextOuterColor = Colors.transparent, Color fillColor = Colors.transparent, Color directionArrowInnerColor = Colors.transparent, Color directionArrowOuterColor = Colors.transparent}) - Create a new set of route render settings.
-
RouteRenderSettings.fromJson(Map<
String, dynamic> json) -
Deserializes a JSON-compatible map to create an instance.
factory
Properties
- directionArrowInnerColor ↔ Color
-
Direction arrow inner color
getter/setter pair
- directionArrowOuterColor ↔ Color
-
Direction arrow outer color
getter/setter pair
- fillColor ↔ Color
-
The fill color for the route.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- imagePosition ↔ ImagePosition
-
Image position
getter/setter pairinherited
- imgSz ↔ double
-
The size of the image in millimeters.
getter/setter pairinherited
- innerColor ↔ Color
-
The color for the inner area.
getter/setter pairinherited
- innerSz ↔ double
-
The size for the inner area in millimeters.
getter/setter pairinherited
- lineType ↔ LineType
-
The line type.
getter/setter pairinherited
-
options
↔ Set<
RouteRenderOptions> -
The set that defines what elements to show.
getter/setter pairinherited
- outerColor ↔ Color
-
The color for the outer area.
getter/setter pairinherited
- outerSz ↔ double
-
The size for the outer area in millimeters.
getter/setter pairinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- textColor ↔ Color
-
The color for the text.
getter/setter pairinherited
- textSz ↔ double
-
The size for the text in millimeters.
getter/setter pairinherited
- traveledInnerColor ↔ Color
-
The color of the traveled part of the route.
getter/setter pair
- turnArrowInnerColor ↔ Color
-
The inner color of the turn arrows on the route.
getter/setter pair
- turnArrowInnerSz ↔ double
-
The default inner size for turn arrows on the route in millimeters.
getter/setter pair
- turnArrowOuterColor ↔ Color
-
The outer color of the turn arrows on the route.
getter/setter pair
- turnArrowOuterSz ↔ double
-
The outer size of the turn arrows on the route in millimeters.
getter/setter pair
- waypointTextInnerColor ↔ Color
-
The inner text color for waypoint labels on the route.
getter/setter pair
- waypointTextOuterColor ↔ Color
-
The outer text color for waypoint labels on the route.
getter/setter pair
- waypointTextSz ↔ double
-
The text size for waypoints on the route in millimeters.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> - Deserializes a JSON-compatible map to create an instance.
-
toJsonWithOptions(
dynamic optionsSerializer(Set options)) → Map< String, dynamic> -
Serializes this instance to a JSON-compatible map.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited