Home > @magiclane/maps-sdk > GemView > cursorSelectionOverlayItemsByType

GemView.cursorSelectionOverlayItemsByType() method

Retrieve the list of overlay items under the cursor location filtered by overlay type.

Use setCursorScreenPosition to set the cursor location.

Signature:

cursorSelectionOverlayItemsByType(overlayId: CommonOverlayId): OverlayItem[];

Parameters

Parameter

Type

Description

overlayId

CommonOverlayId

The overlay id to filter the overlay items.

Returns:

OverlayItem[]

A list of OverlayItem objects under the cursor filtered by the given overlay type. If no overlay items are found, the list will be empty.

Exceptions

An exception if it fails.