Block APIとは
ダイナミックブロックをJavaScriptでカスタマイズするためのAPIです。
ブロック編集時のSCRIPT画面で変数の設定・取得などを行うことができます。
Block API一覧
| Method | Arguments Type | Return Value Type | Purpose | escription |
|---|---|---|---|---|
| krtBlock.setVal(name, value) | name: string value: any | void | 変数設定 | |
| krtBlock.getVal(name) | name: string | any | 変数名から値を取得する | |
| krtBlock.on(eventName, callback) | eventName: string callback: Function | Disposer | 組み込みイベントに対してイベントハンドラを設定する | 現段階ではデータの取得開始/完了に対応する beforeDataLoad と dataLoaded のみが利用可能です |
| krtBlock.getBlockId() | string | ブロックの識別子を取得する | ||
| krtBlock.collection(actionTableId) | actionTableId: string | アクションテーブルにアクセスするためのtableオブジェクトを返す | 返されるtableオブジェクトはWidget Collection とほぼ同様の仕様です | |
| krtBlock.hide(options: { keepArea: }) | keepArea: boolean | ブロックを非表示にする | 一度実行すると自動での表示/非表示は行われなくなります keepArea オプションで非表示時の領域確保を制御できます (true: 領域維持、false: 領域詰める) | |
| krtBlock.show() | ブロックを表示する | krtBlock.hide() と同様、一度実行すると自動での表示/非表示は行われなくなります |
サンプルはこちら