Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Mappedin

Index

Constructors

Properties

#cache: {} = {}

Type declaration

    #data: string = ''
    categories: MappedinCategory[] = []
    events: MappedinEvent[] = []
    images: any
    locationRankings: MappedinLocationRankings[] = []
    deprecated

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

    locationStates: MappedinLocationState[] = []
    locations: MappedinLocation[] = []
    mapGroups: MappedinMapGroup[] = []
    maps: MappedinMap[] = []
    nodes: MappedinNode[] = []
    options: any
    perspective: any
    polygons: MappedinPolygon[] = []
    rankings?: MappedinRankings
    scenes: any
    themes: MappedinTheme[] = []
    things: any
    updatedAt?: string
    venue: MappedinVenue = ...
    vortexes: MappedinVortex[] = []

    Methods

    • fetch(): Promise<void>
    • Returns Promise<void>

    • 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<T, I>(name: T, id: I): null | TAccessors[T]
    • Type parameters

      • T: keyof TAccessors

      • I: string

      Parameters

      • name: T
      • id: I

      Returns null | TAccessors[T]

    • 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>

    • initNavigator(): void
    • Returns void

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

      Returns any

    • toString(): string
    • Export venue data to String

      Returns string