A MappedinVenue is a specific place (like a mall) with one or more Maps (typically representing different floors) and Locations (stores, washrooms, elevators, etc).

A Venue can have more properties such as 'name' and 'slug'. The Mappedin 'things' object is where you would specify what properties you want to download for Venues. Only specify what you will actually use, to minmimze transfer time. Work with your Mappedin developer relations contact to set up any custom properties you need.

See below for an example a 'things' object with available Venue properties specified:

things: {
venue: ['slug', 'name', 'language', 'address', 'city', 'state', 'postal', 'telephone', 'latitude', 'longitude', 'website', 'operationHours'],
locations: [],
categories: [],
maps: []
}

Hierarchy

  • MappedinVenue

Constructors

Properties

address: string = ''
city: string = ''
countrycode: string = ''
defaultLanguage: {
    code: string;
    name: string;
}

Type declaration

  • code: string
  • name: string
defaultMap: string = ''
externalId: string = ''
id: string = ''
languages: {
    code: string;
    name: string;
}[] = []

Type declaration

  • code: string
  • name: string
latitude?: number
logo?: TImage
longitude?: number
name: string = ''
operationHours?: TOpeningHours[]
postal: string = ''
renderOptions: {
    simplifyDirections: boolean;
    useLivePolygons: boolean;
} = ...

Venue render options provided by the server.

Type declaration

  • simplifyDirections: boolean

    Whether the venue should automatically apply TDirectionToOptions simplify: { enabled: true } to all directions.

  • useLivePolygons: boolean

    Whether the venue should use perspectives to render the map or Mappedin.polygons.

secureContentStorage: boolean = false
slug: string = ''
state: string = ''
telephone: string = ''
topLocations?: string[] = []
tzid: string = ''
tzidOverride: string = ''
utcOffset: string = ''
website: string = ''

Accessors

  • get isMultiBuilding(): any
  • Returns any

  • get metadata(): any
  • Returns any

  • set metadata(value): void
  • Parameters

    • value: any

    Returns void

Methods

  • Returns any