Class MPMultiPolygon

A multiPolygon is a collection of MPPolygons that combine to form a single geographical area with multiple bodies.

Export

MPMultiPolygon

Hierarchy (View Summary)

MPGeometry
- MPMultiPolygon

Index

Properties

multiPolygon point polygon

Accessors

bbox bounds coordinates position type

Methods

contains distanceToClosestEdge getArea toJson toJSON create

Properties

`Static` `Readonly`multiPolygon

multiPolygon: string = "MultiPolygon"

Typename for MPMultiPolygon.

Static

`Static` `Readonly`point

point: string = "Point"

Typename for MPPoint.

Static

`Static` `Readonly`polygon

polygon: string = "Polygon"

Typename for MPPolygon.

Static

Accessors

bbox

get bbox(): number[]
Get the polygon's bounding box, the bounding box is in [GeoJson format]https://stevage.github.io/geojson-spec/#section-5

Returns number[]
- Defined in MPMultiPolygon.ts:63
set bbox(box: number[]): void
Update the polygon's bounding box, the bounding box must be in [GeoJson format]https://stevage.github.io/geojson-spec/#section-5
Parameters
- box: number[]
Returns void
- Defined in MPMultiPolygon.ts:51

bounds

get bounds(): MPBounds
Get the polygon's bounds. If bbox is present then that will be used.

Returns MPBounds
- Defined in MPMultiPolygon.ts:97

coordinates

get coordinates(): number[][][][]
Get the coordinates as a collection in [GeoJSON format]https://stevage.github.io/geojson-spec/#section-3.1.7.

Returns number[][][][]
- Defined in MPMultiPolygon.ts:86
set coordinates(coordinates: number[][][][]): void
Update the coordinates list for the polygon, the coordinates must be in [GeoJSON format]https://stevage.github.io/geojson-spec/#section-3.1.7
Parameters
- coordinates: number[][][][]
Returns void
- Defined in MPMultiPolygon.ts:74

position

get position(): MPPoint
Get the position of the polygon, which is roughly its center.

Returns MPPoint
Overrides MPGeometry.position
- Defined in MPMultiPolygon.ts:150

type

get type(): string
Get the type of the polygon. see MPGeometry#multiPolygon

Returns string
Overrides MPGeometry.type
- Defined in MPMultiPolygon.ts:160

Methods

contains

contains(point: MPPoint): Promise<boolean>
Checks whether a point is contained within the geometry.
Parameters
- point: MPPoint
Returns Promise<boolean>
Async
Inherited from MPGeometry.contains
- Defined in MPGeometry.ts:78

distanceToClosestEdge

distanceToClosestEdge(point: MPPoint): Promise<number>
Calculates the squared distance from the point to the closest edge in the polygon.
Parameters
- point: MPPoint
Returns Promise<number>
Async
- Defined in MPMultiPolygon.ts:139

getArea

getArea(): Promise<number>
Get the polygon's area, this is the combined area of all the polygons in the multi-polygon.

Returns Promise<number>
Async
Overrides MPGeometry.getArea
- Defined in MPMultiPolygon.ts:111

toJson

toJson(): string
Stringifies the geometry to JSON.

Returns string
Inherited from MPGeometry.toJson
- Defined in MPGeometry.ts:88

toJSON

toJSON(): MPMultiPolygonParams
Parses the object to a JSON object that is compatible with the MapsIndoors SDK.

Returns MPMultiPolygonParams
- Defined in MPMultiPolygon.ts:181

`Static`create

create(object: MPMultiPolygonParams): MPMultiPolygon
Creator for MPMultiPolygon, used to decode JSON from the MapsIndoors SDK.
Parameters
- object: MPMultiPolygonParams
Returns MPMultiPolygon
Static
- Defined in MPMultiPolygon.ts:127