Skip to main content

Analysis, geometry, and topology

Generated from the same registry as the Chinese reference. Contract version: 0.5-session. Edit the registry and reviewed English catalog, then rerun script_contract; do not edit this file. See the script guide.

Platform labels below are registry declarations, not device acceptance. Consult the platform coverage guide for actual host coverage and limits. These are the existing gis compatibility-module APIs; the shared sqsmap map facade is documented separately.

gis.analysis

gis.analysis.buffer

Create positive-distance meter buffers for points, lines, or polygons, retaining the input CRS.

  • Permission: analysis.execute
  • Declared platforms: desktop, mobile
  • Signature: analysis.buffer(arg0: DatasetRef | FeatureSetRef | MapLayerRef, arg1: BufferOptions): Operation<DatasetRef>

gis.topology

gis.topology.checkOverlaps

Inspect overlaps and return a pageable, revision-bound topology report.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: topology.checkOverlaps(arg0: DatasetRef | MapLayerRef | FeatureSetRef, arg1?: TopologyCheckOptions): Operation<TopologyReportRef>

gis.topology.checkGaps

Inspect gaps and return a pageable, revision-bound topology report.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: topology.checkGaps(arg0: DatasetRef | MapLayerRef | FeatureSetRef, arg1?: TopologyCheckOptions): Operation<TopologyReportRef>

gis.topology.checkSpikes

Inspect spikes and return a pageable, revision-bound topology report.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: topology.checkSpikes(arg0: DatasetRef | MapLayerRef | FeatureSetRef, arg1?: TopologyCheckOptions): Operation<TopologyReportRef>

gis.topology.checkKinks

Inspect kinks and return a pageable, revision-bound topology report.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: topology.checkKinks(arg0: DatasetRef | MapLayerRef | FeatureSetRef, arg1?: TopologyCheckOptions): Operation<TopologyReportRef>

gis.topology.repair

Preview repairs for specified issues and recheck automatically; create an independent result by default.

  • Permission: data.edit
  • Declared platforms: desktop, mobile
  • Signature: topology.repair(arg0: TopologyReportRef, arg1?: TopologyRepairOptions): ChangePlan<DatasetRef | EditSummary>

gis.geometry

gis.geometry.snap

Compute snapping geometry in an explicitly suitable meter projection.

  • Permission: analysis.execute
  • Declared platforms: desktop, mobile
  • Signature: geometry.snap(arg0: Coordinate, arg1: SnapOptions): Operation<SnapResult>

gis.geometry.trace

Compute traced geometry in an explicitly suitable meter projection.

  • Permission: analysis.execute
  • Declared platforms: desktop, mobile
  • Signature: geometry.trace(arg0: TraceOptions): Operation<DatasetRef>

gis.geometry.offset

Compute offset geometry in an explicitly suitable meter projection.

  • Permission: analysis.execute
  • Declared platforms: desktop, mobile
  • Signature: geometry.offset(arg0: Coordinate, arg1: OffsetOptions): Operation<Coordinate>

gis.analysis

gis.analysis.clip

Clip lines or polygons to an explicit polygon boundary, producing an independent result.

  • Permission: analysis.execute
  • Declared platforms: desktop, mobile
  • Signature: analysis.clip(arg0: DatasetRef | FeatureSetRef | MapLayerRef, arg1: DatasetRef | FeatureRef | FeatureSetRef, arg2?: ResultOptions): Operation<DatasetRef>

gis.analysis.erase

Erase using an explicit polygon boundary, producing an independent result.

  • Permission: analysis.execute
  • Declared platforms: desktop, mobile
  • Signature: analysis.erase(arg0: DatasetRef | FeatureSetRef | MapLayerRef, arg1: DatasetRef | FeatureRef | FeatureSetRef, arg2?: ResultOptions): Operation<DatasetRef>

gis.analysis.split

Split into inside and outside results using a polygon boundary.

  • Permission: analysis.execute
  • Declared platforms: desktop, mobile
  • Signature: analysis.split(arg0: DatasetRef | FeatureSetRef | MapLayerRef, arg1: FeatureRef | FeatureSetRef, arg2?: ResultOptions): Operation<DatasetRef>

gis.analysis.merge

Merge selected polygons into an independent result with no inherited attributes.

  • Permission: analysis.execute
  • Declared platforms: desktop, mobile
  • Signature: analysis.merge(arg0: DatasetRef | FeatureSetRef | MapLayerRef, arg1?: ResultOptions): Operation<DatasetRef>

gis.analysis.makeValid

Repair geometry validity and produce an independent result.

  • Permission: analysis.execute
  • Declared platforms: desktop, mobile
  • Signature: analysis.makeValid(arg0: DatasetRef | FeatureSetRef | MapLayerRef, arg1?: ResultOptions): Operation<DatasetRef>

gis.analysis.simplify

Simplify geometry in a suitable meter projection.

  • Permission: analysis.execute
  • Declared platforms: desktop, mobile
  • Signature: analysis.simplify(arg0: DatasetRef | FeatureSetRef | MapLayerRef, arg1: SimplifyOptions): Operation<DatasetRef>

gis.analysis.extractBoundary

Extract polygon boundaries as line data.

  • Permission: analysis.execute
  • Declared platforms: desktop, mobile
  • Signature: analysis.extractBoundary(arg0: DatasetRef | FeatureSetRef | MapLayerRef, arg1?: BoundaryOptions): Operation<DatasetRef>

gis.analysis.intersect

Intersect pairs of 2D polygons and map explicitly selected left/right fields to output aliases. Include __leftIndex/__rightIndex; boundary-only contact produces an empty result.

  • Permission: analysis.execute
  • Declared platforms: desktop, mobile
  • Signature: analysis.intersect(arg0: DatasetRef | FeatureSetRef, arg1: DatasetRef | FeatureSetRef, arg2: IntersectOptions): Operation<DatasetRef>

gis.analysis.dissolve

Dissolve valid 2D polygons by required groupBy fields, eliminating overlap within each group. An empty array dissolves all features; retain only grouping attributes.

  • Permission: analysis.execute
  • Declared platforms: desktop, mobile
  • Signature: analysis.dissolve(arg0: DatasetRef | FeatureSetRef, arg1: DissolveOptions): Operation<DatasetRef>

gis.geometry

gis.geometry.distance3d

Calculate horizontal, vertical, and spatial distance between 3D hits or elevated positions; reject incompatible height datums.

  • Permission: project.read
  • Declared platforms: desktop, mobile, web
  • Signature: geometry.distance3d(arg0: SceneHit | GeoPosition3d, arg1: SceneHit | GeoPosition3d): Operation<Distance3d>