Skip to content

Commit 9348863

Browse files
[fix]知识图谱docs
1 parent dbdd692 commit 9348863

6 files changed

Lines changed: 22 additions & 22 deletions

File tree

‎src/common/iServer/KnowledgeGraphService.js‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,6 @@ import { CommonServiceBase } from './CommonServiceBase';
2020
* @param {Object} [options.headers] - 请求头。
2121
* @usage
2222
*/
23-
/**
24-
* @typedef {Object} KnowledgeGraphService.findShortestPathParams
25-
* @property {string} startID - 开始节点的id
26-
* @property {string} endID - 结束节点id
27-
*/
2823
export class KnowledgeGraphService extends CommonServiceBase {
2924
constructor(url, options) {
3025
super(url, options);

‎src/common/overlay/KnowledgeGraph.js‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,24 @@ import clonedeep from 'lodash.clonedeep';
153153
* @property {Array} nodeIDs - 高亮节点id数组。
154154
* @property {Array} edgeIDs - 高亮边id数组。
155155
*/
156+
157+
/**
158+
* @typedef {Object} KnowledgeGraphService.findShortestPathParams
159+
* @property {string} startID - 开始节点的id
160+
* @property {string} endID - 结束节点id
161+
*/
162+
/**
163+
* @typedef {Object} GraphMap.highlightStateStyles - 高亮节点、边样式, 默认高亮样式和hover高亮样式一致。
164+
* @property {KnowledgeGraph.NodeStyle} [nodeStateStyles] - 高亮节点样式 。
165+
* @property {KnowledgeGraph.EdgeStyle} [edgeStateStyles] - 高亮边样式。
166+
*/
167+
/**
168+
* @typedef {Object} GraphMap.findShortestPathParams
169+
* @property {string} startID - 开始节点的id
170+
* @property {string} endID - 结束节点id
171+
* @property {boolean} [isHighlight = true] - 是否高亮
172+
* @property {GraphMap.highlightStateStyles} [highlightStateStyles] - 高亮节点、边样式, 默认高亮样式和hover高亮样式一致。
173+
*/
156174
export class KnowledgeGraph {
157175
constructor(config, type = 'G6') {
158176
/**

‎src/leaflet/overlay/GraphMap.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ export class GraphMap extends L.Evented {
131131
* @function GraphMap.prototype.clearHighlight
132132
* @version 11.2.0
133133
* @description 取消高亮节点和边。(在渲染完成后调用)
134-
* @param {KnowledgeGraph.claerHighlightParams} [params] - 取消高亮节点id数组和边id数组, 不传默认取消所有激活状态的高亮。
134+
* @param {KnowledgeGraph.clearHighlightParams} [params] - 取消高亮节点id数组和边id数组, 不传默认取消所有激活状态的高亮。
135135
*/
136136
clearHighlight(params) {
137137
if (!this.graph) {

‎src/mapboxgl/overlay/GraphMap.js‎

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,6 @@ import mapboxgl from 'mapbox-gl';
2424
* @usage
2525
*/
2626

27-
/**
28-
* @typedef {Object} GraphMap.highlightStateStyles - 高亮节点、边样式, 默认高亮样式和hover高亮样式一致。
29-
* @property {KnowledgeGraph.NodeStyle} [nodeStateStyles] - 高亮节点样式 。
30-
* @property {KnowledgeGraph.EdgeStyle} [edgeStateStyles] - 高亮边样式。
31-
*/
32-
/**
33-
* @typedef {Object} GraphMap.findShortestPathParams
34-
* @property {string} startID - 开始节点的id
35-
* @property {string} endID - 结束节点id
36-
* @property {boolean} [isHighlight = true] - 是否高亮
37-
* @property {GraphMap.highlightStateStyles} [highlightStateStyles] - 高亮节点、边样式, 默认高亮样式和hover高亮样式一致。
38-
*/
39-
4027
export class GraphMap extends mapboxgl.Evented {
4128
constructor(serverUrl, options) {
4229
super(serverUrl, options);
@@ -141,7 +128,7 @@ export class GraphMap extends mapboxgl.Evented {
141128
* @function GraphMap.prototype.clearHighlight
142129
* @version 11.2.0
143130
* @description 取消高亮节点和边。(在渲染完成后调用)
144-
* @param {KnowledgeGraph.claerHighlightParams} [params] - 取消高亮节点id数组和边id数组, 不传默认取消所有激活状态的高亮。
131+
* @param {KnowledgeGraph.clearHighlightParams} [params] - 取消高亮节点id数组和边id数组, 不传默认取消所有激活状态的高亮。
145132
*/
146133
clearHighlight(params) {
147134
if (!this.graph) {

‎src/maplibregl/overlay/GraphMap.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ export class GraphMap extends maplibregl.Evented {
127127
* @function GraphMap.prototype.clearHighlight
128128
* @version 11.2.0
129129
* @description 取消高亮节点和边。(在渲染完成后调用)
130-
* @param {KnowledgeGraph.claerHighlightParams} [params] - 取消高亮节点id数组和边id数组, 不传默认取消所有激活状态的高亮。
130+
* @param {KnowledgeGraph.clearHighlightParams} [params] - 取消高亮节点id数组和边id数组, 不传默认取消所有激活状态的高亮。
131131
*/
132132
clearHighlight(params) {
133133
if (!this.graph) {

‎src/openlayers/overlay/GraphMap.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ export class GraphMap extends Observable {
129129
* @function GraphMap.prototype.clearHighlight
130130
* @version 11.2.0
131131
* @description 取消高亮节点和边。(在渲染完成后调用)
132-
* @param {KnowledgeGraph.claerHighlightParams} [params] - 取消高亮节点id数组和边id数组, 不传默认取消所有激活状态的高亮。
132+
* @param {KnowledgeGraph.clearHighlightParams} [params] - 取消高亮节点id数组和边id数组, 不传默认取消所有激活状态的高亮。
133133
*/
134134
clearHighlight(params) {
135135
if (!this.graph) {

0 commit comments

Comments
 (0)