require(["esri/form/elements/inputs/TextAreaInput"], (TextAreaInput) => { /* code goes here */ });
import TextAreaInput from "@arcgis/core/form/elements/inputs/TextAreaInput.js";
esri/form/elements/inputs/TextAreaInput
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
-
Parameterproperties Objectoptional
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 |
|---|---|---|---|
| Number | When set, defines the text input's maximum length. | TextAreaInput | |
| Number | When set, defines the text input's minimum length. | TextAreaInput | |
| String | The type of form element input. | TextAreaInput |
Property Details
-
maxLength
PropertymaxLength Number -
When set, defines the text input's maximum length.
-
minLength
PropertyminLength Number -
When set, defines the text input's minimum length.
- Default Value:0
-
type
Propertytype Stringreadonly -
The type of form element input.
For TextAreaInput the type is always "text-area".
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
| TextAreaInput | Creates a deep clone of the | TextAreaInput | |
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | TextAreaInput | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. | TextAreaInput |
Method Details
-
clone
Methodclone(){TextAreaInput} -
Creates a deep clone of the
TextAreaInputclass.ReturnsType Description TextAreaInput A deep clone of the TextAreaInputinstance.
-
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
jsonparameter 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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.