overlays property

OverlayMutableCollection get overlays

Mutable collection of overlays considered during search.

Provides access to the set of overlays that are included in search operations. Can be customized to add specific OverlayInfo instances, allowing the search to work on custom datasets.

Requires the existence of a GemMap instance to function correctly with a style containing overlays applied.

Returns

Implementation

OverlayMutableCollection get overlays {
  final OperationResult resultString = objectMethod(
    pointerId,
    'SearchPreferences',
    'overlays',
  );

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