Calendar | PrimeFaces JavaScript API Docs

Hierarchy

CalendarApi
- Calendar

Constructors

constructor

new Calendar(el: HTMLElement, optionOverrides?: CalendarOptions): Calendar

Overrides CalendarApi.constructor
Parameters
- el: HTMLElement
- Optional optionOverrides: CalendarOptions
Returns Calendar

Properties

currentClassNames

currentClassNames: string[]

currentData

currentData: CalendarData

Optional currentDataManager

currentDataManager?: CalendarDataManager

customContentRenderId

customContentRenderId: number

el

el: HTMLElement

handleAction

handleAction: ((action: Action) => void)

Type declaration

- (action: Action): void
- Parameters
  - action: Action
  Returns void

handleData

handleData: ((data: CalendarData) => void)

Type declaration

- (data: CalendarData): void
- Parameters
  - data: CalendarData
  Returns void

handleRenderRequest

handleRenderRequest: (() => void)

Type declaration

- (): void
- Returns void

isRendered

isRendered: boolean

isRendering

isRendering: boolean

renderRunner

renderRunner: DelayedRunner

Accessors

view

get view(): ViewApi

Overrides CalendarApi.view
Returns ViewApi

Methods

addEvent

addEvent(eventInput: EventInput, sourceInput?: string | boolean | EventSourceApi): null | EventApi

Inherited from CalendarApi.addEvent
Parameters
- eventInput: EventInput
- Optional sourceInput: string | boolean | EventSourceApi
Returns null | EventApi

addEventSource

addEventSource(sourceInput: EventSourceInput): EventSourceApi

Inherited from CalendarApi.addEventSource
Parameters
- sourceInput: EventSourceInput
Returns EventSourceApi

batchRendering

batchRendering(func: any): void

Overrides CalendarApi.batchRendering
Parameters
- func: any
Returns void

changeView

changeView(viewType: string, dateOrRange?: DateInput | DateRangeInput): void

Inherited from CalendarApi.changeView
Parameters
- viewType: string
- Optional dateOrRange: DateInput | DateRangeInput
Returns void

destroy

destroy(): void

Returns void

dispatch

dispatch(action: Action): void

Inherited from CalendarApi.dispatch
Parameters
- action: Action
Returns void

formatDate

formatDate(d: DateInput, formatter: any): string

Inherited from CalendarApi.formatDate
Parameters
- d: DateInput
- formatter: any
Returns string

formatIso

formatIso(d: DateInput, omitTime?: boolean): string

Inherited from CalendarApi.formatIso
Parameters
- d: DateInput
- Optional omitTime: boolean
Returns string

formatRange

formatRange(d0: DateInput, d1: DateInput, settings: any): string

Inherited from CalendarApi.formatRange
Parameters
- d0: DateInput
- d1: DateInput
- settings: any
Returns string

getAvailableLocaleCodes

getAvailableLocaleCodes(): string[]

Inherited from CalendarApi.getAvailableLocaleCodes
Returns string[]

getCurrentData

getCurrentData(): CalendarData

Inherited from CalendarApi.getCurrentData
Returns CalendarData

getDate

getDate(): Date

Inherited from CalendarApi.getDate
Returns Date

getEventById

getEventById(id: string): null | EventApi

Inherited from CalendarApi.getEventById
Parameters
- id: string
Returns null | EventApi

getEventSourceById

getEventSourceById(id: string): null | EventSourceApi

Inherited from CalendarApi.getEventSourceById
Parameters
- id: string
Returns null | EventSourceApi

getEventSources

getEventSources(): EventSourceApi[]

Inherited from CalendarApi.getEventSources
Returns EventSourceApi[]

getEvents

getEvents(): EventApi[]

Inherited from CalendarApi.getEvents
Returns EventApi[]

getOption

getOption<OptionName>(name: OptionName): CalendarOptions[OptionName]

