TilesCollectionGeographicArea - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > TilesCollectionGeographicArea

TilesCollectionGeographicArea class

TilesCollectionGeographicArea object.

Signature:

export declare class TilesCollectionGeographicArea extends GemAutoreleaseObject implements GeographicArea

Extends: GemAutoreleaseObject

Implements: GeographicArea

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the TilesCollectionGeographicArea class.

Properties

Property	Modifiers	Type	Description
boundingBox	`readonly`	RectangleGeographicArea	Get the bounding box.
centerPoint	`readonly`	Coordinates	Retrieves the center point of the geographic area.
isDefault	`readonly`	boolean
isEmpty	`readonly`	boolean	Checks if the geographic area is empty.
pointerId	`readonly`	number \| bigint
type	`readonly`	GeographicAreaType	Retrieves the specific type of the geographic area.

Methods

Method	Modifiers	Description
containsCoordinates(coords)		Checks if the specified point is contained within the geographic area.
convert(toType)		Converts the tile collection to another geographic area type, if possible.
fromJson(json)
reset()		Resets the tile collection to default state. Note: Reset does not persist the changes to the platform.
toJson()		Convert to JSON representation