Home > @magiclane/maps-sdk > MapViewExtensions > getHighlightGroupItemIndex

MapViewExtensions.getHighlightGroupItemIndex() method

Get group highlighted item index for the given highlighted item index (in original list)

Signature:

getHighlightGroupItemIndex(idx: number, highlightId?: number): number;

Parameters

Parameter

Type

Description

idx

number

The highlighted item index in original list for which the group head is searched.

highlightId

number

(Optional) The highlight collection id (optional).

Returns:

number

On success, returns the group index in highlighted items original list. On error, returns the error code.

Exceptions

An exception if it fails.