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 REST API 文档 。

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

declaredClass Stringreadonly inherited

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

globalIds Number[]

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

需要 GeoScene Server 服务 2.0 或更高版本，并且要素图层的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 服务 2.0 或更高版本，并且要素图层的capabilities.query.supportsAttachments为true。

objectIds Number[]

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

returnMetadata Boolean

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

默认值:false

size Number[]

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

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

start Number

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

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

where String

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

方法列表

方法详细说明

clone(){AttachmentQuery}

创建 AttachmentQuery 对象的深拷贝。

返回值:

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

fromJSON(json){*}static

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

参数:

json Object 实例的 json 表达式，以geoscene 格式显示。

返回值:

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

toJSON(){Object}

将此类的实例转换为 GeoScene portal JSON 格式。 有关更多信息，请参阅 使用 fromJSON() 指南。

返回值:

类型	描述
Object	此类实例的 GeoScene portal JSON 格式。