COMPLETE API REFERENCE

Every option.
One searchable contract.

Search the installed @wts-calendar/core declarations, public calendar methods, and every PHP and ASP.NET Core endpoint setting. Types and method signatures are generated from the package pinned by this portal.

248 client options95 public APIs78 event-bus names447 exported symbols20 server settings

95 matching public APIs

Obtain the instance directly or through your framework wrapper's controller/ref.

addEvent

Method

Public WtsCalendar API method.

addEvent: (data: CalendarEventInput | Array<CalendarEventInput>) => CalendarEvent[]

addEventSource

Method

Public WtsCalendar API method.

addEventSource: (source: CalendarEventSource) => string

removeEventSource

Method

Public WtsCalendar API method.

removeEventSource: (id: string) => boolean

refetchEvents

Method

Public WtsCalendar API method.

refetchEvents: (sourceId?: string) => Promise<void>

refetchSources

Method

Public WtsCalendar API method.

refetchSources: () => Promise<void>

getEventSources

Method

Public WtsCalendar API method.

getEventSources: () => readonly CalendarEventSourceInfo[]

getResources

Method

Public WtsCalendar API method.

getResources: () => readonly Readonly<CalendarResource>[]

getResourceById

Method

Public WtsCalendar API method.

getResourceById: (id: string) => Readonly<CalendarResource> | null

setResources

Method

Public WtsCalendar API method.

setResources: (resources: readonly CalendarResource[]) => CalendarResourceMutation

addResource

Method

Public WtsCalendar API method.

addResource: (resource: CalendarResource) => CalendarResourceMutation

updateResource

Method

Public WtsCalendar API method.

updateResource: (id: string, changes: Partial<Omit<CalendarResource, "id">>) => CalendarResourceMutation | null

removeResource

Method

Public WtsCalendar API method.

removeResource: (id: string, options?: CalendarResourceRemovalOptions) => CalendarResourceRemovalResult | null

addResourceSource

Method

Public WtsCalendar API method.

addResourceSource: (source: CalendarResourceSource) => string

removeResourceSource

Method

Public WtsCalendar API method.

removeResourceSource: (id: string) => boolean

refetchResources

Method

Public WtsCalendar API method.

refetchResources: (sourceId?: string, request?: CalendarResourceSourceRequest) => Promise<void>

loadMoreResources

Method

Public WtsCalendar API method.

loadMoreResources: (sourceId: string, request?: CalendarResourceSourceRequest) => Promise<void>

getResourceSources

Method

Public WtsCalendar API method.

getResourceSources: () => readonly CalendarResourceSourceInfo[]

addTaskSource

Method

Public WtsCalendar API method.

addTaskSource: (source: CalendarTaskSource) => string

removeTaskSource

Method

Public WtsCalendar API method.

removeTaskSource: (id: string) => boolean

refetchTasks

Method

Public WtsCalendar API method.

refetchTasks: (sourceId?: string, request?: CalendarTaskSourceRequest) => Promise<void>

loadMoreTasks

Method

Public WtsCalendar API method.

loadMoreTasks: (sourceId: string, request?: CalendarTaskSourceRequest) => Promise<void>

getTaskSources

Method

Public WtsCalendar API method.

getTaskSources: () => readonly CalendarTaskSourceInfo[]

getTasks

Method

Public WtsCalendar API method.

getTasks: () => readonly CalendarTaskSnapshot[]

getTaskById

Method

Public WtsCalendar API method.

getTaskById: (id: string) => CalendarTaskSnapshot | null

addTask

Method

Public WtsCalendar API method.

addTask: (taskId: string, event: CalendarTaskOccurrenceInput) => CalendarTaskMutationTransaction

updateTask

Method

Public WtsCalendar API method.

updateTask: (taskId: string, occurrenceId: string, changes: CalendarTaskOccurrenceChanges) => CalendarTaskMutationTransaction | null

removeTask

Method

Public WtsCalendar API method.

