enableOverlay static method

GemError enableOverlay(int uid, { int categUid = -1, })

Enable an overlay (or a single category) globally.

The operation affects all registered consumers such as map views and alarms.

Parameters

• uid: The overlay UID to enable.
• categUid: Optional category UID within the overlay. When set to -1 the whole overlay is enabled.

Returns

• GemError.success on success.
• GemError.notFound when the overlay (or category) was not found.

See also:

• OverlayInfo.uid - Retrieve the unique identifier of an overlay.
• OverlayCategory.uid - Retrieve the unique identifier of an overlay category.
• disableOverlay - Disable an overlay or category globally.
• isOverlayEnabled - Check whether an overlay or category is enabled.
• CommonOverlayId - Predefined common overlay identifiers.

Implementation

static GemError enableOverlay(final int uid, {final int categUid = -1}) {
  final OperationResult resultString = staticMethod(
    'OverlayService',
    'enableOverlay',
    args: <String, int>{'uid': uid, 'categUid': categUid},
  );

  return GemErrorExtension.fromCode(resultString['result']);
}