trilium
    Preparing search index...

    Interface Fancytree

    interface Fancytree {
        $container: JQuery;
        $div: JQuery;
        focusNode: FancytreeNode;
        options: FancytreeOptions;
        rootNode: FancytreeNode;
        widget: any;
        activateKey(key: string | boolean): FancytreeNode;
        applyPatch(patchList: NodePatch[]): JQueryPromise<any>;
        changeRefKey(oldRefKey: string, newRefKey: string): void;
        clearCookies(): void;
        clearFilter(): void;
        count(): number;
        debug(msg: any): void;
        enableUpdate(enabled: boolean): void;
        expandAll(flag?: boolean, options?: Object): void;
        filterBranches(filter: string): number;
        filterBranches(filter: (node: FancytreeNode) => boolean): number;
        filterNodes(filter: string, leavesOnly?: boolean): number;
        filterNodes(
            filter: (node: FancytreeNode) => boolean,
            leavesOnly?: boolean,
        ): number;
        findAll(
            match: string | ((node: FancytreeNode) => undefined | boolean),
        ): FancytreeNode[];
        findNextNode(match: string, startNode?: FancytreeNode): FancytreeNode;
        findNextNode(
            match: (node: FancytreeNode) => boolean,
            startNode?: FancytreeNode,
        ): FancytreeNode;
        generateFormElements(selected?: boolean, active?: boolean): void;
        getActiveNode(): FancytreeNode;
        getFirstChild(): FancytreeNode;
        getFocusNode(ifTreeHasFocus?: boolean): FancytreeNode;
        getNodeByKey(key: string, searchRoot?: FancytreeNode): FancytreeNode;
        getNodesByRef(refKey: string, rootNode?: FancytreeNode): FancytreeNode[];
        getPersistData(): PersistData;
        getRootNode(): FancytreeNode;
        getSelectedNodes(stopOnParents?: boolean): FancytreeNode[];
        hasFocus(): boolean;
        info(msg: any): void;
        isEditing(): FancytreeNode;
        loadKeyPath(
            keyPathList: string[],
            callback: (node: FancytreeNode, status: string) => void,
        ): JQueryPromise<any>;
        loadKeyPath(
            keyPath: string,
            callback: (node: FancytreeNode, status: string) => void,
        ): JQueryPromise<any>;
        reactivate(): void;
        reload(source?: any): JQueryPromise<any>;
        render(force?: boolean, deep?: boolean): void;
        setFocus(flag?: boolean): void;
        toDict(
            includeRoot?: boolean,
            callback?: (node: FancytreeNode) => void,
        ): any;
        visit(fn: (node: FancytreeNode) => any): boolean;
        warn(msg: any): void;
    }
    Index

    Properties

    $container $div focusNode options rootNode widget

    Methods

    activateKey applyPatch changeRefKey clearCookies clearFilter count debug enableUpdate expandAll filterBranches filterNodes findAll findNextNode generateFormElements getActiveNode getFirstChild getFocusNode getNodeByKey getNodesByRef getPersistData getRootNode getSelectedNodes hasFocus info isEditing loadKeyPath reactivate reload render setFocus toDict visit warn

    Properties

    $container: JQuery
    $div: JQuery
    focusNode: FancytreeNode
    options: FancytreeOptions
    rootNode: FancytreeNode
    widget: any

    Methods

    • Activate node with a given key and fire focus and activate events. A previously activated node will be deactivated. If activeVisible option is set, all parents will be expanded as necessary. Pass key = false, to deactivate the current node only.

      Parameters

      • key: string | boolean

      Returns FancytreeNode

      activate node (null, if not found)

    • [ext-clones] Replace a refKey with a new one.

      Parameters

      • oldRefKey: string
      • newRefKey: string

      Returns void

    • [ext-persist] Remove persistence cookies of the given type(s). Called like $("#tree").fancytree("getTree").clearCookies("active expanded focus selected");

      Returns void

    • Temporarily suppress rendering to improve performance on bulk-updates.

      Parameters

      • enabled: boolean

      Returns void

      previous status

      2.19

    • Generate INPUT elements that can be submitted with html forms. In selectMode 3 only the topmost selected nodes are considered.

      Parameters

      • Optionalselected: boolean
      • Optionalactive: boolean

      Returns void

    • Make sure that a node with a given ID is loaded, by traversing - and loading - its parents. This method is ment for lazy hierarchies. A callback is executed for every node as we go.

      Parameters

      • keyPathList: string[]

        one or more key paths (e.g. '/3/2_1/7')

      • callback: (node: FancytreeNode, status: string) => void

        callback(node, status) is called for every visited node ('loading', 'loaded', 'ok', 'error')

      Returns JQueryPromise<any>

    • Make sure that a node with a given ID is loaded, by traversing - and loading - its parents. This method is ment for lazy hierarchies. A callback is executed for every node as we go.

      Parameters

      • keyPath: string

        a key path (e.g. '/3/2_1/7')

      • callback: (node: FancytreeNode, status: string) => void

        callback(node, status) is called for every visited node ('loading', 'loaded', 'ok', 'error')

      Returns JQueryPromise<any>

    • Render tree (i.e. create DOM elements for all top-level nodes).

      Parameters

      • Optionalforce: boolean

        create DOM elements, even is parent is collapsed (default = false)

      • Optionaldeep: boolean

        (default = false)

      Returns void

    • Return all nodes as nested list of NodeData.

      Parameters

      • OptionalincludeRoot: boolean

        Returns the hidden system root node (and its children) (default = false)

      • Optionalcallback: (node: FancytreeNode) => void

        Called for every node

      Returns any

    • Call fn(node) for all nodes.

      Parameters

      • fn: (node: FancytreeNode) => any

        the callback function. Return false to stop iteration, return "skip" to skip this node and children only.

      Returns boolean

      false, if the iterator was stopped.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods