跳到主要内容

宿主、数据与查询(生成文件)

由 cargo run -p sqs-script --bin script_contract -- docs/lang/generated docs/API/script/reference 生成,契约版本 0.5-session。修改 registry 后重新生成,不要手改本文件。使用方法见 脚本 API 指南。

gis.host

gis.host.layers

列出当前矢量显示并取得本次任务的引用。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:layers(): Operation<Layer[]>

gis.host.metrics

复用当前图层的面积、长度及数量统计。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:metrics(arg0: Layer, arg1?: boolean): Operation<string>

gis.host.fields

读取真实字段及已有业务名称;未知名称不推测。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:fields(arg0: Layer): Operation<Field[]>

gis.host.codes

读取最多20行中的代码样本及已知字典含义,不代表完整代码表。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:codes(arg0: Layer, arg1: string): Operation<CodeSamples>

gis.host.exportGeoJSON

为新文件预演导出,需宿主确认。

  • 权限:export.write
  • 平台:桌面、移动
  • 签名:exportGeoJSON(arg0: Layer, arg1: string): Operation<ChangePlan>

gis.query

gis.query.metrics

在明确的米制投影中统计数量、面积和长度。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:query.metrics(arg0: DatasetRef | FeatureSetRef | FeatureRef | MapLayerRef, arg1?: {scope?: 'all'|'filtered'; measurementCrs?: string}): Operation<MetricSummary>

gis.data

gis.data.fromGeoJSON

读取内存 GeoJSON 并保留原始属性类型,不自动上图。

  • 权限:project.read
  • 平台:桌面、移动、网页
  • 签名:data.fromGeoJSON(arg0: GeoJSON, arg1?: {name?: string}): Operation<DatasetRef>

gis.data.open

读取本地矢量或栅格数据,保留坐标系和字段类型。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:data.open(arg0: string, arg1?: DataOpenOptions): Operation<DatasetRef | RasterRef>

gis.data.layers

分页发现子图层;游标绑定文件及旁文件指纹。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:data.layers(arg0: string, arg1?: PageOptions): Operation<Page<DataLayerInfo>>

gis.data.info

读取数据元信息与坐标系。

  • 权限:project.read
  • 平台:桌面、移动、网页
  • 签名:data.info(arg0: DatasetRef | RasterRef | MapLayerRef | TableRef): Operation<DatasetInfo | RasterInfo | TableInfo>

gis.data.fields

分页发现字段类型;成果表保留声明类型和计量单位,原有无类型全空源字段按可空字符串描述。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:data.fields(arg0: DatasetRef | MapLayerRef | TableRef, arg1?: PageOptions): Operation<Page<FieldInfo | TableFieldInfo>>

gis.data.codes

仅返回已匹配代码表;无代码表时明确报告不存在。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:data.codes(arg0: DatasetRef | MapLayerRef, arg1: PageOptions & {field: string}): Operation<Page<FieldCodeInfo>>

gis.query

gis.query.select

类型化筛选并保留原生要素集合,不改变地图选择。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:query.select(arg0: DatasetRef | MapLayerRef, arg1: SelectionOptions): Operation<FeatureSetRef>

gis.query.rows

分页读取属性;游标绑定查询与版本;表格行只有 values,默认20/最多100行,表格不接受筛选与搜索。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:query.rows(arg0: DatasetRef | MapLayerRef | FeatureSetRef | TableRef, arg1?: RowQueryOptions | TableRowQueryOptions): Operation<Page<AttributeRow> | Page<TableRow>>

gis.query.features

分页读取小要素结果,几何留在宿主且按需返回。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:query.features(arg0: DatasetRef | MapLayerRef, arg1?: FeatureQueryOptions): Operation<Page<FeatureResult>>

gis.query.fieldSummary

完整统计字段缺失与唯一值;样本限制不改变统计范围。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:query.fieldSummary(arg0: DatasetRef | MapLayerRef, arg1: {field: string; scope?: 'all'|'filtered'; sampleLimit?: number}): Operation<FieldSummary>

gis.query.groupMetrics

按真实字段完整分组统计数量与米制度量。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:query.groupMetrics(arg0: DatasetRef | MapLayerRef, arg1: GroupMetricOptions): Operation<GroupMetricSummary>

gis.query.missingValues

检查空值和空白,返回准确扫描覆盖与有限样本。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:query.missingValues(arg0: DatasetRef | MapLayerRef, arg1: FieldQualityOptions): Operation<MissingValueSummary>

gis.query.duplicateValues

按类型检查非空重复值,返回分组计数和有限样本。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:query.duplicateValues(arg0: DatasetRef | MapLayerRef, arg1: FieldQualityOptions): Operation<DuplicateValueSummary>

gis.query.fieldQuality

在同一版本和扫描集合上综合检查字段质量。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:query.fieldQuality(arg0: DatasetRef | MapLayerRef, arg1: FieldQualityOptions): Operation<FieldQualitySummary>

gis.query.parts

按版本分页读取部件与顶点,闭合末尾不重复编号。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:query.parts(arg0: FeatureRef, arg1?: PageOptions): Operation<Page<FeaturePart>>

gis.query.vertices

按版本分页读取部件与顶点,闭合末尾不重复编号。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:query.vertices(arg0: FeatureRef, arg1?: PageOptions): Operation<Page<FeatureVertex>>

gis.query.aggregate

按字段完整统计并返回不可变表格;groupBy 空数组为全体总计,measures 为输出别名对象;几何量算须指定适用 UTM 与单位。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:query.aggregate(arg0: DatasetRef | FeatureSetRef, arg1: AggregateOptions): Operation<TableRef>

gis.query.spatialJoin

按左相对右的空间关系关联,保留左几何;显式选择连接、匹配和字段别名,附输入快照来源索引。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:query.spatialJoin(arg0: DatasetRef | FeatureSetRef, arg1: DatasetRef | FeatureSetRef, arg2: SpatialJoinOptions): Operation<DatasetRef>

gis.query.nearest

按投影后几何最短距离匹配;阈值含边界,all 保留第 k 名并列,first 按右原始索引择优;返回表格距离为米。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:query.nearest(arg0: DatasetRef | FeatureSetRef, arg1: DatasetRef | FeatureSetRef, arg2: NearestOptions): Operation<TableRef>

gis.data

gis.data.reproject

将二维数据真实转换到指定 EPSG 坐标系并保留字段和顺序,返回独立数据引用。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:data.reproject(arg0: DatasetRef | FeatureSetRef, arg1: ReprojectOptions): Operation<DatasetRef>

gis.query

gis.query.sql

对已有数据引用执行本地只读查询;匿名位置绑定,显式选择表格或原坐标系空间成果,不支持远程方言。

  • 权限:project.read
  • 平台:桌面、移动
  • 签名:query.sql(arg0: SqlOptions): Operation<TableRef | DatasetRef>

gis.files

gis.files.pick

让用户选择本地文件(桌面系统文件对话框、网页浏览器选择框、移动端系统选择器),返回 FileRef 列表,可直接作为模型、DEM、点云、矢量、栅格、精灵图等的 path;用户取消时返回空数组。

  • 权限:project.read
  • 平台:桌面、移动、网页
  • 签名:files.pick(arg0?: FilePickOptions): Operation<FileRef[]>