TextBoxInput | References | ArcGIS Maps SDK for JavaScript

import TextBoxInput from "@arcgis/core/form/elements/inputs/TextBoxInput.js";

Inheritance:: TextBoxInput→TextInput→Input→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.16

The TextBoxInput class defines the desired user interface as a single-line text box. This FieldElement.input is used in field elements that are set within a feature layer's or FeatureForm's formTemplate. This is displayed within the Editor widget.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`TextBoxInputProperties`

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

Example

// Create a new TextBox input
const textBoxInput = new TextBoxInput({
  minLength: 10,
  maxLength: 30
})

Properties

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

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`maxLength` inherited	`number \| null \| undefined`	TextInput
`minLength` inherited	`number \| null \| undefined`	TextInput
`type` readonly	`"text-box"`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

maxLength

inherited Property

Type: number | null | undefined

Inherited from: TextInput

When set, defines the text input's maximum length.

minLength

inherited Property

Type: number | null | undefined

Inherited from: TextInput

When set, defines the text input's minimum length.

Default value: 0

type

readonly Property

Type: "text-box"

The type of form element input.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): TextBoxInput`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clone

Method

Signature: clone (): TextBoxInput

Creates a deep clone of the TextBoxInput class.

Returns: TextBoxInput
A deep clone of the TextBoxInput instance.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.