EntranceLocations - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > EntranceLocations

EntranceLocations class

Stores locations & access types for entrances to landmarks.

This class should not be instantiated directly. Instead, use the Landmark.entrances getter to obtain an instance.

Signature:

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

Properties

Property	Modifiers	Type	Description
count	`readonly`	number	Get the entrances count.
id	`readonly`	number \| bigint
mapId	`readonly`	number

Methods

Method	Modifiers	Description
addEntranceLocation(coordinates, type)		Add new entrance location.
dispose()		Dispose the entrance locations object
getCoordinates(index)		Get the coordinates specified by index.
getType(index)		Get the entrance type specified by index.