MapObject Class Reference

Base interface for handling objects on the location view. More...

Inheritance diagram for MapObject:

Public Member Functions
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

Base interface for handling objects on the location view.

Used to manage objects in LocationWindow. Can be handled in the pickMapObjectAt method LocationWindow.

Referenced from CircleMapObject, IconMapObject, PolylineMapObject, PolygonMapObject, DottedPolylineMapObject.

Definition at line 25 of file map_object.dart.

Member Function Documentation

getData()

Uint8List MapObject.getData

(

)

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

(

)

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

(

)

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

)

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");

setData()

void MapObject.setData

(

Uint8List

data

)

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

)

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");

setTitle()

bool MapObject.setTitle

(

String

title

)

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

)

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:

• map_object.dart