The 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 | more details The name of the class. | more details | Accessor | |
Boolean | more details Indicates if the input should provide an option to select the time. | more details | DateTimePickerInput | |
Number | more details The maximum date to allow. | more details | DateTimePickerInput | |
Number | more details The minimum date to allow. | more details | DateTimePickerInput | |
String | more details The type of form element input. | 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 Stringreadonly
-
The type of form element input.
For DateTimePickerInput the type is always "datetime-picker".
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
DateTimePickerInput | more details Creates a deep clone of the | more details | DateTimePickerInput | |
* | more details Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | more details | DateTimePickerInput | |
more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor | ||
Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | more details | DateTimePickerInput |
Method Details
-
clone(){DateTimePickerInput}
-
Creates a deep clone of the
DateTimePicker
class.Returns:Type Description DateTimePickerInput A deep clone of the DateTimePickerInput
instance.
-
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 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.
-
own(handleOrHandles)inheritedSince: ArcGIS API for JavaScript 4.24
-
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.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }); handle.remove(); // Assign a handle using own() this.own(reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }));
Parameter:handleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
-
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.