Hierarchy (View Summary)

Constructors

Properties

bounds: Bounds

The bounds of this geometry

CLASS_NAME: string
id: string

A unique identifier for this geometry.

parent: null | Geometry

This is set when a Geometry is added as component of another geometry

x: number
y: number

Methods

  • Return whether or not the geometry is at the specified location

    Parameters

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

    Returns boolean

  • Method: calculateBounds Create a new Bounds based on the lon/lat

    Returns void

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

    Returns void

  • Destroy this geometry.

    Returns void

  • 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

    Returns 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

    Returns number

  • Determine whether another geometry is equivalent to this one. Geometries are considered equivalent if all components have the same coordinates.

    Parameters

    Returns boolean

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

    Parameters

    Returns void

  • Returns the area of the collection by summing its parts

    Returns number

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

    Returns Bounds

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

    Returns Point

  • Returns the length of the collection by summing its parts

    Returns number

  • Return a list of all points in this geometry.

    Parameters

    • nodes: boolean

    Returns any[]

  • Determine if the input geometry intersects this one.

    Parameters

    Returns boolean

  • Moves a geometry by the given displacement along positive x and y axes. This modifies the position of the geometry and clears the cached bounds.

    Parameters

    • x: number
    • y: number

    Returns void

  • Resize a point relative to some origin. For points, this has the effect of scaling a vector (from the origin to the point). This method is more useful on geometry collection subclasses.

    Parameters

    • scale: number
    • origin: Point
    • Optionalratio: number

    Returns Point

  • Rotate a point around another.

    Parameters

    • angle: number
    • origin: Point

    Returns void

  • 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

  • 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