DateTimePickerInput | References | ArcGIS Maps SDK for JavaScript

import DateTimePickerInput from "@arcgis/core/form/elements/inputs/DateTimePickerInput.js";

Inheritance:: DateTimePickerInput→Input→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.17

The DateTimePickerInput class defines the desired user interface for editing date field 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

FieldElement

Example

const dateTimePickerInput = new DateTimePickerInput({
  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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`DateTimePickerInputProperties`

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`includeTime`	`boolean`
`max`	`Date \| null \| undefined`
`min`	`Date \| null \| undefined`
`type` readonly	`"datetime-picker"`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

includeTime

Property

Type: 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

autocast Property

Type: Date | null | undefined

The maximum date to allow. The number represents the number of milliseconds since epoch (January 1, 1970) in UTC.

min

autocast Property

Type: Date | null | undefined

The minimum date to allow. The number represents the number of milliseconds since epoch (January 1, 1970) in UTC.

type

readonly Property

Type: "datetime-picker"

The type of form element input.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): DateTimePickerInput`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clone

Method

Signature: clone (): DateTimePickerInput

Creates a deep clone of the DateTimePickerInput class.

Returns: DateTimePickerInput
A deep clone of the DateTimePickerInput instance.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.