TimePickerInput | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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.

See also

Example

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

TimePickerInput Constructor new TimePickerInput(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
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

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

max Property max String

The maximum time to allow. The string represents an ISO-8601 time in either hh:mm:ss or hh:mm:ss.sss format. For example, a string of "20:10:15" represents the time of 8:10 PM (20th hour), and 15 seconds.

min Property min String

The minimum time to allow. The string represents an ISO-8601 time in either hh:mm:ss or hh:mm:ss.sss format. For example, a string of 14:15:30 represents the time of 2:15 PM (14th hour), and 30 seconds.

timeResolution Property timeResolution String

The level of detail used to represent time.

Possible Values:"minutes" |"seconds"

Default Value:"minutes"

type Property type Stringreadonly

The type of form element input.

For TimePickerInput the type is always "time-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
TimePickerInput	Creates a deep clone of the `TimePickerInput` class.	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

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(){TimePickerInput}

Creates a deep clone of the TimePickerInput class.

Returns

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

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

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
*	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.