removeTask: (taskId: string, occurrenceId: string) => CalendarTaskMutationTransaction | null

setTaskStatus

Method

Public WtsCalendar API method.

setTaskStatus: (taskId: string, occurrenceId: string, status: CalendarTaskStatus) => CalendarTaskMutationTransaction | null

setEvents

Method

Public WtsCalendar API method.

setEvents: (data: CalendarEventInput[]) => CalendarEvent[]

importICalendar

Method

Public WtsCalendar API method.

importICalendar: (source: string, options?: CalendarICalendarImportIntoOptions) => CalendarICalendarImportResult

exportICalendar

Method

Public WtsCalendar API method.

exportICalendar: (options?: CalendarICalendarExportOptions) => string

batchRendering

Method

Public WtsCalendar API method.

batchRendering: <T>(callback: () => T) => T

batchRenderingAsync

Method

Public WtsCalendar API method.

batchRenderingAsync: <T>(callback: () => T | PromiseLike<T>) => Promise<T>

on

Method

Public WtsCalendar API method.

on: (type: iMethods, callback: CalendarEventCallback) => () => void

off

Method

Public WtsCalendar API method.

off: (type: iMethods, callback?: CalendarEventCallback) => void

getEvents

Method

Public WtsCalendar API method.

getEvents: () => CalendarEvent[]

getEventById

Method

Public WtsCalendar API method.

getEventById: (id: string) => CalendarEvent | null

updateEvent

Method

Public WtsCalendar API method.

updateEvent: (id: string, changes: Partial<CalendarEventInput>) => CalendarEvent | null

createEvent

Method

Public WtsCalendar API method.

createEvent: (input: CalendarEventCreateInput, domEvent?: Event) => CalendarEventMutationTransaction | null

editEvent

Method

Public WtsCalendar API method.

editEvent: (id: string, changes: CalendarOccurrenceChanges | Partial<CalendarEventInput>, options?: CalendarRecurringEditOptions, domEvent?: Event) => CalendarEventMutationTransaction | null

removeEventWithTransaction

Method

Public WtsCalendar API method.

removeEventWithTransaction: (id: string, options?: CalendarRecurringEditOptions, domEvent?: Event) => CalendarEventMutationTransaction | null

updateRecurringEvent

Method

Public WtsCalendar API method.

updateRecurringEvent: (id: string, changes: CalendarOccurrenceChanges | Partial<CalendarEventInput>, options?: CalendarRecurringEditOptions) => CalendarEvent | null

removeRecurringEvent

Method

Public WtsCalendar API method.

removeRecurringEvent: (id: string, options?: CalendarRecurringEditOptions) => boolean

removeEvent

Method

Public WtsCalendar API method.

removeEvent: (id: string) => boolean

removeAllEvents

Method

Public WtsCalendar API method.

removeAllEvents: () => void

makeDraggable

Method

Public WtsCalendar API method.

makeDraggable: (element: HTMLElement, data: CalendarExternalEventData, options?: CalendarExternalDraggableOptions) => () => void

select

Method

Public WtsCalendar API method.

select: {
        (input: CalendarSelectionInput): CalendarSelection | null;
        (start: CalendarDateInput, end?: CalendarDateInput): CalendarSelection | null;
    }

unselect

Method

Public WtsCalendar API method.

unselect: () => boolean

getSelection

Method

Public WtsCalendar API method.

getSelection: () => CalendarSelection | null

getEventHistoryState

Method

Public WtsCalendar API method.

getEventHistoryState: () => CalendarEventHistoryState

undo

Method

Public WtsCalendar API method.

undo: () => boolean

redo

Method

Public WtsCalendar API method.

redo: () => boolean

clearEventHistory

Method

Public WtsCalendar API method.

clearEventHistory: () => void

getDate

Method

Public WtsCalendar API method.

getDate: () => Date

getView

Method

Public WtsCalendar API method.

getView: () => CalendarViewApi

getOption

Method

Public WtsCalendar API method.

