AttachmentsViewModel

AMD: require(["esri/widgets/Attachments/AttachmentsViewModel"], (AttachmentsViewModel) => { /* code goes here */ });
ESM: import AttachmentsViewModel from "@arcgis/core/widgets/Attachments/AttachmentsViewModel";
Class: esri/widgets/Attachments/AttachmentsViewModel
Inheritance: AttachmentsViewModel Accessor
Since: ArcGIS API for JavaScript 4.15

Provides the logic for the Attachments widget.

See also

Constructors

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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
AttachmentInfo

The current AttachmentInfo being edited.

more details
AttachmentsViewModel
AttachmentInfo[]

A collection of AttachmentInfo defined on a feature.

more details
AttachmentsViewModel
String

The name of the class.

more details
Accessor
Graphic

The graphic for the attachments.

more details
AttachmentsViewModel
String

The current mode performed by the user.

more details
AttachmentsViewModel
String

The current state of the widget.

more details
AttachmentsViewModel
Boolean

Defines whether or not the feature supports resizing attachments.

more details
AttachmentsViewModel

Property Details

activeAttachmentInfo AttachmentInfo

The current AttachmentInfo being edited.

See also
attachmentInfos AttachmentInfo[]readonly

A collection of AttachmentInfo defined on a feature.

See also
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

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
Promise<AttachmentInfo[]>

Queries for the attachments on a feature.

more details
AttachmentsViewModel
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

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API 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.

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
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API 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 API 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");

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