Options
All
  • Public
  • Public/Protected
  • All
Menu

A MappedinMap belonging to a specific MappedinVenue. Typically represents a certain floor. Give this to a MiMapView to display to the user.

A Map can have more properties such as 'elevation', 'name' (e.g. Level 1), and 'shortName' (e.g. L1). The elevation property can be used to determine the order of the floors (first, second, etc). Elevation is 0 based, going up and down in integers representing the number of floors above or below 0, which is ground level.

The Mappedin 'things' object is where you would specify what properties you want to download for Maps. 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 Map properties specified:

things: {
    venue: [],
    locations: [],
    categories: [],
    maps: ['name', 'elevation', 'shortName']
}

Hierarchy

  • MappedinMap

Index

Constructors

constructor

Properties

Private #private

#private: any

_scale

_scale: number

Optional elevation

elevation: number

Optional georeference

georeference: TGeoReference[]

group

group: string

id

id: string

name

name: string

Optional scale

scale: number

shortName

shortName: string

Optional x_scale

x_scale: number

Accessors

mapGroup

  • Map Group this map belongs to.

    property

    mapGroup {MappedinMapGroup}

    Returns null | MappedinMapGroup

polygons

  • Polygons on this Map.

    property

    polygons {[MappedinPolygon]}

    Returns undefined | MappedinPolygon[]

Methods

toJSON

  • toJSON(): any
  • Returns any

Static fetch

  • fetch(mappedin: Mappedin): Promise<any>
  • Parameters

    Returns Promise<any>

Static hydrate

  • hydrate(maps: any, mappedin: Mappedin): any
  • Parameters

    Returns any