Skip to main content

Export, raster, and credentials

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

gis.raster.buildOverviews

Build raster overviews on an isolated copy; preview and confirm committing sidecar files.

  • Permission: export.write
  • Declared platforms: desktop, mobile
  • Signature: raster.buildOverviews(arg0: RasterRef): ChangePlan<OverviewResult>

gis.raster.elevationInfo

Read elevation-band metadata, units, and datum notes without loading the entire raster.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: raster.elevationInfo(arg0: RasterRef, arg1?: ElevationOptions): Operation<ElevationInfo>

gis.raster.sampleElevation

Sample actual elevation at WGS84 coordinates, distinguishing outside coverage from invalid pixels.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: raster.sampleElevation(arg0: RasterRef, arg1: [number,number], arg2?: ElevationOptions): Operation<ElevationSampleResult>

gis.raster.profileElevation

Sample a line profile at meter intervals, preserving gaps; return at most 64 detailed points.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: raster.profileElevation(arg0: RasterRef, arg1: [number,number][], arg2: ElevationProfileOptions): Operation<ElevationProfileResult>

gis.secrets

gis.secrets.request

Ask the host to collect credentials securely; return only an opaque reference.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: secrets.request(arg0: {purpose:string;label:string}): Operation<SecretRef>

gis.secrets.get

Acquire a named credential already authorized for this task without exposing plaintext.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: secrets.get(arg0: string): Operation<SecretRef | null>

gis.export

gis.export.dataset

Preview dataset export to a new GeoJSON or GPKG file; applying requires host confirmation.

  • Permission: export.write
  • Declared platforms: desktop, mobile
  • Signature: export.dataset(arg0: DatasetRef | MapLayerRef | FeatureSetRef, arg1: DatasetExportOptions): ChangePlan<FileRef>

gis.export.saveToSource

Preview saving back only for a complete, verifiable single-file result.

  • Permission: export.write
  • Declared platforms: desktop, mobile
  • Signature: export.saveToSource(arg0: MapLayerRef, arg1?: {password?:SecretRef}): ChangePlan<FileRef>

gis.export.feature

Preview exporting one feature, reusing field validation and host confirmation.

  • Permission: export.write
  • Declared platforms: desktop, mobile
  • Signature: export.feature(arg0: FeatureRef, arg1: DatasetExportOptions): ChangePlan<FileRef>

gis.export.map

Freeze the current map and preview PNG or fixed A4 landscape PDF output. Flat/3D offscreen resolution may be 1–4 times the viewport; incomplete content rejects explicitly.

  • Permission: export.write
  • Declared platforms: desktop, mobile
  • Signature: export.map(arg0: MapExportOptions): ChangePlan<FileRef>

gis.export.validate

Check format limitations on fields, geometry, and types without writing files.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: export.validate(arg0: DatasetRef | MapLayerRef | FeatureSetRef, arg1: ExportValidationOptions): Operation<ExportValidationSummary>

gis.raster

gis.raster.zonalStats

Compute 2D polygon statistics by original pixel centers; include boundary centers, process overlaps independently, and exclude invalid pixels. Zone IDs must be unique and non-null.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: raster.zonalStats(arg0: RasterRef, arg1: DatasetRef | FeatureSetRef, arg2: ZonalStatsOptions): Operation<TableRef>

gis.raster.warp

Transform all bands into an explicit target CRS and grid. Categorical data uses nearest-neighbor only; retain raw values and scale parameters. Return a temporary raster reference.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: raster.warp(arg0: RasterRef, arg1: RasterWarpOptions): Operation<RasterRef>

gis.raster.readPixels

Read a bounded source-grid window: bands start at 1, offsets at 0. Reject out-of-bounds windows without clipping. Return raw or scaled physical values; invalid pixels are null. Maximum 4096 pixels and 60 KiB.

  • Permission: project.read
  • Declared platforms: desktop, mobile
  • Signature: raster.readPixels(arg0: RasterRef, arg1: ReadPixelsOptions): Operation<PixelBlock>

gis.raster.hillshade

Create temporary hillshade from a projected meter DEM without changing the source file.

  • Permission: analysis.execute
  • Declared platforms: desktop, mobile
  • Signature: raster.hillshade(arg0: RasterRef, arg1?: HillshadeAnalysisOptions): Operation<RasterRef>

gis.raster.slope

Create temporary slope in degrees from a projected meter DEM.

  • Permission: analysis.execute
  • Declared platforms: desktop, mobile
  • Signature: raster.slope(arg0: RasterRef, arg1?: DemAnalysisOptions): Operation<RasterRef>

gis.raster.aspect

Create temporary aspect in degrees clockwise from north; flat pixels are invalid.

  • Permission: analysis.execute
  • Declared platforms: desktop, mobile
  • Signature: raster.aspect(arg0: RasterRef, arg1?: DemAnalysisOptions): Operation<RasterRef>

gis.raster.contours

Create temporary vector contours at a meter interval; the elevation field is ELEV_M.

  • Permission: analysis.execute
  • Declared platforms: desktop, mobile
  • Signature: raster.contours(arg0: RasterRef, arg1: ContourAnalysisOptions): Operation<DatasetRef>

gis.export

gis.export.raster

Preview GeoTIFF export with host confirmation; each file is at most 64 MiB.

  • Permission: export.write
  • Declared platforms: desktop, mobile
  • Signature: export.raster(arg0: RasterRef, arg1: RasterExportOptions): ChangePlan<FileRef>

gis.export.pointCloudClassification

Preview ground-classification CSV export with host confirmation; leave the point cloud unchanged.

  • Permission: export.write
  • Declared platforms: desktop, mobile
  • Signature: export.pointCloudClassification(arg0: ClassificationRef, arg1: FileExportOptions): ChangePlan<FileRef>

gis.export.splatPreview

Preview a PNG containing only the Gaussian asset from the current camera at 1–4 times resolution; host confirmation is required.

  • Permission: export.write
  • Declared platforms: desktop, mobile
  • Signature: export.splatPreview(arg0: MapLayerRef, arg1: SplatPreviewOptions): ChangePlan<FileRef>