Class Calendar

Hierarchy (View Summary)

CalendarApiImpl
- Calendar

Constructors

constructor

new Calendar(el: HTMLElement, optionOverrides?: CalendarOptions): Calendar
Parameters
- el: HTMLElement
- OptionaloptionOverrides: CalendarOptions
Returns Calendar
Overrides CalendarApiImpl.constructor
- Defined in node_modules/fullcalendar/chunks/b0099b21.d.ts:15

Properties

`Optional`currentDataManager

currentDataManager?: CalendarDataManager

el

el: HTMLElement

Accessors

view

get view(): ViewImpl
Returns ViewImpl
Inherited from CalendarApiImpl.view
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1680

Methods

addEvent

addEvent(
eventInput: EventInput,
sourceInput?: string | boolean | EventSourceImpl,
): EventImpl
Parameters
- eventInput: EventInput
- OptionalsourceInput: string | boolean | EventSourceImpl
Returns EventImpl
Inherited from CalendarApiImpl.addEvent
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1704

addEventSource

addEventSource(sourceInput: EventSourceInput): EventSourceImpl
Parameters
- sourceInput: EventSourceInput
Returns EventSourceImpl
Inherited from CalendarApiImpl.addEventSource
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1711

batchRendering

batchRendering(func: any): void
Parameters
- func: any
Returns void
Overrides CalendarApiImpl.batchRendering
- Defined in node_modules/fullcalendar/chunks/b0099b21.d.ts:20

changeView

changeView(viewType: string, dateOrRange?: DateInput | DateRangeInput): void
Parameters
- viewType: string
- OptionaldateOrRange: DateInput | DateRangeInput
Returns void
Inherited from CalendarApiImpl.changeView
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1688

destroy

destroy(): void
Returns void
- Defined in node_modules/fullcalendar/chunks/b0099b21.d.ts:19

dispatch

dispatch(action: Action): void
Parameters
- action: Action
Returns void
Inherited from CalendarApiImpl.dispatch
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1679

formatDate

formatDate(d: DateInput, formatter: FormatterInput): string
Parameters
- d: DateInput
- formatter: FormatterInput
Returns string
Inherited from CalendarApiImpl.formatDate
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1699

formatIso

formatIso(d: DateInput, omitTime?: boolean): string
Parameters
- d: DateInput
- OptionalomitTime: boolean
Returns string
Inherited from CalendarApiImpl.formatIso
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1701

formatRange

formatRange(d0: DateInput, d1: DateInput, settings: any): string
Parameters
- d0: DateInput
- d1: DateInput
- settings: any
Returns string
Inherited from CalendarApiImpl.formatRange
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1700

getAvailableLocaleCodes

getAvailableLocaleCodes(): string[]
Returns string[]
Inherited from CalendarApiImpl.getAvailableLocaleCodes
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1684

getButtonState

getButtonState(): ButtonStateMap
Returns ButtonStateMap
Inherited from CalendarApiImpl.getButtonState
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1715

getCurrentData

getCurrentData(): CalendarData
Returns CalendarData
Inherited from CalendarApiImpl.getCurrentData
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1678

getDate

getDate(): Date
Returns Date
Inherited from CalendarApiImpl.getDate
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1698

getEventById

getEventById(id: string): EventImpl
Parameters
- id: string
Returns EventImpl
Inherited from CalendarApiImpl.getEventById
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1706

getEvents

getEvents(): EventImpl[]
Returns EventImpl[]
Inherited from CalendarApiImpl.getEvents
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1707

getEventSourceById

getEventSourceById(id: string): EventSourceImpl
Parameters
- id: string
Returns EventSourceImpl
Inherited from CalendarApiImpl.getEventSourceById
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1710

getEventSources

getEventSources(): EventSourceImpl[]
Returns EventSourceImpl[]
Inherited from CalendarApiImpl.getEventSources
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1709

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]
Inherited from CalendarApiImpl.getOption
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1683

gotoDate

