LandmarkBrowseSession - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > LandmarkBrowseSession

LandmarkBrowseSession class

Represents a session for browsing landmarks in a store.

This class should not be instantiated directly. Instead, use the LandmarkStore.createLandmarkBrowseSession method to obtain an instance.

Places

Signature:

export declare class LandmarkBrowseSession 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 LandmarkBrowseSession class.

Properties

Property	Modifiers	Type	Description
id	`readonly`	number	Get the session id
landmarkCount	`readonly`	number	Get the number of landmarks in the session
landmarkStoreId	`readonly`	number	Get the landmark store id
pointerId	`readonly`	any
settings	`readonly`	LandmarkBrowseSessionSettings	Get the browse session settings Modifying the returned object will have no effect on the session

Methods

Method	Modifiers	Description
getLandmarkPosition(landmarkId)		Get the position of the landmark with the specified Landmark.id The position is 0 based
getLandmarks(start, end)		Get the landmarks in the session between the specified start and end index: [start, end)

Method

Modifiers

Description

getLandmarkPosition(landmarkId)

Get the position of the landmark with the specified Landmark.id

The position is 0 based

getLandmarks(start, end)

Get the landmarks in the session between the specified start and end index: [start, end)