overlays property

OverlayMutableCollection get overlays

Collection of overlays to monitor for proximity alarms.

Add overlay IDs (such as CommonOverlayId.socialReports or CommonOverlayId.safety) to this collection to enable proximity alarms for overlay items. Overlay categories can also be added individually for finer control.

A GemMap must be active for overlay alarms to function correctly. Also, a map style containing the specified overlays must be loaded.

Returns

• OverlayMutableCollection: The collection managing monitored overlays.

Implementation

OverlayMutableCollection get overlays {
  final OperationResult result = objectMethod(
    _pointerId,
    'AlarmService',
    'overlays',
  );

  return OverlayMutableCollection.init(result['result']);
}