gotoDate(zonedDateInput: DateInput): void
Parameters
- zonedDateInput: DateInput
Returns void
Inherited from CalendarApiImpl.gotoDate
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1696

incrementDate

incrementDate(deltaInput: DurationInput): void
Parameters
- deltaInput: DurationInput
Returns void
Inherited from CalendarApiImpl.incrementDate
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1697

next(): void
Returns void
Inherited from CalendarApiImpl.next
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1692

nextYear

nextYear(): void
Returns void
Inherited from CalendarApiImpl.nextYear
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1694

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
Inherited from CalendarApiImpl.off
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1686

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
Inherited from CalendarApiImpl.on
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1685

pauseRendering

pauseRendering(): void
Returns void
- Defined in node_modules/fullcalendar/chunks/b0099b21.d.ts:21

prev(): void
Returns void
Inherited from CalendarApiImpl.prev
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1691

prevYear

prevYear(): void
Returns void
Inherited from CalendarApiImpl.prevYear
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1693

refetchEvents

refetchEvents(): void
Returns void
Inherited from CalendarApiImpl.refetchEvents
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1713

removeAllEvents

removeAllEvents(): void
Returns void
Inherited from CalendarApiImpl.removeAllEvents
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1708

removeAllEventSources

removeAllEventSources(): void
Returns void
Inherited from CalendarApiImpl.removeAllEventSources
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1712

render

render(): void
Returns void
- Defined in node_modules/fullcalendar/chunks/b0099b21.d.ts:18

resetOptions

resetOptions(optionOverrides: any, changedOptionNames?: string[]): void
Parameters
- optionOverrides: any
- OptionalchangedOptionNames: string[]
Returns void
- Defined in node_modules/fullcalendar/chunks/b0099b21.d.ts:23

resumeRendering

resumeRendering(): void
Returns void
- Defined in node_modules/fullcalendar/chunks/b0099b21.d.ts:22

scrollToTime

scrollToTime(timeInput: DurationInput): void
Parameters
- timeInput: DurationInput
Returns void
Inherited from CalendarApiImpl.scrollToTime
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1714

select

select(dateOrObj: any, endDate?: DateInput): void
Parameters
- dateOrObj: any
- OptionalendDate: DateInput
Returns void
Inherited from CalendarApiImpl.select
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1702

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
Inherited from CalendarApiImpl.setOption
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1682

today

today(): void
Returns void
Inherited from CalendarApiImpl.today
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1695

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
Inherited from CalendarApiImpl.trigger
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1687

unselect

unselect(pev?: PointerDragEvent): void
Parameters
- Optionalpev: PointerDragEvent
Returns void
Inherited from CalendarApiImpl.unselect
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1703

zoomTo

zoomTo(dateMarker: Date, viewType?: string): void
Parameters
- dateMarker: Date
- OptionalviewType: string
Returns void
Inherited from CalendarApiImpl.zoomTo
- Defined in node_modules/fullcalendar/chunks/05b54543.d.ts:1689

Class Calendar

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Calendar

Properties

OptionalcurrentDataManager

el

Accessors

view

Returns ViewImpl

Methods

addEvent

Parameters

Returns EventImpl

addEventSource

Parameters

Returns EventSourceImpl

batchRendering

Parameters

Returns void

changeView

Parameters

Returns void

destroy

Returns void

dispatch

Parameters

Returns void

formatDate

Parameters

Returns string

formatIso

Parameters

Returns string

formatRange

Parameters

Returns string

getAvailableLocaleCodes

Returns string[]

getButtonState

Returns ButtonStateMap

getCurrentData

Returns CalendarData

getDate

Returns Date

getEventById

Parameters

Returns EventImpl

getEvents

Returns EventImpl[]

getEventSourceById

Parameters

Returns EventSourceImpl

getEventSources

Returns EventSourceImpl[]

getOption

Type Parameters

Parameters

Returns CalendarOptions[OptionName]

gotoDate

Parameters

Returns void

incrementDate

Parameters

Returns void

next

Returns void

nextYear

Returns void

off

Type Parameters

Parameters

Returns void

`Optional`currentDataManager