ESM: import PortalQueryParams from "@arcgis/core/portal/PortalQueryParams.js";
CDN: const PortalQueryParams = await $arcgis.import("@arcgis/core/portal/PortalQueryParams.js");
Class: @arcgis/core/portal/PortalQueryParams
Since: ArcGIS Maps SDK for JavaScript 4.0
Property Overview Any properties can be set, retrieved or listened to. See the Watch for changes topic.Show inherited properties Hide inherited properties
Property DetailsSince: ArcGIS Maps SDK for JavaScript 4.8 PortalQueryParams since 4.0, categories added at 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:
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:
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"]];
Inherited
Property declaredClass Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.
The name of the class. The declared class name is formatted as esri.folder.className
.
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).
Since: ArcGIS Maps SDK for JavaScript 4.22 PortalQueryParams since 4.0, filter added at 4.22.
Structured filter to use instead of the query property.
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.
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 searchPossible Values:"title" |"uploaded" |"modified" |"username" |"created" |"type" |"owner" |"avg-rating" |"num-ratings" |"num-comments" |"num-views"
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"
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.
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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
Handles marked for removal once the object is destroyed.
groupKey *
optionalKey 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.
Creates a deep clone of the instance of PortalQueryParams that calls this method.
Returns
Inherited
Method hasHandles(groupKey){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue
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");
}
Inherited
Method removeHandles(groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA 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");
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4