Inherited from CalendarApi.getOption
Type Parameters
- OptionName extends "duration" | "locale" | "select" | "editable" | "height" | "drop" | "aspectRatio" | "themeSystem" | "navLinkDayClick" | "navLinkWeekClick" | "bootstrapFontAwesome" | "buttonIcons" | "customButtons" | "defaultAllDayEventDuration" | "defaultTimedEventDuration" | "nextDayThreshold" | "scrollTime" | "scrollTimeReset" | "slotMinTime" | "slotMaxTime" | "dayPopoverFormat" | "slotDuration" | "snapDuration" | "headerToolbar" | "footerToolbar" | "defaultRangeSeparator" | "titleRangeSeparator" | "forceEventDuration" | "dayHeaders" | "dayHeaderFormat" | "dayHeaderClassNames" | "dayHeaderContent" | "dayHeaderDidMount" | "dayHeaderWillUnmount" | "dayCellClassNames" | "dayCellContent" | "dayCellDidMount" | "dayCellWillUnmount" | "initialView" | "weekends" | "weekNumberCalculation" | "weekNumbers" | "weekNumberClassNames" | "weekNumberContent" | "weekNumberDidMount" | "weekNumberWillUnmount" | "viewClassNames" | "viewDidMount" | "viewWillUnmount" | "nowIndicator" | "nowIndicatorClassNames" | "nowIndicatorContent" | "nowIndicatorDidMount" | "nowIndicatorWillUnmount" | "showNonCurrentDates" | "lazyFetching" | "startParam" | "endParam" | "timeZoneParam" | "timeZone" | "locales" | "dragRevertDuration" | "dragScroll" | "allDayMaintainDuration" | "unselectAuto" | "dropAccept" | "eventOrder" | "eventOrderStrict" | "handleWindowResize" | "windowResizeDelay" | "longPressDelay" | "eventDragMinDistance" | "expandRows" | "contentHeight" | "direction" | "weekNumberFormat" | "eventResizableFromStart" | "displayEventTime" | "displayEventEnd" | "weekText" | "weekTextLong" | "progressiveEventRendering" | "businessHours" | "initialDate" | "now" | "eventDataTransform" | "stickyHeaderDates" | "stickyFooterScrollbar" | "viewHeight" | "defaultAllDay" | "eventSourceFailure" | "eventSourceSuccess" | "eventDisplay" | "eventStartEditable" | "eventDurationEditable" | "eventOverlap" | "eventConstraint" | "eventAllow" | "eventBackgroundColor" | "eventBorderColor" | "eventTextColor" | "eventColor" | "eventClassNames" | "eventContent" | "eventDidMount" | "eventWillUnmount" | "selectConstraint" | "selectOverlap" | "selectAllow" | "droppable" | "unselectCancel" | "slotLabelFormat" | "slotLaneClassNames" | "slotLaneContent" | "slotLaneDidMount" | "slotLaneWillUnmount" | "slotLabelClassNames" | "slotLabelContent" | "slotLabelDidMount" | "slotLabelWillUnmount" | "dayMaxEvents" | "dayMaxEventRows" | "dayMinWidth" | "slotLabelInterval" | "allDayText" | "allDayClassNames" | "allDayContent" | "allDayDidMount" | "allDayWillUnmount" | "slotMinWidth" | "navLinks" | "eventTimeFormat" | "rerenderDelay" | "moreLinkText" | "moreLinkHint" | "selectMinDistance" | "selectable" | "selectLongPressDelay" | "eventLongPressDelay" | "selectMirror" | "eventMaxStack" | "eventMinHeight" | "eventMinWidth" | "eventShortHeight" | "slotEventOverlap" | "plugins" | "firstDay" | "dayCount" | "dateAlignment" | "dateIncrement" | "hiddenDays" | "monthMode" | "fixedWeekCount" | "validRange" | "visibleRange" | "titleFormat" | "eventInteractive" | "noEventsText" | "viewHint" | "navLinkHint" | "closeHint" | "timeHint" | "eventHint" | "moreLinkClick" | "moreLinkClassNames" | "moreLinkContent" | "moreLinkDidMount" | "moreLinkWillUnmount" | "fixedMirrorParent" | "listDayFormat" | "listDaySideFormat" | "noEventsClassNames" | "noEventsContent" | "noEventsDidMount" | "noEventsWillUnmount" | "allDaySlot" | "datesSet" | "eventsSet" | "eventAdd" | "eventChange" | "eventRemove" | "windowResize" | "eventClick" | "eventMouseEnter" | "eventMouseLeave" | "unselect" | "loading" | "_unmount" | "_beforeprint" | "_afterprint" | "_noEventDrop" | "_noEventResize" | "_resize" | "_scrollRequest" | "dateClick" | "eventDragStart" | "eventDragStop" | "eventDrop" | "eventResizeStart" | "eventResizeStop" | "eventResize" | "eventReceive" | "eventLeave" | "buttonText" | "buttonHints" | "views" | "initialEvents" | "events" | "eventSources"
Parameters
- name: OptionName
Returns CalendarOptions[OptionName]

gotoDate

gotoDate(zonedDateInput: any): void

Inherited from CalendarApi.gotoDate
Parameters
- zonedDateInput: any
Returns void

incrementDate

incrementDate(deltaInput: any): void

Inherited from CalendarApi.incrementDate
Parameters
- deltaInput: any
Returns void

next(): void

Inherited from CalendarApi.next
Returns void

nextYear

nextYear(): void

Inherited from CalendarApi.nextYear
Returns void

off

off<ListenerName>(handlerName: ListenerName, handler: Required<RefinedOptionsFromRefiners<Required<CalendarListenerRefiners>>>[ListenerName]): void

