Skip To ContentArcGIS for DevelopersSign In Dashboard

AttachmentQuery

require(["esri/tasks/support/AttachmentQuery"], function(AttachmentQuery) { /* code goes here */ });
Class: esri/tasks/support/AttachmentQuery
Inheritance: AttachmentQuery Accessor
Since: ArcGIS API for JavaScript 4.9

This class defines parameters for executing queries for feature attachments from a feature layer. Once an AttachmentQuery object's properties are defined, it can then be passed into the QueryTask.executeAttachmentQuery() or FeatureLayer.queryAttachments() methods, which will return attachmentInfos grouped by the source feature objectIds.

Known Limitations

See also:

Constructors

new AttachmentQuery(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String[]

The file format that is supported by query attachment.

more details
more detailsAttachmentQuery
String

The name of the class.

more details
more detailsAccessor
Number[]

An array of globalIds for the features in the layer being queried.

more details
more detailsAttachmentQuery
Number

The number of features to retrieve.

more details
more detailsAttachmentQuery
Number[]

An array of objectIds of the features to be queried for attachments.

more details
more detailsAttachmentQuery
Boolean

If true, the Exchangeable image file format for the attachment will be included in attachmentInfo.

more details
more detailsAttachmentQuery
Number[]

The file size of the attachment is specified in bytes.

more details
more detailsAttachmentQuery
Number

This option fetches query results by skipping a specified number of records.

more details
more detailsAttachmentQuery
String

The where clause to be applied to the layer.

more details
more detailsAttachmentQuery

Property Details

attachmentTypes String[]

The file format that is supported by query attachment. For example, image/jpeg. See the ArcGIS REST API documentation for more information on supported attachment types.

Requires an ArcGIS Server service 10.5 or greater and feature layer's capabilities.query.supportsAttachments to be true.

declaredClass Stringreadonly inherited

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

globalIds Number[]

An array of globalIds for the features in the layer being queried. The query results will return attachments only for specified global ids.

Requires an ArcGIS Server service 10.5 or greater and feature layer's capabilities.query.supportsAttachments to be true.

num Number

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). Default Value is 10.

If not provided, but an instance of AttachmentQuery has a start property, then the default value of num is maxRecordCount. The maximum value for this parameter is the value of the layer's maxRecordCount of the service, which can be found at the REST endpoint of the feature layer.

Requires an ArcGIS Server service 10.5 or greater and feature layer's capabilities.query.supportsAttachments to be true.

objectIds Number[]

An array of objectIds of the features to be queried for attachments. When the feature layer's capabilities.query.supportsAttachments property is false, it only accepts a single objectId.

returnMetadata Boolean
Since: ArcGIS API for JavaScript 4.11

If true, the Exchangeable image file format for the attachment will be included in attachmentInfo.

Default Value:false

The file size of the attachment is specified in bytes. You can enter a file size range [1000,15000] to query for attachments. The query result will return all attachments within the specified file size range (1000 - 15000).

Requires an ArcGIS Server service 10.5 or greater and feature layer's capabilities.query.supportsAttachments to be true.

start Number

This option fetches query results by skipping a specified number of records. The query results start from the next record. The default value is 0. This parameter only applies when the feature layer's capabilities.query.supportsPagination is true. You can use this option to fetch records that are beyond maxRecordCount.

Requires an ArcGIS Server service 10.5 or greater and feature layer's capabilities.query.supportsAttachments to be true.

where String
Since: ArcGIS API for JavaScript 4.11

The where clause to be applied to the layer. Only features that satisfy the where clause and are in the list of objectIds will be returned. Requires an ArcGIS Server service 10.5 or greater and feature layer's capabilities.query.supportsAttachments to be true.

Method Overview

NameReturn TypeSummaryClass
AttachmentQuery

Creates a deep clone of AttachmentQuery object.

more details
more detailsAttachmentQuery
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsAttachmentQuery
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
more detailsAttachmentQuery

Method Details

Creates a deep clone of AttachmentQuery object.

Returns:
TypeDescription
AttachmentQueryA new instance of a AttachmentQuery 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:
TypeDescription
*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() topic in the Guide for more information.

Returns:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...