Skip to content
import EditableInput from "@arcgis/core/widgets/BatchAttributeForm/inputs/EditableInput.js";
Inheritance:
EditableInputInputBase<Template>Accessor
Subclasses:
FieldInput
Since
ArcGIS Maps SDK for JavaScript 4.33

A read-only class used by FieldInput to determine if the BatchAttributeForm input is editable.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.
PropertyTypeClass
declaredClass
readonly inherited
description
readonly inherited
editable
readonly
editType
readonly
existsInAllLayers
readonly inherited
label
readonly inherited
layers
readonly inherited
visible
readonly inherited

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor

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

description

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

The input's description.

editable

readonly Property
Type
boolean

Indicates if the input is editable.

editType

readonly Property
Type
EditType

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

label

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

The input's label.

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

visible

readonlyinherited Property
Type
boolean
Inherited from: InputBase

Indicates whether the input is visible.