Skip to main content

Host, data, and queries

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.host

gis.host.layers

List current vector displays and acquire references for this script run.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: layers(): Operation<Layer[]>

gis.host.metrics

Reuse the current layer's area, length, and feature-count statistics.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: metrics(arg0: Layer, arg1?: boolean): Operation<string>

gis.host.fields

Read actual fields and existing business labels; do not infer unknown meanings.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: fields(arg0: Layer): Operation<Field[]>

gis.host.codes

Read code samples from at most 20 rows and known dictionary meanings; this is not a complete code list.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: codes(arg0: Layer, arg1: string): Operation<CodeSamples>

gis.host.exportGeoJSON

Preview export to a new GeoJSON file; applying the plan requires host confirmation.

  • Permission: export.write
  • Declared platforms: desktop, mobile
  • Signature: exportGeoJSON(arg0: Layer, arg1: string): Operation<ChangePlan>

gis.query

gis.query.metrics

Calculate feature count, area, and length in an explicitly suitable meter projection.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: query.metrics(arg0: DatasetRef | FeatureSetRef | FeatureRef | MapLayerRef, arg1?: {scope?: 'all'|'filtered'; measurementCrs?: string}): Operation<MetricSummary>

gis.data

gis.data.fromGeoJSON

Read in-memory GeoJSON and retain original property types; do not add it to the map automatically.

  • Permission: project.read
  • Declared platforms: desktop, mobile, web
  • Signature: data.fromGeoJSON(arg0: GeoJSON, arg1?: {name?: string}): Operation<DatasetRef>

gis.data.open

Read local vector or raster data and retain its CRS and field types.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: data.open(arg0: string, arg1?: DataOpenOptions): Operation<DatasetRef | RasterRef>

gis.data.layers

Discover sublayers with pagination; cursors bind to file and sidecar fingerprints.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: data.layers(arg0: string, arg1?: PageOptions): Operation<Page<DataLayerInfo>>

gis.data.info

Read dataset metadata and CRS.

  • Permission: project.read
  • Declared platforms: desktop, mobile, web
  • Signature: data.info(arg0: DatasetRef | RasterRef | MapLayerRef | TableRef): Operation<DatasetInfo | RasterInfo | TableInfo>

gis.data.fields

Discover field types with pagination; result tables retain declared types and units. Untyped, entirely empty source fields are nullable strings.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: data.fields(arg0: DatasetRef | MapLayerRef | TableRef, arg1?: PageOptions): Operation<Page<FieldInfo | TableFieldInfo>>

gis.data.codes

Return only a matched code dictionary; explicitly report when no dictionary exists.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: data.codes(arg0: DatasetRef | MapLayerRef, arg1: PageOptions & {field: string}): Operation<Page<FieldCodeInfo>>

gis.query

gis.query.select

Apply a typed filter and retain a native feature set without changing map selection.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: query.select(arg0: DatasetRef | MapLayerRef, arg1: SelectionOptions): Operation<FeatureSetRef>

gis.query.rows

Page through properties using query/revision-bound cursors. Table rows contain values; default 20, maximum 100. Tables do not accept filtering or search options.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: query.rows(arg0: DatasetRef | MapLayerRef | FeatureSetRef | TableRef, arg1?: RowQueryOptions | TableRowQueryOptions): Operation<Page<AttributeRow> | Page<TableRow>>

gis.query.features

Page through small feature results; geometry remains in the host and is returned on demand.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: query.features(arg0: DatasetRef | MapLayerRef, arg1?: FeatureQueryOptions): Operation<Page<FeatureResult>>

gis.query.fieldSummary

Scan the full field for missing and unique values; sample limits do not reduce statistical coverage.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: query.fieldSummary(arg0: DatasetRef | MapLayerRef, arg1: {field: string; scope?: 'all'|'filtered'; sampleLimit?: number}): Operation<FieldSummary>

gis.query.groupMetrics

Group the complete dataset by actual fields and calculate counts and meter-based measurements.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: query.groupMetrics(arg0: DatasetRef | MapLayerRef, arg1: GroupMetricOptions): Operation<GroupMetricSummary>

gis.query.missingValues

Inspect null and blank values; return accurate scan coverage and bounded samples.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: query.missingValues(arg0: DatasetRef | MapLayerRef, arg1: FieldQualityOptions): Operation<MissingValueSummary>

gis.query.duplicateValues

Inspect non-null duplicates by type; return group counts and bounded samples.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: query.duplicateValues(arg0: DatasetRef | MapLayerRef, arg1: FieldQualityOptions): Operation<DuplicateValueSummary>

gis.query.fieldQuality

Combine field-quality checks on the same revision and scan selection.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: query.fieldQuality(arg0: DatasetRef | MapLayerRef, arg1: FieldQualityOptions): Operation<FieldQualitySummary>

gis.query.parts

Page through revision-bound geometry parts; a repeated closing vertex is not numbered twice.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: query.parts(arg0: FeatureRef, arg1?: PageOptions): Operation<Page<FeaturePart>>

gis.query.vertices

Page through revision-bound vertices; a repeated closing vertex is not numbered twice.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: query.vertices(arg0: FeatureRef, arg1?: PageOptions): Operation<Page<FeatureVertex>>

gis.query.aggregate

Aggregate the complete dataset into an immutable table. An empty groupBy means one total; measures maps output aliases. Geometry measurements require suitable UTM and units.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: query.aggregate(arg0: DatasetRef | FeatureSetRef, arg1: AggregateOptions): Operation<TableRef>

gis.query.spatialJoin

Join using the left geometry's relation to the right; retain left geometry. Specify join, matching, and field aliases explicitly; include input-snapshot indices.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: query.spatialJoin(arg0: DatasetRef | FeatureSetRef, arg1: DatasetRef | FeatureSetRef, arg2: SpatialJoinOptions): Operation<DatasetRef>

gis.query.nearest

Match by projected minimum geometry distance. Include threshold equality; all retains ties at rank k, first uses the original right index as tie-breaker. Table distances are meters.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: query.nearest(arg0: DatasetRef | FeatureSetRef, arg1: DatasetRef | FeatureSetRef, arg2: NearestOptions): Operation<TableRef>

gis.data

gis.data.reproject

Transform actual 2D data into the specified EPSG CRS, retaining fields and order; return an independent reference.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: data.reproject(arg0: DatasetRef | FeatureSetRef, arg1: ReprojectOptions): Operation<DatasetRef>

gis.query

gis.query.sql

Run local read-only queries on existing data references using positional bindings; explicitly choose a table or spatial result in the source CRS. Remote dialects are unsupported.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: query.sql(arg0: SqlOptions): Operation<TableRef | DatasetRef>

gis.files

gis.files.pick

Let the user choose files through the host's picker; return FileRef objects usable as resource paths. Cancellation returns an empty array.

  • Permission: project.read
  • Declared platforms: desktop, mobile, web
  • Signature: files.pick(arg0?: FilePickOptions): Operation<FileRef[]>