require(["esri/form/elements/inputs/attachments/AttachmentInput"], (AttachmentInput) => { /* code goes here */ });
import AttachmentInput from "@arcgis/core/form/elements/inputs/attachments/AttachmentInput.js";
esri/form/elements/inputs/attachments/AttachmentInput
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
// 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
-
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 |
---|---|---|---|
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
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
-
inputTypes
inputTypes Array<(AudioInput|DocumentInput|ImageInput|SignatureInput|VideoInput)>autocast
-
Available inputs to add an attachment.
- Default Value:null
- See also
-
type
type Stringreadonly
-
The input type identifier. Valid value of this property is "attachment"
For AttachmentInput the type is always "attachment".
Method Overview
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
-
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();
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.
-
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.
ReturnsType Description this A deep clone of the class instance that invoked this method.
-
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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from Accessor -
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
-
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");
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.