Class EnterpriseVenue

The EnterpriseVenue class holds metadata bout the map, which includes the map name, supported languages, default language, top locations and more. It can be accessed using the MapData.getByType method as shown below.

const venue = mapData.getByType('enterprise-venue');

Refer to the EnterpriseVenue Guide for more information.

Hierarchy

  • default
    • EnterpriseVenue

Implements

  • EnterpriseVenue

Properties

countrycode? coverImage? defaultFloor? defaultLanguage externalId extra? icon? id languages links logo? mappedinWebUrl? operationHours? slug topLocations? tzid?

Accessors

defaultMap name

Methods

toJSON is

Properties

Optionalcountrycode

countrycode?: string

The country code of the venue.

OptionalcoverImage

coverImage?: string

The venue's cover image.

Format

uri

OptionaldefaultFloor

defaultFloor?: string

The default floor of the venue.

defaultLanguage

defaultLanguage: Language = ...

The default language of the venue.

externalId

externalId: string = ''

The external ID of the venue.

Optionalextra

extra?: Record<string, unknown>

Extra properties of the venue.

Optionalicon

icon?: string

A URL to the icon of the venue.

Readonlyid

id: string

The identity of the map metadata.

languages

languages: Language[] = []

The languages supported by the venue.

links

links: Hyperlink[] = []

The links of the venue.

Optionallogo

logo?: string

A URL to the logo of the venue.

OptionalmappedinWebUrl

mappedinWebUrl?: string

A URL to a web page with Mappedin Web for this venue.

OptionaloperationHours

operationHours?: OperationHours[]

When this venue is open.

slug

slug: string = ''

The slug of the venue.

OptionaltopLocations

topLocations?: string[]

The top locations of the venue.

Optionaltzid

tzid?: string

The timezone ID of the venue.

Accessors

defaultMap

  • get defaultMap(): string

    Returns string

    Deprecated

    Use defaultFloor instead The default map of the venue.

name

  • get name(): string

    Gets the name of the EnterpriseVenue.

    Returns string

    The name of the EnterpriseVenue.

Methods

toJSON

  • toJSON(): { __type: string; id: string; name: string }

    Serializes the EnterpriseVenue data to JSON.

    Returns { __type: string; id: string; name: string }

    An object representing the EnterpriseVenue.

Staticis

  • is(instance: object): instance is EnterpriseVenue

    Checks if the provided instance is of type EnterpriseVenue.

    Parameters

    • instance: object

      The instance to check.

    Returns instance is EnterpriseVenue

    True if the instance is a EnterpriseVenue, false otherwise.

Settings

Member Visibility

On This Page

Properties
Accessors
Methods