Represents a polygon object on the location view.
More...
|
| bool | setPolygon (LocationPolygon polygon) |
| | Method is used to specify the source polygon of the object.
|
| |
| bool | setColor (double red, double green, double blue, double alpha) |
| | Method is used to specify the color of the object.
|
| |
| bool | setOrder (int order) |
| | Method is used to specify the rendering order of the object.
|
| |
| 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.
|
| |
Represents a polygon object on the location view.
Referenced from LocationWindow.
Definition at line 24 of file polygon_map_object.dart.
◆ 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:
Map<String, dynamic> retrievedData = _circleMapObject!.data;
print("Circle custom data: $retrievedData");
◆ getId()
Gets the unique identifier of the map object.
- Returns
- The unique identifier of the map object.
Dart code snippet:
int objectId = _circleMapObject!.id;
print("Circle object ID: $objectId");
◆ getType()
Gets the type of the map object.
- Returns
- The type of the map object MapObjectType.
Dart code snippet:
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:
bool alphaSuccess = _circleMapObject!.setAlpha(0.7);
print("Set circle alpha to 0.7: $alphaSuccess");
◆ setColor()
| bool PolygonMapObject.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:
bool colorSuccess = _polygonMapObject!.setColor(0.0, 1.0, 0.0, 0.7);
print("Set polygon color to green with 70% 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:
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:
bool interactiveSuccess = _circleMapObject!.setInteractive(true);
print("Set circle interactive to true: $interactiveSuccess");
◆ setOrder()
| bool PolygonMapObject.setOrder |
( |
int | order | ) |
|
Method is used to specify the rendering order of the object.
- Parameters
-
| order | The rendering order value. Default: 0. |
- Returns
- true if success, false otherwise.
Dart code snippet:
bool orderSuccess = _polygonMapObject!.setOrder(2);
print("Set polygon rendering order to 2: $orderSuccess");
◆ setPolygon()
Method is used to specify the source polygon of the object.
- Parameters
-
- Returns
- true if success, false otherwise.
Dart code snippet:
List<LocationPoint> points = [
LocationPoint(100.0, 200.0),
LocationPoint(150.0, 250.0),
LocationPoint(200.0, 200.0),
LocationPoint(150.0, 150.0),
];
LocationPolygon polygon = LocationPolygon(points);
bool success = _polygonMapObject!.setPolygon(polygon);
print("Set polygon with ${points.length} points: $success");
◆ 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:
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:
bool visibleSuccess = _circleMapObject!.setVisible(true);
print("Set circle visibility to true: $visibleSuccess");
The documentation for this class was generated from the following file: