Class: GridLayout

GridLayout

layoutEngines/gridlayout.js, line 115

GridLayoutエンジンの新しいインスタンスを作成します。

Parameters:
Name Type Description
options Object

GridLayoutの初期化に使用されるオブジェクト。

Name Type Default Description
rowHeaderWidth number 40 optional

行ヘッダセルの幅。

colHeaderHeight number 24 optional

列ヘッダセルの高さ。

headerRow Object optional

ヘッダ行設定の定義に使用されるオブジェクト。

Name Type Description
visible boolean optional

ヘッダ行が表示されるかどうかを指定します。

height number optional

ヘッダ行の高さ。

position string optional

ヘッダ行の位置。'above'または'below'を指定できます。デフォルト値は'below'です。

separateColumn boolean optional

全体的なヘッダを表示するか、ヘッダ行に個々の列を表示するかを指定します。

renderer string optional

デフォルトのヘッダ行レンダラー。列ヘッダテンプレートが存在する場合、ヘッダ行はそのテンプレートをレイアウト構造として使用します。

footerRow Object optional

グリッドフッタの設定。

Name Type Description
visible boolean optional

グリッドフッタが表示されるかどうかを指定します。

height number optional

グリッドフッタの高さ。

data Object optional

グリッドフッタ行の初期データ。オブジェクトまたはコールバック関数を指定できます。

rowHeight number 24 optional

デフォルトの行の高さ。

colWidth number | string '*' optional

デフォルトの列幅。

colMinWidth number 8 optional

デフォルトの最小列幅。

showRowHeader boolean true optional

行ヘッダを表示するかどうかを指定します。

showColHeader boolean true optional

列ヘッダを表示するかどうかを指定します。

allowAutoAddRow boolean false optional

ユーザーがUIActionによって新しい行を追加できるかどうかを指定します。

autoAddRowPosition boolean 'top' optional

新しい行の位置を指定します。

allowFocus boolean true optional

レイアウトエンジンがフォーカスを取得できるかどうかを指定します。

allowEditing boolean false optional

すべての列をグローバルに編集可能にします。

allowSorting boolean false optional

すべての列をグローバルにソート可能にします。

allowCellMerging boolean false optional

セルのマージをグローバルに可能にします。

cellMergingSettings.mode boolean 'restrict' optional

'restrict'と'free'の2つのモードがあります。モードが'restrict'の場合、現在の列の自動マージ領域が前の列によって制限されます。デフォルトモードは'restrict'です。

cellMergingSettings.onlyShowFirstRow boolean false optional

マージされたセルの値を最初の行にのみ表示するかどうかを指定します。

cellMergingSettings.alwaysShowText boolean false optional

マージされたセルのテキストをビューに表示するかどうかを指定します。

cellMergingSettings.groupedColumn.showIcon boolean false optional

マージされたセルにグループ化アイコンを表示するかどうかを指定します。

selectionMode string 'single' optional

選択モード。'single'、'multiple'、'none'のいずれかを指定できます。

selectionUnit string 'row' optional

選択単位を指定します。'row'または'cell'を指定できます。

allowHeaderSelect boolean false optional

行ヘッダにチェックボックスを表示するかどうかを指定します。trueの場合、チェックボックスをオンにする方法によってのみ行を選択できます。

allowColumnReorder boolean true optional

実行時にユーザーが列の順序を変更できるかどうかを指定します。

allowSwipe boolean false optional

タッチスワイプアクションをサポートするかどうかを指定します。

allowColumnResize boolean true optional

実行時にユーザーが列のサイズを変更できるかどうかを指定します。

rightToLeft boolean false optional

要素を右から左にレイアウトするかどうかを示します。

editMode string 'inline' optional

グリッドの編集に使用されるモードを指定します。'inline'、'popup'、'editForm'の3つのモードがあります。

editUnit string 'row' optional

一度にセルと行のどちらを編集するかを指定します。'row'と'cell'の2つのモードがあります。

editRowTemplate string optional

この編集行テンプレートは、'popup'モードおよび'editForm'モードの外観のカスタマイズに使用されます。

filterExpression string optional

データコレクションのフィルタリングに使用されるフィルタ式文字列。

allowGrouping boolean false optional

実行時にユーザーが手動で行をグループ化するのに役立つグループドラッグパネルを表示するかどうかを指定します。

defaultGroupingInfo Object optional

デフォルトのグループ設定オブジェクト。このオブジェクトよりもグループ記述子の設定の方が優先されます。

grouping Object | Array optional

グループの初期化に使用される単一のグループ設定オブジェクトまたはグループ設定オブジェクトの配列。

Name Type Description
field string optional

列のグループ化に使用される列のID。

collapsed boolean optional

グループが折りたたまれているかどうかを指定します。

preDefinedGroups Array optional nullable

ユーザーがカスタマイズできる事前定義されたグループ名。

converter Object optional

グループ名を決定する関数。この関数の呼び出し時にはセル値パラメーターが必要です。

header Object optional

グループヘッダの設定。

Name Type Description
visible boolean optional

グループヘッダが表示されるかどうかを指定します。

