Trilium Frontend API
    Preparing search index...

    Interface ViewScope

    interface ViewScope {
        attachmentId?: string;
        bookmark?: string;
        highlightsListPreviousVisible?: boolean;
        highlightsListTemporarilyHidden?: boolean;
        isReadOnly?: boolean;
        readOnlyTemporarilyDisabled?: boolean;
        searchTerms?: string[];
        tocCollapsedHeadings?: Set<string>;
        tocPreviousVisible?: boolean;
        tocTemporarilyHidden?: boolean;
        viewMode?: ViewMode;
    }
    Index
    attachmentId? bookmark? 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.

    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