Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface geometryEngineAsync

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

Read more...

Hierarchy

  • geometryEngineAsync

Index

Methods

buffer

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

    Read more...

    Parameters

    Returns Promise<Polygon | Polygon[]>

clip

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

    Read more...

    Parameters

    Returns Promise<Geometry>

contains

  • contains(containerGeometry: Geometry, insideGeometry: Geometry): Promise<boolean>
  • Indicates if one geometry contains another geometry.

    Read more...

    Parameters

    Returns Promise<boolean>

convexHull

  • Calculates the convex hull of one or more geometries.

    Read more...

    Parameters

    Returns Promise<Geometry | Geometry[]>

crosses

  • Indicates if one geometry crosses another geometry.

    Read more...

    Parameters

    Returns Promise<boolean>

cut

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

    Read more...

    Parameters

    Returns Promise<Geometry[]>

densify

  • Densify geometries by plotting points between existing vertices.

    Read more...

    Parameters

    Returns Promise<Geometry>

difference

  • Creates the difference of two geometries.

    Read more...

    Parameters

    Returns Promise<Geometry>

disjoint

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

    Read more...

    Parameters

    Returns Promise<boolean>

distance

  • Calculates the shortest planar distance between two geometries.

    Read more...

    Parameters

    Returns Promise<number>

equals

  • Indicates if two geometries are equal.

    Read more...

    Parameters

    Returns Promise<boolean>

extendedSpatialReferenceInfo

flipHorizontal

  • Flips a geometry on the horizontal axis.

    Read more...

    Parameters

    Returns Promise<Geometry>

flipVertical

  • Flips a geometry on the vertical axis.

    Read more...

    Parameters

    Returns Promise<Geometry>

generalize

  • generalize(geometry: Geometry, maxDeviation: number, removeDegenerateParts?: boolean, maxDeviationUnit?: number | LinearUnits): Promise<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 Promise<Geometry>

geodesicArea

  • Calculates the area of the input geometry.

    Read more...

    Parameters

    Returns Promise<number>

geodesicBuffer

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

    Read more...

    Parameters

    Returns Promise<Polygon | Polygon[]>

geodesicDensify

  • Returns a geodesically densified version of the input geometry.

    Read more...

    Parameters

    Returns Promise<Geometry>

geodesicLength

  • Calculates the length of the input geometry.

    Read more...

    Parameters

    Returns Promise<number>

intersect

  • Creates a new geometry through intersection between two geometries.

    Read more...

    Parameters

    Returns Promise<Geometry>

intersects

  • Indicates if one geometry intersects another geometry.

    Read more...

    Parameters

    Returns Promise<boolean>

isSimple

  • isSimple(geometry: Geometry): Promise<boolean>
  • Indicates if the given geometry is topologically simple.

    Read more...

    Parameters

    Returns Promise<boolean>

nearestCoordinate

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

    Read more...

    Parameters

    Returns Promise<NearestPointResult>

nearestVertex

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

    Read more...

    Parameters

    Returns Promise<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 Promise<NearestPointResult>

offset

  • offset(geometry: Geometry | Geometry[], offsetDistance: number, offsetUnit: number | LinearUnits, joinType: "round" | "bevel" | "miter" | "square", bevelRatio?: number, flattenError?: number): Promise<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 Promise<Geometry | Geometry[]>

overlaps

  • Indicates if one geometry overlaps another geometry.

    Read more...

    Parameters

    Returns Promise<boolean>

planarArea

  • Calculates the area of the input geometry.

    Read more...

    Parameters

    Returns Promise<number>

planarLength

  • Calculates the length of the input geometry.

    Read more...

    Parameters

    Returns Promise<number>

relate

  • relate(geometry1: Geometry, geometry2: Geometry, relation: string): Promise<boolean>
  • Indicates if the given DE-9IM relation holds for the two geometries.

    Read more...

    Parameters

    Returns Promise<boolean>

rotate

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

    Read more...

    Parameters

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

    Returns Promise<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 Promise<Geometry>

symmetricDifference

  • Creates the symmetric difference of two geometries.

    Read more...

    Parameters

    Returns Promise<Geometry | Geometry[]>

touches

  • Indicates if one geometry touches another geometry.

    Read more...

    Parameters

    Returns Promise<boolean>

union

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

    Read more...

    Parameters

    Returns Promise<Geometry>

within

  • Indicates if one geometry is within another geometry.

    Read more...

    Parameters

    Returns Promise<boolean>

Generated using TypeDoc