AttachmentInfo
require(["esri/layers/support/AttachmentInfo"], function(AttachmentInfo) { /* code goes here */ });
esri/layers/support/AttachmentInfo
The AttachmentInfo
class returns information about attachments associated with a feature. The contents of the attachment are streamed to the client. Attachments are available if the FeatureLayer.capabilities.data.supportsAttachment is true
.
Constructors
- new AttachmentInfo(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | The content type of the attachment. more details | more details | AttachmentInfo | |
String | The name of the class. more details | more details | Accessor | |
ExifInfo[] | An array of ExifInfo for the attachment. more details | more details | AttachmentInfo | |
String | The global identifier for the attachment. more details | more details | AttachmentInfo | |
Number | The identifier for the attachment. more details | more details | AttachmentInfo | |
String | Keywords used for the attachments. more details | more details | AttachmentInfo | |
String | String value indicating the name of the file attachment. more details | more details | AttachmentInfo | |
OrientationInfo | The OrientationInfo for the attachment. more details | more details | AttachmentInfo | |
Number | The parent or the feature global id of the attachment. more details | more details | AttachmentInfo | |
Number | The parent or the feature object id of the attachment. more details | more details | AttachmentInfo | |
Number | The file size of the attachment. more details | more details | AttachmentInfo | |
String | The URL of the attachment. more details | more details | AttachmentInfo |
Property Details
- contentType String
The content type of the attachment. For example,
'image/jpeg'
. See the ArcGIS REST API documentation for more information on supported attachment types.
The name of the class. The declared class name is formatted as
esri.folder.className
.
- Since: ArcGIS API for JavaScript 4.11
An array of ExifInfo for the attachment.
- globalId String
The global identifier for the attachment.
- id Number
The identifier for the attachment.
- keywords String
Keywords used for the attachments.
- name String
String value indicating the name of the file attachment.
- orientationInfo OrientationInforeadonlySince: ArcGIS API for JavaScript 4.12
The OrientationInfo for the attachment. This is derived from the exifInfo. In order to read this, you must first set the attachment query's returnMetadata to
true
to get theexif
info associated with the attachment.
- parentGlobalId Number
The parent or the feature global id of the attachment.
- parentObjectId Number
The parent or the feature object id of the attachment.
- size Number
The file size of the attachment. This is specified in bytes.
- url String
The URL of the attachment.
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
AttachmentInfo | Creates a deep clone of the AttachmentInfo class. more details | more details | AttachmentInfo | |
* | 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 details | AttachmentInfo | |
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | AttachmentInfo |
Method Details
- clone(){AttachmentInfo}
Creates a deep clone of the AttachmentInfo class.
Returns:Type Description AttachmentInfo A deep clone of the AttachmentInfo instance.
- 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 ObjectA 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() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.
Type Definitions
- ExifInfo
An array of Exchangeable image file format information for the attachment. You must set the attachment query's returnMetadata to
true
to get theexif
info associated with the attachment.
- OrientationInfo
An object containing properties specific to the orientation of an image attachment. This information is stored within the attachment's exifInfo. In order to read this, you must first set the attachment query's returnMetadata to
true
to get theexif
info associated with the attachment.