Landmark class Places
Represents a predefined, permanent location with rich metadata.
A landmark contains structured information about a place such as its name, address, description, geographic area (centroid and full boundary), categories (for example Gas Station or Shopping), entrance locations, contact details, and optional media (icons or images). Landmarks are used throughout the SDK for display, search, routing, and alarms.
Use cases
- Displaying points of interest on maps.
- Searching for nearby services or attractions.
- Routing based on specific landmarks.
See also:
- LandmarkStore — for creating and managing collections of landmarks.
- LandmarkCategory — for the categories used to classify landmarks.
Constructors
- Landmark.new()
-
factory
- Landmark.withCoordinates(Coordinates coordinates)
-
Creates a landmark from an existing Coordinates object.
factory
- Landmark.withLatLng({required double latitude, required double longitude})
-
Creates a landmark tied to specific geographic coordinates.
factory
Properties
- address ↔ AddressInfo
-
Retrieves the address information for this landmark.
getter/setter pair
-
Retrieves the author or creator of this landmark's information.
getter/setter pair
-
categories
→ List<
LandmarkCategory> -
Returns the categories assigned to this landmark.
no setter
- contactInfo ↔ ContactInfo
-
Retrieves contact information for this landmark.
getter/setter pair
- coordinates ↔ Coordinates
-
Retrieves the centroid coordinates of this landmark.
getter/setter pair
- description ↔ String
-
Retrieves the description text for this landmark.
getter/setter pair
- entrances → EntranceLocations
-
Retrieves the entrance locations for this landmark.
no setter
- extraImg ↔ Img
-
Get the extra image as a Img.
getter/setter pair
- extraInfo ↔ ExtraInfo
-
Retrieves additional metadata associated with this landmark.
getter/setter pair
- geographicArea ↔ GeographicArea
-
Retrieves the geographic area that represents the landmark's spatial extent.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasTrackData → bool
-
Checks if this landmark contains waypoint track data.
no setter
- id → int
-
Returns the landmark's unique identifier within its landmark store.
no setter
- imageUid → int
-
Retrieves the unique identifier for the landmark's primary image.
no setter
- img ↔ Img
-
Get the image as a Img.
getter/setter pair
- landmarkStoreId → int
-
Returns the ID of the landmark store that contains this landmark.
no setter
- landmarkStoreType → int
-
Returns the type code of the landmark store this landmark belongs to.
no setter
- name ↔ String
-
Retrieves the display name of this landmark.
getter/setter pair
- overlayItem → OverlayItem?
-
Retrieves the overlay item associated with this landmark.
no setter
- pointerId → int
-
The pointer ID of the native object
no setterinherited
- providerId ↔ int
-
Returns the provider identifier for this landmark's data source.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- timeStamp ↔ DateTime
-
Returns the timestamp when this landmark was created or last updated.
getter/setter pair
- trackData ↔ Path
-
Retrieves the waypoint track data for this landmark.
getter/setter pair
Methods
-
addExtraInfo(
String info) → void - Appends an extra information entry to the landmark's metadata.
-
detachFromStore(
) → void - Detaches this landmark from its associated landmark store.
-
dispose(
) → void -
Disposes the native object.
inherited
-
findExtraInfo(
String startStr) → String -
Finds the first extra info entry that begins with
startStr. -
getContourGeographicArea(
{bool relevantOnly = true}) → RectangleGeographicArea - Retrieves the contour geographic bounding rectangle for this landmark.
-
getExtraImage(
{Size? size, ImageFileFormat? format}) → Uint8List? - Retrieves the landmark's secondary (extra) image as raw bytes.
-
getImage(
{Size? size, ImageFileFormat? format}) → Uint8List? - Retrieves the primary (main) image for this landmark as raw bytes.
-
getJson(
int landmarkImageWidth, int landmarkImageHeight) → Map< String, dynamic> - Serializes this instance to a JSON-compatible map.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerAutoReleaseObject(
int pointerId) → void -
Registers an object for auto release.
inherited
-
reverseTrackData(
) → void - Reverses the sequence of points in the waypoint track data.
-
setExtraImage(
{required Uint8List imageData, required ImageFileFormat format}) → void - Sets the extra image for this landmark from raw image data.
-
setImage(
{required Uint8List imageData, ImageFileFormat format = ImageFileFormat.png}) → void - Sets the primary image for this landmark from raw image data.
-
setImageFromIcon(
GemIcon icon) → void - Sets the primary image for this landmark from a predefined icon.
-
setTrackDataDepartureAndDestination(
Coordinates departure, Coordinates destination) → void - Truncates the track data between specified departure and destination coordinates.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited