LandmarkStoreService - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > LandmarkStoreService

LandmarkStoreService class

Landmark store service

A static service providing high-level management for landmark store lifecycle and discovery. It is the central entry point for creating or registering stores, looking up existing stores, removing stores, enumerating all available stores and obtaining built-in store identifiers used by the map.

Main capabilities include store creation/registration and lookup, retrieval of special-purpose store identifiers used by the SDK, enumeration of available stores. Common tasks are creating or importing a store, resolving a store to use for imports or queries, removing an unused store, listing store and adding/removing event listeners to react to store lifecycle changes.

Places

Signature:

export declare abstract class LandmarkStoreService

Properties

Property	Modifiers	Type	Description
geofenceLandmarkStoreId	`static` `readonly`	number	Get LandmarkStore id attached to geofence database. The result Id cannot be used with getLandmarkStoreById
landmarkStores	`static` `readonly`	LandmarkStore[]	Get all landmark stores.
mapAddressLandmarkStoreId	`static` `readonly`	number	Get Map Address landmarkstore id attached to map address database information. The result Id cannot be used with getLandmarkStoreById
mapCitiesLandmarkStoreId	`static` `readonly`	number	Get Map Cities landmarkstore id attached to map address database information. The result Id cannot be used with getLandmarkStoreById
mapPoisLandmarkStoreId	`static` `readonly`	number	Get Map POIs landmarkstore id.
mapRoadsLandmarkStoreId	`static` `readonly`	number	Get LandmarkStore id attached to map roads database information. The result Id cannot be used with getLandmarkStoreById
overlaysLandmarkStoreId	`static` `readonly`	number	Get LandmarkStore id attached to overlays database. The result Id cannot be used with getLandmarkStoreById

Methods

Method	Modifiers	Description
addListener(listener)	`static`	Add new listener for landmark store events.
createLandmarkStore(name, { zoom, folder }, input)	`static`	Create a new landmark store. The landmark store type for all stores created with this function is LandmarkStoreType.defaultType
getLandmarkStoreById(landmarkStoreId)	`static`	Get landmark store by ID.
getLandmarkStoreByName(name)	`static`	Get landmark store by name.
getLandmarkStoreType(landmarkStoreId)	`static`	Get the type of the landmark store
registerLandmarkStore({ name, path }, input)	`static`	Register an already existing landmark store. The name parameter will override the landmark store internal creation name. This allows registering landmark stores in order to import data from them
removeLandmarkStore(landmarkStoreId)	`static`	Remove the landmark store specified by ID. The landmark store should be disposed before calling this method. Dispose the landmark store using LandmarkStore.dispose. The landmarks store will not be removed unless the object is disposed. The method does not work if the landmark store is in use.
removeListener(listener)	`static`	Remove listener for landmark store events.