Class: DataFlowService

DataFlowService

数据流服务类。用于实现客户端与服务器之间实现低延迟和实时数据传输。数据流服务采用 WebSocket 协议，支持全双工、双向式通信。 服务器可将流数据服务的分析处理结果作为数据来源向客户端广播，客户端与数据流服务建立连接后，即可自动接收服务器广播的数据。

new DataFlowService(url, options)

Usage
import { DataFlowService } from '@supermapgis/iclient-ol';

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

数据流服务地址，如 ws://{ip}:{port}/iserver/services/dataflowTest/dataflow 。
options Object

参数。

Name Type Description
proxy string 可选

服务代理地址。
withCredentials boolean 可选

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

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

请求头。
geometry GeoJSONObject 可选

空间范围，只有在该范围内的要素才能被接收。
excludeField Object 可选

过滤字段。传入此参数，接收到的信息将不包含过滤掉的字段。
Example
new DataFlowService(url).queryChart(param,function(result){
         //doSomething
     })

API Relations

Returned by: DataFlowService.initBroadcast.

Extends

DataFlowService -> ServiceBase -> ol.Observable

Methods

broadcast(obj)

openlayers/services/DataFlowService.js, line 60

加载广播数据。

Name Type Description
obj JSONObject

JSON 格式的要素数据。

initBroadcast(){DataFlowService}

openlayers/services/DataFlowService.js, line 50

初始化广播。

Returns:
Type Description
DataFlowService
  • 数据流服务。

initSubscribe()

openlayers/services/DataFlowService.js, line 69

初始化订阅数据。

setExcludeField(excludeField)

openlayers/services/DataFlowService.js, line 78

设置过滤字段。传入此参数，接收到的信息将不包含过滤掉的字段。

Name Type Description
excludeField Object

过滤字段。

setGeometry(geometry)

openlayers/services/DataFlowService.js, line 89

设置空间范围，只有在该范围内的要素才能被接收。

Name Type Description
geometry GeoJSONObject

空间范围。

unBroadcast()

openlayers/services/DataFlowService.js, line 108

结束加载广播。

unSubscribe()

openlayers/services/DataFlowService.js, line 100

结束订阅数据。