Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MappedinPolygon

The MappedinPolygon class represents the 3D shape of a MappedinLocation on a {MappedinMap. Polygons have access to Locations they belong to, and any entrances to the Polygon.

A Polygon can have more properties but usually the default is sufficient. The Mappedin'things' object is where you would specify what properties you want to download for Polygons. 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.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Optional canvasBounds

canvasBounds?: { align: string; maxHeight: number; maxWidth: number; rotation: number; x: number; y: number }

Type declaration

  • align: string
  • maxHeight: number
  • maxWidth: number
  • rotation: number
  • x: number
  • y: number

Optional externalId

externalId?: string

geometry

geometry: any

Optional holes

holes?: unknown[]

id

id: string

Node ID.

property

id {string}

Optional image

image?: { fitToBounds: boolean; original: string | Blob; position: { x: number; y: number; z: number }; rotation: { x: number; y: number; z: number }; scale: { x: number; y: number }; url: string | Blob; useLocalScaling: boolean; viewBox: { height: number; width: number }; visible: boolean }

Type declaration

  • fitToBounds: boolean
  • original: string | Blob
  • position: { x: number; y: number; z: number }
    • x: number
    • y: number
    • z: number
  • rotation: { x: number; y: number; z: number }
    • x: number
    • y: number
    • z: number
  • scale: { x: number; y: number }
    • x: number
    • y: number
  • url: string | Blob
  • useLocalScaling: boolean
  • viewBox: { height: number; width: number }
    • height: number
    • width: number
  • visible: boolean

Optional label

label?: { align: string; color: string; fontFamily: string; fontSize: number; position: { x: number; y: number; z: number }; rotation: { x: number; y: number; z: number }; text: string; visible: boolean }

Type declaration

  • align: string
  • color: string
  • fontFamily: string
  • fontSize: number
  • position: { x: number; y: number; z: number }
    • x: number
    • y: number
    • z: number
  • rotation: { x: number; y: number; z: number }
    • x: number
    • y: number
    • z: number
  • text: string
  • visible: boolean

Optional layer

layer?: string

Optional layerId

layerId?: string

map

map: string

ID of Map that Polygon is located on.

property

map {string}

material

material: { color: string; opacity?: number }

Type declaration

  • color: string
  • Optional opacity?: number

Optional name

name?: string

Optional textures

textures?: { image: any; name: "front" | "side"; useFrontFaceImage?: boolean }[]

Optional vertexes

vertexes?: { x: number; y: number }[]

Accessors

entrances

  • Polygon's entrance Nodes.

    property

    entrances {[MappedinNode]}

    Returns MappedinNode[]

  • Polygon's entrance Nodes.

    property

    entrances {[MappedinNode]}

    Parameters

    Returns void

locations

  • Locations attached to the Polygon.

    property

    locations {[MappedinLocation]}

    Returns MappedinLocation[]

rank

  • get rank(): null | { node: string; score: number }

  • Ranking for this polygon.

    Returns null | { node: string; score: number }

Methods

directionsTo

directionsToCallback

distanceTo

toJSON

  • toJSON(): any

  • Returns any

Static fetch

Static hydrate