Skip To Content ArcGIS for Developers Sign In Dashboard

PortalQueryParameters QML Type

Base class for parameters needed to perform a search within a Portal. More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.0
Inherits:

Object

Inherited By:

PortalQueryParametersForGroups and PortalQueryParametersForItems

Properties

Signals

Detailed Description

Note: You cannot declare or create a component of this type in QML code.

This class cannot be created but forms ths basis for parameters used when searching for items, and groups. Queries can be specified using this type such that they are limited to:

  • the number of results returned.
  • a spatial search area.
  • resources within an organization.

Results can also be sorted. Start index and results limit are used when paging through large result sets.

See the ArcGIS REST API for more details.

This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.

TypeDefault Property
EnvelopeboundingBox

See also PortalQueryParametersForItems, PortalQueryParametersForGroups, and Portal.

Property Documentation

[default] boundingBox : Envelope

The bounding box for a spatial search.

Spatial search is an overlaps/intersects function of the query bbox and the extent.


limit : int

Gets the results limit, which is used when paging through large result sets.

The default value is 10, and the maximum allowed value is 100.

The startIndex parameter, along with this parameter, can be used to paginate the search results.

The actual number of returned results may be less than the limit. This happens when the number of results remaining after startIndex is less than the limit.


query : string

The query string used to search with.


searchPublic : bool

Returns whether public items outside the organization may be included in the query.


searchString : string

The search string.


sortField : string

Field(s) to sort by.

You can sort by multiple fields by specifying a comma-separated list for field names.

Allowed sort fields are: title, uploaded, type, owner, modified, avgRating, numRatings, numComments, and numViews


sortOrder : Enums.PortalQuerySortOrder

Gets the sort order, indicating whether the results are returned in ascending or descending order.

See also Enums.PortalQuerySortOrder.


startIndex : int

The start index, which is used when paging through large result sets.

The default value of start is 1 (that is, the first search result).

This parameter, along with the limit parameter, can be used to paginate the search results.


Signal Documentation

boundingBoxChanged()

Emitted when the boundingBox property changes.


limitChanged()

Emitted when the limit property changes.


queryChanged()

Emitted when the query property changes.


searchPublicChanged()

Emitted when the searchPublic property changes.


searchStringChanged()

Emitted when the searchString property changes.


sortFieldChanged()

Emitted when the sortField property changes.


sortOrderChanged()

Emitted when the sortOrder property changes.


startIndexChanged()

Emitted when the startIndex property changes.



Feedback on this topic?