ServiceDefinition

AMD: require(["geoscene/rest/knowledgeGraph/ServiceDefinition"], (ServiceDefinition) => { /* code goes here */ });
ESM: import ServiceDefinition from "@geoscene/core/rest/knowledgeGraph/ServiceDefinition.js";
类: geoscene/rest/knowledgeGraph/ServiceDefinition
继承于:ServiceDefinition Accessor
起始版本:GeoScene Maps SDK for JavaScript 4.26
beta

概述 knowledgeGraphService 的服务功能。

示例
{
	"allowGeometryUpdates": false,
	"capabilities": [
		"Delete",
		"Query",
		"Create",
		"Editing",
		"Update"
	],
	"copyrightText": "2023 Esri, all rights reserved",
	"currentVersion": 11.0,
	"dataEditingNotSupported": false,
	"dateFieldsTimeReference": {
		"respectsDaylightSaving": false,
		"timeZone": "UTC"
	},
	"description": "Supply chain data",
	"maxRecordCount": 2000,
	"schemaEditingNotSupported": false,
	"searchMaxRecordCount": 2000,
	"serviceCapabilities": {
		"applyEditsCapabilities": {
			"graphDefaultRollbackOnFailure": false
		},
		"geometryCapabilities": {
			"geometryMaxBoundingRectangleSizeX": 180,
			"geometryMaxBoundingRectangleSizeY": 180,
			"supportedGeometryTypes": [
				"Point",
				"Mulitpoint",
				"Polyline",
				"Polygon"
			],
			"supportsMValues": false,
			"supportsZValues": false
		},
		"indexCapabilities": {
			"supportsDecendingIndex": false,
			"supportsRelationshipIndex": true,
			"supportsUniqueRelationshipConstraint": false
		}
	},
	"searchCapabilities": {
		"allowLeadingWildcardQueries": true,
		"searchTypeFilterCapabilities": [
			"geosceneTypeEntity",
			"geosceneTypeRelationship",
			"geosceneTypeBoth"
		]
	},
	"serviceItemId": "87941a7420e84933882502ff2e9a5c34",
	"spatialReference": {
		"wkid": 4326
	},
	"supportedQueryFormats": [
		"PBF"
	],
	"supportsDocuments": true,
	"supportsSearch": true,
	"units": "geosceneDecimalDegrees",
	"url": "https://myHostName.domain.com/server/rest/services/Hosted/myServiceName/KnowledgeGraphServer"
}

属性概述

所有属性都可以设置、获取和监听。请参阅使用属性主题。
显示继承属性 隐藏继承属性
名称 类型 描述
Boolean

指示是否可以修改图谱中的几何数据。

更多详情
ServiceDefinition
String[]

指定知识图谱的操作功能。

更多详情
ServiceDefinition
String

知识图谱的版权信息。

更多详情
ServiceDefinition
Number

托管知识图谱服务的 GeoScene Enterprise 实例的版本号。

更多详情
ServiceDefinition
Boolean

指示是否不支持数据编辑。

更多详情
ServiceDefinition
Object

指定 dateTime 字段的时区。

更多详情
ServiceDefinition
String

类的名称。

更多详情
Accessor
String

服务的描述。

更多详情
ServiceDefinition
Number

查询操作返回的最大记录数。

更多详情
ServiceDefinition
Boolean

指示是否可以编辑知识图谱架构 (数据模型)。

更多详情
ServiceDefinition
Number

搜索操作返回的最大记录数。

更多详情
ServiceDefinition
Object

指定服务的索引、编辑、搜索和几何功能的详细信息。

更多详情
ServiceDefinition
String

知识图谱服务的 GeoScene Enterprise 门户项目 id。

更多详情
ServiceDefinition
SpatialReference

指定知识图谱服务的 SpatialReference 信息。

更多详情
ServiceDefinition
String[]

服务支持的查询格式。

更多详情
ServiceDefinition
Boolean

指示服务是否支持具有文档角色的实体类型。

更多详情
ServiceDefinition
Boolean

指示服务是否支持搜索操作。

更多详情
ServiceDefinition
String

空间参考的单位。

更多详情
ServiceDefinition

属性详细信息

allowGeometryUpdates Booleanreadonly

指示是否可以修改图谱中的几何数据。如果为 false,则几何属性中的 executeApplyEdits 将失败。

capabilities String[]readonly

指定知识图谱的操作功能。

示例
["Query", "Editing", "Delete", "Create", "Update"]
copyrightText Stringreadonly

知识图谱的版权信息。

currentVersion Numberreadonly

托管知识图谱服务的 GeoScene Enterprise 实例的版本号。

dataEditingNotSupported Booleanreadonly

指示是否不支持数据编辑。如果为 true,则 executeApplyEdits 将失败。

dateFieldsTimeReference Objectreadonly

指定 dateTime 字段的时区。

属性
respectsDaylightSaving Boolean

指示日期时间字段是否考虑夏令时。

