Class MappedinVenue

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

constructor

Properties

address city countrycode defaultLanguage defaultMap externalId id languages latitude? logo? longitude? name operationHours? postal renderOptions secureContentStorage slug state telephone topLocations? tzid tzidOverride utcOffset website

Accessors

isMultiBuilding metadata

Methods

toJSON fetch hydrate

Constructors

constructor

Properties

address

address: string

city

city: string

countrycode

countrycode: string

defaultLanguage

defaultLanguage: {
    code: string;
    name: string;
}

Type declaration

  • code: string
  • name: string

defaultMap

defaultMap: string

externalId

externalId: string

id

id: string

languages

languages: {
    code: string;
    name: string;
}[]

Type declaration

  • code: string
  • name: string

Optional latitude

latitude?: number

Optional logo

logo?: TImage

Optional longitude

longitude?: number

name

name: string

Optional operationHours

operationHours?: TOpeningHours[]

postal

postal: string

renderOptions

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

secureContentStorage: boolean

slug

slug: string

state

state: string

telephone

telephone: string

Optional topLocations

topLocations?: string[]

tzid

tzid: string

tzidOverride

tzidOverride: string

utcOffset

utcOffset: string

website

website: string

Accessors

isMultiBuilding

  • get isMultiBuilding(): any

  • Returns any

metadata

  • get metadata(): any

  • Returns any

  • set metadata(value): void

  • Parameters

    • value: any

    Returns void

Methods

toJSON

  • Returns any

Static fetch

Static hydrate

Settings

Member Visibility

Theme

On This Page