An AttachmentsContent popup element represents an attachment element associated with a
feature. This resource is available only if the FeatureLayer.capabilities.data.supportsAttachment
is true.
- See also:
// Create the AttachmentsContent popup element
// If the selected feature has attributes associated with it, they will display within the popup
let attachmentsElement = new AttachmentsContent({
displayType: "list" // this will show all attachments as a list of linked files
});
// Create the PopupTemplate
let template = new PopupTemplate({
title: "Beverly Hills trees by block",
outFields: ["*"],
content: [attachmentsElement]
});Constructors
-
new AttachmentsContent(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 | more details The name of the class. | more details | Accessor | |
| String | more details Describes the attachment's content in detail. | more details | AttachmentsContent | |
| String | more details A string value indicating how to display an attachment. | more details | AttachmentsContent | |
| String | more details A heading indicating what the attachment's content represents. | more details | AttachmentsContent | |
| String | more details The type of popup element displayed. | more details | AttachmentsContent |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className.
-
description StringSince: ArcGIS API for JavaScript 4.19
-
Describes the attachment's content in detail.
-
displayType StringSince: ArcGIS API for JavaScript 4.22
-
A string value indicating how to display an attachment.
Value Description auto If a feature layer's capabilities supports resizing attachments, the popup will display attachments in previewmode.preview Shows a thumbnail image of the attachment. list Shows a list of attachment links. Possible Values:"auto"|"preview"|"list"
- Default Value:"auto"
-
title StringSince: ArcGIS API for JavaScript 4.19
-
A heading indicating what the attachment's content represents.
-
type Stringreadonly
-
The type of popup element displayed.
For AttachmentsContent the type is always "attachments".
- Default Value:attachments
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| * | more details Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | more details | AttachmentsContent | |
| Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | more details | AttachmentsContent |
Method Details
-
fromJSON(json){*}static
-
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input
jsonparameter 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() guide topic for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.