LandmarkStoreCollection - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > LandmarkStoreCollection

LandmarkStoreCollection class

Landmark store collection class

This class should not be instantiated directly. Instead, use the [MapViewPreferences.lmks] getter to obtain an instance.

Places

Signature:

export declare class LandmarkStoreCollection extends GemAutoreleaseObject

Extends: GemAutoreleaseObject

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the LandmarkStoreCollection class.

Properties

Property	Modifiers	Type	Description
mapId	`readonly`	number
pointerId	`readonly`	number \| bigint
size	`readonly`	number	Get the number of stores in the list.

Methods

Method	Modifiers	Description
add(lms)		Add all categories from the specified store.
addAllStoreCategories(storeId)		Add all categories from the specified store ID.
addStoreCategoryId(storeId, categoryId)		Add a new category ID into the specified store list.
addStoreCategoryList(storeId, categories)		Add a list of categories into the specified store list.
clear()		Remove all stores and categories.
contains(storeId, categoryId)		Check if the specified category ID from the specified store ID was already added.
containsLandmarkStore(lms)		Check if the specified store has any category in the list.
containsStoreId(storeId)		Check if the specified store ID has any category in the list.
getCategoryCount(storeId)		Get the number of categories enabled for the specified store.
getStoreCategoryId(storeId, indexCategory)		Get the specified category ID for the specified store.
getStoreIdAt(index)		Get the store ID for the specified index.
remove(lms)		Remove all categories of the specified store.
removeAllStoreCategories(storeId)		Remove all categories of the specified store ID.
removeStoreCategoryId(storeId, categoryId)		Remove category ID from the specified store list.