サイトのトップへ戻る

jsTreeドキュメント日本語訳

API

$.jstree

関数や変数に関連するjstreeの全てを保持しています。実際のクラスやインスタンスに対して作成、接続、操作といった処理を行うメソッドが含まれています。



$.jstree.version

使用するjstree のバージョンを指定します



$.jstree.defaults

インスタンスが新規作成される時に使用される全ての既定オプションを保持しています。



$.jstree.defaults.plugins

インスタンスでプラグインを有効にするかの設定。有効にする各プラグインの名前を文字列型の配列として設定してください。既定では[]となります。



$.jstree.plugins

読み込んだ全てのjstreeプラグインを保持しています。 (内部的に使用します)



$.jstree.create (el [, options])

jstree インスタンスを作成します

  • el

    DOMElement jQuery Stringインスタンスの作成場所になるエレメント。拡張jQueryもしくはセレクターを設定できます。

  • options

    Object このインスタンスのオプション ( `$.jstree.defaults`を拡張する)

  • Returns

    jsTree 新規に作成されたインスタンス



$.jstree.destroy ()

DOM からjstreeの形跡を全て削除し、全てのインスタンスを破棄します。



$.jstree.core (id)private

jstree クラスのコンストラクタ。内部でのみ使用されます。

  • id

    Number このインスタンスのインデックス番号



$.jstree.reference (needle)

作成済みインスタンスへの参照を取得する

  • needle

    DOMElement jQuery String

  • Returns

    jsTree null インスタンスか、見つからなかった場合は`null`

// provided a container with an ID of "tree", and a nested node with an ID of "branch"
// all of there will return the same instance
$.jstree.reference('tree');
$.jstree.reference('#tree');
$.jstree.reference($('#tree'));
$.jstree.reference(document.getElementByID('tree'));
$.jstree.reference('branch');
$.jstree.reference('#branch');
$.jstree.reference($('#branch'));
$.jstree.reference(document.getElementByID('branch'));


$().jstree([arg])

インスタンスを作成するか、インスタンスを取得するか、インスタンスのコマンドを実行します。

カレントノードに関連するインスタンスがない場合は新規にインスタンスが作成され、 argは新しいインスタンス用の$.jstree.defaultsの拡張に使われます。 戻り値はありません (チェーンは破壊されません)。

作成済みインスタンスが存在してargが文字列だった場合は、argで指定されたコマンドがインスタンスで実行され、追加で指定した引数が関数に渡されます。 戻り値を返す関数だった場合は、戻り値が返ります(チェーンが破壊されるかは関数に依存します)。

作成済みのインスタンスが存在してargが文字列でなかった場合は、インスタンス自体が戻り値として返ります ($.jstree.referenceと同じ動きをします)。

上記以外の場合 - 戻り値は取得されず、チェーンは破壊されません。

  • arg

    String Object

  • Returns

    Mixed

$('#tree1').jstree(); // インスタンスを作成
$('#tree2').jstree({ plugins : [] }); // オプションをつけてインスタンスを作成
$('#tree1').jstree('open_node', '#branch_1'); // 作成済みインスタンスのメソッドを実行し、追加で引数を設定
$('#tree2').jstree(); // 作成済みインスタンスを取得(もしくはインスタンスを作成)
$('#tree2').jstree(true); // 作成済みインスタンスを取得 (インスタンスの新規作成はしない)
$('#branch_1').jstree().select_node('#branch_1'); // インスタンスを取得 (子要素を使ってメソッドを実行)


$(':jstree')

インスタンスを含むエレメントを探すために使われます。

  • Returns

    jQuery

$('div:jstree').each(function () {
    $(this).jstree('destroy');
});


$.jstree.defaults.core

coreの全ての既定値を保持しています。



$.jstree.defaults.core.data

data の設定

falseを設定すると、jstreeコンテナエレメント内のHTMLはツリーを埋め込むのに使われます(that should be an unordered list with list items)。

HTML形式の文字列やJSON形式の配列も設定することができます。

It is possible to pass in a standard jQuery-like AJAX config and jstree will automatically determine if the response is JSON or HTML and use that to populate the tree.
標準のjQuery ajax オプションに加え、 dataurlを使用するための関数を設定できます。この機能はカレントインスタンスのスコープ内で実行され、読み込まれたノードを示すパラメータが設定されます。 これらの関数によって取得できる戻り値はそれぞれURLやデータとして使用できます。

The last option is to specify a function, that function will receive the node being loaded as argument and a second param which is a function which should be called with the result.

