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

MappedinNavigatable
- MappedinPolygon

Index

Constructors

constructor

new MappedinPolygon(mappedin, data): MappedinPolygon
Parameters
- mappedin: Mappedin
- data: any
Returns MappedinPolygon

Overrides MappedinNavigatable.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` categoryRank

categoryRank?: number

Category grouped ranking determined by the MappedinCategory.sortOrder and rank for this polygon.

`Optional` externalId

externalId?: string

geometry

geometry: any

`Optional` holes

holes?: unknown[]

id

id: string

Node ID.

`Optional` image

image?: {
    _isAbsolutelyPositioned?: boolean;
    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

Optional _isAbsolutelyPositioned?: boolean
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

material

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

Type declaration

color: string
Optional opacity?: number

`Optional` name

name?: string

`Optional` perspectives

perspectives?: any

`Optional` textures

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

Type declaration

image: any
name: "front" | "side"
Optional useFrontFaceImage?: boolean

`Optional` vertexes

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

Type declaration

x: number
y: number

Accessors

entrances

get entrances(): MappedinNode[]
Polygon's entrance Nodes.

Returns MappedinNode[]
set entrances(entrances): void
Parameters
- entrances: MappedinNode[]
Returns void

locations

get locations(): MappedinLocation[]
Locations attached to the Polygon.

Returns MappedinLocation[]

map

get map(): MappedinMap
Map Object that this Polygon is located on.

Returns MappedinMap

rank

get rank(): null | {
node: string;
score: number;
}
Ranking for this polygon.

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

Methods

directionsTo

directionsTo(destination, options?): MappedinDirections
Get Directions to a node, polygon, or location
Parameters
- destination: MappedinNode | MappedinPolygon | MappedinLocation
- Optional options: TDirectionToOptions
Returns MappedinDirections

Overrides MappedinNavigatable.directionsTo
directionsTo(destination, options?): MappedinDirections[]
Parameters
- destination: MappedinDestinationSet
- Optional options: TDirectionToOptions
Returns MappedinDirections[]

Overrides MappedinNavigatable.directionsTo

distanceTo

distanceTo(destination, options): number
Calculate distance between 2 nodes, polygons or locations
Parameters
- destination: any
- options: any
Returns number

Overrides MappedinNavigatable.distanceTo

toJSON

toJSON(): any
Returns any

`Static` fetch

fetch(mappedin): Promise<MappedinPolygon[]>
Parameters
- mappedin: Mappedin
Returns Promise<MappedinPolygon[]>

`Static` hydrate

hydrate(polygons, mappedin): MappedinPolygon[]
Parameters
- polygons: any
- mappedin: Mappedin
Returns MappedinPolygon[]

Class MappedinPolygon

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

mappedin: Mappedin

data: any

Returns MappedinPolygon

Properties

Optional canvasBounds

Type declaration

align: string

maxHeight: number

maxWidth: number

rotation: number

x: number

y: number

Optional categoryRank

Optional externalId

geometry

Optional holes

id

Optional image

Type declaration

Optional _isAbsolutelyPositioned?: boolean

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

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

Optional layerId

material

Type declaration

color: string

Optional opacity?: number

Optional name

Optional perspectives

Optional textures

Type declaration

image: any

name: "front" | "side"

Optional useFrontFaceImage?: boolean

Optional vertexes

Type declaration

`Optional` canvasBounds

`Optional` categoryRank

`Optional` externalId

`Optional` holes

`Optional` image

`Optional` _isAbsolutelyPositioned?: boolean

position: {
x: number;
y: number;
z: number;
}

rotation: {
x: number;
y: number;
z: number;
}

scale: {
x: number;
y: number;
}

viewBox: {
height: number;
width: number;
}

`Optional` label

position: {
x: number;
y: number;
z: number;
}

rotation: {
x: number;
y: number;
z: number;
}

`Optional` layer

`Optional` layerId

`Optional` opacity?: number

`Optional` name

`Optional` perspectives

`Optional` textures

`Optional` useFrontFaceImage?: boolean

`Optional` vertexes

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

`Optional` options: TDirectionToOptions

`Optional` options: TDirectionToOptions

`Static` fetch

`Static` hydrate