AttachmentInput

AMD: require(["esri/form/elements/inputs/attachments/AttachmentInput"], (AttachmentInput) => { /* code goes here */ });
ESM: import AttachmentInput from "@arcgis/core/form/elements/inputs/attachments/AttachmentInput.js";
Class: esri/form/elements/inputs/attachments/AttachmentInput
Inheritance: AttachmentInputAccessor
Since: ArcGIS Maps SDK for JavaScript 4.31

The AttachmentInput class defines a flexible user interface for an attachment input. This input is used in attachment elements that are set within a feature layer's or FeatureForm's formTemplate. This is displayed within the Editor widget.

See also
  • esri/form/elements/inputs/attachments/AttachmentElement
Example
// Creates a new AttachmentInput for an attachment element within a form
const attachmentInput = new AttachmentInput({
  inputTypes: [
   { // autocastable to ImageInput
     type: "image",
     maxImageSize: 800,
   },
   { // autocastable to VideoInput
     type: "video",
     inputMethod: "capture",
   },
  ]
});

Constructors

AttachmentInput

Constructor
new AttachmentInput(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

String value which indicates if existing attachments should be associated with the element and how they should be associated.

AttachmentInput

The name of the class.

Accessor

Available inputs to add an attachment.

AttachmentInput

The input type identifier.

AttachmentInput

Property Details

attachmentAssociationType

Property
attachmentAssociationType String

String value which indicates if existing attachments should be associated with the element and how they should be associated. This property is used in conjunction with the attachmentKeyword property.

The table below describes the options.

value description
any Associates all existing attachments to this element. This must be the only attachment element within the form.
exact Associates any attachments with the associated attachmentKeyword.
exactOrNone Associates only attachments that have the keyword specified by attachmentKeyword and any attachments with no keyword defined.

Possible Values:"any" |"exact" |"exactOrNone"

Default Value:"exact"
See also

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

Available inputs to add an attachment.

type

Property
type Stringreadonly

The input type identifier. Valid value of this property is "attachment"

For AttachmentInput the type is always "attachment".

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.

Accessor
this

Creates a deep clone of this object.

AttachmentInput
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

AttachmentInput

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Converts an instance of this class to its ArcGIS portal JSON representation.

AttachmentInput

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor

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){*}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
* Returns a new instance of this class.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor

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

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.

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