Class MPPolygon

MPPolygon is a collection of MPPoints that combine to form a single geographical area with a single body.

Export

Hierarchy

MPGeometry
- MPPolygon

Index

Constructors

Properties

_area? _bbox _bounds? _coordinates multiPolygon point polygon

Accessors

bbox bounds coordinates position type

Methods

clearCache contains distanceToClosestEdge getArea toJSON toJson create

Constructors

`Private` constructor

new MPPolygon(_coordinates, _bbox): MPPolygon
Private
Creates an instance of MPPolygon.
Parameters
- _coordinates: number[][][]
- _bbox: number[]
Returns MPPolygon
Overrides MPGeometry.constructor
- Defined in src/core/MPPolygon.ts:37

Properties

`Private` `Optional` _area

_area?: number

area cache.

`Private` _bbox

_bbox: number[]

`Private` `Optional` _bounds

_bounds?: MPBounds

bounds cache.

`Private` _coordinates

_coordinates: number[][][]

`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 src/core/MPPolygon.ts:63
set bbox(box): 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 src/core/MPPolygon.ts:51

bounds

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

Returns MPBounds
- Defined in src/core/MPPolygon.ts:97

coordinates

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

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

position

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

Returns MPPoint
Overrides MPGeometry.position
- Defined in src/core/MPPolygon.ts:125

type

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

Returns string
Overrides MPGeometry.type
- Defined in src/core/MPPolygon.ts:136

Methods

`Private` clearCache

clearCache(): void
Private
Clears area and bounds cache due to geometry recalculation.

Returns void
- Defined in src/core/MPPolygon.ts:170

contains

contains(point): Promise<boolean>
Checks whether a point is contained within the geometry.
Parameters
- point: MPPoint
Returns Promise<boolean>

Async
Inherited from MPGeometry.contains
- Defined in src/core/MPGeometry.ts:78

distanceToClosestEdge

distanceToClosestEdge(point): 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 src/core/MPPolygon.ts:161

getArea

getArea(): Promise<number>
Get the polygon's area.

Returns Promise<number>

Async
Overrides MPGeometry.getArea
- Defined in src/core/MPPolygon.ts:111

toJSON

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

Returns MPPolygonParams
- Defined in src/core/MPPolygon.ts:182

toJson

toJson(): string
Stringifies the geometry to JSON.

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

`Static` create

create(object): MPPolygon
Creator for MPPolygon, used to decode JSON from the MapsIndoors SDK.
Parameters
- object: MPPolygonParams
Returns MPPolygon

Static
- Defined in src/core/MPPolygon.ts:149

Generated using TypeDoc