AttachmentsContent

AMD: require(["esri/popup/content/AttachmentsContent"], (AttachmentsContent) => { /* code goes here */ });
ESM: import AttachmentsContent from "@arcgis/core/popup/content/AttachmentsContent";
Class: esri/popup/content/AttachmentsContent
Inheritance: AttachmentsContent Content Accessor
Since: ArcGIS Maps SDK for JavaScript 4.11

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.

popuptemplate-attachments-element

See also
Example
// 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 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.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
String

Describes the attachment's content in detail.

more details
AttachmentsContent
String

A string value indicating how to display an attachment.

more details
AttachmentsContent
String

A heading indicating what the attachment's content represents.

more details
AttachmentsContent
String

The type of popup element displayed.

more details
AttachmentsContent

Property Details

declaredClass Stringreadonly inherited

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

description String
Since: ArcGIS Maps SDK for JavaScript 4.19

Describes the attachment's content in detail.

displayType String
Since: ArcGIS Maps SDK 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 preview mode.
preview Shows a thumbnail image of the attachment.
list Shows a list of attachment links.

Possible Values:"auto"|"preview"|"list"

Default Value:"auto"
title String
Since: ArcGIS Maps SDK 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

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
*

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

more details
AttachmentsContent
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

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

more details
AttachmentsContent

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

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 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
Type Description
* Returns a new instance of this class.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.