Class Clndr

Index

Constructors

Methods

addEvents destroy getInterval getSelectedDate getView next nextYear previous previousYear removeEvents render setDate setEvents setExtras setMonth setYear switchView today

Constructors

constructor

new Clndr(element, options): Clndr
Parameters
- element: HTMLElement
- options: ClndrOptions
Returns Clndr
- Defined in Clndr.ts:169

Methods

addEvents

addEvents(events): Clndr
Adds additional calendar events.
Parameters
- events: ClndrEvent[]
Returns Clndr
- Defined in Clndr.ts:1116

destroy

destroy(): void
Detaches the event handler and empties the element the calendar was initialized on.

Returns void
- Defined in Clndr.ts:1143

getInterval

getInterval(): Interval
Returns the interval currently rendered.

Returns Interval
- Defined in Clndr.ts:892

getSelectedDate

getSelectedDate(): undefined | Date
Returns the date currently selected, if the trackSelectedDate option is activated.

Returns undefined | Date
- Defined in Clndr.ts:899

getView

getView(): View
Returns the view currently rendered.

Returns View
- Defined in Clndr.ts:885

next

next(): Promise<void>
Action to go forward one or more pages.

Returns Promise<void>
- Defined in Clndr.ts:962

nextYear

nextYear(): Promise<void>
Navigates forward by one year.

Returns Promise<void>
- Defined in Clndr.ts:1010

previous

previous(): Promise<void>
Action to go backward one or more pages.

Returns Promise<void>
- Defined in Clndr.ts:940

previousYear

previousYear(): Promise<void>
Navigates backward by one year.

Returns Promise<void>
- Defined in Clndr.ts:986

removeEvents

removeEvents(matchingFn): Clndr
Removes all events according to a matching function. Note that this does NOT trigger re-rendering the calendar.
Parameters
- matchingFn: ((event: ClndrEvent) => boolean)
  A function returning true for calendar events to be removed, false otherwise.
  - - (event): boolean
    - Parameters
      event: ClndrEvent
      Returns boolean
Returns Clndr
- Defined in Clndr.ts:1129

render

render(): Promise<void>
Trigger re-rendering the calendar.

Returns Promise<void>
- Defined in Clndr.ts:444

setDate

setDate(newDate): Promise<void>
Ensures a provided date is on the page.
Parameters
- newDate: string | number | Date
Returns Promise<void>
- Defined in Clndr.ts:1053

setEvents

setEvents(events): Clndr
Overwrites all calendar events. Note that this does NOT trigger re-rendering the calendar.
Parameters
- events: ClndrEvent[]
Returns Clndr
- Defined in Clndr.ts:1107

setExtras

setExtras(extras): Clndr
Overwrite the extras. Note that this does NOT trigger re-rendering the calendar.
Parameters
- extras: unknown
Returns Clndr
- Defined in Clndr.ts:1098

setMonth

setMonth(newMonth): Promise<void>
Changes the month being provided a value between 0 and 11.
Parameters
- newMonth: number
Returns Promise<void>
- Defined in Clndr.ts:1068

setYear

setYear(newYear): Promise<void>
Changes the current date to a specific year.
Parameters
- newYear: number
Returns Promise<void>
- Defined in Clndr.ts:1083

switchView

switchView(view, date?): Promise<void>
Switch the view while ensuring the provided date is on the page. If no date is provided, the start of the current page's interval is used.
Parameters
- view: View
- Optionaldate: string | number | Date
Returns Promise<void>
- Defined in Clndr.ts:907

today

today(): Promise<void>
Navigates to today.

Returns Promise<void>
- Defined in Clndr.ts:1032