Class: FeatureService

FeatureService

要素数据集类。提供：ID 查询、范围查询、SQL 查询、空间查询、缓冲区查询、地物编辑，要素附件查询、编辑等方法。

new FeatureService(url, options)

Usage
import { FeatureService } from '@supermapgis/iclient-mapboxgl';

new FeatureService(url, options);
<script type="text/javascript" src="https://iclient.supermap.io/dist/mapboxgl/iclient-mapboxgl.js"></script>
<script>
  new mapboxgl.supermap.FeatureService({paramsNames});
</script>
mapboxgl/services/FeatureService.js, line 13
Name Type Description
url string

数据服务地址，如 http://{ip}:{port}/iserver/services/data-world/rest/data 。
options Object

参数。

Name Type Description
proxy string 可选

服务代理地址。
withCredentials boolean 可选

请求是否携带凭据。默认情况下，仅同源请求包含凭据。
crossOrigin boolean 可选

是否允许跨域请求。
headers Object 可选

请求头。
preferServer boolean 可选

当resultFormat=DataFormat.GEOJSON时，使用服务器直接返回geojson。
Example
new FeatureService(url)
 .getFeaturesByIDs(param,function(result){
    //doSomething
})

Extends

FeatureService -> ServiceBase

Events

inherited initialized

mapboxgl/services/ServiceBase.js, line 32

构造函数构造成功之后触发。

Properties:
Name Type Description
this Object

this 对象。

Methods

editFeatureAttachments(params, callback){Promise}

mapboxgl/services/FeatureService.js, line 154

要素附件编辑服务。

Name Type Description
params EditAttachmentsParameters

要素附件服务中附件添加、删除参数类。
callback RequestCallback 可选

回调函数，该参数未传时可通过返回的 promise 获取结果。
Version:
  • 11.2.0
Returns:
Type Description
Promise Promise 对象。

editFeatures(params, callback){Promise}

mapboxgl/services/FeatureService.js, line 104

地物编辑服务。

Name Type Description
params EditFeaturesParameters

数据服务中数据集添加、修改、删除参数类。
callback RequestCallback 可选

回调函数，该参数未传时可通过返回的 promise 获取结果。
Returns:
Type Description
Promise Promise 对象。

getFeatureAttachments(params, callback){Promise}

mapboxgl/services/FeatureService.js, line 142

要素附件查询服务。

Name Type Description
params AttachmentsParameters

要素附件服务中附件查询除参数类。
callback RequestCallback 可选

回调函数，该参数未传时可通过返回的 promise 获取结果。
Version:
  • 11.2.0
Returns:
Type Description
Promise Promise 对象。

getFeaturesByBounds(params, callback, resultFormat){Promise}

mapboxgl/services/FeatureService.js, line 52

数据集范围查询服务。

Name Type Default Description
params GetFeaturesByBoundsParameters

数据集范围查询参数类。
callback RequestCallback 可选

回调函数，该参数未传时可通过返回的 promise 获取结果。
resultFormat DataFormat DataFormat.GEOJSON 可选

返回结果类型。
Returns:
Type Description
Promise Promise 对象。

getFeaturesByBuffer(params, callback, resultFormat){Promise}

mapboxgl/services/FeatureService.js, line 65

数据集 Buffer 查询服务。

Name Type Default Description
params GetFeaturesByBufferParameters

数据集缓冲区查询参数类。
callback RequestCallback 可选

回调函数，该参数未传时可通过返回的 promise 获取结果。
resultFormat DataFormat DataFormat.GEOJSON 可选

返回结果类型。
Returns:
Type Description
Promise Promise 对象。

getFeaturesByGeometry(params, callback, resultFormat){Promise}

mapboxgl/services/FeatureService.js, line 91

数据集空间查询服务类。

Name Type Default Description
params GetFeaturesByGeometryParameters

数据集空间查询参数类。
callback RequestCallback 可选

回调函数，该参数未传时可通过返回的 promise 获取结果。
resultFormat DataFormat DataFormat.GEOJSON 可选

返回结果类型。
Returns:
Type Description
Promise Promise 对象。

getFeaturesByIDs(params, callback, resultFormat){Promise}

mapboxgl/services/FeatureService.js, line 39

数据集 ID 查询服务。

Name Type Default Description
params GetFeaturesByIDsParameters

ID 查询参数类。
callback RequestCallback 可选

回调函数，该参数未传时可通过返回的 promise 获取结果。
resultFormat DataFormat DataFormat.GEOJSON 可选

返回结果类型。
Returns:
Type Description
Promise Promise 对象。

getFeaturesBySQL(params, callback, resultFormat){Promise}

mapboxgl/services/FeatureService.js, line 78

数据集 SQL 查询服务。

Name Type Default Description
params GetFeaturesBySQLParameters

数据集 SQL 查询参数类。
callback RequestCallback 可选

回调函数，该参数未传时可通过返回的 promise 获取结果。
resultFormat DataFormat DataFormat.GEOJSON 可选

返回结果类型。
Returns:
Type Description
Promise Promise 对象。

getFeaturesCount(params, callback){Promise}

mapboxgl/services/FeatureService.js, line 166

获取要素数量。

Name Type Description
params GetFeaturesByIDsParameters | GetFeaturesByBoundsParameters | GetFeaturesByBufferParameters | GetFeaturesByGeometryParameters | GetFeaturesBySQLParameters

查询参数类。
callback RequestCallback 可选

回调函数，该参数未传时可通过返回的 promise 获取结果。
Version:
  • 11.2.0
Returns:
Type Description
Promise Promise 对象。

getFeaturesDatasetInfo(params, callback){Promise}

mapboxgl/services/FeatureService.js, line 179

获取要素数据集信息。

Name Type Description
params GetFeaturesByIDsParameters | GetFeaturesByBoundsParameters | GetFeaturesByBufferParameters | GetFeaturesByGeometryParameters | GetFeaturesBySQLParameters

查询参数类。
callback RequestCallback 可选

回调函数，该参数未传时可通过返回的 promise 获取结果。
Version:
  • 11.2.0
Returns:
Type Description
Promise Promise 对象。

getMetadata(params, callback){Promise}

mapboxgl/services/FeatureService.js, line 130

地理要素元信息。

Name Type Description
params Object

包括数据源名称、数据集名称、要素 ID。
callback RequestCallback 可选

回调函数，该参数未传时可通过返回的 promise 获取结果。
Version:
  • 11.1.1
Returns:
Type Description
Promise Promise 对象。