AttachmentsContent
require(["esri/popup/content/AttachmentsContent"], function(AttachmentsContent) { /* code goes here */ });
esri/popup/content/AttachmentsContent
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
.
// 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"
});
// 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 | |
---|---|---|---|---|
AttachmentInfo | An array of AttachmentInfo objects used to display within the popup's content. more details | more details | AttachmentsContent | |
String | The name of the class. more details | more details | Accessor | |
String | A string value indicating how to display the attachment. more details | more details | AttachmentsContent | |
String | The type of popup element displayed. more details | more details | AttachmentsContent |
Property Details
- attachmentInfos AttachmentInfoautocast
An array of AttachmentInfo objects used to display within the popup's content.
The name of the class. The declared class name is formatted as
esri.folder.className
.
- displayType String
A string value indicating how to display the attachment.
If
list
is specified, attachments show as links.Possible Values:"preview"|"list"
- 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 | |
---|---|---|---|---|
* | 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 | AttachmentsContent | |
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | 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 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.