activateHighlightOverlayItems method

void activateHighlightOverlayItems(
  1. List<OverlayItem> overlayItems, {
  2. HighlightRenderSettings? renderSettings,
  3. int highlightId = 0,
})

Activate highlight

Parameters

  • IN overlayItems The overlay items to be highlighted
  • IN renderSettings Specifies the way the provided items are displayed on the map
  • IN highlightId The highlighted collection id (optional). If a highlighted collection with this id already exists, it will be replaced

Highlighted collections will be displayed in ascending order sorted by highlightId

Throws

  • An exception if it fails.

Implementation

void activateHighlightOverlayItems(
  final List<OverlayItem> overlayItems, {
  final HighlightRenderSettings? renderSettings,
  final int highlightId = 0,
}) {
  final OverlayItemList landmarkList = OverlayItemList.fromList(overlayItems);

  objectMethod(
    _pointerId,
    'MapView',
    'activateHighlightOverlayItems',
    args: <String, dynamic>{
      'landmarks': landmarkList.pointerId,
      if (renderSettings != null) 'renderSettings': renderSettings.toJson(),
      'highlightId': highlightId,
    },
  );
}