timeZone String

所有日期时间字段的时区。

declaredClass Stringreadonly inherited

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

description Stringreadonly

服务的描述。

maxRecordCount Numberreadonly

查询操作返回的最大记录数。

schemaEditingNotSupported Booleanreadonly

指示是否可以编辑知识图谱架构 (数据模型)。JS API 当前不支持架构编辑,如果为 false,则必须通过 GeoScene REST API for Knowledge Graph 对架构进行任何更新。

searchMaxRecordCount Numberreadonly

搜索操作返回的最大记录数。

serviceCapabilities Objectreadonly

指定服务的索引、编辑、搜索和几何功能的详细信息。

属性
indexCapabilities Object

有关知识图谱服务中索引所支持的功能的信息。

规范
supportsDescendingIndex Boolean

指定服务是否支持按降序排列的索引。

supportsUniqueRelationshipConstraint Boolean

指定系统是否支持为关系类型创建唯一约束

supportsRelationshipIndex Boolean

指定服务是否支持关系上的索引。

applyEditsCapabilities Object

有关 executeApplyEdits 操作所支持的功能的信息。

规范
graphDefaultRollbackOnFailure Boolean

如果为 true,则当应用编辑操作失败时,数据将恢复到更改前的状态。

searchCapabilities Object

有关知识图谱服务中搜索操作的支持功能的信息。

规范
searchTypeFilterCapabilities String

此服务支持的搜索类别过滤器。

可能值"geosceneTypeEntity"|"geosceneTypeRelationship"|"geosceneTypeBoth"

allowLeadingWildcardQueries Boolean

指定搜索字符串是否可以包含前导通配符运算符 (*)。

geometryCapabilities Object

有关知识图谱服务中几何所支持的功能的信息。

规范
geometryMaxBoundingRectangleSizeX Number

沿 x 轴的最大边界矩形大小。

geometryMaxBoundingRectangleSizeY Number

沿 y 轴的最大边界矩形大小。

supportsMValues Number

指定知识图谱服务是否支持几何上的 m 值。

supportsZValues Number

指定知识图谱服务是否支持几何上的 z 值。

supportedGeometryTypes String[]

指定图形支持的几何类型,如 PointMultipointPolylinePolygon

示例
"serviceCapabilities": {
	"applyEditsCapabilities": {
		"graphDefaultRollbackOnFailure": false
	},
	"geometryCapabilities": {
		"geometryMaxBoundingRectangleSizeX": 180,
		"geometryMaxBoundingRectangleSizeY": 180,
		"supportedGeometryTypes": [
			"Point",
			"Mulitpoint",
			"Polyline",
			"Polygon"
		],
		"supportsMValues": false,
		"supportsZValues": false
	},
	"indexCapabilities": {
		"supportsDecendingIndex": false,
		"supportsRelationshipIndex": true,
		"supportsUniqueRelationshipConstraint": false
	}
	},
	"searchCapabilities": {
	"allowLeadingWildcardQueries": true,
	"searchTypeFilterCapabilities": [
		"geosceneTypeEntity",
		"geosceneTypeRelationship",
		"geosceneTypeBoth"
	]
}
serviceItemId Stringreadonly

知识图谱服务的 GeoScene Enterprise 门户项目 id。

spatialReference SpatialReferenceautocastreadonly

指定知识图谱服务的 SpatialReference 信息。

默认值:null
supportedQueryFormats String[]readonly

服务支持的查询格式。

supportsDocuments Booleanreadonly

指示服务是否支持具有文档角色的实体类型。

supportSearch Booleanreadonly

指示服务是否支持搜索操作。如果为 false,executeSearch 将失败。

units Stringreadonly

空间参考的单位。

示例
units: "geosceneDecimalDegrees"

方法概述

显示继承的方法 隐藏继承的方法
名称 返回值类值 描述

添加一个或多个与对象生命周期相关联的句柄

更多详情
Accessor
*

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。

更多详情
ServiceDefinition
Boolean

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

更多详情
Accessor

移除对象拥有的句柄组。

更多详情
Accessor
Object

将此类的实例转换为其 GeoScene Portal JSON 表示。

更多详情
ServiceDefinition

方法详细说明

addHandles(handleOrHandles, groupKey)inherited

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

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

this.addHandles(handle);

// Destroy the object
this.destroy();
参数
handleOrHandles WatchHandle|WatchHandle[]

对象销毁后,标记为要移除的句柄。

groupKey *
optional

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

fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。

参数
json Object

GeoScene 格式实例的 JSON 表示。

返回
类型 描述
* 返回该类的新实例。
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");
toJSON(){Object}

将此类的实例转换为其 GeoScene Portal JSON 表示。有关详细信息,请参阅使用 fromJSON() 指南主题。

返回
类型 描述
Object 此类实例的 GeoScene Portal JSON 表示。

您的浏览器不再受支持。请升级您的浏览器以获得最佳体验。