DateTimePickerInput

AMD: require(["esri/form/elements/inputs/DateTimePickerInput"], (DateTimePickerInput) => { /* code goes here */ });
ESM: import DateTimePickerInput from "@arcgis/core/form/elements/inputs/DateTimePickerInput";
Class: esri/form/elements/inputs/DateTimePickerInput
Inheritance: DateTimePickerInput Accessor
Since: ArcGIS API for JavaScript 4.17

The DateTimePickerInput class defines the desired user interface for editing date fields in a form.

See also:
Example:
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 Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Booleanmore details

Indicates if the input should provide an option to select the time.

more detailsDateTimePickerInput
Numbermore details

The maximum date to allow.

more detailsDateTimePickerInput
Numbermore details

The minimum date to allow.

more detailsDateTimePickerInput
Stringmore details

The type of form element input.

more detailsDateTimePickerInput

Property Details

declaredClass Stringreadonly inherited

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
DateTimePickerInputmore details

Creates a deep clone of the DateTimePicker class.

more detailsDateTimePickerInput
*more details

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

more detailsDateTimePickerInput
Objectmore details

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

more detailsDateTimePickerInput

Method Details

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 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(){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.