Class: GraphMap

GraphMap

对接 SuperMap iServer GraphMap，即 SuperMap iServer 中的知识图谱图文档，此类提供了知识图谱的服务地址、配置项等参数。 配置项包括：知识图谱的尺寸、中心点、缩放比例、布局、节点配置、边配置、高亮样式、拖拽设置等参数。

new GraphMap(serverUrl, options)

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

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

GraphMap 服务地址， 例如：http://{iserver}/services/{knowledgeGraph-provider}/restjsr/graph/graphmaps/{graphmap}。
options Object 可选

参数。

Name Type Description
config KnowledgeGraph.Config 可选

KnowledgeGraph 的配置项。
proxy string 可选

服务代理地址。
withCredentials boolean 可选

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

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

请求头。
Version:
  • 11.1.0
Fires

API Relations

As method parameter: GraphMap.findShortestPath.

Extends

GraphMap -> mapboxgl.Evented

Members

EVENT_TYPES

监听一个自定义事件可用如下方式:

支持的事件如下: loaded - 渲染完成时触发。

graph

KnowledgeGraph 的实例。

Events

loaded

mapboxgl/overlay/GraphMap.js, line 67

渲染完成时触发。

Methods

clearHighlight(params)

mapboxgl/overlay/GraphMap.js, line 127

取消高亮节点和边。（在渲染完成后调用）

Name Type Description
params KnowledgeGraph.clearHighlightParams 可选

取消高亮节点id数组和边id数组, 不传默认取消所有激活状态的高亮。
Version:
  • 11.2.0

findShortestPath(params, callback){Promise}

mapboxgl/overlay/GraphMap.js, line 92

获取开始节点和结束节点之间的最短路径。（在渲染完成后调用）

Name Type Description
params GraphMap.findShortestPathParams

参数。
callback RequestCallback 可选

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

highlight(params)

mapboxgl/overlay/GraphMap.js, line 115

高亮节点和边。（在渲染完成后调用）

Name Type Description
params KnowledgeGraph.highlightParams

高亮参数。
Version:
  • 11.2.0

Type Definitions

findShortestPathParamsObject

Properties:
Name Type Default Description
startID string

开始节点的id
endID string

结束节点id
isHighlight boolean true 可选

是否高亮
highlightStateStyles GraphMap.highlightStateStyles 可选

高亮节点、边样式， 默认高亮样式和hover高亮样式一致。

highlightStateStylesObject

高亮节点、边样式， 默认高亮样式和hover高亮样式一致。

Properties:
Name Type Description
nodeStateStyles KnowledgeGraph.NodeStyle 可选

高亮节点样式 。
edgeStateStyles KnowledgeGraph.EdgeStyle 可选

高亮边样式。