Class: GenerateSpatialDataParameters

GenerateSpatialDataParameters

动态分段操作参数类。此类可用于设置动态分段中的路由数据集及其标识字段、用于生成空间数据的事件表名、 事件表的路由标识、刻度、刻度偏移量、错误信息等参数,还可以对分析结果进行一系列设置。

new GenerateSpatialDataParameters(options)

Usage
// 浏览器
<script type="text/javascript" src="https://iclient.supermap.io/dist/leaflet/iclient-leaflet.js"></script>
<script>
  new L.supermap.GenerateSpatialDataParameters(options);
  
  // 弃用的写法
  new SuperMap.GenerateSpatialDataParameters(options);

</script>

// ES6 Import
import { GenerateSpatialDataParameters } from '@supermapgis/iclient-leaflet';

new GenerateSpatialDataParameters(options);

common/iServer/GenerateSpatialDataParameters.js, line 8
Name Type Description
options Object

参数。

Name Type Description
routeTable string

路由数据集。

routeIDField string

路由数据集的标识字段。

eventTable string

用于生成空间数据的事件表名。

dataReturnOption DataReturnOption

设置数据返回选项。

attributeFilter string 可选

属性过滤条件。

eventRouteIDField string

用于生成空间数据的事件表的路由标识字段。

measureField string 可选

用于生成空间数据的事件表的刻度字段,只有当事件为点事件的时候该属性才有意义。

measureStartField string 可选

用于生成空间数据的事件表的起始刻度字段,只有当事件为线事件的时候该属性才有意义。

measureEndField string 可选

用于生成空间数据的事件表的终止刻度字段,只有当事件为线事件的时候该属性才有意义。

measureOffsetField string 可选

刻度偏移量字段。

errorInfoField string 可选

错误信息字段,直接写入原事件表,用于描述事件未能生成对应的点或线时的错误信息。

retainedFields Array.<string> 可选

欲保留到结果空间数据中的字段集合(系统字段除外)。

Members

attributeFilterstring

属性过滤条件。 当 GenerateSpatialDataParameters.prototype.dataReturnOption.dataReturnModeDataReturnMode.DATASET_AND_RECORDSETDataReturnMode.RECORDSET_ONLY 时有效。

dataReturnOptionDataReturnOption

设置数据返回的选项。

errorInfoFieldstring

错误信息字段,直接写入原事件表,用于描述事件未能生成对应的点或线时的错误信息。

eventRouteIDFieldstring

用于生成空间数据的事件表的路由标识字段。

eventTablestring

用于生成空间数据的事件表名。

measureEndFieldstring

用于生成空间数据的事件表的终止刻度字段,只有当事件为线事件的时候该属性才有意义。

measureFieldstring

用于生成空间数据的事件表的刻度字段,只有当事件为点事件的时候该属性才有意义。

measureOffsetFieldstring

刻度偏移量字段。

measureStartFieldstring

用于生成空间数据的事件表的起始刻度字段,只有当事件为线事件的时候该属性才有意义。

retainedFieldsArray.<string>

欲保留到结果空间数据中的字段集合(系统字段除外)。 生成空间数据时,无论是否指定保留字段,路由 ID 字段、刻度偏移量字段、刻度值字段(点事件为刻度字段,线事件是起始和终止刻度字段)都会保留到结果空间数据中; 如果没有指定 retainedFields 参数或者 retainedFields 参数数组长度为 0,则返回所有用户字段。

routeIDFieldstring

路由数据集的标识字段。

routeTablestring

路由数据集。

Methods

destroy()

common/iServer/GenerateSpatialDataParameters.js, line 113

释放资源,将引用资源的属性置空。