OverlayItem class
Represents a single item from an overlay dataset.
An OverlayItem models a single POI-like entity exposed by an overlay. It exposes identifiers, coordinates, display image/name and preview data which may be downloaded on demand. This class is provided by the SDK and should not be constructed directly by consumers.
See also:
- OverlayInfo - Parent overlay metadata for this item.
- OverlayCategory - Category information for this item.
- GemMapController.registerOnCursorSelectionUpdatedOverlayItems - Method to receive overlay items at the map cursor position.
Properties
- categoryId → int
-
Category identifier for this overlay item.
no setter
- coordinates → Coordinates
-
Item coordinates on the map.
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasPreviewExtendedData → bool
-
Whether this item supports preview extended data (downloadable dynamic data).
no setter
- hasRegisteredAutoReleaseObject ↔ bool
-
getter/setter pairinherited
- image → Uint8List
-
Deprecated image accessor. Use getImage or img instead.
no setter
- img → Img
-
Get the image as a Img.
no setter
- name → String
-
Item display name.
no setter
- overlayInfo → OverlayInfo?
-
Parent overlay metadata for this item.
no setter
- overlayUid → int
-
Parent overlay UID for this item.
no setter
- pointerId → int
-
The pointer ID of the native object
no setterinherited
- previewData → OverlayItemParameters?
-
Typed preview data for the overlay item, when available.
no setter
- previewDataJson → Map
-
Preview data as a JSON-compatible map.
no setter
- previewDataParameterList → SearchableParameterList
-
Raw preview data represented as a SearchableParameterList.
no setter
- previewUrl → String
-
Optional web preview URL for the item.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- uid → int
-
Unique identifier of the item within its parent overlay.
no setter
Methods
-
cancelGetPreviewExtendedData(
ProgressListener listener) → void - Cancel a running preview-extended-data request started with getPreviewExtendedData.
-
dispose(
) → void -
Disposes the native object.
inherited
-
getImage(
{Size? size, ImageFileFormat? format}) → Uint8List? - Obtain the overlay item's image bytes in a specific size/format.
-
getPreviewExtendedData(
void onComplete(GemError error, SearchableParameterList? parameters)) → ProgressListener? - Asynchronously retrieve the preview extended data for this item.
-
getPreviewParametersAs<
T extends OverlayItemParameters> () → T? - Convenience typed accessor for previewData.
-
getPTStopInfo(
) → Future< PTStopInfo?> - Retrieve public-transport stop details when available.
-
isOfType(
CommonOverlayId overlayId) → bool - Check whether this item belongs to the specified predefined overlay type.
-
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
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited