Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CalendarApi

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Optional currentDataManager

currentDataManager?: CalendarDataManager

Private getUnitViewSpec

getUnitViewSpec: any

Private triggerEventAdd

triggerEventAdd: any

Accessors

view

Methods

addEvent

addEventSource

batchRendering

  • batchRendering(callback: (() => void)): void

  • Parameters

    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

changeView

dispatch

  • dispatch(action: Action): void

  • Parameters

    Returns void

formatDate

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

  • Parameters

    Returns string

formatIso

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

  • Parameters

    Returns string

formatRange

getAvailableLocaleCodes

  • getAvailableLocaleCodes(): string[]

  • Returns string[]

getCurrentData

getDate

getEventById

  • getEventById(id: string): null | EventApi

  • Parameters

    • id: string

    Returns null | EventApi

getEventSourceById

getEventSources

getEvents

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

  • Parameters

    • zonedDateInput: any

    Returns void

incrementDate

  • incrementDate(deltaInput: any): void

  • Parameters

    • deltaInput: any

    Returns void

next

  • next(): void

  • Returns void

nextYear

  • nextYear(): void

  • Returns void

off

on

prev

  • prev(): void

  • Returns void

prevYear

  • prevYear(): void

  • Returns void

refetchEvents

  • refetchEvents(): void

  • Returns void

removeAllEventSources

  • removeAllEventSources(): void

  • Returns void

removeAllEvents

  • removeAllEvents(): void

  • Returns void

scrollToTime

select

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

  • Parameters

    Returns void

setOption

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

  • 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

    Returns void

today

  • today(): void

  • Returns void

trigger

unselect

updateSize

  • updateSize(): void

  • Returns void

zoomTo

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

  • Parameters

    • dateMarker: Date
    • Optional viewType: string

    Returns void

Generated using TypeDoc