Class Time

Simple Time class with access to hour/minute/second/period

Hierarchy

Time

Index

Constructors

constructor

Methods

Constructors

constructor

new Time(hour: number, minute: number, second: number): Time
new Time(): Time

- Defined in lumin/ui/common/Time.d.ts:15
Creates Time object with hour, minute, second.

Parameters
- hour: number
  
  hour in the range 0-23.
- minute: number
  
  minute in the range 0-59.
- second: number
  
  second in the range 0-59.
Returns Time
- Defined in lumin/ui/common/Time.d.ts:24
Default ctr

Returns Time

Methods

hour

hour(): number

- Defined in lumin/ui/common/Time.d.ts:43
Get the hour in 24 hour time.

Returns number

hour, hour in the range 0-23.

minute

minute(): number

- Defined in lumin/ui/common/Time.d.ts:67
Gets the minute.

Returns number

minute, minute in the range 0-59.

period

period(): TimePeriod

- Defined in lumin/ui/common/Time.d.ts:91
Gets the TimePeriod, kAM or kPM.

Returns TimePeriod

TimePeriod, will return kAM for hour 0-11, kPM for hour 12-23.

second

second(): number

- Defined in lumin/ui/common/Time.d.ts:83
Gets the second.

Returns number

second, second in the range 0-59.

setHour

setHour(hour: number): void

- Defined in lumin/ui/common/Time.d.ts:35
Sets the hour in 24 hour time. Clamping will be applied for out of range values.

Parameters
- hour: number
  
  hour to be set in the range 0-23.
Returns void

setMinute

setMinute(minute: number): void

- Defined in lumin/ui/common/Time.d.ts:59
Sets the minute. Clamping will be applied for out of range values.

Parameters
- minute: number
  
  minute in the range 0-59.
Returns void

setSecond

setSecond(second: number): void

- Defined in lumin/ui/common/Time.d.ts:75
Sets the second. Clamping will be applied for out of range values.

Parameters
- second: number
Returns void

second, second in the range 0-59.

twelveHourForm

twelveHourForm(): number

- Defined in lumin/ui/common/Time.d.ts:51
Get the hour in 12 hour time.

Returns number

hour, hour in the range 1-12.

Static GetCurrentTime

GetCurrentTime(): Time

- Defined in lumin/ui/common/Time.d.ts:15
Get the time now

Returns Time

a Time object with current time

Generated using TypeDoc