OverlayService class Maps & 3D Scene

Overlay service class

Manages overlay datasets. It lets callers obtain the available overlays, enumerate or inspect overlay entries for UI lists or sync logic, enable or disable entire overlays or specific categories across registered consumers (map views, alarms, etc.), and check whether a given overlay or category is currently active. Typical uses are populating overlay pickers, toggling datasets from settings, and driving overlay-enabled render or alarm behavior.

Constructors

OverlayService.new()

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Methods

disableOverlay(int uid, {int categUid = -1}) GemError
Disables the overlay with the given uid. This will deactivate the overlay for all registered services ( map views, alarms, etc )
enableOverlay(int uid, {int categUid = -1}) GemError
Enables the overlay with the given uid. This will activate the overlay for all registered services ( map views, alarms, etc ).
getAvailableOverlays({void onCompleteDownload(GemError error)?}) → (OverlayCollection, bool)
Get a list of available SDK overlays.
isOverlayEnabled(int uid, {int categUid = -1}) bool
Check if the overlay with the given uid is enabled.