Options
All
  • Public
  • Public/Protected
  • All
Menu

A MappedinLocation is something like a store or washroom on a MappedinMap. It has an ID and will be linked to zero or more MappedinNodes and MappedinPolygons.

A Location's Nodes and Polygons can be on multiple Maps, or in multiple non-adjacent places on the same Map. For example, all washroom at a given Venue could belong to one Location, or a department store could live on multiple floors. A Washroom Location might a have a few Polygons spread throughout the Venue for each one that exists, but a single store might just have one presence, and therefore one Polygon. Some Locations just have a single point and only have Nodes.

A Location can have more properties (typically things like 'name', 'externalId', 'type', 'categories', 'description', 'logo', etc).

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

things: {
    venue: [],
    locations: ['venue', 'name', 'type', 'icon', 'logo', 'language', 'externalId', 'description', 'categories', 'phone', 'operationHours', 'social', 'tags', 'parents', 'sortOrder'],
    categories: [],
    maps: []
}

Hierarchy

  • MappedinNavigatable
    • MappedinLocation

Index

Constructors

constructor

Properties

Private #private

#private: any

Private #private

#private: any

categories

categories: (undefined | string)[]

Optional color

color: TColor

Optional description

description: string

Optional detailsUrl

detailsUrl: string

Optional externalId

externalId: string

Optional gallery

gallery: TGalleryImage[]

id

id: string

Optional logo

logo: TImage

name

name: string

Optional operationHours

operationHours: TOpeningHours[]

Optional phone

phone: TPhone

Optional picture

picture: TPicture

Optional shortName

shortName: string

Optional siblingGroups

siblingGroups: TSiblingGroup[]

Optional social

social: TSocial

Optional sortOrder

sortOrder: number

states

states: undefined | TState[]

Optional tags

tags: string[]

type

type: string

Accessors

nodeOperationHours

  • get nodeOperationHours(): TOperationHoursMap
  • Returns TOperationHoursMap

nodes

  • Nodes this Location is attached to.

    property

    nodes

    Returns undefined | MappedinNode[]

  • Nodes this Location is attached to.

    Parameters

    Returns any

parent

  • Parent of this Location, if any. Used in cases where one Location is inside another, more "important" Location.

    property

    parent

    Returns undefined | MappedinLocation

  • Parent of this Location, if any. Used in cases where one Location is inside another, more "important" Location.

    Parameters

    Returns any

polygons

  • Polygons this Location is attached to.

    property

    polygons

    Returns MappedinPolygon[]

  • Polygons this Location is attached to.

    Parameters

    Returns any

rank

  • get rank(): null | number
  • Ranking for this location.

    Returns null | number

state

  • get state(): undefined | MappedinLocationState
  • Returns undefined | MappedinLocationState

Methods

clone

directionsTo

directionsToCallback

distanceTo

  • Calculate distance between 2 nodes, polygons or locations

    Parameters

    • destination: MappedinLocation | MappedinPolygon | MappedinNode
    • options: TDirectionToOptions
    • Optional cb: (error: any, distance: number) => void
        • (error: any, distance: number): void
        • Parameters

          • error: any
          • distance: number

          Returns void

    Returns number

toJSON

  • toJSON(): any
  • Returns any

Static fetch

Static hydrate