require(["esri/form/elements/inputs/DateTimeOffsetPickerInput"], (DateTimeOffsetPickerInput) => { /* code goes here */ });
import DateTimeOffsetPickerInput from "@arcgis/core/form/elements/inputs/DateTimeOffsetPickerInput.js";
esri/form/elements/inputs/DateTimeOffsetPickerInput
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}
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
-
new DateTimeOffsetPickerInput(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The name of the class. more details | Accessor | |
Boolean | Indicates if the input should provide an option to select the time offset. more details | DateTimeOffsetPickerInput | |
String | The maximum date/time offset to allow. more details | DateTimeOffsetPickerInput | |
String | The minimum date/time offset to allow. more details | DateTimeOffsetPickerInput | |
String | The resolution identifier. more details | DateTimeOffsetPickerInput | |
String | The type of form element input. more details | DateTimeOffsetPickerInput |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
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 String
-
The maximum date/time offset to allow. The string represents an ISO-8601 time with a time offset.
-
min String
-
The minimum date/time offset to allow. The string represents an ISO-8601 time with a time offset.
-
timeResolution String
-
The resolution identifier.
Possible Values:"minutes"|"seconds"|"milliseconds"
- Default Value:"minutes"
-
type Stringreadonly
-
The type of form element input.
For DateTimeOffsetPickerInput the type is always "datetimeoffset-picker".
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
DateTimeOffsetPickerInput | Creates a deep clone of the | DateTimeOffsetPickerInput | |
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | DateTimeOffsetPickerInput | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor | ||
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | DateTimeOffsetPickerInput |
Method Details
-
addHandles(handleOrHandles, groupKey)inherited
-
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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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(){DateTimeOffsetPickerInput}
-
Creates a deep clone of the
DateTimeOffsetPickerInput
class.ReturnsType Description DateTimeOffsetPickerInput A deep clone of the DateTimeOffsetPickerInput
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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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(groupKey)inherited
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.