trilium
    Preparing search index...

    Interface FancytreeOptions

    The this context of any event function is set to tree's the HTMLDivElement

    interface FancytreeOptions {
        activeVisible?: boolean;
        ajax?: { cache: boolean; dataType: string; type: string };
        aria?: boolean;
        autoActivate?: boolean;
        autoCollapse?: boolean;
        autoScroll?: boolean;
        checkbox?:
            | string
            | boolean
            | ((event: JQueryEventObject, data: EventData) => boolean);
        clickFolderMode?: FancytreeClickFolderMode;
        debugLevel?: 0 | 1 | 2 | 3 | 4;
        defaultKey?: (node: FancytreeNode) => string;
        dnd5?: DragAndDrop5;
        enableAspx?: boolean;
        enableTitles?: boolean;
        extensions?: (keyof List)[];
        filter?: Filter;
        focusOnSelect?: boolean;
        generateIds?: boolean;
        icon?: string | boolean;
        idPrefix?: string;
        imagePath?: string;
        keyboard?: boolean;
        keyPathSeparator?: string;
        minExpandLevel?: number;
        quicksearch?: boolean;
        rtl?: boolean;
        scrollOfs?: { bottom: number; top: number };
        scrollParent?: null | JQuery<HTMLElement>;
        selectMode?: FancytreeSelectMode;
        source?: any;
        strings?: TranslationTable;
        tabbable?: boolean;
        table?: Table;
        titlesTabbable?: boolean;
        toggleEffect?: any;
        tooltip?: boolean;
        unselectable?:
            | boolean
            | ((event: JQueryEventObject, data: EventData) => undefined | boolean);
        unselectableIgnore?:
            | boolean
            | ((event: JQueryEventObject, data: EventData) => undefined | boolean);
        unselectableStatus?:
            | boolean
            | ((event: JQueryEventObject, data: EventData) => undefined | boolean);
        activate(event: JQueryEventObject, data: EventData): void;
        beforeActivate(event: JQueryEventObject, data: EventData): boolean;
        beforeExpand(event: JQueryEventObject, data: EventData): boolean;
        beforeSelect(event: JQueryEventObject, data: EventData): boolean;
        blur(event: JQueryEventObject, data: EventData): void;
        blurTree(event: JQueryEventObject, data: EventData): void;
        click(event: JQueryEventObject, data: EventData): boolean;
        collapse(event: JQueryEventObject, data: EventData): void;
        create(event: JQueryEventObject, data: EventData): void;
        createNode(event: JQueryEventObject, data: EventData): void;
        dblclick(event: JQueryEventObject, data: EventData): boolean;
        deactivate(event: JQueryEventObject, data: EventData): void;
        expand(event: JQueryEventObject, data: EventData): void;
        focus(event: JQueryEventObject, data: EventData): void;
        focusTree(event: JQueryEventObject, data: EventData): void;
        init(event: JQueryEventObject, data: EventData): void;
        keydown(event: JQueryEventObject, data: EventData): boolean;
        keypress(event: JQueryEventObject, data: EventData): void;
        lazyLoad(event: JQueryEventObject, data: EventData): void;
        loadChildren(event: JQueryEventObject, data: EventData): void;
        loadError(event: JQueryEventObject, data: EventData): boolean;
        postProcess(event: JQueryEventObject, data: EventData): void;
        removeNode(event: JQueryEventObject, data: EventData): void;
        renderColumns(event: JQueryEventObject, data: EventData): void;
        renderNode(event: JQueryEventObject, data: EventData): void;
        renderTitle(event: JQueryEventObject, data: EventData): void;
        restore(event: JQueryEventObject, data: EventData): void;
        select(event: JQueryEventObject, data: EventData): void;
        [extension: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [extension: string]: any

      Options for misc extensions - see docs for typings

    Index

    Properties

    activeVisible? ajax? aria? autoActivate? autoCollapse? autoScroll? checkbox? clickFolderMode? debugLevel? defaultKey? dnd5? enableAspx? enableTitles? extensions? filter? focusOnSelect? generateIds? icon? idPrefix? imagePath? keyboard? keyPathSeparator? minExpandLevel? quicksearch? rtl? scrollOfs? scrollParent? selectMode? source? strings? tabbable? table? titlesTabbable? toggleEffect? tooltip? unselectable? unselectableIgnore? unselectableStatus?

    Methods

    activate? beforeActivate? beforeExpand? beforeSelect? blur? blurTree? click? collapse? create? createNode? dblclick? deactivate? expand? focus? focusTree? init? keydown? keypress? lazyLoad? loadChildren? loadError? postProcess? removeNode? renderColumns? renderNode? renderTitle? restore? select?

    Properties

    activeVisible?: boolean

    Make sure that the active node is always visible, i.e. its parents are expanded (default: true).

    ajax?: { cache: boolean; dataType: string; type: string }

    Default options for ajax requests.

    Type declaration

    • cache: boolean

      false: Append random '_' argument to the request url to prevent caching.

    • dataType: string

      Default 'json' -> Expect json format and pass json object to callbacks.

    • type: string

      HTTP Method (default: 'GET')

    aria?: boolean

    (default: false) Add WAI-ARIA attributes to markup

    autoActivate?: boolean

    Activate a node when focused with the keyboard (default: true)

    autoCollapse?: boolean

    Automatically collapse all siblings, when a node is expanded (default: false).

    autoScroll?: boolean

    Scroll node into visible area, when focused by keyboard (default: false).

    checkbox?:
        | string
        | boolean
        | ((event: JQueryEventObject, data: EventData) => boolean)

    Display checkboxes to allow selection (default: false)

    clickFolderMode?: FancytreeClickFolderMode

    Defines what happens, when the user click a folder node. (default: activate_dblclick_expands)

    debugLevel?: 0 | 1 | 2 | 3 | 4

    0..4 (null: use global setting $.ui.fancytree.debugInfo)

    defaultKey?: (node: FancytreeNode) => string

    callback(node) is called for new nodes without a key. Must return a new unique key. (default null: generates default keys like that: "_" + counter)

    dnd5?: DragAndDrop5
    enableAspx?: boolean

    Accept passing ajax data in a property named d (default: true).

    enableTitles?: boolean

    Enable titles (default: false)

    extensions?: (keyof List)[]

    List of active extensions (default: [])

    filter?: Filter
    focusOnSelect?: boolean

    Set focus when node is checked by a mouse click (default: false)

    generateIds?: boolean

    Add id="..." to node markup (default: true).

    icon?: string | boolean

    Node icon url, if only filename, please use imagePath to set the path

    idPrefix?: string

    Prefix (default: "ft_")

    imagePath?: string

    Path to a folder containing icons (default: null, using 'skin/' subdirectory).

    keyboard?: boolean

    Support keyboard navigation (default: true).

    keyPathSeparator?: string

    (default: "/")

    minExpandLevel?: number

    2: top-level nodes are not collapsible (default: 1)

    quicksearch?: boolean

    navigate to next node by typing the first letters (default: false)

    rtl?: boolean

    Right to left mode (default: false)

    scrollOfs?: { bottom: number; top: number }

    optional margins for node.scrollIntoView() (default: {top: 0, bottom: 0})

    scrollParent?: null | JQuery<HTMLElement>

    scrollable container for node.scrollIntoView() (default: $container)

    selectMode?: FancytreeSelectMode

    default: multi_hier

    source?: any

    Used to Initialize the tree.

    strings?: TranslationTable

    Translation table

    tabbable?: boolean

    Add tabindex='0' to container, so tree can be reached using TAB

    table?: Table
    titlesTabbable?: boolean

    Add tabindex='0' to node title span, so it can receive keyboard focus

    toggleEffect?: any

    Animation options, false:off (default: { effect: "blind", options: {direction: "vertical", scale: "box"}, duration: 200 })

    tooltip?: boolean

    Tooltips

    unselectable?:
        | boolean
        | ((event: JQueryEventObject, data: EventData) => undefined | boolean)

    (dynamic Option)Prevent (de-)selection using mouse or keyboard.

    unselectableIgnore?:
        | boolean
        | ((event: JQueryEventObject, data: EventData) => undefined | boolean)

    (dynamic Option)Ignore this node when calculating the partsel status of parent nodes in selectMode 3 propagation.

    unselectableStatus?:
        | boolean
        | ((event: JQueryEventObject, data: EventData) => undefined | boolean)

    (dynamic Option)Use this as constant selected value (overriding selectMode 3 propagation).

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods