Skip to main content

getValue()

returns the current value of a TimePicker control

getValue<T extends boolean = false>(asObject?: T): T extends true ? ITimeObject : string;

Parameters:

asObject: boolean - optional, specifies that the value will be returned as an object, false by default

Returns:

Either a string, or object with the current value of the control.

Example

// return value as a string in the 24-hour format
var val1 = timepicker.getItem("timepicker").getValue();
// -> "00:39"

// return value as an object in the 24-hour format
var val2 = timepicker.getItem("timepicker").getValue(true);
// -> {hour: 0, minute: 39}

// return value as a string in the 12-hour format
var val3 = timepicker.getItem("timepicker").getValue();
// -> "06:00AM"

// return value as an object in the 12-hour format
var val4 = timepicker.getItem("timepicker").getValue(true);
// -> {hour: 6, minute: 0, AM: true}

The returned value can be of several types, depending on the passed parameter and the applied time format:

  • for the 24-hour format a return string value will include just the hour and minutes: "00:39"
  • for the 12-hour format a return string value will include hour, minutes, and am/pm identifiers: "06:00AM"
  • for the 24-hour format a return object value will contain key:value pairs for hours, minutes and their values
  • for the 12-hour format a return object value will contain key:value pairs for hours, minutes, am/pm identifiers and their values

Change log:

The asObject parameter of the method is added in v7.0