📖ドキュメント一覧▼

コンテナ API (ComponentContainer)

ComponentContainer のインスタンスは、すべてのコンポーネントファクトリ関数またはコンストラクタに渡されます。コンポーネントが配置される DOM コンテナを表し、基盤となる HTML 要素、寸法、状態管理、ライフサイクルイベントへの直接アクセスを提供します。

layout.registerComponentFactoryFunction('dashboard', (container, state) => {
  // 1. ネイティブ HTMLElement への直接アクセス
  container.element.innerHTML = `
    <div class="dashboard-root"><h3>${state?.title || 'ダッシュボード'}</h3></div>
  `;

  // 2. 状態取得 & 永続化コールバック
  container.stateRequestEvent = () => {
    return { title: '更新後のタイトル', scrollPos: 120 };
  };

  // 3. コンテナライフサイクルリスナー
  container.on('resize', () => {
    console.log(`リサイズ: ${container.width}x${container.height}`);
  });

  container.on('destroy', () => {
    // チャートやサブコンポーネントの破棄・クリーンアップ
  });
});

プロパティ (Properties)

element

DOM 内でこのコンテナを保持するネイティブの HTMLElement。子要素の追加や仮想ポータルのマウントは、このノードに対して直接行います。

initialState

アイテム設定の componentState または読み込まれたレイアウトから渡された初期の SerializableValue。

state

コンポーネントの現在のシリアライズ済み状態(container.stateRequestEvent() により評価)。

title

コンテナの現在のタイトル。関連付けられたタブに反映されます。

width

コンテナの現在の内側の幅(ピクセル単位)。

height

コンテナの現在の内側の高さ(ピクセル単位)。

componentType

このコンポーネントを識別する登録済みタイプ名。

component

インスタンス化されたコンポーネントオブジェクト(コンストラクタ経由で作成された場合)。

parent

親ノードである ComponentItem ツリーノードへの参照。

tab

このコンテナを制御しているアクティブな Tab コントロールへの参照。

layoutManager

親となる StrelitLayout レイアウトマネージャーインスタンスへの参照。

isHidden

このコンテナがスタック内の他のタブの後ろに隠れて非アクティブな場合に true。

visible

コンテナが DOM 内で現在可視状態である場合に true。

virtual

コンポーネントが仮想レイアウトモードで動作している場合に true。

イベント (Events)

open

コンテナのサイズが確定し、アクティブなドキュメント DOM ツリーに挿入された後に発行されます。

resize

ユーザーのドラッグやウィンドウリサイズによってコンテナの寸法が変更されたときに発行されます。

show

タブがアクティブになり、コンテナが表示状態になったときに発行されます。

hide

スタック内の別のタブがアクティブになり、このコンテナが非表示になったときに発行されます。

focus

コンポーネントコンテナがフォーカスを受け取ったときに発行されます。

blur

コンポーネントコンテナがフォーカスを失ったときに発行されます。

tab

タブコントロールがこのコンテナにバインドされたときに発行されます。

destroy

コンテナおよびその DOM 要素がレイアウトから削除される直前に発行されます。イベントリスナー、タイマー、フレームワークコンポーネントの破棄には必ずこのフックを使用してください。

close

このコンテナの閉じるボタンが押されたときに発行されます。

stateRequestEvent

layout.saveLayout() が呼び出された際に、コンポーネントの現在の動的状態をシリアライズするためのコールバック関数を container.stateRequestEvent に割り当てます。

container.stateRequestEvent = () => {
  return {
    selectedIds: myGrid.getSelectedRowIds(),
    filterQuery: searchInput.value,
  };
};

replaceComponent( itemConfig )

引数型省略可デフォルト説明
itemConfigComponentItemConfigfalse-

新しいコンポーネント設定(新しい componentType、title、 componentState)。

レイアウトツリーの構造を変更することなく、このコンテナ内でホストされているコンポーネントを別のコンポーネントにその場で置き換えます。

focus( suppressEvent? ) / blur( suppressEvent? )

このコンテナおよび親コンポーネントアイテムのフォーカスを設定または解除します。

setTitle( title )

引数型省略可デフォルト説明
titlestringfalse-コンテナおよびタブに適用する新しいタイトル文字列。

close()

プログラムからこのコンテナを閉じ、レイアウトツリーからコンポーネントを削除します。

マルチ画面トレーディング端末やエンタープライズ分析ダッシュボードの構築、レガシーレイアウトからの移行など、チームとコミュニティがサポートします。

GitHub で Issue を作成 →