constructor(element: any, options?: any): DashboardLayout
Initializes a new instance of the DashboardLayout class.
The DOM element that will host the control, or a selector for the host element (e.g. '#theCtrl').
JavaScript object containing initialization data for the control.
Gets or sets a boolean value decides whether the DashboardLayout could show all the tiles.
コントロールが無効かどうかを判定する値を取得または設定します。
無効化されたコントロールは、マウスイベントやキーボードイベントを取得できません。
Gets or sets a value of the **tabindex** attribute associated with the control.
**tabindex** attribute value can be defined statically for a Wijmo control by specifying it on the control's host HTML element. But this value can't be changed later during application lifecycle, because Wijmo controls have complex structure, and the control may need to propagate this attribute value to its internal element to work properly.
Because of this, to read or change control's **tabindex** dynamically, you should do it using this property.
addEventListener(target: EventTarget, type: string, fn: any, capture?: boolean, passive?: boolean): void
このControl が所有する要素にイベントリスナーを追加します。
コントロールは、アタッチされているリスナーとそのハンドラのリストを保持し、コントロールが破棄されているときにそれらを簡単に削除すること ができます（dispose と removeEventListener メソッドを参照してください）。
イベントリスナーを削除しないと、メモリリークが発生する可能があります。
デフォルトでは passive パラメータはfalseに設定されています。これはイベントハンドラが event.preventDefault() を呼び出すことを意味します。タッチイベントまたはマウスホイールイベントにpassiveハンドラを追加する場合は、このパラメータをtrueに設定するとアプリケーションのパフォーマンスが向上します。
passive イベントリスナーの詳細については、「<a target="_blank" href="https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#Improving_scrolling_performance_with_passive_listeners">Improving scrolling performance with passive listeners</a>」を参考してください。
Target element for the event.
String that specifies the event.
Function to execute when the event occurs.
Whether the listener should be handled by the control before it is handled by the target element.
Indicates that the handler will never call preventDefault().
applyTemplate(classNames: string, template: string, parts: Object, namePart?: string): HTMLElement
コントロールの新しいインスタンスにテンプレートを適用し、ルート要素を返します。
このメソッドはテンプレート化されたコントロールのコンストラクターによって呼び出される必要があります。テンプレートのパーツを対応するコントロールメンバにバインドする役割を持ちます。
以下のサンプルコードは、InputNumber コントロールのインスタンスにテンプレートを適用します。 このテンプレートには、'wj-part'属性が'input'、'btn-inc'、および'btn-dec'に設定された要素を含める必要があります。 コントロールのメンバである'_tbx'、'_btnUp'、'_btnDn'には、これらの要素への参照が割り当てられます。
```typescript this.applyTemplate('wj-control wj-inputnumber', templateString, { _tbx: 'input', _btnUp: 'btn-inc', _btnDn: 'btn-dec' }, 'input'); ``````
Names of classes to add to the control's host element.
An HTML string that defines the control template.
A dictionary of part variables and their names.
Name of the part to be named after the host element. This determines how the control submits data when used in forms.
deferUpdate(fn: Function): void
beginUpdate/endUpdateブロック内で関数を実行します。
この関数の実行が完了するまでコントロールは更新されません。 このメソッドは、関数が例外を生成した場合でもendUpdate が呼び出されるようにします。
Function to be executed.
dispose(): void
ホスト要素との関連付けを解除することによってコントロールを破棄します。
dispose メソッドは、addEventListener メソッドによって追加されたイベントリスナーを自動的に削除します。
コントロールを動的に作成および削除するアプリケーションでは、dispose メソッドを呼び出すことが重要です。コントロールを破棄しないと、メモリリークが発生する可能があります。
disposeAll(e?: HTMLElement): void
HTML要素に含まれるすべてのWijmoコントロールを破棄します。
Container element.
getControl(element: any): Control
指定したDOM要素でホストされているコントロールを取得します。
The DOM element that hosts the control, or a CSS selector for the host element (e.g. '#theCtrl').
getTemplate(): string
initialize(options: any): void
指定したオブジェクトからプロパティをコピーしてコントロールを初期化します。
このメソッドを使用すると、各プロパティの値をコードで設定する代わりにプレーンなデータオブジェクトを使用してコントロールを初期化できます。
例:
```typescript grid.initialize({ itemsSource: myList, autoGenerateColumns: false, columns: [ { binding: 'id', header: 'Code', width: 130 }, { binding: 'name', header: 'Name', width: 60 } ] });
// 以下と同等です。 grid.itemsSource = myList; grid.autoGenerateColumns = false; // など ```
初期化データは適用時に型チェックされます。初期化オブジェクトに不明なプロパティ名または無効なデータ型が含まれている場合、このメソッドは例外をスローします。
Object that contains the initialization data.
invalidate(fullUpdate?: boolean): void
非同期更新を発生させるため、コントロールを無効にします。
Whether to update the control layout as well as the content.
invalidateAll(e?: HTMLElement): void
指定したHTML要素に含まれるすべてのWijmoコントロールを無効化します。
このメソッドは、コントロールの表示状態やサイズを変更する動的なパネルをアプリケーションで使用している場合に使用します。たとえば、スプリッタ、アコーディオン、およびタブコントロールは通常、その中の要素の表示状態を変更します。この場合、その要素に含まれるコントロールに通知しないと、それらのコントロールが適切に機能しなくなる可能性があります。
これが起こる場合は、動的コンテナーで適切なイベントを処理し、invalidateAllメソッドを呼び出してコンテナー内のWijmoコントロールのレイアウト情報が適切に更新されるようにする必要があります。
Container element. If set to null, all Wijmo controls on the page will be invalidated.
loadLayout(value: string): void
Loads the layout from a JSON string.
A json string for a layout.
onFormatTile(e: TileFormattedEventArgs): void
Raises the formatTile event.
TileFormattedEventArgs that contains the event data.
onGotFocus(e?: EventArgs): void
gotFocus イベントを発生させます。
onInvalidInput(e: CancelEventArgs): void
invalidInput イベントを発生させます。
イベントハンドラがイベントをキャンセルした場合、コントロールは無効な入力とフォーカスを保持します。
onLostFocus(e?: EventArgs): void
lostFocus イベントを発生させます。
onRefreshed(e?: EventArgs): void
refreshedイベントを発生させます。
onRefreshing(e?: EventArgs): void
refreshingイベントを発生させます。
onTileActivated(e: TileEventArgs): void
Raises the tileActivated event.
TileEventArgs that contains the event data.
onTileSizeChanged(e: TileSizeChangedEventArgs): void
Raises the tileSizeChanged event.
TileSizeChangedEventArgs that contains the event data.
refresh(fullUpdate?: boolean): void
コントロールを更新します。
Whether to update the control layout as well as the content.
refreshAll(e?: HTMLElement): void
HTML要素で存在するすべてのWijmoコントロールを更新する。
コントロールが時間おいて更新される代わりに直ちに更新されること以外はinvalidateAll メソッドと同様です。
Container element. If set to null, all Wijmo controls on the page will be invalidated.
remove(removedTile: Tile): void
Removes the tile.
The tile to be removed.
removeEventListener(target?: EventTarget, type?: string, fn?: any, capture?: boolean): number
このControl が所有する要素にアタッチされている1つまたは複数のイベントリスナーを解除します。
Target element for the event. If null, removes listeners attached to all targets.
String that specifies the event. If null, removes listeners attached to all events.
Handler to remove. If null, removes all handlers.
Whether the listener is capturing. If null, removes capturing and non-capturing listeners.
saveLayout(): string
Saves the current layout into a JSON string.
The string represents an object with the layout type and the layout properties. With the loadLayout method, it can be used to persist the layouts defined by the users so they are preserved across sessions, and can also be used to implement undo/redo functionality in applications that allows users to modify the layout.
The tile maximum state is temporary. It will not be saved.
For example, the text represents a FlowLayout with two tiles and its direction is TopToDown.
{
"fullTypeName": "c1.nav.flow.FlowLayout",
"layout": {
"direction": 1,
"items":[
{
"headerText": "This is the header text of the first tile.",
"content": "This is the content of the first tile."
},
{
"headerText": "This is the header text of the second tile.",
"content": "This is the content of the second tile."
}
]
}
}
showAll(): void
すべてのタイルを表示します。
Occurs when an element representing a Tile has been created.
For a tile, there are three areas: Header, Toolbar and Content. These areas can be customized via this event. The related dom elements or objects can be obtained in the event argument(TileFormattedEventArgs): headerElement, toolbar and contentElement.
For example, this code sets the backgroundColor of the tile to 'red'.
dashboard.formatTile.addHandler(function (s, e) {
// add an image after the header title.
var eleInfor = document.createElement('img');
eleInfor.src = '~/Content/images/down.png';
e.headerElement.appendChild(eleInfor);
// append some text to the tile content.
var spanText = document.createElement('span');
spanText.innerText = 'This is the cost budgeting for the whole 2018 year!';
e.contentElement.appendChild(spanText);
// customize the toolbar.
e.toolbar.clear(); //clear the toolbar items
// add a item to export the chart.
toolbar.insertToolbarItem({
icon: '<img src="~/Content/images/export.png" />',
title: 'Export',
command: function () {
var selector = e.tile.content,
chart = wijmo.Control.getControl(selector);
chart.saveImageToFile(selector.substr(1) + '.png');
}
}, 0);
// add a 'Delete' item in toolbar for removing the tile from the dashboard via dom.
var iconClose = document.createElement('img');
iconClose.style.marginLeft = '6px';
iconClose.style.cursor = 'default';
iconClose.src = '~/Content/images/close.png';
e.toolbar.hostElement.appendChild(iconClose);
iconClose.addEventListener('click', function () {
// remove the tile from the dashboard.
e.tile.remove();
});
});
無効な入力値が検出された場合に発生します。
ユーザーが適切な型に変換できない値、または有効な範囲外の値を入力または貼り付けると、無効な入力が発生する可能性があります。
イベントハンドラがイベントをキャンセルした場合、コントロールは無効なコンテンツとフォーカスを保持するため、ユーザーはエラーを修正できます。
イベントがキャンセルされない場合、コントロールは無効な入力を無視し、元のコンテンツを保持します。
It is a consolidated display of many views and related information in a single place. It is used to compare and monitor a variety of data simultaneously. The different data views are displayed all at once. Now DashboardLayout supports three layouts: FlowLayout, GridLayout(Auto and Manual) and SplitLayout. The user can define many layouts by implementing the ILayout interface, or extending from the LayoutBase for simple.