jQuery Event Calendar API
    Preparing search index...

    Interface IEventCalendarOptions

    Configuration options for initializing the EventCalendar plugin.

    interface IEventCalendarOptions {
        cacheJson?: boolean;
        callbacks?: { changeDay?: (date: Date) => void };
        dateTimeOffset?: number;
        eventsLimit?: number;
        eventsScrollable?: boolean;
        eventTemplateBuilder?: (event: IEvent, i18nText: II18n) => string;
        i18n?: II18n;
        jsonData: string | IEvent[];
        jsonDateFormat?: "timestamp" | "human";
        locale?: string;
        moveOpacity?: number;
        moveSpeed?: number;
        onlyOneDescription?: boolean;
        openEventInNewWindow?: boolean;
        showDayAsWeeks?: boolean;
        showDayNameInCalendar?: boolean;
        showDaysOfOtherMonths?: boolean;
        showDescription?: boolean;
        showEventsWithoutDate?: boolean;
        showFirstMonthWithEvents?: boolean;
        showTimeOfEvent?: boolean;
        startDate?: string | number;
        startWeekOnMonday?: boolean;
    }
    Index
    cacheJson? callbacks? dateTimeOffset? eventsLimit? eventsScrollable? eventTemplateBuilder? i18n? jsonData jsonDateFormat? locale? moveOpacity? moveSpeed? onlyOneDescription? openEventInNewWindow? showDayAsWeeks? showDayNameInCalendar? showDaysOfOtherMonths? showDescription? showEventsWithoutDate? showFirstMonthWithEvents? showTimeOfEvent? startDate? startWeekOnMonday?
    cacheJson?: boolean
    callbacks?: { changeDay?: (date: Date) => void }

    Type Declaration

    • OptionalchangeDay?: (date: Date) => void

      Fired when the user clicks on a specific day in the grid.

    dateTimeOffset?: number

    The default offset in minutes to apply to the passed date/time UTC (if a number). If this value is null, the local browser time zone will be applied.

    eventsLimit?: number
    eventsScrollable?: boolean
    eventTemplateBuilder?: (event: IEvent, i18nText: II18n) => string

    Optional function to build custom HTML for each event in the list. SECURITY WARNING: If you provide a custom builder, YOU are responsible for sanitizing the event data to prevent XSS (Cross-Site Scripting) attacks.

    i18n?: II18n
    jsonData: string | IEvent[]
    jsonDateFormat?: "timestamp" | "human"
    locale?: string
    moveOpacity?: number
    moveSpeed?: number
    onlyOneDescription?: boolean
    openEventInNewWindow?: boolean
    showDayAsWeeks?: boolean
    showDayNameInCalendar?: boolean
    showDaysOfOtherMonths?: boolean
    showDescription?: boolean
    showEventsWithoutDate?: boolean
    showFirstMonthWithEvents?: boolean
    showTimeOfEvent?: boolean
    startDate?: string | number

    Unix date/time (UTC) or date format (e.g., "YYYY-MM-dd") or null. Forces the calendar to initialize on this specific date.

    startWeekOnMonday?: boolean

    Settings
    Member Visibility

    On This Page
    Properties