w2layout.get

get(type)

指定したパネルを検索し、オブジェクトを返します。

type: string

パネル名。

説明

第1引数のtypeは、パネルの名前を指定します。 名前は以下を指定することができます。

• top
• left
• main
• right
• preview
• bottom

.panels配列が存在しない場合、nullを返します。 panelオブジェクトの構造は以下の通りです。

panel: {
    type:       null,    // パネルのタイプ。(left、right、top、bottom、previewを指定することができます。)
    size:       100,     // 幅または高さ。パネルのタイプによって変わります。
    minSize:    20,      // リサイズした時の最小サイズ(px)
    hidden:     false,   // パネルを非表示にするかどうかを指定します。
    resizable:  false,   // パネルのリサイズの可否を指定します。
    overflow:   'auto',  // CSSのoverflowに似たプロパティです。overflowと同じ値を指定することができます。
    style:      '',      // パネルに追加CSSを指定します。
    content:    '',      // パネル内に表示する文字または .render(box) を持ったオブジェクトを指定することができます。
    width:      null,    // パネルの幅。読み取り専用。
    height:     null,    // パネルの高さ。読み取り専用。
    onRefresh:  null,    // パネルの更新イベントです。
    onShow:     null,    // パネルの表示イベントです。
    onHide:     null     // パネルの非表示イベントです。
}

JavaScriptはオブジェクトを参照渡しするので、 返されたオブジェクトを変更すると、元々のオブジェクトが変更されます。 パネルのプロパティを直接変更するよりも良い方法は.set()メソッドを使うことです。 このメソッドを使うと、表示内容の変更も適用されます。

パネルの検索方法は以下の通りです。

$('#layout').w2layout({
    name    : 'layout',
    panels  : [
        { type: 'top', size: 40 },
        { type: 'main', content: 'This is main panel' },
        { type: 'preview', size: 200, hidden: true }
    ]
});

console.log(w2ui['layout'].get('preview'));

デモ

previewパネル(非表示)のオブジェクトを取得し、console.logに出力します。

JavaScript

$('#layout').w2layout({
    name    : 'mylayout',
    panels  : [
        { type: 'top', content: 'top', size: 40 },
        { type: 'main', content: 'This is main panel' },
        { type: 'preview', content: 'preview', size: 200, hidden: true }
    ]
});

console.log(w2ui['layout'].get('preview'));