PortalQueryParams

Property Overview

Property Details

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

Since: ArcGIS Maps SDK for JavaScript 4.8

An array of categories stored within the item. Use this property to filter the results from Portal.queryItems() and PortalGroup.queryItems(). It accepts an array of:

• individual string elements or
• an array of strings.

The query looks at each element within the array and performs a SQL AND operation on them. If the element is an array instead of a single string element, the elements within this array are read as OR. See the snippet below:

Note: String[] elements are only supported by ArcGIS Online and version 10.6.1 of Portal for ArcGIS Enterprise.

Example

// 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

Since: ArcGIS Maps SDK for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

extent Extentautocast

Only relevant when querying for PortalItems. When specified, restricts the results of the query to the extent defined here.

The spatial reference of the given extent must be WGS84 (wkid 4326) or Web Mercator (wkid 3857).

filter String

Since: ArcGIS Maps SDK for JavaScript 4.22

Structured filter to use instead of the query property.

See also

• ArcGIS REST API Search Reference

num Number

The maximum number of results to be included in the result set response. The maximum value allowed is 100. The start property combined with the num property can be used to paginate the search results.

Default Value:10

query String

The query string used for the search. View the ArcGIS REST API Search Reference for details on constructing a valid query.

See also

• ArcGIS REST API Search Reference

sortField String

A comma-delimited list of fields to sort. Field names may vary depending on what is being queried. For example, the fields allowed for a user query are much more limited than if performing a basic search query for portal items. A list of possible field names is listed below. These names correspond to either item (search), group, and/or user queries.

Field name	Query functionality
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

Possible Values:"title"|"uploaded"|"modified"|"username"|"created"|"type"|"owner"|"avg-rating"|"num-ratings"|"num-comments"|"num-views"

See also

• Rest API: Search

• Rest API: Group Search

• Rest API: User Search

sortOrder String

The order in which to sort the results.

Possible Value	Description
asc	Sort the results in ascending order.
desc	Sort the results in descending order.

Possible Values:"asc"|"desc"

Default Value:asc

start Number

The index of the first entry in the result set response. The index is 1-based. The start property, along with the num property can be used to paginate the search results.

Default Value:1

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

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

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle[] Handles marked for removal once the object is destroyed.

groupKey * optional Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

clone(){PortalQueryParams}

Creates a deep clone of the instance of PortalQueryParams that calls this method.

Returns

Type	Description
PortalQueryParams	A clone of the instance that called this method.

hasHandles(groupKey){Boolean}inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter

groupKey * optional A group key.

Returns

Type	Description
Boolean	Returns true if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles(groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter

groupKey * optional A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");