Defines query parameters for the QueryTask.executeRelationshipQuery() method.
Constructors
new RelationshipQuery(properties)
properties Object See the properties for a list of all the properties that may be passed into the constructor. |
Property Overview
| Name | Type | Summary | |
|---|---|---|---|
| String | The name of the class. more details | more details | |
| String | The definition expression to be applied to the related table or layer. more details | more details | |
| Number | Specify the number of decimal places for the geometries returned by the query operation. more details | more details | |
| Number | The maximum allowable offset used for generalizing geometries returned by the query operation. more details | more details | |
| Number[] | A comma delimited list of | more details | |
| String[] | Attribute fields to include in the FeatureSet. more details | more details | |
| SpatialReference | The spatial reference for the returned geometry. more details | more details | |
| Number | The ID of the relationship to test. more details | more details | |
| Boolean | If | more details | |
Property Details
declaredClassStringreadonly
The name of the class. The declared class name is formatted as
esri.folder.className.definitionExpressionString
The definition expression to be applied to the related table or layer. Only records that fit the definition expression and are in the list of
objectIdswill be returned.geometryPrecisionNumber
Specify the number of decimal places for the geometries returned by the query operation.
maxAllowableOffsetNumber
The maximum allowable offset used for generalizing geometries returned by the query operation. The offset is in the units of the
outSpatialReference. IfoutSpatialReferenceis not defined, the spatial reference of the map is used.objectIdsNumber[]
A comma delimited list of
ObjectIdsfor the features in the layer/table that you want to query.outFieldsString[]
Attribute fields to include in the FeatureSet. Fields must exist in the map layer. You must list the actual field names rather than the alias names. Returned fields are also the actual field names. However, you are able to use the alias names when you display the results. You can set field alias names in the map document.
When you specify the output fields, you should limit the fields to only those you expect to use in the query or the results. The fewer fields you include, the faster the response will be.
Each query must have access to the Shape and ObjectId fields for a layer, but your list of fields does not need to include these two fields.
outSpatialReferenceSpatialReference
The spatial reference for the returned geometry. If not specified, the geometry is returned in the spatial reference of the map.
relationshipIdNumber
The ID of the relationship to test. The ids for the relationships the table or layer participates in are listed in the ArcGIS Services directory.
returnGeometryBoolean
If
true, each feature in the FeatureSet includes the geometry. Set tofalse(default) if you do not plan to include highlighted features on a map since the geometry makes up a significant portion of the response.
Method Overview
| Name | Return Type | Summary | |
|---|---|---|---|
| Object | Converts an instance of this class to its ArcGIS Portal JSON representation. more details | more details | |
Method Details
toJSON(){Object}
Converts an instance of this class to its ArcGIS Portal JSON representation. See the Using fromJSON() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS Portal JSON representation of an instance of this class.