RelatedQueryParameters QML Type
Parameters to perform a related query on an ArcGISFeatureTable. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.1 |
| Inherits: |
Properties
- maxFeatures : int
- orderByFields : list<OrderBy>
- relationshipInfo : RelationshipInfo
- resultOffset : int
- returnGeometry : bool
- whereClause : string
Signals
- maxFeaturesChanged()
- orderByFieldsChanged()
- relationshipInfoChanged()
- resultOffsetChanged()
- returnGeometryChanged()
- whereClauseChanged()
Detailed Description
When querying related features, all participating tables must be included in the same Map or Scene, as either feature layers or non-spatial tables. The query that uses these parameters will load these related tables.
RelatedQueryParameters lets you specify:
- Details about the relationship to be queried.
- A where clause used to filter features from the related table.
- How to sort the results.
- Whether to return geometry within the results.
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 |
|---|---|
| OrderBy | orderByFields (appends to list) |
| RelationshipInfo | relationshipInfo |
See also ArcGISFeatureTable::queryRelatedFeatures() and ServiceFeatureTable::queryRelatedFeaturesWithFieldOptions().
Property Documentation
[since Esri.ArcGISRuntime 100.3] maxFeatures : int |
The maximum number of features the query should return.
For consistent ordering of results when using pagination, provide a value for orderByFields. Note that if you provide a maximum features value to support paging of results, you must also set a QueryParameters::resultOffset value. Otherwise, the result may contain local features in place of server features if they satisfy the query. To ensure strict paging of server features, specify both maximum features and resultOffset.
This property was introduced in Esri.ArcGISRuntime 100.3.
[default] orderByFields : list<OrderBy> |
The list of OrderBy objects that indicates how to sort the results.
Results can be sorted on one or more fields. Each order by instance includes a field name and whether to sort by that field in ascending or descending order. If a service-based table is being queried it must support advanced queries.
See also OrderBy.
relationshipInfo : RelationshipInfo |
The RelationshipInfo that is being used to define the tables to use for this query.
See also RelationshipInfo.
[since Esri.ArcGISRuntime 100.3] resultOffset : int |
The starting offset of results to fetch. This is useful for paging through results.
For consistent ordering of results when using pagination, you should also provide a value for the orderByFields. Note that if you provide a result offset to support paging of results, you must also set a maxFeatures value. Otherwise, the result offset is ignored.
This property was introduced in Esri.ArcGISRuntime 100.3.
returnGeometry : bool |
true if geometry values are returned in the results, otherwise false.
This is needed when you want to display the features on a map or a scene. When querying non-spatial data, results do not include geometry.
Default value is true.
whereClause : string |
The where clause to apply to the destination table.
The where clause should follow standard SQL syntax similar to that discussed in the document SQL reference for query expressions used in ArcGIS.
If the where clause includes dates, they must be correctly formatted based on the geodatabase datasource used in the service. Refer to Dates and time for date formats expected by different data sources.
ArcGISFeatureTable objects expect that any Enums.FieldTypeGlobalId or Enums.FieldTypeGUID parameters in the where clause are formatted as: '{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}'. All characters are uppercase, wrapped in curly braces and surrounded by single quotes.
Signal Documentation
|
Emitted when the maxFeatures property changes.
Note: The corresponding handler is onMaxFeaturesChanged.
This signal was introduced in Esri.ArcGISRuntime 100.3.
orderByFieldsChanged() |
Emitted when the orderByFields property changes.
Note: The corresponding handler is onOrderByFieldsChanged.
relationshipInfoChanged() |
Emitted when the relationshipInfo property changes.
Note: The corresponding handler is onRelationshipInfoChanged.
|
Emitted when the resultOffset property changes.
Note: The corresponding handler is onResultOffsetChanged.
This signal was introduced in Esri.ArcGISRuntime 100.3.
returnGeometryChanged() |
Emitted when the returnGeometry property changes.
Note: The corresponding handler is onReturnGeometryChanged.
whereClauseChanged() |
Emitted when the whereClause property changes.
Note: The corresponding handler is onWhereClauseChanged.