AttachmentElement | API Reference | ArcGIS Maps SDK for JavaScript 4.31

An AttachmentElement defines how one or more attachments can participate in the form. When present in the form, the user has the ability to upload an attachment specific to the form element.

See also

Example

// Create the attachment element
const attachmentElement = new AttachmentElement({
  label: "Tree images",
  input: { // autocastable to ImageInput
     type: "image",
     maxFileSize: 800,
  },
  attachmentKeyword: "treeKeyword"
  displayFilename: true,
  minAttachmentCount: 1,
  maxAttachmentCount: 5,
});


// Next pass in element to the FormTemplate
const formTemplate = new FormTemplate({
  title: "Tree inspection",
  description: "Attach tree info",
  elements: [attachmentElement] // Add element to the template
});

Constructors

AttachmentElement Constructor new AttachmentElement(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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Boolean	Determines whether the user renaming an attachment is allowed.	AttachmentElement
String	A string to identify the attachment(s).	AttachmentElement
String	The name of the class.	Accessor
String	The element's description providing the purpose behind it.	Element
Boolean	Determines whether the file name should be displayed.	AttachmentElement
String	A reference to an Arcade expression that returns a boolean value.	AttachmentElement
String	Determines the name of a new attachment.	AttachmentElement
AttachmentInput\|AudioInput\|DocumentInput\|ImageInput\|SignatureInput\|VideoInput	The input user interface to use for the attachment.	AttachmentElement
String	A string value containing the field alias.	Element
Number	Defines the maximum number of attachments allowed for this element.	AttachmentElement
Number	Defines the minimum number of attachments required for this element.	AttachmentElement
String	The type of the element.	AttachmentElement
Boolean	Determines whether the uploaded attachment's file name is preserved.	AttachmentElement
String	A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate.	Element

Property Details

allowUserRename Property allowUserRename Boolean

Determines whether the user renaming an attachment is allowed.

Default Value:true

attachmentKeyword Property attachmentKeyword String

A string to identify the attachment(s). When a file is attached using the form, this property is used to set the value of the keywords field for the attachment. When a form is displaying existing attachments, this property is used to query attachments using an exact match on the keywords field.

Default Value:null

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

description Inherited Property description String Inherited from Element

The element's description providing the purpose behind it.

displayFilename Property displayFilename Boolean

Determines whether the file name should be displayed. Default is false.

Default Value:false

editableExpression Property editableExpression String

A reference to an Arcade expression that returns a boolean value. When this expression evaluates to true, the element is editable. When the expression evaluates to false the element is not editable.

Default Value:null

See also

ExpressionInfo

filenameExpression Property filenameExpression String

Determines the name of a new attachment. If not specified, a unique name will be generated using the attachmentKeyword and the current timestamp when attachment is added.

Default Value:{attachmentKeyword}_{now}

The input user interface to use for the attachment.

Default Value:null

label Inherited Property label String Inherited from Element

A string value containing the field alias. This should not be used for referencing fields in Arcade expressions. Rather, the service fieldName should be referenced.

maxAttachmentCount Property maxAttachmentCount Number

Defines the maximum number of attachments allowed for this element. If not specified, there is no maximum number required.

Default Value:null

minAttachmentCount Property minAttachmentCount Number

Defines the minimum number of attachments required for this element. If not specified, there is no minimum number required.

Default Value:null

type Property type Stringreadonly

The type of the element.

For AttachmentElement the type is always "attachment".

useOriginalFilename Property useOriginalFilename Boolean

Determines whether the uploaded attachment's file name is preserved. If false, the name is updated based on filenameExpression. Default is true.

Default Value:true

visibilityExpression Inherited Property visibilityExpression String Inherited from Element

A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate.

When this expression evaluates to true, the element is displayed. When the expression evaluates to false the element is not displayed. If no expression is provided, the element is always displayed. Care must be taken when defining a visibility expression for a non-nullable field as to make certain the specified field has either 1) a default value, or 2) is made visible to the end user to enter a value before submitting the form.

The expression must follow the specification defined in the Form Calculation Profile. This expression references field values within an individual feature or in other layers and must return either a date, number, or string value.
The referenced expression must be defined in the form template's expressionInfos. It cannot be set inline within the element object.
Field and Group elements must be visible if the field or one of the grouped fields is required.

See also

Example

// Expression created within ExpressionInfos and is referenced in element
const expression = new ExpressionInfo({
  name: "alwaysHidden",
  expression: "false"
});

// Reference an already-defined visibilityExpression set within the ExpressionInfos
const fieldElement = new FieldElement({
  type: "field",
  fieldName: "inspemail",
  label: "Email address",
  visibilityExpression: "alwaysHidden"
});

formTemplate.expressionInfos = [ expression ];
formTemplate.elements = [ fieldElement ];

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
AttachmentElement	Creates a deep clone of the AttachmentElement class.	AttachmentElement
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	Element
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	Element

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(){AttachmentElement}

Creates a deep clone of the AttachmentElement class.

Returns

Type	Description
AttachmentElement	A deep clone of the AttachmentElement instance.

fromJSON Inherited 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 Inherited Method toJSON(){Object} Inherited from Element

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.