require(["esri/widgets/Attachments/AttachmentsViewModel"], (AttachmentsViewModel) => { /* code goes here */ });
import AttachmentsViewModel from "@arcgis/core/widgets/Attachments/AttachmentsViewModel.js";
esri/widgets/Attachments/AttachmentsViewModel
Provides the logic for the Attachments widget.
- See also
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The current AttachmentInfo being edited. | AttachmentsViewModel | ||
A collection of AttachmentInfo defined on a feature. | AttachmentsViewModel | ||
Configures the attachment editing functionality that can be performed by the user. | AttachmentsViewModel | ||
The name of the class. | Accessor | ||
The graphic for the attachments. | AttachmentsViewModel | ||
The current mode performed by the user. | AttachmentsViewModel | ||
The current state of the widget. | AttachmentsViewModel | ||
Defines whether or not the feature supports resizing attachments. | AttachmentsViewModel |
Property Details
-
activeAttachmentInfo
activeAttachmentInfo AttachmentInfo
-
The current AttachmentInfo being edited.
-
attachmentInfos
attachmentInfos AttachmentInfo[]readonly
-
A collection of AttachmentInfo defined on a feature.
-
capabilities
capabilities AttachmentsCapabilities
Since: ArcGIS Maps SDK for JavaScript 4.27AttachmentsViewModel since 4.15, capabilities added at 4.27. -
Configures the attachment editing functionality that can be performed by the user.
-
graphic
graphic Graphic
-
The graphic for the attachments.
-
mode
mode String
-
The current mode performed by the user.
Possible Values:"view" |"add" |"edit"
- Default Value:"view"
-
state
state Stringreadonly
-
The current state of the widget.
Possible Values:"ready" |"disabled" |"loading"
- Default Value:"ready"
-
supportsResizeAttachments
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
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Queries for the attachments on a feature. | AttachmentsViewModel | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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
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
.ReturnsType Description Promise<AttachmentInfo[]> When resolved, returns the AttachmentInfo of the queried feature. - See also
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
Type Definitions
-
An object that specifies the available attachments capabilities.
- Properties
-
editing Boolean
Indicates whether to allow attachment editing. The feature layer must be enabled to support editing. Default value is
false
.optional Describes the configurable attachments operations. See the object specification below.
- Specification
-
add Boolean
Indicates whether to allow adding attachments. Default value is
true
.update BooleanIndicates whether to allow updating an existing attachment. Default value is
true
.delete BooleanIndicates whether to allow deleting an existing attachment. Default value is
true
.