ASP.NET MVC コントロールヘルプ
ILayout Interface
ファイル
c1.nav.js
モジュール
c1.nav

Defines the interface for the layout.

We can define the layout by implementing this interface.

プロパティ

メソッド

プロパティ

activeTile

Gets the active tile.

Tile

definition

Gets or sets the current layout settings as a JSON string.

This property is typically used to persist the layout settings.

any

items

Gets the layout item collection.

ObservableArray

メソッド

attachTo

attachTo(dashboard: DashboardLayout): void

Applies this layout to the specified DashboardLayout control.

In this method, the layout is applied to some dashboard. Adds the codes to implement the rendering parts for the layout.

パラメーター
戻り値
void

detach

detach(): void

Detaches this layout from the DashboardLayout control.

In this method, the resources related will be released. It is often used when applying the new layout. It is called to detach the old layout.

戻り値
void

endMove

endMove(movedTile: Tile, endPosition: Point): void

Ends the moving operation and exits the moving mode.

パラメーター
  • movedTile: Tile

    The tile to be moved.

  • endPosition: Point

    The position where the tile is moved to.

戻り値
void

move

move(movedTile: Tile, position: Point): void

Moves the tile.

Adds the codes in this method to do somethings during moving. For example, creates a special moving icon represeting the moving tile, shows some tips for moving.

パラメーター
  • movedTile: Tile

    The tile to be moved.

  • position: Point

    The position of the moving mouse. It is the coordinate within the browser visible area.

戻り値
void

refresh

refresh(fullUpdate): void

Refreshes the layout.

When the layout properties are changed, especially the items are updated, this method should be called to redraw the layout.

パラメーター
  • fullUpdate:

    Whether to update the layout as well as the content.

戻り値
void

remove

remove(removedTile: Tile): boolean

Removes the tile.

パラメーター
  • removedTile: Tile

    The tile to be removed.

戻り値
boolean

resize

resize(resizedTile: Tile, toPosition: Point): boolean

タイルをサイズ変更します。

このメソッドでサイズ変更を実装するためのコードを追加します。

パラメーター
  • resizedTile: Tile

    The tile to be resized.

  • toPosition: Point

    The position where the tile is resized to. It is the coordinate within the browser visible area.

戻り値
boolean

showAll

showAll(): void

すべてのタイルを表示します。

戻り値
void

startMove

startMove(movedTile: Tile, startPosition: Point): boolean

タイルの移動を開始します。

このメソッドにコードを追加して、移動の準備をします。たとえば、移動開始位置である移動タイルを保存します。

パラメーター
  • movedTile: Tile

    The tile to be moved.

  • startPosition: Point

    The started position where the tile will be moved from. It is the coordinate within the browser visible area.

戻り値
boolean

toggleSize

toggleSize(currentTile: Tile): void

タイルのサイズ状態を切り替えます。

このメソッドで最大化と復元を実装するためのコードを追加します。

パラメーター
  • currentTile: Tile

    The tile to be toggled.

戻り値
void