PolygonGeographicArea - @magiclane/maps-sdk API Reference

PolygonGeographicArea class

PolygonGeographicArea object.

Signature:

export declare class PolygonGeographicArea implements GeographicArea

Implements: GeographicArea

Constructor	Modifiers	Description
(constructor)({ coordinates }, input)		Constructor

Property	Modifiers	Type	Description
boundingBox	`readonly`	RectangleGeographicArea	Get the bounding box.
centerPoint	`readonly`	Coordinates	Retrieves the center point of the geographic area.
coordinates		Coordinates[]	List of coordinates defining the polygon
isDefault	`readonly`	boolean
isEmpty	`readonly`	boolean	Checks if the geographic area is empty.
type	`readonly`	GeographicAreaType	Retrieves the specific type of the geographic area.

Method	Modifiers	Description
containsCoordinates(point)		Checks if the specified point is contained within the geographic area.
convert(toType)		Converts the polygon to another geographic area type, if possible.
equals(other)		Equality comparison
fromJson(json)
fromJson(json)	`static`	Create from JSON representation
reset()		Resets the polygon to default state.
toJson()		Convert to JSON representation
toJSON()		JSON.stringify hook: native calls receive the toJson() form (lowercase keys plus type), which is what the engine's area parser expects.
toString()		String representation