require(["esri/form/elements/inputs/TimePickerInput"], (TimePickerInput) => { /* code goes here */ });
import TimePickerInput from "@arcgis/core/form/elements/inputs/TimePickerInput.js";
esri/form/elements/inputs/TimePickerInput
The TimePickerInput class defines the desired user interface for editing time-only field type input. These inputs are used in field elements that are set within a feature layer or FeatureForm formTemplate which will be picked up and displayed within the Editor widget.
const timePickerInput = new TimePickerInput({
min: "14:15:00" , // the minimum time input allowed, this equates to 2:15 PM (14th hour), 30 seconds, and 132 milliseconds.
max: "20:10:15", // the maximum time input allowed, this equates to 8:10 PM (20th hour), 15 seconds, and 123 milliseconds.
timeResolution: "minutes" // the level of precision needed for the time input
});Constructors
-
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. | Accessor | |
| String | The maximum time to allow. | TimePickerInput | |
| String | The minimum time to allow. | TimePickerInput | |
| String | The level of detail used to represent time. | TimePickerInput | |
| String | The type of form element input. | TimePickerInput |
Property Details
-
max
Propertymax String -
The maximum time to allow. The string represents an ISO-8601 time in either
hh:mm:ssorhh:mm:ss.sssformat. For example, a string of"20:10:15"represents the time of 8:10 PM (20th hour), and 15 seconds.
-
min
Propertymin String -
The minimum time to allow. The string represents an ISO-8601 time in either
hh:mm:ssorhh:mm:ss.sssformat. For example, a string of14:15:30represents the time of 2:15 PM (14th hour), and 30 seconds.
-
timeResolution
PropertytimeResolution String -
The level of detail used to represent time.
Possible Values:"minutes"|"seconds"
- Default Value:"minutes"
-
type
Propertytype Stringreadonly -
The type of form element input.
For TimePickerInput the type is always "time-picker".
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| TimePickerInput | Creates a deep clone of the | TimePickerInput | |
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | TimePickerInput | |
| 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. | TimePickerInput |
Method Details
-
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();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
Methodclone(){TimePickerInput} -
Creates a deep clone of the
TimePickerInputclass.ReturnsType Description TimePickerInput A deep clone of the TimePickerInputinstance.
-
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
jsonparameter 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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
-
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
MethodtoJSON(){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.