Inherited from CalendarApi.off
Type Parameters
- ListenerName extends keyof CalendarListenerRefiners
Parameters
- handlerName: ListenerName
- handler: Required<RefinedOptionsFromRefiners<Required<CalendarListenerRefiners>>>[ListenerName]
Returns void

on

on<ListenerName>(handlerName: ListenerName, handler: Required<RefinedOptionsFromRefiners<Required<CalendarListenerRefiners>>>[ListenerName]): void

Inherited from CalendarApi.on
Type Parameters
- ListenerName extends keyof CalendarListenerRefiners
Parameters
- handlerName: ListenerName
- handler: Required<RefinedOptionsFromRefiners<Required<CalendarListenerRefiners>>>[ListenerName]
Returns void

pauseRendering

pauseRendering(): void

Returns void

prev(): void

Inherited from CalendarApi.prev
Returns void

prevYear

prevYear(): void

Inherited from CalendarApi.prevYear
Returns void

refetchEvents

refetchEvents(): void

Inherited from CalendarApi.refetchEvents
Returns void

removeAllEventSources

removeAllEventSources(): void

Inherited from CalendarApi.removeAllEventSources
Returns void

removeAllEvents

removeAllEvents(): void

Inherited from CalendarApi.removeAllEvents
Returns void

render

render(): void

Returns void

resetOptions

resetOptions(optionOverrides: any, append?: any): void

Parameters
- optionOverrides: any
- Optional append: any
Returns void

resumeRendering

resumeRendering(): void

Returns void

scrollToTime

scrollToTime(timeInput: DurationInput): void

Inherited from CalendarApi.scrollToTime
Parameters
- timeInput: DurationInput
Returns void

select

select(dateOrObj: any, endDate?: DateInput): void

Inherited from CalendarApi.select
Parameters
- dateOrObj: any
- Optional endDate: DateInput
Returns void

setClassNames

setClassNames(classNames: string[]): void

Parameters
- classNames: string[]
Returns void

setHeight

setHeight(height: CssDimValue): void

Parameters
- height: CssDimValue
Returns void

setOption

setOption<OptionName>(name: OptionName, val: CalendarOptions[OptionName]): void

Inherited from CalendarApi.setOption
Type Parameters
- OptionName extends "duration" | "locale" | "select" | "editable" | "height" | "drop" | "aspectRatio" | "themeSystem" | "navLinkDayClick" | "navLinkWeekClick" | "bootstrapFontAwesome" | "buttonIcons" | "customButtons" | "defaultAllDayEventDuration" | "defaultTimedEventDuration" | "nextDayThreshold" | "scrollTime" | "scrollTimeReset" | "slotMinTime" | "slotMaxTime" | "dayPopoverFormat" | "slotDuration" | "snapDuration" | "headerToolbar" | "footerToolbar" | "defaultRangeSeparator" | "titleRangeSeparator" | "forceEventDuration" | "dayHeaders" | "dayHeaderFormat" | "dayHeaderClassNames" | "dayHeaderContent" | "dayHeaderDidMount" | "dayHeaderWillUnmount" | "dayCellClassNames" | "dayCellContent" | "dayCellDidMount" | "dayCellWillUnmount" | "initialView" | "weekends" | "weekNumberCalculation" | "weekNumbers" | "weekNumberClassNames" | "weekNumberContent" | "weekNumberDidMount" | "weekNumberWillUnmount" | "viewClassNames" | "viewDidMount" | "viewWillUnmount" | "nowIndicator" | "nowIndicatorClassNames" | "nowIndicatorContent" | "nowIndicatorDidMount" | "nowIndicatorWillUnmount" | "showNonCurrentDates" | "lazyFetching" | "startParam" | "endParam" | "timeZoneParam" | "timeZone" | "locales" | "dragRevertDuration" | "dragScroll" | "allDayMaintainDuration" | "unselectAuto" | "dropAccept" | "eventOrder" | "eventOrderStrict" | "handleWindowResize" | "windowResizeDelay" | "longPressDelay" | "eventDragMinDistance" | "expandRows" | "contentHeight" | "direction" | "weekNumberFormat" | "eventResizableFromStart" | "displayEventTime" | "displayEventEnd" | "weekText" | "weekTextLong" | "progressiveEventRendering" | "businessHours" | "initialDate" | "now" | "eventDataTransform" | "stickyHeaderDates" | "stickyFooterScrollbar" | "viewHeight" | "defaultAllDay" | "eventSourceFailure" | "eventSourceSuccess" | "eventDisplay" | "eventStartEditable" | "eventDurationEditable" | "eventOverlap" | "eventConstraint" | "eventAllow" | "eventBackgroundColor" | "eventBorderColor" | "eventTextColor" | "eventColor" | "eventClassNames" | "eventContent" | "eventDidMount" | "eventWillUnmount" | "selectConstraint" | "selectOverlap" | "selectAllow" | "droppable" | "unselectCancel" | "slotLabelFormat" | "slotLaneClassNames" | "slotLaneContent" | "slotLaneDidMount" | "slotLaneWillUnmount" | "slotLabelClassNames" | "slotLabelContent" | "slotLabelDidMount" | "slotLabelWillUnmount" | "dayMaxEvents" | "dayMaxEventRows" | "dayMinWidth" | "slotLabelInterval" | "allDayText" | "allDayClassNames" | "allDayContent" | "allDayDidMount" | "allDayWillUnmount" | "slotMinWidth" | "navLinks" | "eventTimeFormat" | "rerenderDelay" | "moreLinkText" | "moreLinkHint" | "selectMinDistance" | "selectable" | "selectLongPressDelay" | "eventLongPressDelay" | "selectMirror" | "eventMaxStack" | "eventMinHeight" | "eventMinWidth" | "eventShortHeight" | "slotEventOverlap" | "plugins" | "firstDay" | "dayCount" | "dateAlignment" | "dateIncrement" | "hiddenDays" | "monthMode" | "fixedWeekCount" | "validRange" | "visibleRange" | "titleFormat" | "eventInteractive" | "noEventsText" | "viewHint" | "navLinkHint" | "closeHint" | "timeHint" | "eventHint" | "moreLinkClick" | "moreLinkClassNames" | "moreLinkContent" | "moreLinkDidMount" | "moreLinkWillUnmount" | "fixedMirrorParent" | "listDayFormat" | "listDaySideFormat" | "noEventsClassNames" | "noEventsContent" | "noEventsDidMount" | "noEventsWillUnmount" | "allDaySlot" | "datesSet" | "eventsSet" | "eventAdd" | "eventChange" | "eventRemove" | "windowResize" | "eventClick" | "eventMouseEnter" | "eventMouseLeave" | "unselect" | "loading" | "_unmount" | "_beforeprint" | "_afterprint" | "_noEventDrop" | "_noEventResize" | "_resize" | "_scrollRequest" | "dateClick" | "eventDragStart" | "eventDragStop" | "eventDrop" | "eventResizeStart" | "eventResizeStop" | "eventResize" | "eventReceive" | "eventLeave" | "buttonText" | "buttonHints" | "views" | "initialEvents" | "events" | "eventSources"
Parameters
- name: OptionName
- val: CalendarOptions[OptionName]
Returns void

