Variable geometryEngineCompatConst

Type declaration

• buffer: ((input: GeometryEngineInput, distance: number, unit?: EsriLinearUnit) => EsriGeometry | null)

  • • (input, distance, unit?): EsriGeometry | null

    • Buffer a geometry by distance in unit. Backed by geodesic @turf/buffer (reprojected through WGS84), which differs from Esri's planar buffer; use this where a geometryEngine.geodesicBuffer-equivalent result is acceptable.

      Parameters

      • input: GeometryEngineInput
      • distance: number
      • unit: EsriLinearUnit = "meters"

      Returns EsriGeometry | null

• contains: ((container: GeometryEngineInput, inside: GeometryEngineInput) => boolean)

  • • (container, inside): boolean

    • True if container completely contains inside. Backed by @turf/boolean-contains.

      Parameters

      • container: GeometryEngineInput
      • inside: GeometryEngineInput

      Returns boolean

• convexHull: ((input: GeometryEngineInput) => EsriGeometry | null)

  • • (input): EsriGeometry | null

    • Convex hull of a geometry. Backed by @turf/convex.

      Parameters

      • input: GeometryEngineInput

      Returns EsriGeometry | null

• difference: ((input: GeometryEngineInput, subtractor: GeometryEngineInput) => EsriGeometry | null)

  • • (input, subtractor): EsriGeometry | null

    • Difference input − subtractor. Backed by @turf/difference.

      Parameters

      • input: GeometryEngineInput
      • subtractor: GeometryEngineInput

      Returns EsriGeometry | null

• geodesicArea: ((input: GeometryEngineInput, unit?: EsriAreaUnit) => number)

  • • (input, unit?): number

    • Geodesic (great-circle) area, reprojecting to WGS84 first.

      Parameters

      • input: GeometryEngineInput
      • unit: EsriAreaUnit = "square-meters"

      Returns number

• geodesicLength: ((input: GeometryEngineInput, unit?: EsriLinearUnit) => number)

  • • (input, unit?): number

    • Geodesic (great-circle) length, reprojecting to WGS84 first.

      Parameters

      • input: GeometryEngineInput
      • unit: EsriLinearUnit = "meters"

      Returns number

• intersect: ((input: GeometryEngineInput, intersector: GeometryEngineInput) => EsriGeometry | null)

  • • (input, intersector): EsriGeometry | null

    • Intersection of two geometries. Backed by @turf/intersect.

      Parameters

      • input: GeometryEngineInput
      • intersector: GeometryEngineInput

      Returns EsriGeometry | null

• intersects: ((a: GeometryEngineInput, b: GeometryEngineInput) => boolean)

  • • (a, b): boolean

    • True if a and b intersect. Backed by @turf/boolean-intersects.

      Parameters

      • a: GeometryEngineInput
      • b: GeometryEngineInput

      Returns boolean

• planarArea: ((input: GeometryEngineInput, unit?: EsriAreaUnit) => number)

  • • (input, unit?): number

    • Planar area in the geometry's native coordinate plane (shoelace).

      Parameters

      • input: GeometryEngineInput
      • unit: EsriAreaUnit = "square-meters"

      Returns number

• planarLength: ((input: GeometryEngineInput, unit?: EsriLinearUnit) => number)

  • • (input, unit?): number

    • Planar length/perimeter in the geometry's native coordinate plane.

      Parameters

      • input: GeometryEngineInput
      • unit: EsriLinearUnit = "meters"

      Returns number

• simplify: ((input: GeometryEngineInput) => EsriGeometry | null)

  • • (input): EsriGeometry | null

    • Topologically normalize a geometry (rewind rings to a valid orientation via the Esri↔GeoJSON round-trip). This mirrors geometryEngine.simplify's intent of producing a topologically valid geometry rather than reducing vertices.

      Parameters

      • input: GeometryEngineInput

      Returns EsriGeometry | null

• union: ((inputs: readonly GeometryEngineInput[]) => EsriGeometry | null)

  • • (inputs): EsriGeometry | null

    • Union of two or more geometries. Backed by @turf/union.

      Parameters

      • inputs: readonly GeometryEngineInput[]

      Returns EsriGeometry | null