Loading...
Searching...
No Matches
MapObject Class Referenceabstract

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 23 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.

◆ getId()

int MapObject.getId ( )

Gets the unique identifier of the map object.

Returns
The unique identifier of the map object.

◆ getType()

MapObjectType MapObject.getType ( )

Gets the type of the map object.

Returns
The type of the map object map_object_type.

◆ setAlpha()

bool MapObject.setAlpha ( double alpha)

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

Parameters
alphaOpacity 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.

◆ setData()

void MapObject.setData ( Uint8List data)

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

Parameters
dataData to store in the map object.
Returns
true if the operation is successful, false otherwise.

◆ setInteractive()

bool MapObject.setInteractive ( bool interactive)

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

Parameters
interactiveSpecifies 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.

◆ setTitle()

bool MapObject.setTitle ( String title)

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

Parameters
titleThe title to display on the location view.
Returns
true if the operation is successful, false otherwise.

◆ setVisible()

bool MapObject.setVisible ( bool visible)

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

Parameters
visibleSpecifies whether the object is visible (true) or hidden (false). Default: true.
Returns
true if the operation is successful, false otherwise.

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