AttachmentsViewModel | API Reference | ArcGIS Maps SDK for JavaScript

Provides the logic for the Attachments widget.

See also

Constructors

AttachmentsViewModel Constructor new AttachmentsViewModel(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
AttachmentInfo\|null\|undefined	The current AttachmentInfo being edited.	AttachmentsViewModel
Collection<AttachmentInfo>	A collection of AttachmentInfo defined on a feature.	AttachmentsViewModel
String []\|null\|undefined	An array of strings used to identify attachment(s).	AttachmentsViewModel
String []\|null\|undefined	An array of strings representing MIME types.	AttachmentsViewModel
AttachmentsCapabilities	Configures the attachment editing functionality that can be performed by the user.	AttachmentsViewModel
String	The name of the class.	Accessor
Graphic\|null\|undefined	The graphic for the attachments.	AttachmentsViewModel
String	The current mode performed by the user.	AttachmentsViewModel
AttachmentsOrderByInfo []\|null\|undefined	An array of AttachmentsOrderByInfo indicating the display order for the attachments, and whether they should be sorted in ascending `asc` or descending `desc` order.	AttachmentsViewModel
String	The current state of the widget.	AttachmentsViewModel
Boolean	Defines whether or not the feature supports resizing attachments.	AttachmentsViewModel

Property Details

activeAttachmentInfo Property activeAttachmentInfo AttachmentInfo |null |undefined

The current AttachmentInfo being edited.

See also

ArcGIS REST API - Attachment Infos (Feature Service)

attachmentInfos Property attachmentInfos Collection<AttachmentInfo>readonly

A collection of AttachmentInfo defined on a feature.

See also

ArcGIS REST API - Attachment Infos (Feature Service)

attachmentKeywords Property attachmentKeywords String[] |null |undefined

An array of strings used to identify attachment(s). When attachments are displayed, this property is used to query attachments using an exact match on the keywords provided.

Default Value:null

attachmentTypes Property attachmentTypes String[] |null |undefined

An array of strings representing MIME types. When attachments are displayed, this property is used to query attachments based on MIME type. Valid values: application, audio, image, model, text, and video.

Default Value:null

capabilities Property capabilities AttachmentsCapabilities Since: ArcGIS Maps SDK for JavaScript 4.27 AttachmentsViewModel since 4.15, capabilities added at 4.27.

Configures the attachment editing functionality that can be performed by the user.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

graphic Property graphic Graphic |null |undefinedautocast

The graphic for the attachments.

mode Property mode String

The current mode performed by the user.

Possible Values:"view" |"add" |"edit"

Default Value:"view"

orderByFields Property orderByFields AttachmentsOrderByInfo[] |null |undefinedautocast

An array of AttachmentsOrderByInfo indicating the display order for the attachments, and whether they should be sorted in ascending asc or descending desc order.

state Property state Stringreadonly

The current state of the widget.

Possible Values:"ready" |"disabled" |"loading"

Default Value:"ready"

supportsResizeAttachments Property supportsResizeAttachments Booleanreadonly

Defines whether or not the feature supports resizing attachments. This depends on whether the feature layer's capabilities.attachment.supportsResize is set to true.

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
Promise<AttachmentInfo []>	Queries for the attachments on a feature.	AttachmentsViewModel
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

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.

getAttachments Method getAttachments(){Promise<AttachmentInfo[]>}

Queries for the attachments on a feature. Attachments for multiple features can be queried if the layer's capabilities.operations.supportsQueryAttachments is true.

Returns

Type	Description
Promise<AttachmentInfo []>	When resolved, returns the AttachmentInfo of the queried feature.

See also

FeatureLayer.queryAttachments

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");

Type Definitions

AttachmentsCapabilities Type Definition AttachmentsCapabilities

An object that specifies the available attachments capabilities.

Properties

editing Boolean

optional

Indicates whether to allow attachment editing. The feature layer must be enabled to support editing. Default value is false.

operations Object

optional

Describes the configurable attachments operations. See the object specification below.

Specification: add Boolean

optional
Indicates whether to allow adding attachments. Default value is true.

update Boolean

optional
Indicates whether to allow updating an existing attachment. Default value is true.

delete Boolean

optional
Indicates whether to allow deleting an existing attachment. Default value is true.