DatePickerInput | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: DatePickerInput→Input→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.28

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`DatePickerInputProperties`

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
`max`	`string \| null \| undefined`
`min`	`string \| null \| undefined`
`type` readonly	`"date-picker"`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

max

Property

Type: string | null | undefined

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-31 represents the year 2030, on the 31st day in the month of December.

min

Property

Type: string | null | undefined

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-15 represents the year 1982, on the 15th day in the month of January.

type

readonly Property

Type: "date-picker"

The type of form element input.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): DatePickerInput`
`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 (): DatePickerInput

Creates a deep clone of the DatePickerInput class.

Returns: DatePickerInput
A deep clone of the DatePickerInput 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.