require(["esri/support/ContentElement/Attachments"], function(AttachmentsContentElement) { /* code goes here */ });
Class: esri/support/ContentElement/Attachments
Inheritance: Attachments ContentElement Accessor
Since: ArcGIS API for JavaScript 4.10

An AttachmentsContentElement represents an attachment element associated with a feature. This resource is available only if the FeatureLayer.capabilities.data.supportsAttachment is true.

popuptemplate-attachments-element

See also:
Example:
// Create the AttachmentsContentElement
// If the selected feature has attributes associated with it, they will display within the popup
let attachmentsElement = new AttachmentsContentElement({
  displayType: "list"
});

// Create the PopupTemplate
let template = new PopupTemplate({
  title: "Beverly Hills trees by block",
  outFields: ["*"],
  content: [attachmentsElement]
});

Constructors

new Attachments(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
AttachmentInfo

An array of AttachmentInfo objects used to display within the popup's content.

more details
more detailsAttachments
String

The name of the class.

more details
more detailsAccessor
String

A string value indicating how to display the attachment.

more details
more detailsAttachments
String

The type of popup element displayed.

more details
more detailsAttachments

Property Details

attachmentInfosAttachmentInfoautocast

An array of AttachmentInfo objects used to display within the popup's content.

declaredClassStringreadonly inherited

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

displayTypeString

A string value indicating how to display the attachment. Possible values are: preview | list

If list is specified, attachments show as links.

typeStringreadonly

The type of popup element displayed.

Default Value:attachments

Method Overview

NameReturn TypeSummaryClass
Attachments

Creates a deep clone of the AttachmentsContentElement class.

more details
more detailsAttachments
*

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 detailsAttachments
Object

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

more details
more detailsAttachments

Method Details

clone(){Attachments}

Creates a deep clone of the AttachmentsContentElement class.

Returns:
TypeDescription
AttachmentsA deep clone of the AttachmentsContentElement 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 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...