Trilium Frontend API
    Preparing search index...

    Interface NoteContextDataMap

    interface NoteContextDataMap {
        boardColumns: {
            columns: { count: number; icon: string; title: string; value: string }[];
            scrollToColumn(column: string): void;
        };
        chatHighlights: ChatHighlightsContext;
        contentLoad: { retry: () => void; state: "error" | "loading" | "loaded" };
        highlights: HighlightContext;
        pdfAnnotations: {
            annotations: PdfAnnotationInfo[];
            scrollToAnnotation(annotationId: string, pageNumber: number): void;
        };
        pdfAttachments: {
            attachments: PdfAttachment[];
            downloadAttachment(id: string): void;
        };
        pdfLayers: {
            layers: PdfLayer[];
            toggleLayer(layerId: string, visible: boolean): void;
        };
        pdfPages: {
            currentPage: number;
            totalPages: number;
            requestThumbnail(page: number): void;
            scrollToPage(page: number): void;
        };
        saveState: { state: SaveState };
        toc: HeadingContext;
    }
    Index
    boardColumns chatHighlights contentLoad highlights pdfAnnotations pdfAttachments pdfLayers pdfPages saveState toc
    boardColumns: {
        columns: { count: number; icon: string; title: string; value: string }[];
        scrollToColumn(column: string): void;
    }

    Published by a board, so the right pane can list its columns and scroll the board to one.

    Type Declaration

    • columns: { count: number; icon: string; title: string; value: string }[]

      The columns in the order the board draws them.

    • scrollToColumn: function
      • scrollToColumn(column: string): void

        Parameters

        • column: string

        Returns void

    chatHighlights: ChatHighlightsContext
    contentLoad: { retry: () => void; state: "error" | "loading" | "loaded" }

    Published by content widgets (via useNoteBlob) while the note's content is being fetched, so the note detail can show a loading state instead of the previous note's content.

    Type Declaration

    • retry: () => void

      Re-attempts the content fetch (e.g. from a "Retry" button after an error).

    • state: "error" | "loading" | "loaded"
    highlights: HighlightContext
    pdfAnnotations: {
        annotations: PdfAnnotationInfo[];
        scrollToAnnotation(annotationId: string, pageNumber: number): void;
    }
    pdfAttachments: {
        attachments: PdfAttachment[];
        downloadAttachment(id: string): void;
    }
    pdfLayers: {
        layers: PdfLayer[];
        toggleLayer(layerId: string, visible: boolean): void;
    }
    pdfPages: {
        currentPage: number;
        totalPages: number;
        requestThumbnail(page: number): void;
        scrollToPage(page: number): void;
    }
    saveState: { state: SaveState }
    toc: HeadingContext

    Settings
    Member Visibility

    On This Page
    Properties