require(["esri/form/elements/inputs/DatePickerInput"], (DatePickerInput) => { /* code goes here */ });
import DatePickerInput from "@arcgis/core/form/elements/inputs/DatePickerInput.js";
esri/form/elements/inputs/DatePickerInput
The DatePickerInput class defines the desired user interface for editing date-only field type input. 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
const datePickerInput = new DatePickerInput({
min: "1982-01-15", // example showing the minimum date input allowed, ie. starts at January 15, 1982
max: "2030-12-31" // example showing the maximum date input allowed, ie. ends with December 31, 2030
});Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| String | The name of the class. | Accessor | |
| String | The maximum date to allow. | DatePickerInput | |
| String | The minimum date to allow. | DatePickerInput | |
| String | The type of form element input. | DatePickerInput |
Property Details
-
max
Propertymax String -
The maximum date to allow. The string represents an ISO-8601 date and follows the format pattern of
YYYY-MM-DD. For example, a string of"2030-12-31represents the year 2030, on the 31st day in the month of December.
-
min
Propertymin String -
The minimum date to allow. The string represents an ISO-8601 date and follows the format pattern of
YYYY-MM-DD. For example, a string of"1982-01-15represents the year 1982, on the 15th day in the month of January.
-
type
Propertytype Stringreadonly -
The type of form element input.
For DatePickerInput the type is always "date-picker".
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| DatePickerInput | Creates a deep clone of the | DatePickerInput | |
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | DatePickerInput | |
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor | ||
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. | DatePickerInput |
Method Details
-
Inherited from Accessor
-
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
clone
Methodclone(){DatePickerInput} -
Creates a deep clone of the
DatePickerInputclass.ReturnsType Description DatePickerInput A deep clone of the DatePickerInputinstance.
-
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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
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.