Property Overview

Property Details

declaredClass Stringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

gdbVersion String

Since: ArcGIS API for JavaScript 4.7

Specify the geodatabase version to query.

geometryPrecision Number

Specify the number of decimal places for the geometries returned by the query operation.

historicMoment Date

Since: ArcGIS API for JavaScript 4.7

The historic moment to query. This parameter applies only if the supportsHistoricMoment on FeatureLayer property of the layer is set to true.

maxAllowableOffset Number

The maximum allowable offset used for generalizing geometries returned by the query operation. The offset is in the units of outSpatialReference. If outSpatialReference is not defined, the spatialReference of the view is used.

num Number

Since: ArcGIS API for JavaScript 4.17

The number of features to retrieve. This option should be used in conjunction with the start property. Use this to implement paging (i.e. to retrieve "pages" of results when querying).

If not provided, but an instance of Query has a start property, then the default value of num is 10. If neither num nor start properties are provided, then the default value of num is equal to the maxRecordCount of the service, which can be found at the REST endpoint of the FeatureLayer.

objectIds Number[]

An array of objectIds for the features in the layer/table being queried.

orderByFields String[]

Since: ArcGIS API for JavaScript 4.17

One or more field names used to order the query results. Specify ASC (ascending) or DESC (descending) after the field name to control the order. The default order is ASC.

Known Limitations

• If querying a MapImageLayer, then supportsAdvancedQueries must be true on the service.
• For FeatureLayer, FeatureLayer.capabilities.queryRelated.supportsOrderBy must be true.

See also:

• FeatureLayer.capabilities

Example:

query.orderByFields = ["STATE_NAME DESC"];

outFields String[]

Attribute fields to include in the FeatureSet. Fields must exist in the map layer. You must list actual field names rather than the alias names. You are, however, able to use the alias names when you display the results.

When specifying 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. However, your list of fields does not need to include these two fields.

Example:

query.outFields = [ "NAME", "STATE_ABBR", "POP04" ];

outSpatialReference SpatialReferenceautocast

The spatial reference for the returned geometry. If outSpatialReference is not defined, the spatialReference of the view is used.

relationshipId Number

The ID of the relationship to be queried. The ids for the relationships the table or layer participates in are listed in the ArcGIS Services directory. The ID of the relationship to be queried. The relationships that this layer/table participates in are included in the Feature Service Layer resource response. Records in tables/layers corresponding to the related table/layer of the relationship are queried.

returnGeometry Boolean

If true, each feature in the FeatureSet includes the geometry. Set to false (default) if you do not plan to include highlighted features on a map since the geometry makes up a significant portion of the response.

Default Value:false

returnM Boolean

Since: ArcGIS API for JavaScript 4.16

If true, and returnGeometry is true, then m-values are included in the geometry.

returnZ Boolean

Since: ArcGIS API for JavaScript 4.16

If true, and returnGeometry is true, then z-values are included in the geometry.

start Number

Since: ArcGIS API for JavaScript 4.17

The zero-based index indicating where to begin retrieving features. This property should be used in conjunction with num. Use this to implement paging and retrieve "pages" of results when querying. Features are sorted ascending by object ID by default.

where String

Since: ArcGIS API for JavaScript 4.11

The definition expression to be applied to the related table or layer. Only records in the list of objectIds that satisfy the definition expression are queried for related records.

Method Overview

Method Details

clone(){RelationshipQuery}

Since: ArcGIS API for JavaScript 4.7

Creates a deep clone of RelationshipQuery object.

Returns:

Type	Description
RelationshipQuery	A new instance of a RelationshipQuery object equal to the object used to call .clone().

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:

json Object A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:

Type	Description
*	Returns a new instance of this class.

toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.