DateTimePickerInput
require(["esri/form/elements/inputs/DateTimePickerInput"], function(DateTimePickerInput) { /* code goes here */ });esri/form/elements/inputs/DateTimePickerInputThe DateTimePickerInput class defines the desired user interface for editing date fields in a form.
- See also:
const dateTimePicker = new DateTimePicker({
includeTime: true, // this will allow time input, default is false
min: 1547678342000, // the minimum date input allowed
max: 1610836742000 // the maximum date input allowed
});Constructors
- new DateTimePickerInput(properties)
- Parameter:properties 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. more details | more details | Accessor | |
| Boolean | Indicates if the input should provide an option to select the time. more details | more details | DateTimePickerInput | |
| Number | The maximum date to allow. more details | more details | DateTimePickerInput | |
| Number | The minimum date to allow. more details | more details | DateTimePickerInput | |
| String | The type of input. more details | more details | DateTimePickerInput |
Property Details
The name of the class. The declared class name is formatted as
esri.folder.className.
- includeTime Boolean
Indicates if the input should provide an option to select the time. If not provided, the default value is
false.- Default Value:false
- max Number
The maximum date to allow. The number represents the number of milliseconds since epoch (January 1, 1970) in UTC.
- min Number
The minimum date to allow. The number represents the number of milliseconds since epoch (January 1, 1970) in UTC.
- type String
The type of input.
For DateTimePickerInput the type is always "datetime-picker".
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| DateTimePickerInput | Creates a deep clone of the | more details | DateTimePickerInput | |
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | DateTimePickerInput | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | DateTimePickerInput |
Method Details
- clone(){DateTimePickerInput}
Creates a deep clone of the
DateTimePickerclass.Returns:Type Description DateTimePickerInput A deep clone of the DateTimePickerInputinstance.
- fromJSON(json){*}static
Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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.Parameter:json 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.
Returns:Type Description * Returns a new instance of this class.
- 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.