PortalQueryParams

属性列表

属性详细说明

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

起始版本: GeoScene API for JavaScript 4.22

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

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

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

注：字符串[]元素仅受 GeoScene Online 支持。

示例代码:

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

declaredClass Stringreadonly inherited

起始版本: GeoScene API for JavaScript 4.22

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

extent Extentautocast

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

给定范围的 spatial reference 必须是WGS84（wkid 4326）或Web Mercator（wkid 3857）。

filter String

起始版本: GeoScene API for JavaScript 4.22

使用结构化筛选器，而不是 query 属性。

示例:

• GeoScene REST API 搜索参考

num Number

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

默认值:10

query String

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

示例:

• GeoScene REST API 搜索参考

sortField String

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

字段名	查询功能
title	搜索, 群组
uploaded	搜索
modified	搜索
username	用户
created	用户, 群组
type	搜索
owner	搜索, 群组
avg-rating	搜索
num-ratings	搜索
num-comments	搜索
num-views	搜索

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

示例:

• Rest API: Search

• Rest API: Group Search

• Rest API: User Search

sortOrder String

对结果进行排序的顺序。

可选值	描述
asc	按照顺序排序。
desc	按照逆序排序。

可选值:"asc"|"desc"

默认值:asc

start Number

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

默认值:1

方法列表

方法详细说明

clone(){PortalQueryParams}

创建调用此方法的 PortalQueryParams 实例的深拷贝。

返回值:

类型	描述
PortalQueryParams	调用此方法的实例的拷贝。