Trilium Frontend API
    Preparing search index...

    Interface CalendarApi

    interface CalendarApi {
        view: ViewApi;
        addEvent(
            eventInput: EventInput,
            sourceInput?: string | boolean | EventSourceApi,
        ): EventApi;
        addEventSource(sourceInput: EventSourceInput): EventSourceApi;
        changeView(
            viewType: string,
            dateOrRange?: DateInput | DateRangeInput,
        ): void;
        formatDate(d: DateInput, formatter: FormatterInput): string;
        formatIso(d: DateInput, omitTime?: boolean): string;
        formatRange(d0: DateInput, d1: DateInput, settings: any): string;
        getAvailableLocaleCodes(): string[];
        getDate(): Date;
        getEventById(id: string): EventApi;
        getEvents(): EventApi[];
        getEventSourceById(id: string): EventSourceApi;
        getEventSources(): EventSourceApi[];
        getOption<
            OptionName extends
                | "className"
                | "class"
                | "viewClass"
                | "viewDidMount"
                | "viewWillUnmount"
                | "views"
                | "plugins"
                | "initialEvents"
                | "events"
                | "eventSources"
                | (keyof BaseOptions)
                | (keyof CalendarListeners),
        >(
            name: OptionName,
        ): CalendarOptions[OptionName];
        gotoDate(zonedDateInput: DateInput): void;
        incrementDate(deltaInput: DurationInput): void;
        next(): void;
        nextYear(): void;
        off<ListenerName extends keyof CalendarListeners>(
            handlerName: ListenerName,
            handler: Required<CalendarListeners>[ListenerName],
        ): void;
        on<ListenerName extends keyof CalendarListeners>(
            handlerName: ListenerName,
            handler: Required<CalendarListeners>[ListenerName],
        ): void;
        prev(): void;
        prevYear(): void;
        refetchEvents(): void;
        removeAllEvents(): void;
        removeAllEventSources(): void;
        scrollToTime(timeInput: DurationInput): void;
        select(dateOrObj: any, endDate?: DateInput): void;
        setOption<
            OptionName extends
                | "className"
                | "class"
                | "viewClass"
                | "viewDidMount"
                | "viewWillUnmount"
                | "views"
                | "plugins"
                | "initialEvents"
                | "events"
                | "eventSources"
                | (keyof BaseOptions)
                | (keyof CalendarListeners),
        >(
            name: OptionName,
            val: CalendarOptions[OptionName],
        ): void;
        today(): void;
        trigger<ListenerName extends keyof CalendarListeners>(
            handlerName: ListenerName,
            ...args: Parameters<Required<CalendarListeners>[ListenerName]>,
        ): void;
        unselect(): void;
        zoomTo(dateMarker: Date, viewType?: string): void;
    }

    Implemented by

    Index
    view
    addEvent addEventSource changeView formatDate formatIso formatRange getAvailableLocaleCodes getDate getEventById getEvents getEventSourceById getEventSources getOption gotoDate incrementDate next nextYear off on prev prevYear refetchEvents removeAllEvents removeAllEventSources scrollToTime select setOption today trigger unselect zoomTo
    view: ViewApi

    • Parameters

      Returns string

    • Parameters

      Returns string

    • Returns string[]

    • Returns Date

    • Parameters

      • id: string

      Returns EventApi

    • Returns EventApi[]

    • Parameters

      • id: string

      Returns EventSourceApi

    • Type Parameters

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

      Parameters

      Returns CalendarOptions[OptionName]

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Type Parameters

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

      Parameters

      Returns void

    • Returns void

    • Returns void

    • Parameters

      • dateMarker: Date
      • OptionalviewType: string

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods