Trilium Frontend API
    Preparing search index...

    Interface ViewScope

    interface ViewScope {
        attachmentId?: string;
        bookmark?: string;
        card?: string;
        column?: string;
        columnColor?: string;
        columnIcon?: string;
        columnTitle?: string;
        floatingToolbar?: boolean;
        highlightsListPreviousVisible?: boolean;
        highlightsListTemporarilyHidden?: boolean;
        isReadOnly?: boolean;
        readOnlyTemporarilyDisabled?: boolean;
        searchTerms?: string[];
        tocCollapsedHeadings?: Set<string>;
        tocPreviousVisible?: boolean;
        tocTemporarilyHidden?: boolean;
        viewMode?: ViewMode;
    }
    Index
    attachmentId? bookmark? card? column? columnColor? columnIcon? columnTitle? floatingToolbar? highlightsListPreviousVisible? highlightsListTemporarilyHidden? isReadOnly? readOnlyTemporarilyDisabled? searchTerms? tocCollapsedHeadings? tocPreviousVisible? tocTemporarilyHidden? viewMode?
    attachmentId?: string
    bookmark?: string

    When set, scrolls to a bookmark anchor within the note after navigation.

    card?: string

    The note id of the board card a reference points at, revealed the same way column is.

    column?: string

    The id of the board column a reference points at, which the board reveals once it has drawn it. Consumed once, as bookmark is.

    columnColor?: string
    columnIcon?: string
    columnTitle?: string

    The title, icon and colour a column reference renders as, copied from the board when the reference was made. Carried in the link because reading them needs the board's own configuration; column is what the board resolves, so a rename only dates the label.

    floatingToolbar?: boolean

    If true, a text note is edited with the floating toolbar whatever the user's editor-type option says — the toolbar following the selection rather than standing in a bar of its own.

    For views too narrow to carry a full toolbar, such as the geo map's marker pane: a classic bar built for the width of a note either spills out of them or eats the room the note is left.

    highlightsListPreviousVisible?: boolean
    highlightsListTemporarilyHidden?: boolean
    isReadOnly?: boolean

    If true, it indicates that the note in the view should be opened in read-only mode (for supported note types such as text or code).

    The reason why we store this information here is that a note can become read-only as the user types content in it, and we wouldn't want to immediately enter read-only mode.

    readOnlyTemporarilyDisabled?: boolean
    searchTerms?: string[]

    Search terms to highlight and jump to after navigating from search results; consumed once by the destination type widget (mirrors bookmark semantics).

    tocCollapsedHeadings?: Set<string>
    tocPreviousVisible?: boolean
    tocTemporarilyHidden?: boolean
    viewMode?: ViewMode
    • "source", when viewing the source code of a note.
    • "attachments", when viewing the attachments of a note.
    • "contextual-help", if the current view represents a help window that was opened to the side of the main content.
    • "default", otherwise.

    Settings
    Member Visibility

    On This Page
    Properties