Home > @magiclane/maps-sdk > LandmarkStore > getLandmarks

LandmarkStore.getLandmarks() method

Get the landmarks within the specified category.

Signature:

getLandmarks(categoryId?: number): Landmark[];

Parameters

Parameter

Type

Description

categoryId

number

(Optional) The category id for which landmarks are retrieved (default LandmarkCategory.invalidLandmarkCategId, meaning all categories). If the category ID is LandmarkCategory.uncategorizedLandmarkCategId, all uncategorized landmarks are retrieved. If the category ID is LandmarkCategory.invalidLandmarkCategId, all landmarks are retrieved.

Returns:

Landmark[]

The landmark list.

Exceptions

An exception if it fails.