RelatedQueryParameters QML Type

Contains the input parameters for a related tables query. More...

Import Statement:	import Esri.ArcGISRuntime 100.15
Since:	Esri.ArcGISRuntime 100.1
Inherits:	Object

List of all members, including inherited members

Properties

maxFeatures : int
orderByFields : list<OrderBy>
relationshipInfo : RelationshipInfo
resultOffset : int
returnGeometry : bool
whereClause : string

Detailed Description

Instances of this type represent the query parameters to perform a related query operation. A prerequisite for querying related features is that all the participating tables must be part of a map, as either feature layers or non-spatial tables.

RelatedQueryParameters lets you specify details about the related query to perform and how to return the result, including:

Details about the relationship to be queried.
A whereClause 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

Property Documentation

maxFeatures : int

The maximum number of features the query should return.

If 0, then there is no limit set on the number of features.

This property was introduced in Esri.ArcGISRuntime 100.3.

[default] orderByFields : list<OrderBy>

The list of OrderBy objects, indicating the fields the results are sorted by, and the order in which they are sorted.

Results can be sorted on one or more fields. Each OrderBy instance includes a field name and whether to sort by that field in ascending or descending order.

See also OrderBy.

relationshipInfo : RelationshipInfo

The RelationshipInfo that is being used to define the tables to use for this query.

See also RelationshipInfo.

resultOffset : int

The starting offset of results to fetch in the query.

When providing a result offset to support paging of results, you must also set a maximum features value. If the result offset is set, but the maximum features value is not, the offset is ignored. For consistent ordering of the results when using pagination, the orderByFields property must be set.

This property was introduced in Esri.ArcGISRuntime 100.3.

returnGeometry : bool

Whether geometries are returned in the result.

Default value is true.

whereClause : string

The where clause to apply in the query.

Signal Documentation

maxFeaturesChanged()

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.

resultOffsetChanged()

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.