Class CircleGeographicArea

constructor

• new CircleGeographicArea(
      options: { centerCoordinates: Coordinates; radius: number },
  ): CircleGeographicArea

  Constructor

  Parameters

  • options: { centerCoordinates: Coordinates; radius: number }

    The options object.

    • centerCoordinates: Coordinates

      Center coordinates.

    • radius: number

      Radius in meters.

  Returns CircleGeographicArea

centerCoordinates

radius

boundingBox

• get boundingBox(): RectangleGeographicArea

  Get the bounding box.

  Returns RectangleGeographicArea

  A RectangleGeographicArea representing the bounding box

centerPoint

• get centerPoint(): Coordinates

  Retrieves the center point of the geographic area.

  Returns Coordinates

  The center coordinates

isDefault

• get isDefault(): boolean

  Checks if the geographic area has default values.

  Returns boolean

  true if the area has default values, false otherwise.

isEmpty

• get isEmpty(): boolean

  Checks if the geographic area is empty.

  Returns boolean

  true if the area is empty (radius is 0), false otherwise.

type

• get type(): GeographicAreaType

  Retrieves the specific type of the geographic area.

  Returns GeographicAreaType

  The GeographicAreaType of the area.

containsCoordinates

• containsCoordinates(point: Coordinates): boolean

  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.

convert

• convert(toType: GeographicAreaType): GeographicArea | null

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

  Parameters

  • toType: GeographicAreaType

  Returns GeographicArea | null

equals

• equals(other: CircleGeographicArea): boolean

  Equality comparison

  Parameters

  • other: CircleGeographicArea

  Returns boolean

fromJson

• fromJson(json: any): GeographicArea

  Create from JSON representation

  Parameters

  • json: any

  Returns GeographicArea

reset

• reset(): void

  Resets the circle to default state.

  Returns void

toJson

• toJson(): any

  Convert to JSON representation

  Returns any

toString

• toString(): string

  String representation

  Returns string

StaticfromJson

• fromJson(json: any): CircleGeographicArea

  Create from JSON representation

  Parameters

  • json: any

  Returns CircleGeographicArea