API Reference
Calendar API reference for the Calendar class.
import { Calendar } from '@forcecalendar/core' ; new Calendar (config ?: CalendarConfig) Param Type Default config.view'month' | 'week' | 'day' | 'list''month'config.dateDatenew Date()config.weekStartsOnnumber0config.localestring'en-US'config.timeZonestringSystem timezone config.showWeekNumbersbooleanfalseconfig.showWeekendsbooleantrueconfig.fixedWeekCountbooleantrueconfig.businessHours{ start: string, end: string }{ start: '09:00', end: '17:00' }config.eventsEventData[]undefined
Method Signature Returns setView(viewType: string, date?: Date) => void— getView() => stringCurrent view type getViewData() => ViewDataStructured view data
Method Signature Returns next() => void— previous() => void— today() => void— goToDate(date: Date) => void—
Method Signature Returns addEvent(eventData: EventData) => EventCreated Event updateEvent(eventId: string, updates: Partial<EventData>) => EventUpdated Event removeEvent(eventId: string) => void— getEvent(eventId: string) => Event | undefinedEvent or undefined getEvents() => Event[]All events setEvents(events: EventData[], options?: SetEventsOptions) => EventsSetPayloadSnapshot change set reconcileEvents(events: EventData[], options?: ReconcileOptions) => EventsSetPayloadReconciled change set getEventsVersion() => numberStore change counter queryEvents(filters: QueryFilters) => Event[]Filtered events getEventsForDate(date: Date, timezone?: string) => Event[]Events on date getEventsInRange(start: Date, end: Date, timezone?: string) => Event[]Events in range
Method Signature Returns setTimezone(timezone: string) => void— getTimezone() => stringIANA timezone convertTimezone(date: Date, from: string, to: string) => DateConverted date toCalendarTimezone(date: Date, from?: string) => DateDate in calendar tz fromCalendarTimezone(date: Date, to?: string) => DateDate in target tz formatInTimezone(date: Date, tz?: string, options?: object) => stringFormatted string getTimezones() => Array<{ value: string, label: string, offset: string }>Timezone descriptors
Method Signature Returns setLocale(locale: string) => void— setWeekStartsOn(weekStartsOn: number) => void—
Method Signature Returns selectEvent(eventId: string) => void— clearEventSelection() => void— selectDate(date: Date) => void— clearDateSelection() => void—
Method Signature Returns getOverlapGroups(date: Date, timedOnly = true) => Event[][]Overlap groups calculateEventPositions(events: Event[]) => MapPosition map
Method Signature Returns on(eventName: string, callback: Function) => void— off(eventName: string, callback: Function) => void—
Method Signature Returns use(plugin: { install: Function }) => void—
Method Signature Returns destroy() => void—
viewChange, navigate, eventAdd, eventUpdate, eventRemove, eventsSet, stateChange, eventStoreChange, timezoneChange, localeChange, weekStartsOnChange, eventSelect, eventDeselect, dateSelect, dateDeselect, destroy
Property Type Description eventStoreEventStoreInternal event store stateStateManagerInternal state manager timezoneManagerTimezoneManagerTimezone singleton configobjectResolved configuration
Core setEvents() clears/reloads by default; opt into { reconcile: true } or call reconcileEvents(). Interface snapshots reconcile by default. See snapshot reconciliation .
forceCalendar by N. R. Dhanawada