TextAreaInput

AMD: require(["esri/form/elements/inputs/TextAreaInput"], (TextAreaInput) => { /* code goes here */ });
ESM: import TextAreaInput from "@arcgis/core/form/elements/inputs/TextAreaInput.js";
Class: esri/form/elements/inputs/TextAreaInput
Since: ArcGIS Maps SDK for JavaScript 4.16

The TextAreaInput class defines the desired user interface as a multi-line text area. This 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

TextAreaInput

Constructor
new TextAreaInput(properties)
Parameter
properties Object
optional

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

Example
// Create a new TextArea input
const textAreaInput = new TextAreaInput({
  minLength: 10,
  maxLength: 300
})

Property Overview

Name Type Summary Class

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

TextAreaInput

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

TextAreaInput

The type of form element input.

TextAreaInput

Property Details

maxLength

Property
maxLength Number

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

minLength

Property
minLength Number

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

Default Value:0

type

Property
type Stringreadonly

The type of form element input.

For TextAreaInput the type is always "text-area".

Method Overview

Name Return Type Summary Class

Creates a deep clone of the TextAreaInput class.

TextAreaInput
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

TextAreaInput

Converts an instance of this class to its ArcGIS portal JSON representation.

TextAreaInput

Method Details

clone

Method
clone(){TextAreaInput}

Creates a deep clone of the TextAreaInput class.

Returns
Type Description
TextAreaInput A deep clone of the TextAreaInput instance.

fromJSON

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.

toJSON

Method
toJSON(){Object}

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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.