PortalQueryParams

属性概述

属性详细信息

categories Array<(string|Array<string>)>

起始版本：GeoScene Maps SDK for JavaScript 4.8

存储在项目中的类别数组。使用此属性可从 Portal.queryItems() 和 PortalGroup.queryItems() 中过滤结果。它接受以下数组：

• 单个字符串元素或
• 字符串数组。

查询可查看数组中的每个元素，并对它们执行 SQL AND 操作。如果元素是数组而不是单个字符串元素，则此数组中的元素将被读取为 OR。请参见以下片段：

注：String[] 元素仅受 GeoScene Online 和 GeoScene Enterprise 1.6.1 版本的支持。

示例

// Query items with categories tagged as 'Basemaps' OR 'Imagery' AND 'People' OR 'Environment'
// i.e. (Basemaps || Imagery) && (People || Environment)
params.categories = [["底图", "Imagery"], ["People", "Environment"]];

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

extent Extentautocast

仅在查询 PortalItems 时相关。指定时，将查询结果限制在此处定义的范围内。

给定范围的空间参考必须是 WGS84 (wkid 4326) 或 Web Mercator (wkid 3857)。

filter String

起始版本：GeoScene Maps SDK for JavaScript 4.22

使用结构化过滤器，而不是 query 属性。

num Number

要包含在结果集响应中的最大结果数。允许的最大值为 100。与 num 属性结合使用的 start 属性可用于对搜索结果进行分页。

默认值：10

query String

用于搜索的查询字符串。有关构造有效查询的详细信息，请查看 GeoScene REST API 搜索引用。

sortField String

以逗号分隔的要排序的字段列表。字段名称可能因查询内容而异。例如，与对门户项目执行基本搜索查询相比，用户查询所允许的字段要有限得多。下面列出了可能的字段名列表。这些名称对应于项目 (搜索)、群组和/或用户查询。

字段名称	查询功能
title	search, group
uploaded	search
modified	search
username	user
created	user, group
type	search
owner	search, group
avg-rating	search
num-ratings	search
num-comments	search
num-views	search

可能值："title"|"uploaded"|"modified"|"username"|"created"|"type"|"owner"|"avg-rating"|"num-ratings"|"num-comments"|"num-views"

sortOrder String

对结果进行排序的顺序。

可能值	描述
asc	按升序对结果进行排序。
desc	按降序对结果进行排序。

可能值："asc"|"desc"

默认值：asc

start Number

结果集响应中第一个条目的索引。索引从 1 开始。start 属性和 num 属性可用于对搜索结果进行分页。

默认值：1

方法概述

方法详细说明

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(){PortalQueryParams}

创建调用此方法的 PortalQueryParams 实例的深度克隆。

返回

类型	描述
PortalQueryParams	调用此方法的实例的克隆。

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");