template string optional

グループヘッダのテンプレート。

height number optional

グループヘッダの高さ。

footer Object optional

グループフッタの設定。

Name Type Description
visible boolean optional

グループフッタが表示されるかどうかを指定します。

template string optional

グループフッタのテンプレート。

columns Array optional

グループフッタ領域の個々の列レンダラーまたは集計式を指定するための配列。

Name Type Description
id string optional

列ID

groupFooter string optional

現在のグループレベルの列レンダラーまたは集計式。これは列の設定で定義されたgroupFooterよりも優先されます。

height number optional

グループフッタの高さ。

collapseWithGroup boolean optional

グループが折りたたまれているときにフッタも折りたたまれるかどうかを指定します。falseの場合、グループが折りたたまれた場合でもフッタは表示されたままになります。

groupStrategy Object optional

グループレイアウトストラテジーの定義に使用されるグループストラテジーオブジェクト。

rowTemplate string optional

'#'+templateIDで始まる文字列、または行の構造とレイアウトを表す生のHTML文字列。

pinnedLeftRowTemplate string optional

'#'+templateIDで始まる文字列、または左に固定された行の構造とレイアウトを表す生のHTML文字列。

pinnedRightRowTemplate string optional

'#'+templateIDで始まる文字列、または右に固定された行の構造とレイアウトを表す生のHTML文字列。

colHeaderTemplate string optional

'#'+templateIDで始まる文字列、または列ヘッダ行の構造とレイアウトを表す生のHTML文字列。

pinnedLeftColHeaderTemplate string optional

'#'+templateIDで始まる文字列、または左に固定された列ヘッダ行の構造とレイアウトを表す生のHTML文字列。

pinnedRightColHeaderTemplate string optional

'#'+templateIDで始まる文字列、または右に固定された列ヘッダ行の構造とレイアウトを表す生のHTML文字列。

hierarchy Object optional

階層構造の初期化に使用される単一の階層設定オブジェクト。

Name Type Description
keyField string optional

そのdataFieldにデータ項目の一意フィールドの名前が格納されている列のID。

parentField string optional

そのdataFieldにデータ項目の親フィールドの名前が格納されている列のID。

collapsed boolean optional

ツリーノードの初期状態。

column string optional

ツリーノードが表示される列のID。

offset number | GC.Spread.Views.DataView~hierarchyOffsetCallback optional

ツリー列全体のオフセット。オフセットをカスタマイズするためのコールバック関数を指定することもできます。

offsetUnit number optional

options.hierarchy.offsetが指定されていない場合、オフセットはノードレベルとoffsetUnitによって計算されます。デフォルト値は20pxです。

footer Object optional

階層構造のフッタの設定。

Name Type Description
visible boolean optional

階層フッタを表示するかどうかを指定します。

height number optional

階層フッタの高さ。設定されていない場合はその行の高さになります。

template string optional

フッタの外観を定義するHTMLフラグメント。設定されていない場合は、行テンプレートを使用してフッタがレンダリングされます。

sorting Object | Array optional

ソートの初期化に使用される単一のソート設定オブジェクトまたはソート設定オブジェクトの配列。

Name Type Default Description
field string optional

ソートするフィールド。

ascending boolean true optional nullable

ソート順序を示します。デフォルト値はtrueです。

converter Object optional

ソート用のコンバータコールバック。

pageSize number optional

1ページに表示される項目の数。このプロパティはpagingプラグインが参照されている場合にのみ有効です。

startPageIndex number optional

初期の開始ページインデックス。このプロパティはpagingプラグインが参照されている場合にのみ有効です。

localeResource.groupDragText string optional

グループ化パネルのプレイスホルダー。

localeResource.toolPanelGroupPanelText string optional

ツールパネルのグループ化部分のプレイスホルダー。

localeResource.toolPanelGroupPanelTitle string optional

ツールパネルのグループ化部分のタイトル。

localeResource.toolPanelColPanelTitle string optional

ツールパネルの列操作部分のタイトル。

localeResource.addColPanelTitle string optional

列の追加ダイアログのタイトル。

localeResource.addColPanelText string optional

列の追加ダイアログのプレイスホルダー。

localeResource.addColPanelErrorText string optional

列挿入エラーの後に表示されるテキスト。

localeResource.addText string optional

追加ボタンの表示テキスト。

localeResource.cancelText string optional

キャンセルボタンの表示テキスト。

localeResource.updateText string optional

更新ボタンの表示テキスト。

localeResource.buildInActionSave string optional

組み込みの保存アクションの表示テキスト。

localeResource.buildInActionEdit string optional

組み込みの編集アクションの表示テキスト。

localeResource.buildInActionCancel string optional

組み込みのキャンセルアクションの表示テキスト。

localeResource.editFormTitle string optional

編集フォームのタイトル。

updateOverlayStatusCallback GC.Spread.Views.DataView~updateOverlayStatusCallback optional

オーバーレイ更新コールバック。

allowAsyncRender boolean false optional

列でasyncRenderメソッドを実行するかどうかを示します。

Tutorials:
  • Tutorial: [object Object]