today

today(): void

Inherited from CalendarApi.today
Returns void

trigger

trigger<ListenerName>(handlerName: ListenerName, ...args: Parameters<Required<RefinedOptionsFromRefiners<Required<CalendarListenerRefiners>>>[ListenerName]>): void

Inherited from CalendarApi.trigger
Type Parameters
- ListenerName extends keyof CalendarListenerRefiners
Parameters
- handlerName: ListenerName
- Rest ...args: Parameters<Required<RefinedOptionsFromRefiners<Required<CalendarListenerRefiners>>>[ListenerName]>
Returns void

unselect

unselect(pev?: PointerDragEvent): void

Inherited from CalendarApi.unselect
Parameters
- Optional pev: PointerDragEvent
Returns void

updateSize

updateSize(): void

Overrides CalendarApi.updateSize
Returns void

zoomTo

zoomTo(dateMarker: Date, viewType?: string): void

Inherited from CalendarApi.zoomTo
Parameters
- dateMarker: Date
- Optional viewType: string
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

el: HTMLElement

Optional optionOverrides: CalendarOptions

Returns Calendar

Properties

currentClassNames

currentData

Optional currentDataManager

customContentRenderId

el

handleAction

Type declaration

Parameters

action: Action

Returns void

handleData

Type declaration

Parameters

data: CalendarData

Returns void

handleRenderRequest

Type declaration

Returns void

isRendered

isRendering

renderRunner

Accessors

view

Returns ViewApi

Methods

addEvent

Parameters

eventInput: EventInput

Optional sourceInput: string | boolean | EventSourceApi

Returns null | EventApi

addEventSource

Parameters

sourceInput: EventSourceInput

Returns EventSourceApi

batchRendering

Parameters

func: any

Returns void

changeView

Parameters

viewType: string

Optional dateOrRange: DateInput | DateRangeInput

Returns void

destroy

Returns void

dispatch

Parameters

action: Action

Returns void

formatDate

Parameters

d: DateInput

formatter: any

Returns string

formatIso

Parameters

d: DateInput

Optional omitTime: boolean

Returns string

formatRange

Parameters

d0: DateInput

d1: DateInput

settings: any

Returns string

getAvailableLocaleCodes

Returns string[]