CallioText API Reference - v0.0.22
    Preparing search index...

    Variable tree_op_mixinConst

    tree_op_mixin: {
        add_nodes<NT extends Node>(
            editor: EditorComponent,
            nodes: NT | NT[],
            path: number[],
        ): void;
        add_nodes_after<NT extends Node, TT extends Node & ConceptNode>(
            editor: EditorComponent,
            nodes: NT | NT[],
            target_node: TT,
        ): void;
        add_nodes_before<NT extends Node, TT extends Node & ConceptNode>(
            editor: EditorComponent,
            nodes: NT | NT[],
            target_node: TT,
        ): void;
        add_nodes_here<NT extends Node>(
            editor: EditorComponent,
            nodes: NT | NT[],
        ): void;
        auto_set_parameter<NT extends Node & ConceptNode>(
            editor: EditorComponent,
            node: NT,
            parameters: ParameterList,
        ): void;
        delete_concept_node<NT extends Node & ConceptNode>(
            editor: EditorComponent,
            node: NT,
        ): void;
        delete_node_by_path<NT extends Node>(
            editor: EditorComponent,
            path: number[],
        ): void;
        delete_nodes_by_paths<NT extends Node>(
            editor: EditorComponent,
            paths: number[][],
        ): void;
        move_concept_node<NT extends Node & ConceptNode>(
            editor: EditorComponent,
            node_from: NT,
            position_to: number[],
        ): void;
        move_node_by_path<NT extends Node>(
            editor: EditorComponent,
            position_from: number[],
            position_to: number[],
        ): void;
        replace_nodes<NT extends Node & ConceptNode, ST extends Node>(
            editor: EditorComponent,
            father_node: NT,
            nodes: ST[],
        ): void;
        set_node<NT extends Node & ConceptNode>(
            editor: EditorComponent,
            node: NT,
            new_val: Partial<NT>,
        ): void;
        set_node_by_path<NT extends Node & ConceptNode>(
            editor: EditorComponent,
            path: number[],
            new_val: Partial<NT>,
        ): void;
        unwrap_node<NT extends Node & ConceptNode>(
            editor: EditorComponent,
            node: NT,
        ): void;
        wrap_nodes<NT extends BaseElement>(
            editor: EditorComponent,
            node: NT,
            from: BasePoint,
            to: BasePoint,
            options: { match?: (n: Node) => boolean; split?: boolean },
        ): void;
        wrap_selected_nodes<NT extends BaseElement>(
            editor: EditorComponent,
            node: NT,
            options: { match?: (n: Node) => boolean; split?: boolean },
        ): void;
    } = ...

    这个混入对象提供所有跟节点树操作有关的函数。 基本上就是slate的Transforms的代理。

    Type Declaration

    • add_nodes: function
    • add_nodes_after: function
    • add_nodes_before: function
    • add_nodes_here: function
    • auto_set_parameter: function
    • delete_concept_node: function
    • delete_node_by_path: function
    • delete_nodes_by_paths: function

      • 这个函数按路径批量删除节点。 按显式路径删除，不依赖当前选区，因此在编辑器没有焦点时（比如在effect里）也能正常工作。 无效或已失效的路径会被静默忽略。

        Type Parameters

        • NT extends Node

        Parameters

        Returns void

    • move_concept_node: function
    • move_node_by_path: function
    • replace_nodes: function
    • set_node: function
    • set_node_by_path: function
    • unwrap_node: function
    • wrap_nodes: function

      • 把当前选择的区域打包成一个节点。

        Type Parameters

        • NT extends BaseElement

        Parameters

        • editor: EditorComponent
        • node: NT
        • from: BasePoint
        • to: BasePoint
        • options: { match?: (n: Node) => boolean; split?: boolean }
          • Optionalmatch?: (n: Node) => boolean

            判断子节点中哪些要打包的函数。

          • Optionalsplit?: boolean

            是否允许分裂父节点。

        Returns void

    • wrap_selected_nodes: function

      • 把当前选择的区域打包成一个节点。

        Type Parameters

        • NT extends BaseElement

        Parameters

        • editor: EditorComponent
        • node: NT
        • options: { match?: (n: Node) => boolean; split?: boolean }
          • Optionalmatch?: (n: Node) => boolean

            判断子节点中哪些要打包的函数。

          • Optionalsplit?: boolean

            是否允许分裂父节点。

        Returns void

    Settings
    Member Visibility