Represents a polyline object with points placed along it on the location view. More...

Inheritance diagram for DottedPolylineMapObject:

Public Member Functions
bool	setPolyLine (LocationPolyline polyline)
	Method is used to specify the source polyline for the points.

bool	setColor (double red, double green, double blue, double alpha)
	Method is used to specify the color of the object.

bool	setSize (double width, double height)
	Method is used to specify the size of the points.

bool	setCollisionEnabled (bool enabled)
	Method is used to enable or disable collision detection for the icon.

bool	setPlacement (Placement placement)
	Method is used to specify the placement mode for points along the polyline.

bool	setPlacementMinRatio (double ratio)
	Method is used to specify the minimum ratio of the polyline length for point placement.

bool	setPlacementSpacing (double spacing)
	Method is used to specify the spacing between points for spaced placement.

bool	setRepeatDistance (double distance)
	Method is used to specify the distance interval for repeating points along the polyline.

bool	setRepeatGroup (int group)
	Method is used to specify the group identifier for repeating points.

bool	setPriority (double priority)
	Method is used to specify the priority of the icon.

int	getId ()
	Gets the unique identifier of the map object.

MapObjectType	getType ()
	Gets the type of the map object.

Uint8List	getData ()
	Gets the user-defined data associated with the map object.

bool	setVisible (bool visible)
	Method is used to specify the visibility of the map object.

bool	setInteractive (bool interactive)
	Method is used to specify whether the map object can be interacted with.

void	setData (Uint8List data)
	Method is used to set user-defined data for the map object.

bool	setTitle (String title)
	Method is used to set the title of the map object.

bool	setAlpha (double alpha)
	Method is used to set the opacity of the map object.

Detailed Description

Represents a polyline object with points placed along it on the location view.

Referenced from LocationWindow.

Definition at line 25 of file dotted_polyline_map_object.dart.

Member Function Documentation

◆ getData()

Uint8List MapObject.getData ( )

inherited

Gets the user-defined data associated with the map object.

Returns: The data stored in the map object.

Dart code snippet:

      // Get custom data
      Map<String, dynamic> retrievedData = _circleMapObject!.data;
      print("Circle custom data: $retrievedData");

◆ getId()

int MapObject.getId ( )

inherited

Gets the unique identifier of the map object.

Returns: The unique identifier of the map object.

Dart code snippet:

      // Get object ID
      int objectId = _circleMapObject!.id;
      print("Circle object ID: $objectId");

◆ getType()

MapObjectType MapObject.getType ( )

inherited

Gets the type of the map object.

Returns: The type of the map object MapObjectType.

Dart code snippet:

      // Get object type
      String objectTypeString = _circleMapObject!.type;
      print("Circle object type: $objectTypeString");

◆ setAlpha()

bool MapObject.setAlpha ( double alpha )

inherited

Method is used to set the opacity of the map object.

Parameters

alpha Opacity multiplier. Values below 0 will be set to 0. Values above 1 will be set to 1. Default: 1.

Returns: true if the operation is successful, false otherwise.

Dart code snippet:

      // Set alpha transparency
      bool alphaSuccess = _circleMapObject!.setAlpha(0.7);
      print("Set circle alpha to 0.7: $alphaSuccess");

◆ setCollisionEnabled()

bool DottedPolylineMapObject.setCollisionEnabled ( bool enabled )

Method is used to enable or disable collision detection for the icon.

Parameters

enabled Specifies whether collision detection is enabled (true) or disabled (false). Default: false.

Returns: true if the operation is successful, false otherwise.

Dart code snippet:

      // Enable collision detection
      bool collisionSuccess = _dottedPolylineMapObject!.setCollisionEnabled(
        true,
      );
      print(
        "Enabled collision detection for dotted polyline: $collisionSuccess",
      );

◆ setColor()

bool DottedPolylineMapObject.setColor	(	double	red,
		double	green,
		double	blue,
		double	alpha )

Method is used to specify the color of the object.

Parameters

red	Red RGBA component.
green	Green RGBA component.
blue	Blue RGBA component.
alpha	Opacity multiplier. Values below 0 will be set to 0. Default: 1.

Returns: true if success, false otherwise.

Dart code snippet:

      // Set dotted polyline color
      bool colorSuccess = _dottedPolylineMapObject!.setColor(
        0.5,
        0.0,
        1.0,
        0.8,
      );
      print(
        "Set dotted polyline color to purple with 80% opacity: $colorSuccess",
      );

◆ setData()

void MapObject.setData ( Uint8List data )

inherited

Method is used to set user-defined data for the map object.

Parameters

data	Data to store in the map object.

Dart code snippet:

      // Set custom data
      Map<String, dynamic> customData = {"key": "value", "number": 42};
      bool dataSuccess = _circleMapObject!.setData(customData);
      print("Set circle custom data: $dataSuccess");

◆ setInteractive()

bool MapObject.setInteractive ( bool interactive )

inherited

Method is used to specify whether the map object can be interacted with.

Parameters

interactive Specifies whether the object can be picked in the pickMapObjectAt method (true) or not (false). Default: false.

Returns: true if the operation is successful, false otherwise.

Dart code snippet:

      // Set interactive mode
      bool interactiveSuccess = _circleMapObject!.setInteractive(true);
      print("Set circle interactive to true: $interactiveSuccess");

◆ setPlacement()

bool DottedPolylineMapObject.setPlacement ( Placement placement )

Method is used to specify the placement mode for points along the polyline.

Parameters

placement The placement mode Placement. Default: VERTEX.

