Class CalendarApiImpl

constructor

• new CalendarApiImpl(): CalendarApiImpl

  Returns CalendarApiImpl

OptionalcurrentDataManager

view

• get view(): ViewImpl

  Returns ViewImpl

addEvent

• addEvent(
      eventInput: EventInput,
      sourceInput?: string | boolean | EventSourceImpl,
  ): EventImpl

  Parameters

  • eventInput: EventInput
  • OptionalsourceInput: string | boolean | EventSourceImpl

  Returns EventImpl

addEventSource

• addEventSource(sourceInput: EventSourceInput): EventSourceImpl

  Parameters

  • sourceInput: EventSourceInput

  Returns EventSourceImpl

batchRendering

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

  Parameters

  • callback: () => void

  Returns void

changeView

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

  Parameters

  • viewType: string
  • OptionaldateOrRange: DateInput | DateRangeInput

  Returns void

dispatch

• dispatch(action: Action): void

  Parameters

  • action: Action

  Returns void

formatDate

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

  Parameters

  • d: DateInput
  • formatter: FormatterInput

  Returns string

formatIso

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

  Parameters

  • d: DateInput
  • OptionalomitTime: boolean

  Returns string

formatRange

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

  Parameters

  • d0: DateInput
  • d1: DateInput
  • settings: any

  Returns string

getAvailableLocaleCodes

• getAvailableLocaleCodes(): string[]

  Returns string[]

getButtonState

• getButtonState(): ButtonStateMap

  Returns ButtonStateMap

getCurrentData

• getCurrentData(): CalendarData

  Returns CalendarData

getDate

• getDate(): Date

  Returns Date

getEventById

• getEventById(id: string): EventImpl

  Parameters

  • id: string

  Returns EventImpl

getEvents

• getEvents(): EventImpl[]

  Returns EventImpl[]

getEventSourceById

• getEventSourceById(id: string): EventSourceImpl

  Parameters

  • id: string

  Returns EventSourceImpl

getEventSources

• getEventSources(): EventSourceImpl[]

  Returns EventSourceImpl[]

getOption

• getOption<
      OptionName extends
          | "className"
          | "class"
          | "viewClass"
          | "viewDidMount"
          | "viewWillUnmount"
          | "views"
          | "plugins"
          | "initialEvents"
          | "events"
          | "eventSources"
          | (keyof BaseOptions)
          | (keyof CalendarListeners),
  >(
      name: OptionName,
  ): CalendarOptions[OptionName]

  Type Parameters

  • OptionName extends
        | "className"
        | "class"
        | "viewClass"
        | "viewDidMount"
        | "viewWillUnmount"
        | "views"
        | "plugins"
        | "initialEvents"
        | "events"
        | "eventSources"
        | (keyof BaseOptions)
        | (keyof CalendarListeners)

  Parameters

  • name: OptionName

  Returns CalendarOptions[OptionName]

gotoDate

• gotoDate(zonedDateInput: DateInput): void

  Parameters

  • zonedDateInput: DateInput

  Returns void

incrementDate

• incrementDate(deltaInput: DurationInput): void

  Parameters

  • deltaInput: DurationInput

  Returns void

next

• next(): void

  Returns void

nextYear

• nextYear(): void

  Returns void

off

• off<ListenerName extends keyof CalendarListeners>(
      handlerName: ListenerName,
      handler: Required<CalendarListeners>[ListenerName],
  ): void

  Type Parameters

  • ListenerName extends keyof CalendarListeners

  Parameters

  • handlerName: ListenerName
  • handler: Required<CalendarListeners>[ListenerName]

  Returns void

on

• on<ListenerName extends keyof CalendarListeners>(
      handlerName: ListenerName,
      handler: Required<CalendarListeners>[ListenerName],
  ): void

  Type Parameters

  • ListenerName extends keyof CalendarListeners

  Parameters

  • handlerName: ListenerName
  • handler: Required<CalendarListeners>[ListenerName]

  Returns void

prev

• prev(): void

  Returns void

prevYear

• prevYear(): void

  Returns void

refetchEvents

• refetchEvents(): void

  Returns void

removeAllEvents

• removeAllEvents(): void

  Returns void

removeAllEventSources

• removeAllEventSources(): void

  Returns void

scrollToTime

• scrollToTime(timeInput: DurationInput): void

  Parameters

  • timeInput: DurationInput

  Returns void

select

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

  Parameters

  • dateOrObj: any
  • OptionalendDate: DateInput

  Returns void

setOption

• setOption<
      OptionName extends
          | "className"
          | "class"
          | "viewClass"
          | "viewDidMount"
          | "viewWillUnmount"
          | "views"
          | "plugins"
          | "initialEvents"
          | "events"
          | "eventSources"
          | (keyof BaseOptions)
          | (keyof CalendarListeners),
  >(
      name: OptionName,
      val: CalendarOptions[OptionName],
  ): void

  Type Parameters

  • OptionName extends
        | "className"
        | "class"
        | "viewClass"
        | "viewDidMount"
        | "viewWillUnmount"
        | "views"
        | "plugins"
        | "initialEvents"
        | "events"
        | "eventSources"
        | (keyof BaseOptions)
        | (keyof CalendarListeners)

  Parameters

  • name: OptionName
  • val: CalendarOptions[OptionName]

  Returns void

today

• today(): void

  Returns void

trigger

• trigger<ListenerName extends keyof CalendarListeners>(
      handlerName: ListenerName,
      ...args: Parameters<Required<CalendarListeners>[ListenerName]>,
  ): void

  Type Parameters

  • ListenerName extends keyof CalendarListeners

  Parameters

  • handlerName: ListenerName
  • ...args: Parameters<Required<CalendarListeners>[ListenerName]>

  Returns void

unselect

• unselect(pev?: PointerDragEvent): void

  Parameters

  • Optionalpev: PointerDragEvent

  Returns void

zoomTo

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

  Parameters

  • dateMarker: Date
  • OptionalviewType: string

  Returns void