AttachmentsContent | API Reference | ArcGIS Maps SDK for JavaScript 4.32

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

Preview view	List view

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({
  // Shows all attachments as a list of linked files
  displayType: "list",
  // Sorts the attachments by their `ATT_NAME` attachmentInfo field in descending order
  orderByFields: [{ field: "ATT_NAME", order: "descending" }]
});

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

Constructors

AttachmentsContent Constructor 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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
String\|null\|undefined	Describes the attachment's content in detail.	AttachmentsContent
String	A string value indicating how to display an attachment.	AttachmentsContent
AttachmentsOrderByInfo []\|null\|undefined	An array of AttachmentsOrderByInfo indicating the display order for the attachments, and whether they should be sorted in ascending or descending order.	AttachmentsContent
String\|null\|undefined	A heading indicating what the attachment's content represents.	AttachmentsContent
String	The type of popup element displayed.	AttachmentsContent

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

description Property description String |null |undefined Since: ArcGIS Maps SDK for JavaScript 4.19 AttachmentsContent since 4.11, description added at 4.19.

Describes the attachment's content in detail. Starting at version 4.30, the description supports rendering HTML.

displayType Property displayType String Since: ArcGIS Maps SDK for JavaScript 4.22 AttachmentsContent since 4.11, displayType added at 4.22.

A string value indicating how to display an attachment.

Value	Description
auto	The attachments will display in `preview` mode if the feature layer capabilities or sublayer capabilites support resized attachments. Otherwise, the attachments are displayed in `list` mode.
preview	Shows a thumbnail image of the attachment.
list	Shows a list of attachment links.

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

Default Value:"auto"

orderByFields Property orderByFields AttachmentsOrderByInfo[] |null |undefinedautocast Since: ArcGIS Maps SDK for JavaScript 4.32 AttachmentsContent since 4.11, orderByFields added at 4.32.

An array of AttachmentsOrderByInfo indicating the display order for the attachments, and whether they should be sorted in ascending or descending order. This only applies if the feature layer capabilities supports attachment.supportsOrderByFields.

Example

// Sort the attachments by their `ATT_NAME` attribute in descending order
const attachmentsElement = new AttachmentsContent({
  orderByFields: [
    { field: "ATT_NAME", order: "descending" }
  ]
});

title Property title String |null |undefined Since: ArcGIS Maps SDK for JavaScript 4.19 AttachmentsContent since 4.11, title added at 4.19.

A heading indicating what the attachment's content represents. Starting at version 4.30, the title supports rendering HTML.

type Property 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

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
this	Creates a deep clone of this object.	AttachmentsContent
*\|null\|undefined	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	AttachmentsContent
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	AttachmentsContent

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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 }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

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.

clone Method clone(){this}

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns

Type	Description
this	A deep clone of the class instance that invoked this method.

fromJSON Method fromJSON(json){* |null |undefined}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
* \| null \| undefined	Returns a new instance of this class.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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 Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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 Method 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.