@magiclane/maps-sdk
    Preparing search index...

    Interface GeographicArea

    This object represents a geographical area on the surface of a WGS 84 Ellipsoid.

    interface GeographicArea {
        boundingBox: RectangleGeographicArea;
        centerPoint: Coordinates;
        isDefault: boolean;
        isEmpty: boolean;
        type: GeographicAreaType;
        containsCoordinates(point: Coordinates): boolean;
        convert(toType: GeographicAreaType): GeographicArea | null;
        fromJson(json: any): GeographicArea;
        reset(): void;
        toJson(): any;
    }

    Implemented by

    Index

    Properties

    boundingBox centerPoint isDefault isEmpty type

    Methods

    containsCoordinates convert fromJson reset toJson

    Properties

    boundingBox: RectangleGeographicArea

    Get the bounding box. This is the smallest rectangle that can be drawn around the area such that it surrounds this geographic area completely.

    A RectangleGeographicArea object representing the bounding box.

    centerPoint: Coordinates

    Retrieves the center point of the geographic area.

    Coordinates object representing the center point of the area.

    isDefault: boolean

    Checks if the geographic area has default values.

    true if the area has default values, false otherwise.

    isEmpty: boolean

    Checks if the geographic area is empty.

    true if the area is empty, false otherwise.

    type: GeographicAreaType

    Retrieves the specific type of the geographic area.

    The GeographicAreaType of the area.

    Methods

    • Checks if the specified point is contained within the geographic area.

      Parameters

      • point: Coordinates

        A Coordinates object representing the point to check.

      Returns boolean

      True if the point is within the geographic area, false otherwise.

    • Converts the geographic area to another type, if possible.

      Parameters

      Returns GeographicArea | null

      A GeographicArea object representing the converted area, or null if the conversion failed.

    • Create from JSON representation

      Parameters

      • json: any

      Returns GeographicArea

    • Returns void

    • Convert to JSON representation

      Returns any

    Settings

    Member Visibility

    On This Page

    Properties
    Methods