projects/angular-calendar/src/modules/common/calendar-date-formatter/calendar-date-formatter.interface.ts
The parameter type passed to the date formatter methods.
Properties |
|
date |
date:
|
Type : Date
|
The date to format. |
daysInWeek |
daysInWeek:
|
Type : number
|
Optional |
The number of days in a week. Can be used to create a shorter or longer week view.
The first day of the week will always be the |
excludeDays |
excludeDays:
|
Type : number[]
|
Optional |
An array of day indexes (0 = sunday, 1 = monday etc) that will be hidden on the view |
locale |
locale:
|
Type : string
|
Optional |
The users preferred locale. |
weekStartsOn |
weekStartsOn:
|
Type : number
|
Optional |
The start day number of the week |
export interface DateFormatterParams {
/**
* The date to format.
*/
date: Date;
/**
* The users preferred locale.
*/
locale?: string;
/**
* The start day number of the week
*/
weekStartsOn?: number;
/**
* An array of day indexes (0 = sunday, 1 = monday etc) that will be hidden on the view
*/
excludeDays?: number[];
/**
* The number of days in a week. Can be used to create a shorter or longer week view.
* The first day of the week will always be the `viewDate`
*/
daysInWeek?: number;
}
/**
* If using a completely custom date formatter then it should implement this interface.
*/
export interface CalendarDateFormatterInterface {
/**
* The month view header week day labels
*/
monthViewColumnHeader(params: DateFormatterParams): string;
/**
* The month view cell day number
*/
monthViewDayNumber(params: DateFormatterParams): string;
/**
* The month view title
*/
monthViewTitle(params: DateFormatterParams): string;
/**
* The week view header week day labels
*/
weekViewColumnHeader(params: DateFormatterParams): string;
/**
* The week view sub header day and month labels
*/
weekViewColumnSubHeader(params: DateFormatterParams): string;
/**
* The week view title
*/
weekViewTitle(params: DateFormatterParams): string;
/**
* The time formatting down the left hand side of the day view
*/
weekViewHour(params: DateFormatterParams): string;
/**
* The time formatting down the left hand side of the day view
*/
dayViewHour(params: DateFormatterParams): string;
/**
* The day view title
*/
dayViewTitle(params: DateFormatterParams): string;
}