Class MPVenue

constructor

• new MPVenue(
      id: string,
      administrativeId: string,
      tilesUrl: string,
      mapStyles: MPMapStyle[],
      geometry: MPPolygon,
      defaultFloor: number,
      venueInfo: MPVenueInfo,
      anchor: MPPoint,
      entryPoints: MPPoint[],
      externalId?: string,
      graphId?: string,
  ): MPVenue

  Creates an instance of MPVenue.

  Parameters

  • id: string

    The venue's ID.
  • administrativeId: string

    The venue's readable ID.
  • tilesUrl: string

    The URL that is used to fetch tiles for the venue.
  • mapStyles: MPMapStyle[]

    An array of mapStyles that can be used on this venue.
  • geometry: MPPolygon

    The geometry of the venue.
  • defaultFloor: number

    The venue's defalt floor index.
  • venueInfo: MPVenueInfo

    A collection of information about the venue.
  • anchor: MPPoint

    The anchor point for the location.
  • entryPoints: MPPoint[]

    Points of entry that are used to create routes between MapsIndoors and the underlying map.
  • OptionalexternalId: string

    An optional ID used to map the venue to a customer's ID.
  • OptionalgraphId: string

    The ID of the graph used to route on this venue.

  Returns MPVenue

ReadonlyadministrativeId

Readonlyanchor

ReadonlydefaultFloor

ReadonlyentryPoints

ReadonlyexternalId

Readonlygeometry

Optional ReadonlygraphId

Readonlyid

ReadonlymapStyles

ReadonlytilesUrl

ReadonlyvenueInfo

bounds

• get bounds(): MPBounds

  Get the venue's bounds.

  Returns MPBounds

defaultMapStyle

• get defaultMapStyle(): MPMapStyle

  Get the venue's default mapstyle.

  Returns MPMapStyle

isPoint

• get isPoint(): boolean

  Inherited from MPEntity, a venue's geometry is never a MPPoint.

  Returns boolean

name

• get name(): string

  Get the venue's name.

  Returns string

position

• get position(): MPPoint

  Get the position of the venue, this will correspond to the venue's anchor point.

  Returns MPPoint

contains

• contains(point: MPPoint): Promise<boolean>

  Check whether the venue contains a point.

  Parameters

  • point: MPPoint

  Returns Promise<boolean>

  Async

getField

• getField(key?: string): MPDataField

  Fetch a field from the venue's info member.

  Parameters

  • Optionalkey: string

  Returns MPDataField

hasGraph

• hasGraph(): Promise<boolean>

  Check whether the venue has a valid routing graph.

  Returns Promise<boolean>

  Async

isMapStyleValid

• isMapStyleValid(style?: MPMapStyle): boolean

  Check whether a given mapstyle is valid for the venue.

  Parameters

  • Optionalstyle: MPMapStyle

  Returns boolean

toJSON

• toJSON(): MPVenueParams

  Parses the object to a JSON object that is compatible with the MapsIndoors SDK.

  Returns MPVenueParams

Staticcreate

• create(object: MPVenueParams): MPVenue

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

  Parameters

  • object: MPVenueParams

  Returns MPVenue

  Static