import AttachmentElementInput from "@arcgis/core/widgets/BatchAttributeForm/inputs/AttachmentElementInput.js";
Inheritance
AttachmentElementInputEditableInput<any>InputBaseAccessor
Since
ArcGIS Maps SDK for JavaScript 5.1

This is a read-only support class that represents an attachment element in a BatchAttributeForm.

See also

Constructors

Constructor

Constructor

Parameters

ParameterTypeDescriptionRequired
properties
See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

allAttachmentsVisibleOnDefaultPage

readonly Property
Type
boolean

Indicates whether all attachments for this input are visible on the default page.

allowUserRename

readonly Property
Type
boolean | null | undefined

Indicates if the input allows users to rename attachments.

attachmentKeyword

readonly Property
Type
string | undefined

The input's attachment keyword. This is used to filter attachments associated with the active feature.

attachments

Property
Type
AttachmentInfo[]

The attachments applicable to this input.

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor
Since
ArcGIS Maps SDK for JavaScript 4.7

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

defaultPageAttachments

readonly Property
Type
AttachmentInfo[]

The attachments visible on the default page before showing the full attachments list action.

description

readonlyinherited Property
Type
string | null | undefined
Inherited from: InputBase

The input's description.

displayCount

Property
Type
number

The maximum number of attachments displayed on the default page before showing the full attachments list action.

Default value
3

displayFilename

readonly Property
Type
boolean | null | undefined

Indicates if the attachment filename should be displayed.

editable

readonlyinherited Property
Type
boolean
Inherited from: EditableInput

Indicates if the input is editable.

editType

readonlyinherited Property
Type
EditType
Inherited from: EditableInput

The type of edit operation the form is being used for. This can influence whether a field is editable or not (e.g., the layer only allows certain edit operations)

This is also the value that will be set for the Arcade variable $editcontext.editType in the Arcade context used to evaluate form expressions.

Accepted values are "INSERT", "UPDATE", "DELETE", and "NA".

For FieldInputs with value expressions, this property is also used in determining whether or not the value expressions should be applied. Per the Web Map Specification, value expressions are ignored if the associated layer field is not editable. Determining whether the layer field is editable must consider whether the specific type of edit being attempted is allowed. For example, if a layer has the supportsAdd capability but does not have the supportsUpdate capability, then the value expression will be applied if editType is INSERT but ignored if editType is UPDATE.

For the purposes of determining whether or not the layer allows the current edit type, a value of "NA" is always considered allowed.

Default value
"NA"

existsInAllLayers

readonlyinherited Property
Type
boolean
Inherited from: InputBase

Indicates whether the input pertains to all the features in the BatchAttributeForm in which the input belongs.

Default value
true

feature

readonly Property
Type
Graphic | null | undefined

The single feature associated with this attachment element.

See also

group

readonly Property
Type
GroupInput | null

The group containing the attachment element input.

input

readonly Property
Type
AttachmentInputUnion | null | undefined

The configured attachment input for this element.

label

readonlyinherited Property
Type
string | null | undefined
Inherited from: InputBase

The input's label.

layer

readonly Property
Type
AttributeFormSupportedLayerUnion | null | undefined

Identifies the single feature layer associated with this attachment element. The layer must support feature editing and field access.

The following layer types are supported:

See also

layers

readonlyinherited Property
Type
AttributeFormSupportedLayerUnion[]
Inherited from: InputBase

An array of layers included in the BatchAttributeForm. Each layer must support feature editing and field access.

The following layer types are supported:

See also

maxAttachmentCount

readonly Property
Type
number | null | undefined

The maximum number of attachments allowed.

minAttachmentCount

readonly Property
Type
number | null | undefined

The minimum number of attachments required.

type

readonly Property
Type
"attachment"

The type of input.

useOriginalFilename

readonly Property
Type
boolean | null | undefined

Indicates if the original filename should be used when creating attachments.

valid

readonlyinherited Property
Type
boolean
Inherited from: EditableInput

Indicates whether the input currently has valid user input.

visible

readonlyinherited Property
Type
boolean
Inherited from: InputBase

Indicates whether the input is visible.