getOption: <K extends keyof CalendarOptions>(name: K) => CalendarOptions[K]

getLicenseStatus

Method

Public WtsCalendar API method.

getLicenseStatus: () => CalendarLicenseStatus

render

Method

Public WtsCalendar API method.

render: () => void

rerenderEvents

Method

Public WtsCalendar API method.

rerenderEvents: () => void

whenIdle

Method

Public WtsCalendar API method.

whenIdle: () => Promise<void>

destroy

Method

Public WtsCalendar API method.

destroy: () => void

destroyAsync

Method

Public WtsCalendar API method.

destroyAsync: () => Promise<void>

format

Method

Public WtsCalendar API method.

format: (date: Date, format: string) => string

formatDate

Method

Public WtsCalendar API method.

formatDate: (date: CalendarDateInput, format?: CalendarDateFormatInput) => string

formatRange

Method

Public WtsCalendar API method.

formatRange: (start: CalendarDateInput, end: CalendarDateInput, format?: CalendarDateFormatInput) => string

formatIso

Method

Public WtsCalendar API method.

formatIso: (date: CalendarDateInput, options?: CalendarFormatIsoOptions) => string

setView

Method

Public WtsCalendar API method.

setView: (view: Views, date?: CalendarDateInput) => void

changeView

Method

Public WtsCalendar API method.

changeView: (view: Views, dateOrRange?: CalendarDateInput | CalendarVisibleRangeInput) => void

next

Method

Public WtsCalendar API method.

next: () => void

prev

Method

Public WtsCalendar API method.

prev: () => void

previous

Method

Public WtsCalendar API method.

previous: () => void

today

Method

Public WtsCalendar API method.

today: () => void

prevYear

Method

Public WtsCalendar API method.

prevYear: () => void

previousYear

Method

Public WtsCalendar API method.

previousYear: () => void

nextYear

Method

Public WtsCalendar API method.

nextYear: () => void

gotoDate

Method

Public WtsCalendar API method.

gotoDate: (date: CalendarDateInput) => void

incrementDate

Method

Public WtsCalendar API method.

incrementDate: (duration: CalendarDurationInput) => void

scrollToTime

Method

Public WtsCalendar API method.

scrollToTime: (time: string) => void

updateSize

Method

Public WtsCalendar API method.

updateSize: () => void

setDate

Method

Public WtsCalendar API method.

setDate: (date: CalendarDateInput) => void

setOption

Method

Public WtsCalendar API method.

setOption: <K extends CalendarDynamicOptionName>(name: K, value: CalendarOptions[K]) => CalendarOptionChange

setOptions

Method

Public WtsCalendar API method.

setOptions: (changes: CalendarOptionChanges) => CalendarOptionChange

updateCustomTitle

Method

Public WtsCalendar API method.

updateCustomTitle: (title: string, element: HTMLElement | Element | string) => void

events

Property

Public WtsCalendar property.

readonly events: CalendarEvent[]

option

Property

Public WtsCalendar property.

readonly option: Readonly<CalendarOptions>

view

Property

Public WtsCalendar property.

readonly view: Views

viewName

Property

Public WtsCalendar property.

readonly viewName: Views

viewApi

Property

Public WtsCalendar property.

readonly viewApi: CalendarViewApi

viewDate

Property

Public WtsCalendar property.

readonly viewDate: Date

methods

Property

Public WtsCalendar property.

readonly methods: {
        [key: string]: Function[];
    }

document

Property

Public WtsCalendar property.

readonly document: Document

isDestroyed

Property

Public WtsCalendar property.

readonly isDestroyed: boolean

lifecycleState

Property

Public WtsCalendar property.

readonly lifecycleState: CalendarLifecycleState

pendingOperationCount

Property

Public WtsCalendar property.

readonly pendingOperationCount: number

createLicensed

Method

Public WtsCalendar API method.

static createLicensed(option: CalenderOptiopn | CalenderOptiopnRepeatedTask, token: string): Promise<WtsCalendar>;