trilium
    Preparing search index...

    Type Alias CommandMappings

    The keys represent the different commands that can be triggered via AppContext#triggerCommand (first argument), and the values represent the data or arguments definition of the given command. All data for commands must extend CommandData.

    type CommandMappings = {
        addNewLabel: CommandData;
        addNewLabelDefinition: CommandData;
        addNewRelation: CommandData;
        addNewRelationDefinition: CommandData;
        addNoteLauncher: ContextMenuCommandData;
        addScriptLauncher: ContextMenuCommandData;
        addSpacerLauncher: ContextMenuCommandData;
        addTextToActiveEditor: CommandData & { text: string };
        addWidgetLauncher: ContextMenuCommandData;
        "api-log-messages": CommandData;
        cloneNoteIdsTo: CommandData & { noteIds: string[] };
        cloneNotesTo: ContextMenuCommandData;
        closeActiveTab: CommandData & { $el: JQuery<HTMLElement> };
        closeAllTabs: CommandData;
        closeHlt: CommandData;
        closeOtherTabs: CommandData;
        closeProtectedSessionPasswordDialog: CommandData;
        closeRightTabs: CommandData;
        closeTab: CommandData;
        closeThisNoteSplit: CommandData;
        closeToc: CommandData;
        closeTocCommand: CommandData;
        collapseSubtree: ContextMenuCommandData;
        convertNoteToAttachment: ContextMenuCommandData;
        copyImageReferenceToClipboard: CommandData;
        copyImageToClipboard: CommandData;
        copyNotePathToClipboard: ContextMenuCommandData;
        copyNotesToClipboard: ContextMenuCommandData;
        copyTabToNewWindow: CommandData;
        cutNotesToClipboard: ContextMenuCommandData;
        delete: ContextMenuCommandData;
        deleteFromMap: { noteId: string };
        deleteNotes: ContextMenuCommandData;
        duplicateSubtree: ContextMenuCommandData;
        editBranchPrefix: ContextMenuCommandData;
        editNoteTitle: {};
        enterProtectedSession: CommandData;
        executeInActiveNoteDetailWidget: CommandData & {
            callback: (value: default | PromiseLike<default>) => void;
        };
        executeWithCodeEditor: CommandData & ExecuteCommandData<CodeMirrorInstance>;
        executeWithContentElement: CommandData & ExecuteCommandData<
            JQuery<HTMLElement>,
        >;
        executeWithTextEditor: CommandData & ExecuteCommandData<TextEditor> & {
            callback?: GetTextEditorCallback;
        };
        executeWithTypeWidget: CommandData & ExecuteCommandData<default | null>;
        expandSubtree: ContextMenuCommandData;
        exportNote: ContextMenuCommandData;
        focusAndSelectTitle: CommandData & { isNewNote?: boolean };
        focusOnDetail: CommandData;
        focusOnSearchDefinition: Required<CommandData>;
        focusOnTitle: CommandData;
        focusTree: CommandData;
        hideFloatingButtons: {};
        hideLeftPane: CommandData;
        hoistNote: CommandData & { noteId: string };
        importIntoNote: ContextMenuCommandData;
        importMarkdownInline: CommandData;
        insertChildNote: ContextMenuCommandData;
        insertNoteAfter: ContextMenuCommandData;
        leaveProtectedSession: CommandData;
        moveBranchIdsTo: CommandData & { branchIds: string[] };
        moveLauncherToAvailable: ContextMenuCommandData;
        moveLauncherToVisible: ContextMenuCommandData;
        moveNoteDown: ContextMenuCommandData;
        moveNoteDownInHierarchy: ContextMenuCommandData;
        moveNotesTo: ContextMenuCommandData;
        moveNoteUp: ContextMenuCommandData;
        moveNoteUpInHierarchy: ContextMenuCommandData;
        moveTabToNewWindow: CommandData;
        moveThisNoteSplit: CommandData & { isMovingLeft: boolean };
        noteContextReorder: CommandData & {
            newMainNtxId?: string | null;
            ntxIdsInOrder: string[];
            oldMainNtxId?: string | null;
        };
        openAboutDialog: CommandData;
        openBulkActionsDialog: | ContextMenuCommandData
        | { selectedOrActiveNoteIds?: string[] };
        openedFileUpdated: CommandData & {
            entityId: string;
            entityType: string;
            filePath: string;
            lastModifiedMs: number;
        };
        openGeoLocation: { event: MouseDownEvent; noteId: string };
        openInTab: ContextMenuCommandData;
        openInWindow: NoteCommandData;
        openNewNoteSplit: NoteCommandData;
        openNoteInNewSplit: CommandData;
        openNoteInNewTab: CommandData;
        openNoteInNewWindow: CommandData;
        openNoteInSplit: ContextMenuCommandData;
        pasteNotesAfterFromClipboard: ContextMenuCommandData;
        pasteNotesFromClipboard: ContextMenuCommandData;
        protectSubtree: ContextMenuCommandData;
        recentChangesInSubtree: ContextMenuCommandData;
        reEvaluateRightPaneVisibility: CommandData;
        refreshNoteList: CommandData & { noteId: string };
        refreshResults: {};
        refreshSearchDefinition: {};
        reloadAttributes: CommandData;
        reopenLastTab: CommandData;
        replaceMisspelling: CommandData;
        resetLauncher: ContextMenuCommandData;
        runActiveNote: CommandData;
        saveAttributes: CommandData;
        scrollContainerToCommand: CommandData & { position: number };
        scrollToEnd: CommandData;
        searchInSubtree: ContextMenuCommandData;
        searchNotes: CommandData & {
            ancestorNoteId?: string | null;
            searchString?: string;
        };
        selectAllNotesInParent: ContextMenuCommandData;
        setActiveScreen: CommandData & { screen: Screen };
        setZoomFactorAndSave: { zoomFactor: string };
        showAddLinkDialog: CommandData & { text: string; textTypeWidget: default };
        showConfirmDeleteNoteBoxWithNoteDialog: ConfirmWithTitleOptions;
        showConfirmDialog: ConfirmWithMessageOptions;
        showDeleteNotesDialog: CommandData & {
            branchIdsToDelete: string[];
            callback: (value: ResolveOptions) => void;
            forceDeleteAllClones: boolean;
        };
        showExportDialog: CommandData & {
            defaultType: "single"
            | "subtree";
            notePath: string;
        };
        showImportDialog: CommandData & { noteId: string };
        showIncludeNoteDialog: CommandData & { textTypeWidget: default };
        showInfoDialog: ConfirmWithMessageOptions;
        showLaunchBarSubtree: CommandData;
        showLeftPane: CommandData;
        showOptions: CommandData & { section: string };
        showPasswordNotSet: CommandData;
        showPromptDialog: PromptDialogOptions;
        showProtectedSessionPasswordDialog: CommandData;
        showRecentChanges: CommandData & { ancestorNoteId: string };
        showRevisions: CommandData;
        showUploadAttachmentsDialog: CommandData & { noteId: string };
        sortChildNotes: ContextMenuCommandData;
        toggleNoteHoisting: ContextMenuCommandData;
        toggleZenMode: CommandData;
        unprotectSubtree: ContextMenuCommandData;
        updateAttributeList: CommandData & { attributes: Attribute[] };
        updateAttributesList: { attributes: Attribute[] };
    }
    Index

    Properties

    addNewLabel addNewLabelDefinition addNewRelation addNewRelationDefinition addNoteLauncher addScriptLauncher addSpacerLauncher addTextToActiveEditor addWidgetLauncher api-log-messages cloneNoteIdsTo cloneNotesTo closeActiveTab closeAllTabs closeHlt closeOtherTabs closeProtectedSessionPasswordDialog closeRightTabs closeTab closeThisNoteSplit closeToc closeTocCommand collapseSubtree convertNoteToAttachment copyImageReferenceToClipboard copyImageToClipboard copyNotePathToClipboard copyNotesToClipboard copyTabToNewWindow cutNotesToClipboard delete deleteFromMap deleteNotes duplicateSubtree editBranchPrefix editNoteTitle enterProtectedSession executeInActiveNoteDetailWidget executeWithCodeEditor executeWithContentElement executeWithTextEditor executeWithTypeWidget expandSubtree exportNote focusAndSelectTitle focusOnDetail focusOnSearchDefinition focusOnTitle focusTree hideFloatingButtons hideLeftPane hoistNote importIntoNote importMarkdownInline insertChildNote insertNoteAfter leaveProtectedSession moveBranchIdsTo moveLauncherToAvailable moveLauncherToVisible moveNoteDown moveNoteDownInHierarchy moveNotesTo moveNoteUp moveNoteUpInHierarchy moveTabToNewWindow moveThisNoteSplit noteContextReorder openAboutDialog openBulkActionsDialog openedFileUpdated openGeoLocation openInTab openInWindow openNewNoteSplit openNoteInNewSplit openNoteInNewTab openNoteInNewWindow openNoteInSplit pasteNotesAfterFromClipboard pasteNotesFromClipboard protectSubtree recentChangesInSubtree reEvaluateRightPaneVisibility refreshNoteList refreshResults refreshSearchDefinition reloadAttributes reopenLastTab replaceMisspelling resetLauncher runActiveNote saveAttributes scrollContainerToCommand scrollToEnd searchInSubtree searchNotes selectAllNotesInParent setActiveScreen setZoomFactorAndSave showAddLinkDialog showConfirmDeleteNoteBoxWithNoteDialog showConfirmDialog showDeleteNotesDialog showExportDialog showImportDialog showIncludeNoteDialog showInfoDialog showLaunchBarSubtree showLeftPane showOptions showPasswordNotSet showPromptDialog showProtectedSessionPasswordDialog showRecentChanges showRevisions showUploadAttachmentsDialog sortChildNotes toggleNoteHoisting toggleZenMode unprotectSubtree updateAttributeList updateAttributesList

    Properties

    addNewLabel: CommandData
    addNewLabelDefinition: CommandData
    addNewRelation: CommandData
    addNewRelationDefinition: CommandData
    addNoteLauncher: ContextMenuCommandData
    addScriptLauncher: ContextMenuCommandData
    addSpacerLauncher: ContextMenuCommandData
    addTextToActiveEditor: CommandData & { text: string }
    addWidgetLauncher: ContextMenuCommandData
    "api-log-messages": CommandData
    cloneNoteIdsTo: CommandData & { noteIds: string[] }
    cloneNotesTo: ContextMenuCommandData
    closeActiveTab: CommandData & { $el: JQuery<HTMLElement> }
    closeAllTabs: CommandData
    closeHlt: CommandData
    closeOtherTabs: CommandData
    closeProtectedSessionPasswordDialog: CommandData
    closeRightTabs: CommandData
    closeTab: CommandData
    closeThisNoteSplit: CommandData
    closeToc: CommandData
    closeTocCommand: CommandData
    collapseSubtree: ContextMenuCommandData
    convertNoteToAttachment: ContextMenuCommandData
    copyImageReferenceToClipboard: CommandData
    copyImageToClipboard: CommandData
    copyNotePathToClipboard: ContextMenuCommandData
    copyNotesToClipboard: ContextMenuCommandData
    copyTabToNewWindow: CommandData
    cutNotesToClipboard: ContextMenuCommandData
    delete: ContextMenuCommandData
    deleteFromMap: { noteId: string }
    deleteNotes: ContextMenuCommandData
    duplicateSubtree: ContextMenuCommandData
    editBranchPrefix: ContextMenuCommandData
    editNoteTitle: {}
    enterProtectedSession: CommandData
    executeInActiveNoteDetailWidget: CommandData & {
        callback: (value: default | PromiseLike<default>) => void;
    }
    executeWithCodeEditor: CommandData & ExecuteCommandData<CodeMirrorInstance>
    executeWithContentElement: CommandData & ExecuteCommandData<JQuery<HTMLElement>>

    Called upon when attempting to retrieve the content element of a NoteContext. Generally should not be invoked manually, as it is used by NoteContext.getContentElement.

    executeWithTextEditor: CommandData & ExecuteCommandData<TextEditor> & {
        callback?: GetTextEditorCallback;
    }
    executeWithTypeWidget: CommandData & ExecuteCommandData<default | null>
    expandSubtree: ContextMenuCommandData
    exportNote: ContextMenuCommandData
    focusAndSelectTitle: CommandData & { isNewNote?: boolean }
    focusOnDetail: CommandData
    focusOnSearchDefinition: Required<CommandData>
    focusOnTitle: CommandData
    focusTree: CommandData
    hideFloatingButtons: {}
    hideLeftPane: CommandData
    hoistNote: CommandData & { noteId: string }
    importIntoNote: ContextMenuCommandData
    importMarkdownInline: CommandData
    insertChildNote: ContextMenuCommandData
    insertNoteAfter: ContextMenuCommandData
    leaveProtectedSession: CommandData
    moveBranchIdsTo: CommandData & { branchIds: string[] }
    moveLauncherToAvailable: ContextMenuCommandData
    moveLauncherToVisible: ContextMenuCommandData
    moveNoteDown: ContextMenuCommandData
    moveNoteDownInHierarchy: ContextMenuCommandData
    moveNotesTo: ContextMenuCommandData
    moveNoteUp: ContextMenuCommandData
    moveNoteUpInHierarchy: ContextMenuCommandData
    moveTabToNewWindow: CommandData
    moveThisNoteSplit: CommandData & { isMovingLeft: boolean }
    noteContextReorder: CommandData & {
        newMainNtxId?: string | null;
        ntxIdsInOrder: string[];
        oldMainNtxId?: string | null;
    }
    openAboutDialog: CommandData
    openBulkActionsDialog:
        | ContextMenuCommandData
        | { selectedOrActiveNoteIds?: string[] }
    openedFileUpdated: CommandData & {
        entityId: string;
        entityType: string;
        filePath: string;
        lastModifiedMs: number;
    }
    openGeoLocation: { event: MouseDownEvent; noteId: string }
    openInTab: ContextMenuCommandData
    openInWindow: NoteCommandData
    openNewNoteSplit: NoteCommandData
    openNoteInNewSplit: CommandData
    openNoteInNewTab: CommandData
    openNoteInNewWindow: CommandData
    openNoteInSplit: ContextMenuCommandData
    pasteNotesAfterFromClipboard: ContextMenuCommandData
    pasteNotesFromClipboard: ContextMenuCommandData
    protectSubtree: ContextMenuCommandData
    recentChangesInSubtree: ContextMenuCommandData
    reEvaluateRightPaneVisibility: CommandData
    refreshNoteList: CommandData & { noteId: string }
    refreshResults: {}
    refreshSearchDefinition: {}
    reloadAttributes: CommandData
    reopenLastTab: CommandData
    replaceMisspelling: CommandData

    Works only in the electron context menu.

    resetLauncher: ContextMenuCommandData
    runActiveNote: CommandData
    saveAttributes: CommandData
    scrollContainerToCommand: CommandData & { position: number }
    scrollToEnd: CommandData
    searchInSubtree: ContextMenuCommandData
    searchNotes: CommandData & {
        ancestorNoteId?: string | null;
        searchString?: string;
    }
    selectAllNotesInParent: ContextMenuCommandData
    setActiveScreen: CommandData & { screen: Screen }

    Sets the active Screen (e.g. to toggle the tree sidebar). It triggers the EventMappings.activeScreenChanged event, but only if the provided screen is different than the current one.

    setZoomFactorAndSave: { zoomFactor: string }
    showAddLinkDialog: CommandData & { text: string; textTypeWidget: default }
    showConfirmDeleteNoteBoxWithNoteDialog: ConfirmWithTitleOptions
    showConfirmDialog: ConfirmWithMessageOptions
    showDeleteNotesDialog: CommandData & {
        branchIdsToDelete: string[];
        callback: (value: ResolveOptions) => void;
        forceDeleteAllClones: boolean;
    }
    showExportDialog: CommandData & {
        defaultType: "single" | "subtree";
        notePath: string;
    }
    showImportDialog: CommandData & { noteId: string }
    showIncludeNoteDialog: CommandData & { textTypeWidget: default }
    showInfoDialog: ConfirmWithMessageOptions
    showLaunchBarSubtree: CommandData
    showLeftPane: CommandData
    showOptions: CommandData & { section: string }
    showPasswordNotSet: CommandData
    showPromptDialog: PromptDialogOptions
    showProtectedSessionPasswordDialog: CommandData
    showRecentChanges: CommandData & { ancestorNoteId: string }
    showRevisions: CommandData
    showUploadAttachmentsDialog: CommandData & { noteId: string }
    sortChildNotes: ContextMenuCommandData
    toggleNoteHoisting: ContextMenuCommandData
    toggleZenMode: CommandData
    unprotectSubtree: ContextMenuCommandData
    updateAttributeList: CommandData & { attributes: Attribute[] }
    updateAttributesList: { attributes: Attribute[] }

    Settings

    Member Visibility

    On This Page

    Properties
    addNewLabeladdNewLabelDefinitionaddNewRelationaddNewRelationDefinitionaddNoteLauncheraddScriptLauncheraddSpacerLauncheraddTextToActiveEditoraddWidgetLauncherapi-log-messagescloneNoteIdsTocloneNotesTocloseActiveTabcloseAllTabscloseHltcloseOtherTabscloseProtectedSessionPasswordDialogcloseRightTabscloseTabcloseThisNoteSplitcloseToccloseTocCommandcollapseSubtreeconvertNoteToAttachmentcopyImageReferenceToClipboardcopyImageToClipboardcopyNotePathToClipboardcopyNotesToClipboardcopyTabToNewWindowcutNotesToClipboarddeletedeleteFromMapdeleteNotesduplicateSubtreeeditBranchPrefixeditNoteTitleenterProtectedSessionexecuteInActiveNoteDetailWidgetexecuteWithCodeEditorexecuteWithContentElementexecuteWithTextEditorexecuteWithTypeWidgetexpandSubtreeexportNotefocusAndSelectTitlefocusOnDetailfocusOnSearchDefinitionfocusOnTitlefocusTreehideFloatingButtonshideLeftPanehoistNoteimportIntoNoteimportMarkdownInlineinsertChildNoteinsertNoteAfterleaveProtectedSessionmoveBranchIdsTomoveLauncherToAvailablemoveLauncherToVisiblemoveNoteDownmoveNoteDownInHierarchymoveNotesTomoveNoteUpmoveNoteUpInHierarchymoveTabToNewWindowmoveThisNoteSplitnoteContextReorderopenAboutDialogopenBulkActionsDialogopenedFileUpdatedopenGeoLocationopenInTabopenInWindowopenNewNoteSplitopenNoteInNewSplitopenNoteInNewTabopenNoteInNewWindowopenNoteInSplitpasteNotesAfterFromClipboardpasteNotesFromClipboardprotectSubtreerecentChangesInSubtreereEvaluateRightPaneVisibilityrefreshNoteListrefreshResultsrefreshSearchDefinitionreloadAttributesreopenLastTabreplaceMisspellingresetLauncherrunActiveNotesaveAttributesscrollContainerToCommandscrollToEndsearchInSubtreesearchNotesselectAllNotesInParentsetActiveScreensetZoomFactorAndSaveshowAddLinkDialogshowConfirmDeleteNoteBoxWithNoteDialogshowConfirmDialogshowDeleteNotesDialogshowExportDialogshowImportDialogshowIncludeNoteDialogshowInfoDialogshowLaunchBarSubtreeshowLeftPaneshowOptionsshowPasswordNotSetshowPromptDialogshowProtectedSessionPasswordDialogshowRecentChangesshowRevisionsshowUploadAttachmentsDialogsortChildNotestoggleNoteHoistingtoggleZenModeunprotectSubtreeupdateAttributeListupdateAttributesList