Class MappedinMap

A MappedinMap belonging to a specific MappedinVenue. Typically represents a certain floor. Give this to a MapView 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

Constructors

constructor

Properties

_scale elevation georeference group height id layers name perspectiveId? scale? scene shortName subtitle? width x_scale?

Accessors

center locations mapGroup nodes polygons

Methods

createCoordinate getNorth toJSON fetch hydrate updateInPlace

Constructors

constructor

Properties

_scale

_scale: number = 0

elevation

elevation: number = 0

georeference

georeference: TGeoReference[] = []

group

group: string = ''

height

height: number = 0

id

id: string = ''

layers

layers: {
    id: string;
    name: string;
    visible: boolean;
}[]

Type declaration

  • id: string
  • name: string
  • visible: boolean

name

name: string = ''

Optional perspectiveId

perspectiveId?: string

Optional scale

scale?: number = 0

scene

scene: any

shortName

shortName: string = ''

Optional subtitle

subtitle?: string

width

width: number = 0

Optional x_scale

x_scale?: number

Accessors

center

locations

mapGroup

nodes

polygons

Methods

createCoordinate

  • Create coordinate using lat/lon

    Parameters

    • lat: number

      latitude of coordinate

    • lon: number

      longitude of coordinate

    Returns MappedinCoordinate

getNorth

  • Returns any

    map rotation in radians from north

toJSON

  • Returns any

Static fetch

Static hydrate

Static updateInPlace

  • Parameters

    • mappedin: Mappedin
    • Optional hydrateData: any

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page