DateTimeOffsetPickerInput | API Reference | ArcGIS Maps SDK for JavaScript 4.32

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

{@link:esri/form/elements/FieldElement}
{@link:esri/form/elements/FieldElement#input inputs}

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

DateTimeOffsetPickerInput Constructor new DateTimeOffsetPickerInput(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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
Boolean	Indicates if the input should provide an option to select the time offset.	DateTimeOffsetPickerInput
String\|null\|undefined	The maximum date/time offset to allow.	DateTimeOffsetPickerInput
String\|null\|undefined	The minimum date/time offset to allow.	DateTimeOffsetPickerInput
String	The level of detail used to represent time.	DateTimeOffsetPickerInput
String	The type of form element input.	DateTimeOffsetPickerInput

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

includeTimeOffset Property includeTimeOffset 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 max String |null |undefined

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

min Property min String |null |undefined

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

timeResolution Property timeResolution String

The level of detail used to represent time.

Possible Values:"minutes" |"seconds" |"milliseconds"

Default Value:"minutes"

type Property type Stringreadonly

The type of form element input.

For DateTimeOffsetPickerInput the type is always "datetimeoffset-picker".

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
DateTimeOffsetPickerInput	Creates a deep clone of the `DateTimeOffsetPickerInput` class.	DateTimeOffsetPickerInput
*\|null\|undefined	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	DateTimeOffsetPickerInput
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	DateTimeOffsetPickerInput

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor

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.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

clone Method clone(){DateTimeOffsetPickerInput}

Creates a deep clone of the DateTimeOffsetPickerInput class.

Returns

Type	Description
DateTimeOffsetPickerInput	A deep clone of the `DateTimeOffsetPickerInput` instance.

fromJSON Method fromJSON(json){* |null |undefined}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
* \| null \| undefined	Returns a new instance of this class.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON Method 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.