Class Geometry

constructor

• new Geometry(): Geometry

  A Geometry is a description of a geographic object.

  Returns Geometry

bounds

CLASS_NAME

id

parent

atPoint

• atPoint(lonlat: LonLat, toleranceLon?: number, toleranceLat?: number): boolean

  Return whether or not the geometry is at the specified location

  Parameters

  • lonlat: LonLat
  • OptionaltoleranceLon: number
  • OptionaltoleranceLat: number

  Returns boolean

clearBounds

• clearBounds(): void

  Nullify this components bounds and that of its parent as well.

  Returns void

clone

• clone(): Geometry

  Create a clone of this geometry. Does not set any non-standard properties of the cloned geometry.

  Returns Geometry

destroy

• destroy(): void

  Destroy this geometry.

  Returns void

distanceTo

• distanceTo(geometry: Geometry, options: DistanceOptions<true>): DistanceInfo

  Calculate the closest distance between two geometries (on the x-y plane). Return {Number | Object} The distance between this geometry and the target. If details is true, the return will be an object with distance, x0, y0, x1, and x2 properties. The x0 and y0 properties represent the coordinates of the closest point on this geometry. The x1 and y1 properties represent the coordinates of the closest point on the target geometry.

  Parameters

  • geometry: Geometry
  • options: DistanceOptions<true>

  Returns DistanceInfo
• distanceTo(geometry: Geometry, options?: DistanceOptions<false>): number

  Calculate the closest distance between two geometries (on the x-y plane). Return {Number | Object} The distance between this geometry and the target. If details is true, the return will be an object with distance, x0, y0, x1, and x2 properties. The x0 and y0 properties represent the coordinates of the closest point on this geometry. The x1 and y1 properties represent the coordinates of the closest point on the target geometry.

  Parameters

  • geometry: Geometry
  • Optionaloptions: DistanceOptions<false>

  Returns number

extendBounds

• extendBounds(newBounds: Bounds): void

  Extend the existing bounds to include the new bounds. If geometry's bounds is not yet set, then set a new Bounds.

  Parameters

  • newBounds: Bounds

  Returns void

getArea

• getArea(): number

  Returns the area of the collection by summing its parts

  Returns number

getBounds

• getBounds(): Bounds

  Get the bounds for this Geometry. If bounds is not set, it is calculated again, this makes queries faster.

  Returns Bounds

getCentroid

• getCentroid(): Point

  Calculate the centroid of this geometry. This method is defined in subclasses.

  Returns Point

getLength

• getLength(): number

  Returns the length of the collection by summing its parts

  Returns number

getVertices

• getVertices(nodes: boolean): any[]

  Return a list of all points in this geometry.

  Parameters

  • nodes: boolean

  Returns any[]

setBounds

• setBounds(bounds: Bounds): void

  Set the bounds for this Geometry.

  Parameters

  • bounds: Bounds

  Returns void

toString

• toString(): string

  Returns a text representation of the geometry. If the WKT format is included in a build, this will be the Well-Known Text representation.

  Returns string

StaticdistanceToSegment

• distanceToSegment(
      point: { x: number; y: number },
      segment: { x1: number; x2: number; y1: number; y2: number },
  ): DistanceToSegmentInfo

  Function: OpenLayers.Geometry.distanceToSegment

  Parameters: point - {Object} An object with x and y properties representing the point coordinates. segment - {Object} An object with x1, y1, x2, and y2 properties representing endpoint coordinates.

  Returns: {Object} An object with distance, along, x, and y properties. The distance will be the shortest distance between the input point and segment. The x and y properties represent the coordinates along the segment where the shortest distance meets the segment. The along attribute describes how far between the two segment points the given point is.

  Parameters

  • point: { x: number; y: number }
  • segment: { x1: number; x2: number; y1: number; y2: number }

  Returns DistanceToSegmentInfo

StaticfromWKT

• fromWKT(wkt: string): Geometry

  Parameters

  • wkt: string

  Returns Geometry