Class Mappedin

constructor

• new Mappedin(options): Mappedin

• Parameters

  • options: TGetVenueOptionsInternal & TGetVenueOptions

  Returns Mappedin

  Deprecated

  Use hydrateVenue instead

analytics

categories

currentLanguage

events

Optional imageBinaries

images

locationStates

locations

mapGroups

maps

nodes

options

perspective

polygons

Optional rankings

scenes

themes

things

Optional updatedAt

venue

vortexes

changeLanguage

• changeLanguage(languageCode, cache?): Promise<void>

• Change the language of the venue. This will trigger a re-fetch of the venue data and emit a {GET_VENUE_EVENT.LANGUAGE_CHANGED} event.

  Parameters

  • languageCode: string

    The language code to change to

  • Optional cache: boolean

    Whether or not to cache the current language so it doesn't need to be re-fetched

  Returns Promise<void>

fetch

• fetch(): Promise<void>

• Returns Promise<void>

getCollectionItemById

• getCollectionItemById<T, I>(name, id): null | TAccessors[T]

• Type Parameters

  • T extends keyof TAccessors

  • I extends string

  Parameters

  • name: T

  • id: I

  Returns null | TAccessors[T]

hydrate

• hydrate(mappedinSerializableData, shouldPopulateBundledImagesAsBlobs?): Promise<undefined>
• Experimental

  Hydrate the Mappedin instance using a response from either Mappedin.toString, getVenueBundle or by downloading the bundle manually

  Parameters

  • mappedinSerializableData: string | Record<string, unknown>

    Mappedin data that was serialized or exported as JSON

  • Optional shouldPopulateBundledImagesAsBlobs: boolean

    Takes the scenes and images from a bundle and maps them as blobs to where they exist as URLs in the bundle. False by default

  Returns Promise<undefined>

toJSON

• toJSON(): any

• Export venue data to JSON (for storage, encryption, etc)

  Returns any

toString

• toString(): string

• Export venue data to String

  Returns string