Base class for parameters needed to perform a search within a Portal. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: | |
| Inherited By: | PortalQueryParametersForGroups and PortalQueryParametersForItems |
Properties
- boundingBox : Envelope
- categories : list<string>
- limit : int
- query : string
- searchPublic : bool
- searchString : string
- sortField : string
- sortOrder : Enums.PortalQuerySortOrder
- startIndex : int
Signals
- boundingBoxChanged()
- categoriesChanged()
- limitChanged()
- queryChanged()
- searchPublicChanged()
- searchStringChanged()
- sortFieldChanged()
- sortOrderChanged()
- startIndexChanged()
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.
| Type | Default Property |
|---|---|
| Envelope | boundingBox |
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.
The string list of content category specifications to use when searching for items.
Each entry in the list is a string containing a comma-separated list of up to eight organization-level content categories.
The full path of each category is required and an OR relationship is applied between the categories within a particular string.
There can be up to eight Strings with an AND relationship being applied between the different strings.
For example, to search for items belonging to either the Water or Forest categories, both within the US, specify two strings as follows: "/Categories/Water,/Categories/Forest" and "/Region/US".
The categories property is ignored if the PortalQueryParameters is used to search for groups using Portal::findGroups.
This property was introduced in Esri.ArcGISRuntime 100.13.
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.
Returns whether public items outside the organization may be included in the query.
Field(s) to sort by.
You can sort by multiple fields by specifying a comma-separated list for field names.
Sort field names are case-insensitive. Allowed sort fields are: title, created, type, owner, modified, avgrating, numratings, numcomments, and numviews.
Gets the sort order, indicating whether the results are returned in ascending or descending order.
See also Enums.PortalQuerySortOrder.
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
Emitted when the boundingBox property changes.
Note: The corresponding handler is onBoundingBoxChanged.
Emitted when the categories property changes.
Note: The corresponding handler is onCategoriesChanged.
This signal was introduced in Esri.ArcGISRuntime 100.13.
Emitted when the limit property changes.
Note: The corresponding handler is onLimitChanged.
Emitted when the query property changes.
Note: The corresponding handler is onQueryChanged.
Emitted when the searchPublic property changes.
Note: The corresponding handler is onSearchPublicChanged.
Emitted when the searchString property changes.
Note: The corresponding handler is onSearchStringChanged.
Emitted when the sortField property changes.
Note: The corresponding handler is onSortFieldChanged.
Emitted when the sortOrder property changes.
Note: The corresponding handler is onSortOrderChanged.
Emitted when the startIndex property changes.
Note: The corresponding handler is onStartIndexChanged.