Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Mappedin

Hierarchy

  • Mappedin

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private #cache

#cache: MappedinCache

Private #data

#data: string = ''

analytics

analytics: Analytics

categories

categories: MappedinCategory[] = []

events

events: MappedinEvent[] = []

Optional imageBinaries

imageBinaries?: Map<string, Uint8Array>

images

images: any

locationRankings

locationRankings: MappedinLocationRankings[] = []
deprecated

use polygonRankings instead TODO: remove when we know that nobody is using this

locationStates

locationStates: MappedinLocationState[] = []

locations

locations: MappedinLocation[] = []

mapGroups

mapGroups: MappedinMapGroup[] = []

maps

maps: MappedinMap[] = []

nodes

nodes: MappedinNode[] = []

options

options: any

perspective

perspective: any

polygons

polygons: MappedinPolygon[] = []

Optional rankings

rankings?: MappedinRankings

scenes

scenes: any

themes

themes: MappedinTheme[] = []

things

things: any

Optional updatedAt

updatedAt?: string

venue

venue: MappedinVenue = ...

vortexes

vortexes: MappedinVortex[] = []

Methods

fetch

  • fetch(): Promise<void>

  • Returns Promise<void>

Private generateGetters

  • generateGetters(names: ("locations" | "nodes" | "polygons" | "categories" | "vortexes" | "maps" | "venue" | "events" | "mapGroups" | "themes" | "locationStates" | "locationRankings" | "rankings")[]): Mappedin

  • Parameters

    • names: ("locations" | "nodes" | "polygons" | "categories" | "vortexes" | "maps" | "venue" | "events" | "mapGroups" | "themes" | "locationStates" | "locationRankings" | "rankings")[]

    Returns Mappedin

getCollectionItemById

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

  • Type Parameters

    • T extends keyof TAccessors

    • I extends string

    Parameters

    • name: T
    • id: I

    Returns null | TAccessors[T]

hydrate

  • hydrate(mappedinSerializableData: string | object, shouldPopulateBundledImagesAsBlobs?: boolean): Promise<undefined>

  • [experimental] Hydrate the Mappedin instance using a response from either {@link IMappedin.toString()}, getVenueBundle or by downloading the bundle manually

    Parameters

    • mappedinSerializableData: string | object

      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>

Private initNavigator

  • initNavigator(): void

  • Returns void

toJSON

  • toJSON(): any

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

    Returns any

toString

  • toString(): string

  • Export venue data to String

    Returns string