CircleGeographicArea - @magiclane/maps-sdk API Reference

CircleGeographicArea class

CircleGeographicArea object.

Signature:

export declare class CircleGeographicArea implements GeographicArea

Implements: GeographicArea

Constructor	Modifiers	Description
(constructor)({ radius, centerCoordinates }, input)		Constructor

Property	Modifiers	Type	Description
boundingBox	`readonly`	RectangleGeographicArea	Get the bounding box.
centerCoordinates		Coordinates	Center coordinates of the circle
centerPoint	`readonly`	Coordinates	Retrieves the center point of the geographic area.
isDefault	`readonly`	boolean
isEmpty	`readonly`	boolean	Checks if the geographic area is empty.
radius		number	Radius of the circle in meters
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 circle to another geographic area type, if possible.
equals(other)		Equality comparison
fromJson(json)
fromJson(json)	`static`	Create from JSON representation
reset()		Resets the circle 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