// AJAX
$('#tree').jstree({
    'core' : {
        'data' : {
            'url' : '/get/children/',
            'data' : function (node) {
                return { 'id' : node.id };
            }
        }
    });

// direct data
$('#tree').jstree({
    'core' : {
        'data' : [
            'Simple root node',
            {
                'id' : 'node_2',
                'text' : 'Root node with options',
                'state' : { 'opened' : true, 'selected' : true },
                'children' : [ { 'text' : 'Child 1' }, 'Child 2']
            }
        ]
    });

// function
$('#tree').jstree({
    'core' : {
        'data' : function (obj, callback) {
            callback.call(this, ['Root 1', 'Root 2']);
        }
    });


$.jstree.defaults.core.check_callback

ユーザーがツリー構造を変更しようとした際に発生する処理を設定します。falseにした場合、作成・名前の変更・削除・移動・コピーのような全ての操作が禁止されます。
これにtrueを設定することで、全ての操作や関数が使用できるようになり、より詳細な制御ができるようになります。

$('#tree').jstree({
    'core' : {
        'check_callback' : function (operation, node, node_parent, node_position, more) {
            // operation can be 'create_node', 'rename_node', 'delete_node', 'move_node' or 'copy_node'
            // in case of 'rename_node' node_position is filled with the new node name
            return operation === 'rename_node' ? true : false;
        }
    }
});


$.jstree.defaults.core.error

何らかの処理が失敗した時に(操作の中断やajaxの失敗など)、一つのオブジェクトパラメータを渡されてインスタンススコープ内で呼び出されるコールバック



$.jstree.defaults.core.animation

開く/閉じるといったアニメーションの動作時間をミリ秒単位で表したもの - これにfalseを設定するとアニメーションを無効にします。 (既定では200が設定されています)



$.jstree.defaults.core.multiple

複数のノードを選択可能かを示すboolean型の値



$.jstree.defaults.core.themes

テーマ設定用オブジェクト



$.jstree.defaults.core.themes.name

使用するテーマの名前(falseが設定されている場合は既定のテーマが使用されます)



$.jstree.defaults.core.themes.url

テーマに使うCSSファイルのURL。手動でCSSテーマを読み込むのであればfalseを設定してください(推奨)。 trueを設定して自動でテーマを読み込むこともできます。



$.jstree.defaults.core.themes.dir

全てのjstreeテーマがある場所。 - urltrueが設定されている場合にのみ使用されます。



$.jstree.defaults.core.themes.dots

接続ドットが表示されるかどうかを示す boolean 型の値



$.jstree.defaults.core.themes.icons

ノードアイコンが表示されるかどうかを示す boolean 型の値



$.jstree.defaults.core.themes.stripes

ツリーの背景がストライプ化されるかどうかを示す boolean 型の値



$.jstree.defaults.core.themes.variant

(テーマバリアントをサポートしているのであれば)使用するテーマバリアントを指定する文字列(もしくはboolean型のfalse)



$.jstree.defaults.core.themes.responsive

a boolean specifying if a reponsive version of the theme should kick in on smaller screens (if the theme supports it).既定では false



$.jstree.defaults.core.expand_selected_onload

trueを設定した場合、ツリーを読み込むと選択されている全ノードの全ての親ノードも展開されます。 (そのため 全ての選択ノードはユーザーに見える状態になります。)



$.jstree.defaults.core.worker

trueを設定した場合、可能であればJSONデータの解析にウェブウォーカーが使用されます。そのため大量にリクエストによってUIが邪魔されることはありません。 しかし、ウォーカーを使うと30%ほど遅くなります。既定値は trueです。



$.jstree.defaults.core.force_text

ノードテキストを強制的にプレーンなテキストに変換します。(and escape HTML). 既定値はfalseです。



$.jstree.defaults.core.dblclick_toggle

テキストがダブルクリックされた場合、ノードを切り替り変える。既定値はtrueです。



plugin (deco [, opts])private

インスタンスをプラグインで拡張するために使います。内部的に使用されます。

  • deco

    String 拡張に使うプラグイン

  • opts

    Object プラグインのオプション

  • Returns

    jsTree



init (el, optons)private

インスタンスを初期化します。内部的に使用されます。

  • el

    DOMElement jQuery String the element we are transforming

  • options

    Object このインスタンスのオプション

  • Triggers

    init.jstree loading.jstree loaded.jstree ready.jstree changed.jstree



init.jstree Event

全てのイベントが紐付けされた後には発生するイベント



loading.jstree Event

読み込んだテキストが表示された後と、読み込みが開始される前に発生するイベント



destroy ()

インスタンスを破棄する

  • keep_html

    Boolean`true`が設定された場合はコンテナは空になり、`false`の場合は現在のDOMエレメントは全て保持されます。



teardown ()private

インスタンス破棄処理において一部の役割を果たす。内部的に使用されます。



bind ()private

全てのイベントに紐付けを行います。内部的に使用されます。



bind ()private

全てのイベントに紐付けを行います。内部的に使用されます。



// 削除
case 46:
e.preventDefault();
o = this.get_node(e.currentTarget);
if(o && o.id && o.id !== '#') {
o = this.is_selected(o) ? this.get_selected() : o;
this.delete_node(o);
}
break;
// f2
case 113:
e.preventDefault();
o = this.get_node(e.currentTarget);
if(o && o.id && o.id !== '#') {
// this.edit(o);
}
break;
default:
// console.log(e.which);
break;



loaded.jstree Event

初めて最上部のルートノードが読み込まれた後に発生するイベント



ready.jstree Event

全てノード読み込みが完了した後に発生するイベント



unbind ()private

インスタンス破棄処理において一部の役割を果たす。内部的に使用されます。



trigger (ev [, data])private

イベントをトリガーにする。内部的に使用されます。

  • ev

    String トリガーにするイベントの名前

  • data

    Object イベントに設定する追加のデータ



get_container ()

jQueryの拡張インスタンスコンテナを戻り値として取得します。

  • Returns

    jQuery



get_container_ul ()private

インスタンスコンテナ内のjQuery拡張メインULを戻り値として取得します。内部的に使用されます。

  • Returns

    jQuery



get_string (key)private

置き換える文字列を取得します(localization)。内部的に使用されます。

  • key

    String

  • Returns

    String



_firstChild (dom)private

DOM ノードの最初の子ノードを取得します。内部的に使用されます。

  • dom

    DOMElement

  • Returns

    DOMElement



_nextSibling (dom)private

DOM ノードと同階層にある次のノードを取得します。内部的に使用されます。

  • dom

    DOMElement

  • Returns

    DOMElement



_previousSibling (dom)private

DOM ノードと同階層にある前のノードを取得します。内部的に使用されます。

  • dom

    DOMElement

  • Returns

    DOMElement



get_node (obj [, as_dom])

DOM 子エレメントやID、セレクターなどを使い、ノード(もしくはjQuery拡張DOMノード)を表すJSONデータを取得します。

  • obj

    mixed

  • as_dom

    Boolean

  • Returns

    Object jQuery



get_path (obj [, glue, ids])

ノードへのパスを取得します。パスはノードテキストもしくはノードIDのいずれかによって構成され、必要に応じて連結されるか配列型になります。

  • obj

    mixed ノード

  • glue

    Stringパスを文字列として取得したい場合 - ここに連結文字を設定します(例えば '/'のような)。falsy 値を設定した場合、配列型の値が戻り値として返されます。

  • ids

    Boolean trueを設定した場合はIDを使ってパスが作成され、falseを設定した場合はノードテキストを使ってパスが作成されます。

  • Returns

    mixed



get_next_dom (obj [, strict])

obj ノードの下にある次の可視ノードを取得します。stricttrue を設定した場合、同階層にあるノードのみが取得されます。

  • obj

    mixed

  • strict

    Boolean

  • Returns

    jQuery



get_prev_dom (obj [, strict])

obj ノードの上にある前の可視ノードを取得します。 stricttrue を設定した場合、兄弟ノードのみが取得されます。

  • obj

    mixed

  • strict

    Boolean

  • Returns

    jQuery



get_parent (obj)

親ノードのIDを取得します。

  • obj

    mixed

  • Returns

    String



get_children_dom (obj)

指定したノードの全ての子ノードのjQueryコレクションを取得します (node must be rendered)

  • obj

    mixed

  • Returns

    jQuery



is_parent (obj)

ノードが子ノードを持っているか確認します

  • obj

    mixed

  • Returns

    Boolean



is_loaded (obj)

指定したノードの読み込みが完了しているかを確認します。 (読み込みが完了している場合、子ノードも使用可能になっています)

  • obj

    mixed

  • Returns

    Boolean



is_loading (obj)

指定したノードが現在読み込み中かを確認します。 (読み込み中の場合、子ノードも取得途中です)

  • obj

    mixed

  • Returns

    Boolean



is_open (obj)

ノードが展開されているかを確認します

  • obj

    mixed

  • Returns

    Boolean



is_closed (obj)

ノードが閉じられている状態かを確認します

  • obj

    mixed

  • Returns

    Boolean



is_leaf (obj)

ノードが子ノードを持っていないかを確認します。

  • obj

    mixed

  • Returns

    Boolean



load_node (obj [, callback])

ノードを読み込みます (core.data 設定を使って子ノードも取得します)。配列を使って複数のノードを設定できます。

  • obj

    mixed

  • callback

    function 読み込みが完了したときに実行される関数。この関数はインスタンスのスコープ内で実行され、引数を二つ(ノードとboolean型の値)受け取ります。

  • Returns

    Boolean

  • Triggers

    load_node.jstree



load_node (obj [, callback])

ノードを読み込みます (core.data 設定を使って子ノードも取得します)。配列を使って複数のノードを設定できます。

  • obj

    mixed

  • callback

    function 読み込みが完了したときに実行される関数。この関数はインスタンスのスコープ内で実行され、引数を二つ(ノードとboolean型の値)受け取ります。

  • Returns

    Boolean

  • Triggers

    load_node.jstree



load_node.jstree Event

ノードが読み込まれた後に発生するイベント

  • node

    Object読み込まれたノード

  • status

    Booleanノードの読み込みに成功したか



_load_nodes (nodes [, callback])private

ノードの配列を読み込みます (ツリーに表示されたばかりでまだ使用できないノードも読み込まれます)。内部的に使用されます。

  • nodes

    array

  • callback

    function 読み込みが完了したときに実行される関数。この関数はインスタンスのスコープ内で実行され、引数を一つ(_load_nodesに設定する配列)受け取ります。



load_all ([obj, callback])

アンロードされた全てのノードを読み込みます

  • obj

    mixed再度読み込むノード。省略されるとツリー内の全てのノードが読み込まれます。

  • callback

    function 全てのノードの読み込みが完了した時に実行される関数。

  • Triggers

    load_all.jstree



load_all.jstree Event

load_all の実行が完了した後に発生するイベント

  • node

    Object再度読み込まれたノード



_load_node (obj [, callback])private

ノードの読み込みを実際に処理します。内部的に使用されます。

  • obj

    mixed

  • callback

    function 読み込みが完了したときに実行される関数。この関数はインスタンスのスコープ内で実行され、引数を一つ(boolean型のステータス)受け取ります。

  • Returns

    Boolean



_node_changed (obj [, callback])private

再描写するノード一覧にノードを追加します。内部でのみ使用されます。

  • obj

    mixed



_append_html_data (obj, data)private

ツリーにHTMLコンテンツを埋め込みます。内部的に使用されます。

  • obj

    mixed追加するノード

  • data

    String 解析および埋め込みの対象となるHTML文字列

  • Triggers

    model.jstree changed.jstree



model.jstree Event

新しいデータがツリーモデルに挿入されたときに発生するイベント

  • nodes

    ArrayノードIDの配列

  • parent

    String親ノードのID



_append_json_data (obj, data)private

ツリーにJSONコンテンツを埋め込みます。内部的に使用されます。

  • obj

    mixed 埋め込むノード

  • data

    String 解析および埋め込みの対象となるHTML文字列

  • force_processing

    Boolean 内部パラメータ - 設定しないでください

  • Triggers

    model.jstree changed.jstree



_parse_model_from_html (d [, p, ps])private

jQuery オブジェクトからノードを解析し、それらをツリーモデルのメモリに追加します。内部的に使用されます。

  • d

    jQuery解析する jQuery オブジェクト

  • p

    String 親 ID

  • ps

    Array 全ての親の一覧

  • Returns

    Stringモデルに追加するオブジェクトのID



_parse_model_from_flat_json (d [, p, ps])private

jQuery オブジェクトからノードを解析し、それをツリーモデルのメモリに追加します(入れ子はないがIDとparentプロパティを持っているフラットなデータの場合に使われます。)。内部的に使用されます。

  • d

    Object 解析する jQuery オブジェクト

  • p

    String 親 ID

  • ps

    Array 全ての親の一覧

  • Returns

    String モデルに追加するオブジェクトのID



_parse_model_from_json (d [, p, ps])private

オブジェクトからノードを解析し、それをツリーモデルのメモリに追加します。内部的に使用されます。

  • d

    Object 解析する jQuery オブジェクト

  • p

    String 親 ID

  • ps

    Array 全ての親の一覧

  • Returns

    String モデルに追加するオブジェクトのID



_redraw ()private

再描写が必要な全てのノードを再描写します。。内部的に使用されます。

  • Triggers

    redraw.jstree



redraw.jstree Event

全てのノードが再描写された後に発生するイベント

  • nodes

    array描写されたノード



redraw ([full])

再描写が必要な全てのノード、もしくは必要に応じてツリー全体を再描写します。

  • full

    Boolean`true`が設定された場合、全てのノードが再描写されます。



draw_children (node)private

ノードの子ノードを一つ再描写します。内部的に使用されます。

  • node

    mixed再描写される子ノードを持つノード



redraw_node (node, deep, is_callback, force_render)private

ノードを一つ再描写します。内部的に使用されます。

  • node

    mixed 再描写するノード

  • deep

    Boolean子ノードも再描写されるべきかどうか

  • is_callback

    Boolean これが再帰呼び出しかどうか

  • force_render

    Boolean親ノードが閉じている場合、その子ノードを描写すべきかどうか



open_node (obj [, callback, animation])

ノードを開き、その子ノードを展開します。ノードが読み込まれれていない場合は、準備ができてからノードが読み込まれて展開されます。

  • obj

    mixed 展開するノード

  • callback

    Function ノードが展開されてから実行される関数

  • animation

    Number ノードを展開する際のアニメーションの再生時間をミリ秒単位で表したもの (`core.animation`の設定を上書きします)。アニメーションをしない場合は`false`を使います。

  • Triggers

    open_node.jstree after_open.jstree before_open.jstree



before_open.jstree Event

ノードが展開される時に発生するイベント(ノードがDOMと想定される場合、トリガーは発生しますが表示はされません。)

  • node

    Object 展開するノード



open_node.jstree Event

ノードが展開し終わった時に発生するイベント (開閉アニメーションを設定している場合、アニメーションの完了までは含みません)

  • node

    Object 展開するノード



after_open.jstree Event

ノードが展開が終わり、開閉アニメーションも完了した時に発生するイベント

  • node

    Object展開するノード



_open_to (obj)private

(読み込みが完了している)ノードの全ての親を展開します

  • obj

    mixed 展開するノード



close_node (obj [, animation])

ノードを閉じ、その子ノードを隠します。

  • obj

    mixed閉じるノード

  • animation

    Number ノードを閉じる際のアニメーションの再生時間をミリ秒単位で表したもの (`core.animation`の設定を上書きします)。アニメーションさせない場合は`false`を使います。

  • Triggers

    close_node.jstree after_close.jstree



close_node.jstree Event

ノードが閉じ終わった時に発生するイベント (開閉アニメーションを設定している場合、アニメーションの完了までは含みません)

  • node

    Object閉されたノード



after_close.jstree Event

ノードが閉じ終わり、開閉アニメーションも完了した時に発生するイベント

  • node

    Object閉じられたノード



toggle_node (obj)

ノードを切り替えます。 - ノードが開いている場合は閉じ、閉じている場合は開きます。

  • obj

    mixed切り替えるノード



open_all ([obj, animation, original_obj])

ノード内(もしくはツリー内)の全てのノードを展開し、子ノードを表示します。ノードが読み込まれていない場合、準備ができてから読み込まれ、展開されます。

  • obj

    mixed 再帰的に展開するノード。省略した場合はツリー内全てのノードが展開されます。

  • animation

    Number ノードを展開する際のアニメーションの再生時間をミリ秒単位で表したもの。既定ではアニメーションしません

  • reference

    jQueryプロセスを開始したノードへの参照(内部的に使用します)

  • Triggers

    open_all.jstree



open_all.jstree Event

open_all の実行が完了した時に発生するイベント

  • node

    Object展開されたノード



close_all ([obj, animation])

ノード内(もしくはツリー内)の全てのノードを閉じます。 revaling their children

  • obj

    mixed 再帰的に閉じるノード。省略するとツリー内の全てのノードが閉じられます。

  • animation

    Number ノードを閉じる際のアニメーションの再生時間をミリ秒単位で表したもの。既定ではアニメーションしません

  • Triggers

    close_all.jstree



close_all.jstree Event

close_all の実行が完了した時に発生するイベント

  • node

    Object閉じられるノード



is_disabled (obj)

ノードが無効になっている(選択できない状態)かどうかを確認します。

  • obj

    mixed

  • Returns

    Boolean



enable_node (obj)

ノードを有効にします - これによってノードを選択できるようになります。

  • obj

    mixed 有効にするノード

  • Triggers

    enable_node.jstree



enable_node.jstree Event

ノードが有効になった時に発生するイベントです。

  • node

    Object有効になったノード



disable_node (obj)

ノードを無効にします - これによってノードが選択できなくなります。

  • obj

    mixed 無効にするノード

  • Triggers

    disable_node.jstree



disable_node.jstree Event

ノードが無効になった時に発生するイベント

  • node

    Object無効になったノード



activate_node (obj, e)private

ノードが選択されたときに実行される。内部的に使用します。

  • obj

    mixed ノード

  • e

    Object 関連するイベント

  • Triggers

    activate_node.jstree changed.jstree



activate_node.jstree Event

ユーザーによってノードがクリックされたり挿入された時に発生するイベント

  • node

    Object



hover_node (obj)private

ノードをマウスオーバー状態にします。ユーザーによってノードがマウスオーバーになった時に実行されます。内部的に使用されます。

  • obj

    mixed

  • Triggers

    hover_node.jstree



hover_node.jstree Event

ノードがマウスオーバー状態になった時に発生するイベント

  • node

    Object



dehover_node (obj)private

ユーザーに操作によってマウスオーバーでなくなった場合、対象ノードのマウスオーバー状態を解除します。内部的に使用されます。

  • obj

    mixed

  • Triggers

    dehover_node.jstree



dehover_node.jstree Event

ノードがマウスオーバーでなくなった時に発生するイベント

  • node

    Object



select_node (obj [, supress_event, prevent_open])

ノードを選択します

  • obj

    mixed 配列を使って複数のノードを選択することが可能です

  • supress_event

    Boolean`true` を設定した場合、`changed.jstree`イベントはトリガーになりません

  • prevent_open

    Boolean `true`を設定した場合、選択したノードの親ノードは展開されません

  • Triggers

    select_node.jstree changed.jstree



select_node.jstree Event

ノードが選択されたときに発生するイベント

  • node

    Object

  • selected

    Array 現在選択されているノード

  • event

    Object(もしあれば)このselect_nodeをトリガーとしているイベント



changed.jstree Event

選択状態が変わった時に発生するイベント

  • node

    Object

  • action

    Object選択変更を発生させた動作

  • selected

    Array 現在選択されているノード

  • event

    Object (もしあれば)この変更イベントをトリガーとしているイベント



deselect_node (obj [, supress_event])

ノードの選択を解除します

  • obj

    mixed 配列を使って複数のノードの選択を解除することが可能です

  • supress_event

    Boolean `true` を設定した場合、`changed.jstree`イベントはトリガーになりません

  • Triggers

    deselect_node.jstree changed.jstree



deselect_node.jstree Event

ノードの選択が解除されたときに発生するイベント

  • node

    Object

  • selected

    Array 現在選択されているノード

  • event

    Object (もしあれば)このdeselect_nodeをトリガーとしているイベント



select_all ([supress_event])

ツリー内の全てのノードを選択します

  • supress_event

    Boolean `true` を設定した場合、`changed.jstree`イベントはトリガーになりません

  • Triggers

    select_all.jstree changed.jstree



select_all.jstree Event

全てのノードが選択された時に発生するイベント

  • selected

    Array 現在選択しているノード



deselect_all ([supress_event])

全てのノードの選択を解除する

  • supress_event

    Boolean `true` を設定した場合、`changed.jstree`イベントはトリガーになりません

  • Triggers

    deselect_all.jstree changed.jstree



deselect_all.jstree Event

全てのノードの選択状態が解除されたときに発生するイベント

  • node

    Object 先ほどまで選択状態だったノード

  • selected

    Array 現在選択状態のノード



is_selected (obj)

ノードが選択状態かどうかを確認します

  • obj

    mixed

  • Returns

    Boolean



get_selected ([full])

選択状態の全てのノードを配列で取得します

  • full

    mixed `true`を設定した場合、取得される配列は完全なノードオブジェクトになります。falseを設定した場合 - IDのみが取得されます。

  • Returns

    Array



get_top_selected ([full])

選択状態のノードのうち一番上位階層にあるもの全ての配列を取得します。(選択されたノードの子ノードは無視されます。)

  • full

    mixed `true`を設定した場合、取得される配列は完全なノードオブジェクトになります。falseを設定した場合 - IDのみが取得されます。

  • Returns

    Array



get_bottom_selected ([full])

選択状態のノードのうち一番下位階層にあるもの全ての配列を取得します。 (選択状態の親ノードは無視されます)

  • full

    mixed `true`を設定した場合、取得される配列は完全なノードオブジェクトになります。falseを設定した場合 - IDのみが取得されます。

  • Returns

    Array



get_state ()private

現在のツリーの状態を取得します。これにより、後からset_state(state)を実行してツリーの復元ができるようになります。内部的に使用されます。

  • Returns

    Object



set_state (state [, callback])private

ツリーの状態を設定します。内部的に使用されます。

  • state

    Object 復元に使う状態情報

  • callback

    Function状態が復元された時に追加で実行する関数。

  • Triggers

    set_state.jstree



set_state.jstree Event

set_state の実行が完了した時に発生するイベント



refresh ()

ツリーを更新します - load_nodeを実行して全てのノードが再読み込みされます。

  • skip_loading

    Boolean 読み込み進捗状態の表示をスキップするか決めるオプション

  • forget_state

    Mixed `true`を設定した場合、現在のツリー状態は再適用されません。(現在の状態を引数として受け取る)関数を設定した場合、その関数の実行結果がツリーの状態と私鉄川割れます。

  • Triggers

    refresh.jstree



refresh.jstree Event

refresh の処理が完了した時に発生するイベント



refresh_node (obj)

ツリー内のノードを更新します (子ノードを読み込みます)。 load_nodeを実行して内部のノードを読み込んで全て展開します。.

  • obj

    mixed the node

  • Triggers

    refresh_node.jstree



refresh_node.jstree Event

ノードが更新されたときに発生するイベント

  • node

    Object - 更新されるノード

  • nodes

    Array - 読み込まれる各ノードのIDの配列



set_id (obj, id)

ノードのIDを設定(変更)します

  • obj

    mixed ノード

  • id

    String 新しく割り振るID

  • Returns

    Boolean



get_text (obj)

ノードのテキスト値を取得します。

  • obj

    mixed ノード

  • Returns

    String



set_text (obj, val)private

ノードのテキスト値を設定します。これは内部的に使用されるものなので、あなたはrename_node(obj, val)を使ってください。

  • obj

    mixed ノード。ノードの配列を設定して複数のノードにテキストを設定することが可能です。

  • val

    String 新しく設定するテキスト

  • Returns

    Boolean

  • Triggers

    set_text.jstree



set_text.jstree Event

テキストの値が変更された時に発生するイベント

  • obj

    Object

  • text

    String新しい値



get_json ([obj, options])

ノード(もしくはツリー全体)を表すJSONを取得します。

  • obj

    mixed

  • options

    Object

  • options.no_state

    Boolean 状態情報を返さない

  • options.no_id

    Boolean IDを返さない

  • options.no_children

    Boolean 子ノードを含まない

  • options.no_data

    Boolean ノードデータを含まない

  • options.flat

    Boolean 階層分けされていないフラットなJSONを返す。

  • Returns

    Object



create_node ([obj, node, pos, callback, is_loaded])

ノードを新規に作成します。 (load_nodeと混同しないでください)

  • par

    mixed 親ノード (最上部のノード作成する場合は"#" (文字列) もしくは `null`のいずれかを使ってください)

  • node

    mixed 新しいノートのデータ (有効な JSON オブジェクトもしくは単純に名前として使う文字列)

  • pos

    mixed ノードを挿入する位置。 "first" と "last" もサポートしており、既定は"last"

  • callback

    Functionこのノードが作成された時に実行される関数

  • is_loaded

    Boolean親ノードの読み込みに成功したかどうかを示す内部パラメータ

  • Returns

    String新規に作成されるノードのID

  • Triggers

    model.jstree create_node.jstree



create_node.jstree Event

ノードが作成された時に発生するイベント

  • node

    Object

  • parent

    String 親のID

  • position

    Number 新規に作成されたノードの、同階層にいる他の子ノードの中での位置



rename_node (obj, val)

ノードのテキスト値を設定します

  • obj

    mixed ノード。ノードの配列を渡して、複数のノードを同じ名前にすることも可能です

  • val

    String 新しいテキスト値

  • Returns

    Boolean

  • Triggers

    rename_node.jstree



rename_node.jstree Event

ノードの名前が変更された時に発生するイベント

  • node

    Object

  • text

    String新しい値

  • old

    String古い値



delete_node (obj)

ノードを削除します

  • obj

    mixedノード。ノードの配列を渡して複数のノードを削除することも可能です。

  • Returns

    Boolean

  • Triggers

    delete_node.jstree changed.jstree



delete_node.jstree Event

ノードが削除された時に発生するイベント

  • node

    Object

  • parent

    String 親の ID



check (chk, obj, par, pos)private

ツリー上での操作が許可されているか確認します。内部的に使用されます。

  • chk

    String チェックする操作。 "create_node", "rename_node", "delete_node", "copy_node" もしくは "move_node"のいずれかが入ります。

  • obj

    mixed ノード

  • par

    mixed

  • pos

    mixed 挿入する位置。もしくはノードの新しい名前 - "rename_node"を実行して名前を変更しただけの場合。、

  • more

    mixed様々な追加情報。例えば、DNDによって"move_node" 操作が行われていた場合は、マウスオーバー状態のノードの情報

  • Returns

    Boolean



last_error ()

最後に発生したエラーを取得します。

  • Returns

    Object



move_node (obj, par [, pos, callback, is_loaded])

ノードを新しい親ノードへ移動します。

  • obj

    mixed 移動させるノード。ノードの配列を渡すと、複数のノードを移動させます。

  • par

    mixed 新しい親

  • pos

    mixed 挿入する位置(整数値以外にも、"before" と "after"同様 "first" と "last" をサポートしています)。既定では整数の `0`

  • callback

    function移動が完了した時に実行される関数。ノード、新しい親、位置の三つの引数を受け取ります。

  • is_loaded

    Boolean 親ノードが読み込まれているかを示す内部パラメータ

  • skip_redraw

    Booleanツリーの再描写が必要かどうかを示す内部パラメータ

  • instance

    Boolean このノードが他のインスタンスから移動してきたのかを示す内部パラメータ

  • Triggers

    move_node.jstree



move_node.jstree Event

ノードが移動されたときに発生するイベント

  • node

    Object

  • parent

    String 親のID

  • position

    Number 同階層にいる他の子ノードの中での位置

  • old_parent

    Stringノードの以前の親

  • old_position

    Number ノードの以前の位置

  • is_multi

    Boolean このノードと新しい親を別のインスタンスに属させる

  • old_instance

    jsTreeこのノードの移動元インスタンス

  • new_instance

    jsTree新しい親のインスタンス



copy_node (obj, par [, pos, callback, is_loaded])

ノードを新しい親にコピーする

  • obj

    mixed コピーするノード。ノードの配列を渡すと複数のノードをコピーします。

  • par

    mixed 新しい親

  • pos

    mixed (整数値以外にも、"before" と "after"同様 "first" と "last" をサポートしています)。既定では整数の `0``

  • callback

    function移動が完了した時に実行される関数。ノード、新しい親、位置の三つの引数を受け取ります。

  • is_loaded

    Boolean 親ノードが読み込まれているかを示す内部パラメータ

  • skip_redraw

    Boolean ツリーの再描写が必要かどうかを示す内部パラメータ

  • instance

    Boolean このノードが他のインスタンスから移動してきたのかを示す内部パラメータ

  • Triggers

    model.jstree copy_node.jstree



copy_node.jstree Event

ノードがコピーされた時に発生するイベント

  • node

    Object コピーするノード

  • original

    Object オリジナルノード

  • parent

    String 親のID

  • position

    Number 同階層にいる他の子ノードの中での位置

  • old_parent

    String ノードの以前の親

  • old_position

    Number オリジナルノードの位置

  • is_multi

    Boolean このノードと新しい親を別のインスタンスに属させる

  • old_instance

    jsTree このノードのコピー元インスタンス

  • new_instance

    jsTree 新しい親のインスタンス



cut (obj)

ノードを切り取る (後でpaste(obj)を実行してノードを移動できます)

  • obj

    mixed 配列を使って複数のオブジェクトを渡すことが可能です

  • Triggers

    cut.jstree



cut.jstree Event

ノードが移動用バッファに格納された時に発生するイベント

  • node

    Array



copy (obj)

ノードをコピーします(後でpaste(obj)を実行してノードをコピーできます)

  • obj

    mixed配列を使って複数のオブジェクトを渡すことができます。

  • Triggers

    copy.jstree



copy.jstree Event

ノードがコピー用バッファに格納された時に発生するイベント

  • node

    Array



get_buffer ()

現在のバッファを取得します (貼り付け処理を待っている全てのノード)

  • Returns

    Objectオブジェクトは`mode`("copy_node" もしくは "move_node")、`node` (オブジェクトの配列)、`inst` (インスタンス)によって構成されます。



can_paste ()

バッファ内に貼り付けできるものが保存されているか確認します。

  • Returns

    Boolean



paste (obj [, pos])

前に切り取りもしくはコピーしたノードを、新しい親に移動もしくはコピーします。

  • obj

    mixed 新しい親

  • pos

    mixed 挿入する位置(整数値以外にも、"first" と "last" をサポートしています)。既定では整数の `0`

  • Triggers

    paste.jstree



paste.jstree Event

貼り付けが実行された時に発生するイベント

  • parent

    String 受け取るノードのID/p>

  • node

    Array バッファ内のノード

  • mode

    String 実行された操作 - "copy_node" もしくは "move_node"



clear_buffer ()

以前にコピーもしくは切り取ったノードのバッファをクリアします。

  • Triggers

    clear_buffer.jstree



clear_buffer.jstree Event

コピーもしくは切り取りのバッファがクリアされたときに発生するイベント



edit (obj [, default_text])

ノードを編集モードにします。 (ノードの名前を変更する入力欄)

  • obj

    mixed

  • default_text

    String入力に使われるテキスト (省略された場合はノードのテキスト値が使われます)



set_theme (theme_name [, theme_url])

テーマを変更します

  • theme_name

    String 適用する新しいテーマの名前

  • theme_url

    mixedこのテーマのCSSファイルの設置場所。手動でファイルをインクルードするのであれば、省略するか`false`を設定してください。 `true`を設定すると `core.themes.dir` ディレクトリから自動的にファイルを読み込みます。.

  • Triggers

    set_theme.jstree



set_theme.jstree Event

テーマが設定された時に発生するイベント

  • theme

    String 新しいテーマ



get_theme ()

現在適用されているテーマの名前を取得します

  • Returns

    String



set_theme_variant (variant_name)

テーマバリアントを変更します (テーマがバリアントを持っていた場合)

  • variant_name

    String Boolean 適用するバリアント (`false` を設定した場合、現在のバリアントは削除されます)



get_theme ()

現在適用されているテーマバリアントの名前を取得します。

  • Returns

    String



show_stripes ()

コンテナ上にストライプの背景を表示します (テーマがストライプ背景をサポートしている場合)



hide_stripes ()

コンテナ上のストライプ背景を非表示にします



toggle_stripes ()

コンテナ上のストライプ背景の表示を切り替えます



show_dots ()

接続ドットを表示します (テーマが接続ドットをサポートしている場合)



hide_dots ()

接続ドットを非表示にします



toggle_dots ()

接続ドットの表示を切り替えます。



show_icons ()

ノードアイコンを表示します



hide_icons ()

ノードアイコンを非表示にします



toggle_icons ()

ノードアイコンの表示を切り替えます



set_icon (obj, icon)

ノードにノードアイコンを設定します。

  • obj

    mixed

  • icon

    String 新しいアイコン - アイコンへのパスもしくはクラス名が使用できます。カレントディレクトリにある画像を使いたい場合は頭に./ をつけてください。つけない場合、文字列はクラス名と見なされます。



get_icon (obj)

ノードのノードアイコンを取得します

  • obj

    mixed

  • Returns

    String



hide_icon (obj)

ノードのアイコンを個別に非表示にします

  • obj

    mixed



show_icon (obj)

ノードのアイコンを個別に表示します

  • obj

    mixed



注意事項

  • 本サイトはjsTreeのサイトを翻訳したものであり、jsTreeに関する著作権は全てそちらに帰属しています。
  • 誤訳が判明した場合、より分かりやすい言い回しが見つかった場合、原文が変更された場合などにより、本サイトの内容は予告なく変更されることがあります。
  • 誤訳についての指摘や未翻訳部分についての助言など、ご意見についてはこちらへいただけると助かります。
  • 翻訳の内容には誤りがある可能性があります。本サイトの記述内容によって不利益が発生した場合も、サイト管理人は一切の責任を負いません。
  •   

エンジェル戦記