Trilium Frontend API
    Preparing search index...

    Interface EventApi

    interface EventApi {
        allDay: boolean;
        allow: any;
        className: string;
        color: string;
        constraint: any;
        contrastColor: string;
        display: string;
        durationEditable: boolean;
        end: Date;
        endStr: string;
        extendedProps: Dictionary;
        groupId: string;
        id: string;
        overlap: boolean;
        source: EventSourceApi;
        start: Date;
        startEditable: boolean;
        startStr: string;
        title: string;
        url: string;
        formatRange(formatInput: FormatterInput): any;
        moveDates(deltaInput: DurationInput): void;
        moveEnd(deltaInput: DurationInput): void;
        moveStart(deltaInput: DurationInput): void;
        remove(): void;
        setAllDay(allDay: boolean, options?: { maintainDuration?: boolean }): void;
        setDates(
            startInput: DateInput,
            endInput: DateInput,
            options?: { allDay?: boolean; granularity?: string },
        ): void;
        setEnd(endInput: DateInput, options?: { granularity?: string }): void;
        setExtendedProp(name: string, val: any): void;
        setProp(name: string, val: any): void;
        setStart(
            startInput: DateInput,
            options?: { granularity?: string; maintainDuration?: boolean },
        ): void;
        toJSON(): Dictionary;
        toPlainObject(settings?: { collapseExtendedProps?: boolean }): Dictionary;
    }

    Implemented by

    Index
    allDay allow className color constraint contrastColor display durationEditable end endStr extendedProps groupId id overlap source start startEditable startStr title url
    formatRange moveDates moveEnd moveStart remove setAllDay setDates setEnd setExtendedProp setProp setStart toJSON toPlainObject
    allDay: boolean
    allow: any
    className: string
    color: string
    constraint: any
    contrastColor: string
    display: string
    durationEditable: boolean
    end: Date
    endStr: string
    extendedProps: Dictionary
    groupId: string
    id: string
    overlap: boolean
    source: EventSourceApi
    start: Date
    startEditable: boolean
    startStr: string
    title: string
    url: string

    • Parameters

      Returns any

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Parameters

      Returns void

    • Returns void

    • Parameters

      • allDay: boolean
      • Optionaloptions: { maintainDuration?: boolean }

      Returns void

    • Parameters

      • startInput: DateInput
      • endInput: DateInput
      • Optionaloptions: { allDay?: boolean; granularity?: string }

      Returns void

    • Parameters

      • endInput: DateInput
      • Optionaloptions: { granularity?: string }

      Returns void

    • Parameters

      • name: string
      • val: any

      Returns void

    • Parameters

      • name: string
      • val: any

      Returns void

    • Parameters

      • startInput: DateInput
      • Optionaloptions: { granularity?: string; maintainDuration?: boolean }

      Returns void

    • Returns Dictionary

    • Parameters

      • Optionalsettings: { collapseExtendedProps?: boolean }

      Returns Dictionary

    Settings
    Member Visibility

    On This Page
    Properties
    Methods