AttachmentQuery

属性概述

属性详细信息

attachmentsWhere String

应用于附件查询的 where 子句。仅满足 attachmentsWhere 子句的附件才会被返回。

示例

const query = new AttachmentQuery({
  where: "1=1", // query all features in the layer
  attachmentsWhere: "keywords = 'ladybug, purple'" // attachment queries
});

attachmentTypes String[]

查询附件支持的文件格式。例如，image/jpeg。 。

需要 GeoScene Server 服务 1.5 或更高版本，并且要素图层的 capabilities.query.supportsAttachments 为 true。

cacheHint Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.24

指示服务是否应缓存附件查询结果。它仅适用于图层的 capabilities.attachment.supportsCacheHint 设置为 true 的情况。仅用于每次使用应用程序时具有相同参数的查询。可缓存查询的一些示例：

• 基于预设输入的查询，例如美国各州的下拉列表。
• 在 web 地图中基于预设范围的查询，例如书签。

默认值：undefined

declaredClass Stringreadonly inherited

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

globalIds Number[]

正在查询的图层中的要素的 globalId 数组。查询结果将仅返回指定全局 id 的附件。

需要 GeoScene Server 服务 1.5 或更高版本，并且要素图层的 capabilities.query.supportsAttachments 为 true。

keywords String[]

用于查询与提供的 keywords 相匹配的附件。

示例

const query = new AttachmentQuery({
  where: "1=1", // query all features in the layer
  attachmentsWhere: "keywords = 'ladybug, purple'" // attachment queries
});

const query = new AttachmentQuery({
  where: "1=1", // query all features in the layer
  attachmentsWhere: "keywords like 'buildings%'" // attachment queries
});

name String

用于查询与此 name 相匹配的附件。

示例

const query = new AttachmentQuery({
  where: "1=1", // query all features in the layer
  attachmentsWhere: "name = 'ladybug.png'" // attachment queries
});

num Number

要检索的要素数。此选项应与 start 属性结合使用。可使用它来实现分页 (即，在查询时检索结果的 "页面")。默认值为 10。

如果未提供，但 AttachmentQuery 实例具有 start 属性，则默认 num 值为 maxRecordCount。此参数的最大值是图层的服务 maxRecordCount 的值，可在要素图层的 REST 端点找到。

需要 GeoScene Server 服务 1.5 或更高版本，并且要素图层的 capabilities.query.supportsAttachments 为 true。

objectIds Number[]

要查询附件的要素的 objectIds 数组。当要素图层的 capabilities.query.supportsAttachments 属性为 false 时，它仅接受单个 objectId。

returnMetadata Boolean

如果为 true，附件的可交换图像文件格式将包含在 attachmentInfo 中。图层的 capabilities.attachment.supportsExifInfo 必须为 true，附件查询才能返回附件的 exifInfo。

默认值：false

size Number[]

附件的文件大小以字节为单位指定。您可以输入文件大小范围 [1000,15000] 来查询附件。查询结果将返回指定文件大小范围 (1000 - 15000) 内的所有附件。

需要 GeoScene Server 服务 1.5 或更高版本，并且要素图层的 capabilities.query.supportsAttachments 为 true。

start Number

该选项通过跳过指定数量的记录来获取查询结果。查询结果从下一条记录开始。默认值为 0。此参数仅适用于要素图层的 capabilities.query.supportsPagination 为 true 的情况。您可以使用此选项来获取超出 maxRecordCount 的记录。

需要 GeoScene Server 服务 1.5 或更高版本，并且要素图层的 capabilities.query.supportsAttachments 为 true。

where String

要应用于图层的 where 子句。只有满足该 where 子句并且在 objectIds 列表中的要素才会被返回。需要 GeoScene Server 服务 1.5 或更高版本，并且要素图层的 capabilities.query.supportsAttachments 为 true。

方法概述

方法详细说明

addHandles(handleOrHandles, groupKey)inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

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

// 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() 进行删除。如果未提供键，则句柄将被添加到默认组。

clone(){AttachmentQuery}

创建 AttachmentQuery 对象的深度克隆。

返回

类型	描述
AttachmentQuery	AttachmentQuery 对象的新实例，其等于用于调用 .clone() 的对象。

fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。有关何时以及如何使用该函数的详细信息和示例，请参阅指南中的使用 fromJSON() 主题。

参数

json Object GeoScene 格式实例的 JSON 表示。有关各种输入 JSON 对象的结构示例，请参阅 GeoScene REST API 文档。

返回

类型	描述
*	返回该类的新实例。

hasHandles(groupKey){Boolean}inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

如果存在指定的句柄组，则返回 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

起始版本：GeoScene Maps SDK for JavaScript 4.25

移除对象拥有的句柄组。

参数

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 表示。