DateTimeOffsetPickerInput | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: DateTimeOffsetPickerInput→Input→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.28

The DateTimeOffsetPickerInput class defines the desired user interface for editing timestamp-offset 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

Example

const dateTimeOffsetPickerInput = new DateTimeOffsetPickerInput({
  min: "2020-03-15T14:30-05:00", // the minimum date/time input allowed, this equates to March 15, 2020, at 2:30 PM in the Eastern time zone, which is UTC-5.
  max: "2020-04-15T24:00-08:00", // the maximum date/time input allowed, this equates to midnight (00:00) on April 15, 2020, in the Pacific time zone with a UTC offset of -8 hours.
  includeTimeOffset: true
});

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`DateTimeOffsetPickerInputProperties`

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
`includeTimeOffset`	`boolean`
`max`	`string \| null \| undefined`
`min`	`string \| null \| undefined`
`timeResolution`	`TimeResolutionMS`
`type` readonly	`"datetimeoffset-picker"`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

includeTimeOffset

Property

Type: boolean

Indicates if the input should provide an option to select the time offset. The time offset represents the difference in hours and minutes between UTC and the local system time. If not provided, the default value is true.

Default value: true

max

Property

Type: string | null | undefined

The maximum date/time offset to allow. The string represents an ISO-8601 time with a time offset.

min

Property

Type: string | null | undefined

The minimum date/time offset to allow. The string represents an ISO-8601 time with a time offset.

timeResolution

Property

Type: TimeResolutionMS

The level of detail used to represent time.

Default value: "minutes"

type

readonly Property

Type: "datetimeoffset-picker"

The type of form element input.

Methods

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

Creates a deep clone of the DateTimeOffsetPickerInput class.

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