Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface geometryEngine

A client-side geometry engine for testing, measuring, and analyzing the spatial relationship between two or more 2D geometries.

Read more...

Hierarchy

  • geometryEngine

Index

Methods

buffer

  • Creates planar (or Euclidean) buffer polygons at a specified distance around the input geometries.

    Read more...

    Parameters

    Returns Polygon | Polygon[]

clip

  • Calculates the clipped geometry from a target geometry by an envelope.

    Read more...

    Parameters

    Returns Geometry

contains

  • Indicates if one geometry contains another geometry.

    Read more...

    Parameters

    Returns boolean

convexHull

  • Calculates the convex hull of one or more geometries.

    Read more...

    Parameters

    Returns Geometry | Geometry[]

crosses

  • Indicates if one geometry crosses another geometry.

    Read more...

    Parameters

    Returns boolean

cut

  • Splits the input Polyline or Polygon where it crosses a cutting Polyline.

    Read more...

    Parameters

    Returns Geometry[]

densify

  • Densify geometries by plotting points between existing vertices.

    Read more...

    Parameters

    Returns Geometry

difference

disjoint

  • Indicates if one geometry is disjoint (doesn't intersect in any way) with another geometry.

    Read more...

    Parameters

    Returns boolean

distance

  • Calculates the shortest planar distance between two geometries.

    Read more...

    Parameters

    Returns number

equals

  • Indicates if two geometries are equal.

    Read more...

    Parameters

    Returns boolean

extendedSpatialReferenceInfo

  • Returns an object containing additional information about the input spatial reference.

    Read more...

    Parameters

    Returns SpatialReferenceInfo

flipHorizontal

  • Flips a geometry on the horizontal axis.

    Read more...

    Parameters

    Returns Geometry

flipVertical

  • Flips a geometry on the vertical axis.

    Read more...

    Parameters

    Returns Geometry

generalize

  • generalize(geometry: Geometry, maxDeviation: number, removeDegenerateParts?: boolean, maxDeviationUnit?: number | LinearUnits): Geometry
  • Performs the generalize operation on the geometries in the cursor.

    Read more...

    Parameters

    • geometry: Geometry
    • maxDeviation: number
    • Optional removeDegenerateParts: boolean
    • Optional maxDeviationUnit: number | LinearUnits

    Returns Geometry

geodesicArea

  • Calculates the area of the input geometry.

    Read more...

    Parameters

    Returns number

geodesicBuffer

  • Creates geodesic buffer polygons at a specified distance around the input geometries.

    Read more...

    Parameters

    Returns Polygon | Polygon[]

geodesicDensify

  • Returns a geodesically densified version of the input geometry.

    Read more...

    Parameters

    Returns Geometry

geodesicLength

  • Calculates the length of the input geometry.

    Read more...

    Parameters

    Returns number

intersect

  • Creates a new geometry through intersection between two geometries.

    Read more...

    Parameters

    Returns Geometry | Geometry[]

intersects

  • Indicates if one geometry intersects another geometry.

    Read more...

    Parameters

    Returns boolean

isSimple

  • Indicates if the given geometry is topologically simple.

    Read more...

    Parameters

    Returns boolean

nearestCoordinate

  • Finds the coordinate of the geometry that is closest to the specified point.

    Read more...

    Parameters

    Returns NearestPointResult

nearestVertex

  • Finds the vertex on the geometry nearest to the specified point.

    Read more...

    Parameters

    Returns NearestPointResult

nearestVertices

  • Finds all vertices in the given distance from the specified point, sorted from the closest to the furthest and returns them as an array of Objects.

    Read more...

    Parameters

    • geometry: Geometry
    • inputPoint: Point
    • searchRadius: number
    • maxVertexCountToReturn: number

    Returns NearestPointResult[]

offset

  • offset(geometry: Geometry | Geometry[], offsetDistance: number, offsetUnit: number | LinearUnits, joinType: "round" | "bevel" | "miter" | "square", bevelRatio?: number, flattenError?: number): Geometry | Geometry[]
  • The offset operation creates a geometry that is a constant planar distance from an input polyline or polygon.

    Read more...

    Parameters

    • geometry: Geometry | Geometry[]
    • offsetDistance: number
    • offsetUnit: number | LinearUnits
    • joinType: "round" | "bevel" | "miter" | "square"
    • Optional bevelRatio: number
    • Optional flattenError: number

    Returns Geometry | Geometry[]

overlaps

  • Indicates if one geometry overlaps another geometry.

    Read more...

    Parameters

    Returns boolean

planarArea

  • Calculates the area of the input geometry.

    Read more...

    Parameters

    Returns number

planarLength

  • Calculates the length of the input geometry.

    Read more...

    Parameters

    Returns number

relate

  • Indicates if the given DE-9IM relation is true for the two geometries.

    Read more...

    Parameters

    Returns boolean

rotate

  • Rotates a geometry counterclockwise by the specified number of degrees.

    Read more...

    Parameters

    • geometry: Geometry
    • angle: number
    • Optional rotationOrigin: Point

    Returns Geometry

simplify

  • Performs the simplify operation on the geometry which alters the given geometries to make their definitions topologically legal with respect to their geometry type.

    Read more...

    Parameters

    Returns Geometry

symmetricDifference

touches

  • Indicates if one geometry touches another geometry.

    Read more...

    Parameters

    Returns boolean

union

  • All inputs must be of the same type of geometries and share one spatial reference.

    Read more...

    Parameters

    Returns Geometry

within

  • Indicates if one geometry is within another geometry.

    Read more...

    Parameters

    Returns boolean

Generated using TypeDoc