Constructors

Section titled "Constructors"

CalendarDay 

new CalendarDay(args: CalendarDayParams): CalendarDay

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:51

Returns CalendarDay

Accessors

Section titled "Accessors"

date

Section titled "date"

Returns the date

 
get date(): number

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:110

Returns number

day

Section titled "day"

Returns the day of the week (Sunday = 0).

 
get day(): number

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:95

Returns number

month

Section titled "month"

Returns the month.

 
get month(): number

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:105

Returns number

native

Section titled "native"

Returns the underlying native date instance.

 
get native(): Date

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:220

Returns Date

timestamp

Section titled "timestamp"

Returns the timestamp since epoch in milliseconds.

 
get timestamp(): number

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:115

Returns number

week

Section titled "week"

Returns the ISO 8601 week number.

 
get week(): number

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:120

Returns number

weekend

Section titled "weekend"

Whether the current date is a weekend day.

 
get weekend(): boolean

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:230

Returns boolean

year

Section titled "year"

Returns the full year.

 
get year(): number

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:100

Returns number

today

Section titled "today"

Constructs and returns the current day.

 
get today(): CalendarDay

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:38

Returns CalendarDay

Methods

Section titled "Methods"

add

Section titled "add" 
add(unit: DayInterval, value: number): CalendarDay

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:71

Parameters

Returns CalendarDay

clone

Section titled "clone"

Returns a copy of this instance.

 
clone(): CalendarDay

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:56

Returns CalendarDay

equalTo

Section titled "equalTo" 
equalTo(value: DayParameter): boolean

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:234

Parameters

Returns boolean

getWeekNumber

Section titled "getWeekNumber"

Gets the week number based on week start day. Uses ISO 8601 (first Thursday rule) only when weekStart is Monday (1). For other week starts, uses simple counting from January 1st.

 
getWeekNumber(weekStart: number): number

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:129

Parameters

  • weekStart: number

Returns number

greaterThan

Section titled "greaterThan" 
greaterThan(value: DayParameter): boolean

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:238

Parameters

Returns boolean

greaterThanOrEqual

Section titled "greaterThanOrEqual" 
greaterThanOrEqual(value: DayParameter): boolean

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:241

Parameters

Returns boolean

lessThan

Section titled "lessThan" 
lessThan(value: DayParameter): boolean

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:245

Parameters

Returns boolean

lessThanOrEqual

Section titled "lessThanOrEqual" 
lessThanOrEqual(value: DayParameter): boolean

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:249

Parameters

Returns boolean

set

Section titled "set"

Returns a new instance with values replaced.

 
set(args: Partial<CalendarDayParams>): CalendarDay

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:63

Parameters

  • args: Partial<CalendarDayParams>

Returns CalendarDay

toString

Section titled "toString" 
toString(): string

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:253

Returns string

from

Section titled "from"

Constructs a new CalendarDay instance from a Date object.

 
from(date: Date): CalendarDay

Defined in projects/igniteui-angular/core/src/date-common/util/model.ts:43

Parameters

  • date: Date

Returns CalendarDay