@mapsindoors/react-native-maps-indoors-google-maps
    Preparing search index...

    Class MPLocation

    A MapsIndoors geographical entity. A location can exist anywhere, but it is usually only used inside MPVenues and MPBuildings.

    MPLocation

    Hierarchy (View Summary)

    Index

    Properties

    geometry? id restrictions type

    Accessors

    activeFrom activeTo aliases baseType buildingName categories description externalId floorIndex floorName imageUrl isPoint name position selectable typeName venueName

    Methods

    getProperty isBookable toJson create

    Properties

    geometry?: MPGeometry

    The geometry of the location.

    id: string

    The location's ID.

    restrictions: string[]

    An array of restrictions placed on the location.

    type: string

    The type of the entity (eg. MPLocation).

    Accessors

    • get activeFrom(): number

      Get the time location is active from.

      Returns number

    • get activeTo(): number

      Get the time location is active to.

      Returns number

    • get aliases(): string[]

      Get the location's aliases.

      Returns string[]

    • get buildingName(): string

      Get the name of the building the location is in.

      Returns string

    • get categories(): string[]

      Get the location's categories.

      Returns string[]

    • get description(): string

      Get the location's description.

      Returns string

    • get externalId(): string

      Get the location's external identifier.

      Returns string

    • get floorIndex(): number

      Get the location's floorIndex.

      Returns number

    • get floorName(): string

      Get the name of the floor the location is on.

      Returns string

    • get imageUrl(): string

      Get the URL of the location's icon image.

      Returns string

    • get isPoint(): boolean

      Get whether this location's geometry is a MPPoint.

      Returns boolean

    • get name(): string

      Get the location's name.

      Returns string

    • get position(): MPPoint

      Get the location's position.

      Returns MPPoint

    • get selectable(): boolean

      Get the location's selectable flag.

      Returns boolean

    • set selectable(selectable: boolean): void

      Set the location's selectable flag.

      Parameters

      • selectable: boolean

      Returns void

    • get typeName(): string

      Get the location's type name.

      Returns string

    • get venueName(): string

      Get the name of the venue the location is on.

      Returns string

    Methods

    • Get whether the location is bookable.

      Returns boolean

    • Stringifies the entity.

      Returns string

    • Creator for MPLocation, used to decode JSON from the MapsIndoors SDK.

      Parameters

      • Optionalobject: any

      Returns MPLocation

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors
    Methods