AttachmentsViewModel

Property Overview

Property Details

activeAttachmentInfo AttachmentInfo

The current AttachmentInfo being edited.

See also

• ArcGIS REST API - Attachment Infos (Feature Service)

attachmentInfos AttachmentInfo[]readonly

A collection of AttachmentInfo defined on a feature.

See also

• ArcGIS REST API - Attachment Infos (Feature Service)

capabilities AttachmentsCapabilities

Since: ArcGIS Maps SDK for JavaScript 4.27

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

declaredClass Stringreadonly inherited

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

graphic Graphic

The graphic for the attachments.

mode String

The current mode performed by the user.

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

Default Value:"view"

state Stringreadonly

The current state of the widget.

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

Default Value:"ready"

supportsResizeAttachments Boolean

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

Method Overview

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

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

Type Definitions

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.