Returns: true if the operation is successful, false otherwise.

Dart code snippet:

      // Set placement type
      bool placementSuccess = _dottedPolylineMapObject!.setPlacement(
        Placement.center,
      );
      print("Set dotted polyline placement to center: $placementSuccess");

◆ setPlacementMinRatio()

bool DottedPolylineMapObject.setPlacementMinRatio ( double ratio )

Method is used to specify the minimum ratio of the polyline length for point placement.

Parameters

ratio The minimum ratio of the polyline length (typically between 0 and 1). Default: 1.0.

Returns: true if the operation is successful, false otherwise.

Dart code snippet:

      // Set placement min ratio
      bool minRatioSuccess = _dottedPolylineMapObject!.setPlacementMinRatio(
        0.5,
      );
      print("Set dotted polyline placement min ratio to 0.5: $minRatioSuccess");

◆ setPlacementSpacing()

bool DottedPolylineMapObject.setPlacementSpacing ( double spacing )

Method is used to specify the spacing between points for spaced placement.

Parameters

spacing The spacing distance in pixels. Default: 80.

Returns: true if the operation is successful, false otherwise.

Dart code snippet:

      // Set placement spacing
      bool spacingSuccess = _dottedPolylineMapObject!.setPlacementSpacing(10.0);
      print("Set dotted polyline placement spacing to 10.0: $spacingSuccess");

◆ setPolyLine()

bool DottedPolylineMapObject.setPolyLine ( LocationPolyline polyline )

Method is used to specify the source polyline for the points.

Parameters

polyline Metrics coordinates of the polyline LocationPolyline.

Returns: true if the operation is successful, false otherwise.

Dart code snippet:

      // Set dotted polyline geometry
      List<Point> dottedPoints = [
        Point(0.0, 100.0),
        Point(50.0, 150.0),
        Point(100.0, 100.0),
        Point(150.0, 150.0),
      ];
      Polyline dottedPolyline = Polyline(dottedPoints);
      LocationPolyline locationDottedPolyline = LocationPolyline(
        dottedPolyline,
      );
      bool success = _dottedPolylineMapObject!.setPolyLine(
        locationDottedPolyline,
      );
      print("Set dotted polyline geometry: $success");

◆ setPriority()

bool DottedPolylineMapObject.setPriority ( double priority )

Method is used to specify the priority of the icon.

Parameters

priority The priority value for rendering or interaction. Default: max.

Returns: true if the operation is successful, false otherwise.

Dart code snippet:

      // Set rendering priority
      bool prioritySuccess = _dottedPolylineMapObject!.setPriority(1);
      print("Set dotted polyline rendering priority to 1: $prioritySuccess");

◆ setRepeatDistance()

bool DottedPolylineMapObject.setRepeatDistance ( double distance )

Method is used to specify the distance interval for repeating points along the polyline.

Parameters

distance The repeat distance in pixels. Default: 0.

Returns: true if the operation is successful, false otherwise.

Dart code snippet:

      // Set repeat distance
      bool repeatDistanceSuccess = _dottedPolylineMapObject!.setRepeatDistance(
        20.0,
      );
      print(
        "Set dotted polyline repeat distance to 20.0: $repeatDistanceSuccess",
      );

◆ setRepeatGroup()

bool DottedPolylineMapObject.setRepeatGroup ( int group )

Method is used to specify the group identifier for repeating points.

Parameters

group The group identifier for point repetition. Default: 0.

Returns: true if the operation is successful, false otherwise.

Dart code snippet:

      // Set repeat group
      bool repeatGroupSuccess = _dottedPolylineMapObject!.setRepeatGroup(1);
      print("Set dotted polyline repeat group to 1: $repeatGroupSuccess");

◆ setSize()

bool DottedPolylineMapObject.setSize	(	double	width,
		double	height )

Method is used to specify the size of the points.

Parameters

width	Width of the points in pixels.
height	Height of the points in pixels.

Returns: true if the operation is successful, false otherwise.

Dart code snippet:

      // Set size
      bool sizeSuccess = _dottedPolylineMapObject!.setSize(16.0, 16.0);
      print("Set dotted polyline size to 16x16: $sizeSuccess");

◆ setTitle()

bool MapObject.setTitle ( String title )

inherited

Method is used to set the title of the map object.

Parameters

title The title to display on the location view.

Returns: true if the operation is successful, false otherwise.

Dart code snippet:

      // Set title
      bool titleSuccess = _circleMapObject!.setTitle("Circle Object");
      print("Set circle title to 'Circle Object': $titleSuccess");

◆ setVisible()

bool MapObject.setVisible ( bool visible )

inherited

Method is used to specify the visibility of the map object.

Parameters

visible Specifies whether the object is visible (true) or hidden (false). Default: true.

Returns: true if the operation is successful, false otherwise.

Dart code snippet:

      // Set visibility
      bool visibleSuccess = _circleMapObject!.setVisible(true);
      print("Set circle visibility to true: $visibleSuccess");

The documentation for this class was generated from the following file:

dotted_polyline_map_object.dart

Public Member Functions

Detailed Description

Member Function Documentation

◆ getData()

◆ getId()

◆ getType()

◆ setAlpha()

◆ setCollisionEnabled()

◆ setColor()

◆ setData()

◆ setInteractive()

◆ setPlacement()

◆ setPlacementMinRatio()

◆ setPlacementSpacing()

◆ setPolyLine()

◆ setPriority()

◆ setRepeatDistance()

◆ setRepeatGroup()

◆ setSize()

◆ setTitle()

◆ setVisible()