OverlayService class abstract
Service-level APIs to discover and manage overlays.
OverlayService exposes static helpers for retrieving available overlays, enabling/disabling overlays or categories, and managing offline overlay data grabbers.
See also:
- OverlayInfo - Information about a single overlay dataset.
- OverlayCollection - A collection of available overlay datasets.
Constructors
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
-
cancelGrabOverlayOfflineData(
int uid) → void - Cancel a previously started offline overlay data grab operation for the specified overlay UID.
-
disableOverlay(
int uid, {int categUid = -1}) → GemError - Disable an overlay (or a single category) globally.
-
disableOverlayOfflineDataGrabber(
int uid) → GemError - Disable the offline data grabber for the specified overlay UID.
-
enableOverlay(
int uid, {int categUid = -1}) → GemError - Enable an overlay (or a single category) globally.
-
enableOverlayOfflineDataGrabber(
int uid) → GemError - Enable the offline data grabber for an overlay UID.
-
getAvailableOverlays(
{void onCompleteDownload(GemError error)?}) → (OverlayCollection, bool) - Retrieve overlays available for the current map style.
-
grabOverlayOfflineData(
{required int uid, required void onComplete(GemError error)}) → TaskHandler? - Start grabbing (downloading) the latest offline overlay data for all existing offline map areas.
-
isOverlayEnabled(
int uid, {int categUid = -1}) → bool - Check whether an overlay (or a category) is currently enabled.
-
isOverlayOfflineDataGrabberEnabled(
int uid) → bool - Return whether the offline data grabber is enabled for an overlay.
-
isOverlayOfflineDataGrabberSupported(
int uid) → bool - Check whether an overlay UID supports the offline data grabber feature.