GraphSearch

//searches for 'solar' in the properties of all entities in the knowledge graph
require([
 "geoscene/rest/knowledgeGraphService"
], (KnowledgeGraphModule) => {
 KnowledgeGraphModule
   .executeSearch(kg, {
     searchQuery: "solar",
     typeCategoryFilter: "entity",
   })
   .then((queryResult) => {
     // do something with the search results
     console.log("Graph Search Result", queryResult);
   });
});

//sample return from above search
[{
 "declaredClass": "geoscene.rest.knowledgeGraph.Entity",
 "properties": {
   "shape": {
     "declaredClass": "geoscene.geometry.Point",
     "cache": {},
     "hasM": false,
     "hasZ": false,
     "latitude": 53.589000000000009,
     "longitude": -0.9633,
     "type": "point",
     "extent": null,
     "spatialReference": {
       "wkid": 4326
     },
     "x": -0.9633,
     "y": 53.589000000000009
   },
   "Name": "Suncommon",
   "Employee_Count": 400,
   "energyType": "solar"
 },
 "typeName": "Company",
 "id": "156786"
}]

属性概述

属性详细信息

declaredClass Stringreadonly inherited

类的名称。声明的类名称格式化为 geoscene.folder.className。

searchQuery String

要在知识图谱中进行搜索的文本。接受 Lucene 搜索语法。

必需项

• 如果不提供，则 knowledgeGraphService.executeSearch() 将失败。

typeCategoryFilter String

指定是否搜索实体、关系或两者。有效值为：entity、relationship 或 both。

注

• 检查 knowledgeGraphService 的服务定义 (请参阅 GeoScene REST API - 托管知识图谱服务)，以获取 typeCategoryFilter 的有效值。并非所有服务都支持 both。

必需项

• 成功执行搜索需要此属性。如果服务不支持 both，则必须指定其他选项之一。

可能值："entity"|"relationship"|"both"

默认值："both"

方法概述

方法详细说明

addHandles(handleOrHandles, groupKey)inherited

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时，将移除句柄。

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

参数

handleOrHandles WatchHandle|WatchHandle[] 对象销毁后，标记为要移除的句柄。

groupKey * optional 标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键，则句柄将被添加到默认组。

hasHandles(groupKey){Boolean}inherited

如果存在指定的句柄组，则返回 true。

参数

groupKey * optional 组键。

返回

类型	描述
Boolean	如果存在指定的句柄组，则返回 true。

示例

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles(groupKey)inherited

移除对象拥有的句柄组。

参数

groupKey * optional 要移除的组键或组键的数组或集合。

示例

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");