DataViewの新しいインスタンスを作成します。
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
container |
HTMLElement |
グリッドを格納するコンテナーノード。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data |
Array | Object |
グリッドモデルのオブジェクトの配列、またはdataSourceオブジェクト。詳細については、dataSourceの定義を参照してください。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
config |
Array | Object |
列定義の配列、またはグリッドの逆シリアル化に使用されるJSONオブジェクト。列オブジェクトの配列の場合、各列オブジェクトには以下のプロパティが含まれます。
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
layoutEngine |
Object |
layoutEngineインスタンス。 |
Classes
Methods
staticGC.Spread.Views.DataView.getControlByElement(node){Object}
指定したノードにホストされているDataViewのインスタンスを取得します。
Parameters:
| Name | Type | Description |
|---|---|---|
node |
Element |
DataViewインスタンスのホストに使用されているHTML要素。 |
Returns: {Object} DataViewインスタンス。
cancelBatchEdit()
バッチ編集をキャンセルして変更をクリアします。
cancelEditing()
現在の行の編集をキャンセルします。
clearSelection()
選択をクリアします。
destroy()
DataViewインスタンスをホストから削除し、現在のインスタンスによって使用されているすべてのリソース（レイアウトエンジンやグループストラテジーを含む）を破棄します。
formatDataItem(dataItem){Object}
列の書式に基づいてdataItemを書式設定します。
Parameters:
| Name | Type | Description |
|---|---|---|
dataItem |
Object |
書式設定するオブジェクト。 |
Returns: {Object} 書式設定されたオブジェクト。
getCachedBatchActions()
キャッシュ内の保存されていないアクションを取得します。
getItem(index){GC.Spread.Views.DataView.itemInfo|Array}
指定したインデックスまたは行IDによって項目情報を取得します。
Parameters:
| Name | Type | Description |
|---|---|---|
index |
Number | string | Array |
入力表示インデックスまたは行ID。配列を指定できます。インデックスはコントロールにおける表示インデックスであることに注意してください。 |
Returns: {GC.Spread.Views.DataView.itemInfo|Array} 照会された項目情報。
getLayoutInfo(){GC.Spread.Views.DataView.layoutInfo}
現在のインスタンスのレイアウト情報を取得します。
Returns: {GC.Spread.Views.DataView.layoutInfo} キーとして領域名、値としてレイアウト情報を使用するオブジェクト。
getRenderInfo(option){GC.Spread.Views.DataView.renderInfoObj}
レンダリング情報を取得します。
Parameters:
| Name | Type | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
option |
Object |
領域、水平スクロールオフセット、垂直スクロールオフセットの指定に使用されるオブジェクト。このオブジェクトは、戻り値に行レンダリング情報が含まれるかどうかを示します。
|
Returns: {GC.Spread.Views.DataView.renderInfoObj} レンダリング情報の結果。
getRowId(hitInfo){string}
hitInfoから対応する行要素IDを取得するユーティリティメソッド
Parameters:
| Name | Type | Description |
|---|---|---|
hitInfo |
GC.Spread.Views.DataView.hitTestInfoObj |
ヒットテスト結果。これはhitTestメソッドを呼び出すことによって取得できます。 |
Returns: {string} 行要素ID
getRowInfoFromId(rowId){object}
行IDから行情報を取得するユーティリティメソッド
Parameters:
| Name | Type | Description |
|---|---|---|
rowId |
string |
行のID |
Returns: {object} 行情報。
getSelections(){Array}
選択されている行のデータを取得します。
Returns: {Array} 選択されている行の情報（データ、sourceRow、列IDなど）。
hideLoadingOverlay()
組み込みのローディングオーバーレイを非表示にします。
hitTest(e){GC.Spread.Views.DataView.hitTestInfoObj}
Parameters:
| Name | Type | Description |
|---|---|---|
e |
TouchEvent | MouseEvent |
Returns: {GC.Spread.Views.DataView.hitTestInfoObj} ヒットテスト情報。
invalidate(rebuildDOMTree)
コントロール全体を無効にします。
Parameters:
| Name | Type | Description |
|---|---|---|
rebuildDOMTree |
boolean |
DOMツリー全体を再構築するかどうか。trueの場合、新しいDOMツリーによって古いDOMツリーが置き換えられます。それ以外の場合は、古いDOMツリーコンテナーが更新されて各レイアウト領域が再描画されます。 デフォルト値はtrueです。 |
refresh(area)
グリッドの指定した部分を更新します。
Parameters:
| Name | Type | Description |
|---|---|---|
area |
string |
更新する領域。 |
saveBatchEdit(callback)
バッチ編集の変更を保存します。
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
function |
すべてのアクションをサーバー戻り結果に保存した後に実行されるコールバック関数。 |
setSelections(sourceRow, columns)
選択を設定します。
Parameters:
| Name | Type | Description |
|---|---|---|
sourceRow |
number | Array |
選択されている行のソース行インデックスまたはソース行インデックスの配列。 |
columns |
string | Array |
選択されている行の列IDコレクション。selectionUnitがセルの場合に使用できます。 |
showLoadingOverlay()
組み込みのローディングオーバーレイを表示します。
startEditing(viewIndex, colIndex)
現在の行の編集を開始します。
Parameters:
| Name | Type | Description |
|---|---|---|
viewIndex |
number | string |
dataViewの行のviewIndexまたはID。 |
colIndex |
number |
dataViewの列インデックス。 |
stopEditing()
現在の行の編集を終了し、新しい値を確定します。
toJSON(){Object}
現在のインスタンスをJSONオブジェクトにシリアル化します。
Returns: {Object} JSONオブジェクト
innerfailedCallback(error)
failedCallback関数は、ユーザーがCRUD/バッチによってサーバーからデータを取得/操作した後に呼び出す必要があります。
Parameters:
| Name | Type | Description |
|---|---|---|
error |
Object |
エラー情報。 |
innersuccessCallback(data, dataSourceLength)
successCallback関数は、ユーザーがCRUD/バッチによってサーバーからデータを取得/操作した後に呼び出す必要があります。
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Array | Object |
要求されたデータ。バッチ編集で使用する場合、これはサーバーからの応答の配列です。 |
dataSourceLength |
number |
nullable
データの長さを変更します。loadRangeコールバックのみで使用されます。 |
Type Definitions
GC.Spread.Views.DataView.hitTestInfoObjObject
hitTest結果を表すために使用されるオブジェクト。
Properties:
| Name | Type | Argument | Description | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
area |
string | 領域名。 |
|||||||||||||||||||||||||||||||||
row |
number | 行インデックス。groupInfoまたはnodeInfoが空でない場合は、groupInfoまたはnodeInfo内の行を使用してください。 |
|||||||||||||||||||||||||||||||||
column |
number |
<optional> |
行の列インデックス。groupInfoまたはnodeInfoが空でない場合は、groupInfoまたはnodeInfo内の列を使用してください。 |
||||||||||||||||||||||||||||||||
headerInfo |
object |
<optional> |
headerInfoオブジェクト。領域がcolumnHeaderの場合、詳細情報を含むheaderInfoオブジェクトが存在します。 Properties
|
||||||||||||||||||||||||||||||||
onTreeExpandToggle |
boolean |
<optional> |
これがツリー展開/折りたたみボタン上にあるかどうかを示します。このプロパティはグループ化が存在しない場合にのみ発生します。それ以外の場合、このプロパティはgroupInfoオブジェクト内にあります。 |
||||||||||||||||||||||||||||||||
isHierarchyFooter |
boolean |
<optional> |
これがツリーフッタ上にあるかどうかを示します。このプロパティはグループ化が存在しない場合にのみ発生します。それ以外の場合、このプロパティはgroupInfoオブジェクト内にあります。 |
||||||||||||||||||||||||||||||||
groupInfo |
Object |
<optional> |
グループが存在する場合のgroupInfoオブジェクト。 Properties
|
GC.Spread.Views.DataView.itemInfoObject
オブジェクト。
Properties:
| Name | Type | Description |
|---|---|---|
groupArea |
string | グループ領域。 |
group |
DataManagerGroup | グループインスタンス。 |
nodeArea |
string | ツリーノードの領域。 |
node |
DataManagerNode | ツリーノードのインスタンス。 |
item |
Object | 照会された行のデータ項目。 |
GC.Spread.Views.DataView.layoutInfoObject
キーとして領域名、値としてレイアウト情報を使用するオブジェクト。任意の領域を含めることができます。
Properties:
| Name | Type | Description |
|---|---|---|
areaName |
GC.Spread.Views.DataView.layoutInfoObj | 領域名。 |
GC.Spread.Views.DataView.layoutInfoObjObject
Properties:
| Name | Type | Description |
|---|---|---|
top |
number | コンテナーの左上隅から現在のビューポート矩形の左上隅までの垂直オフセット。 |
left |
number | コンテナーの左上隅から現在のビューポート矩形の左上隅までの水平オフセット。 |
height |
number | 現在のビューポート矩形の高さ。 |
width |
number | 現在のビューポート矩形の幅。 |
contentHeight |
number | 現在のビューポート矩形の内容領域の高さ。 |
contentWidth |
number | 現在のビューポート矩形の内容領域の幅。 |
GC.Spread.Views.DataView.renderInfoObjObject
ビューポートのレンダリング情報オブジェクトを表すために使用されるオブジェクト。
Properties:
| Name | Type | Description | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
outerDivStyle |
Object | 外側divに使用されるスタイルオブジェクト。 |
||||||||||||||||||||||||
outerDivCssClass |
Object | 外側divに使用されるクラスリスト。 |
||||||||||||||||||||||||
innerDivStyle |
Object | 内側divに使用されるスタイルオブジェクト。 |
||||||||||||||||||||||||
innerDivTranslate |
Object | 内側divの平行移動の設定に使用される平行移動オブジェクト。 Properties
|
||||||||||||||||||||||||
renderedRows |
Array.<Object> | 行のレンダリング情報のコレクション。 Properties
|
batchCallback(params)
このコールバックはRequesterクラスの一部として表示されています。
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
Object |
パラメーター。
|
Callback(params)
このコールバックはRequesterクラスの一部として表示されています。
Parameters:
| Name | Type | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
Object |
パラメーター。
|
createCallback(params)
このコールバックはRequesterクラスの一部として表示されています。
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
Object |
パラメーター。
|
CRUDactionObject
CRUD（create/update/delete）アクション。
Properties:
| Name | Type | Argument | Description |
|---|---|---|---|
type |
string | CRUDのタイプ。'create'、'update'、'delete'のいずれかになります。 |
|
dataItem |
Object | 操作するdataItem。タイプがupdateの場合は更新後の新しい項目。 |
|
index |
number |
<optional> |
dataItemの現在のビューでのインデックス。タイプがcreateの場合は存在しません。 |
oldDataItem |
Object |
<optional> |
更新前のdataItem。タイプがupdateの場合にのみ存在します。 |
dataSourceObject
データソースオブジェクト。
Properties:
| Name | Type | Argument | Description |
|---|---|---|---|
loadRange |
GC.Spread.Views.DataView~loadRangeCallback |
<nullable> |
loadRangeコールバック。dataViewでデータの更新が必要なときに呼び出されます。 |
create |
GC.Spread.Views.DataView~createCallback |
<nullable> |
createコールバック。dataViewの新しい項目を作成するときに呼び出されます。 |
update |
GC.Spread.Views.DataView~updateCallback |
<nullable> |
updateコールバック。dataViewの項目を編集するときに呼び出されます。 |
delete |
GC.Spread.Views.DataView~deleteCallback |
<nullable> |
deleteコールバック。dataViewの項目を削除するときに呼び出されます。 |
batch |
GC.Spread.Views.DataView~batchCallback |
<nullable> |
batchコールバック。バッチ編集モードで、ユーザーがsaveBatchEditを呼び出したときに呼び出されます。 |
batchEdit |
boolean | バッチ編集を使用するかどうかを決定します。バッチ編集モードが適用される場合、作成、更新、削除を実行してもサーバーデータはすぐには要求されず、ユーザーがsaveBatchEditを呼び出した後にバッチリクエストが送信されます。また、ユーザーがcancelBatchEditを呼び出すと元の状態に戻ります。 |
|
serverSideSort |
boolean | サーバー側でソートするかどうか。trueに設定されている場合、ローカルではソートできません。 |
|
serverSideFilter |
boolean | サーバー側でフィルタリングするかどうか。trueに設定されている場合、ローカルではフィルタリングできません。 |
deleteCallback(params)
このコールバックはRequesterクラスの一部として表示されています。
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
Object |
パラメーター。
|
formatCallback(args){string}
このコールバックはRequesterクラスの一部として表示されています。
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
args |
object |
書式設定関数が受け取る引数。
|
Returns: {string} 書式設定された値。
hierarchyOffsetCallback(node){number}
このコールバックはRequesterクラスの一部として表示されています。
Parameters:
| Name | Type | Description |
|---|---|---|
node |
dataManagerNode |
レンダリングするdataManagerノード。 |
Returns: {number} オフセット値（ピクセル単位）。
updateCallback(params)
このコールバックはRequesterクラスの一部として表示されています。
Parameters:
| Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
params |
Object |
パラメーター。
|
updateOverlayStatusCallback(args)
このコールバックが存在する場合、リモートサーバーからデータをロードするときにこのコールバックが呼び出されます。このコールバックが存在しない場合は、データをロードする前に組み込みのshowLoadingOverlayが呼び出され、データをロードした後にhideLoadingOverlayが呼び出されます。
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
args |
object |
コールバック関数が受け取る引数。
|
Events
GC.Spread.Views.DataView.#event:collectionChanged
ソート後、フィルタリング後、グループ化後など、データが変更された後に発生します。
Type:
- object
Properties:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
sender |
Object | このイベントを発生させたコントロールインスタンス。 |
||||||
args |
Object | イベントに役立つ引数を提供します。 Properties
|
columnChanged
ユーザーが列の表示/非表示設定、固定オプション、列の幅、または列グループの展開/折りたたみ状態をUIから変更したときに発生します。
Type:
- object
Properties:
| Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sender |
Object | このイベントを発生させたコントロールインスタンス。 |
|||||||||||||||
args |
Object | イベントに役立つ引数を提供します。 Properties
|
columnReorder
ユーザーが列のドラッグを開始したとき、列ヘッダにその列をドロップする前に発生します。
Type:
- object
Properties:
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sender |
Object | このイベントを発生させたコントロールインスタンス。 |
||||||||||||||||||
args |
Object | イベントに役立つ引数を提供します。 Properties
|
editing
Editingイベント。このイベントは、編集を開始する前、編集を開始した後、編集を終了する前、編集を終了した後、または編集をキャンセルしたときに発生します。
Type:
- object
Properties:
| Name | Type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sender |
Object | このイベントを発生させたコントロールインスタンス。 |
||||||||||||||||||||||||||||||
args |
Object | イベントに役立つ引数を提供します。 Properties
|
focusChanged
行フォーカス変更イベント。このイベントはGridLayoutまたはHorizontalLayoutで発生します。
Type:
- object
Properties:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
sender |
Object | このイベントを発生させたコントロールインスタンス。 |
|||||||||
args |
Object | イベントに役立つ引数を提供します。 Properties
|
grouping
ユーザーがUI操作によってグループを更新したときに発生します。このイベントは、実際の更新が行われる前に発生します。
Type:
- object
Properties:
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sender |
Object | このイベントを発生させたコントロールインスタンス。 |
||||||||||||||||||
args |
Object | イベントに役立つ引数を提供します。 Properties
|
rowClick
行がクリックされたときに発生します。
Type:
- object
Properties:
| Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sender |
Object | このイベントを発生させたコントロールインスタンス。 |
|||||||||||||||
args |
Object | イベントに役立つ引数を提供します。 Properties
|
rowDbClick
行がダブルクリックされたときに発生します。
Type:
- object
Properties:
| Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sender |
Object | このイベントを発生させたコントロールインスタンス。 |
|||||||||||||||
args |
Object | イベントに役立つ引数を提供します。 Properties
|
selectionChanged
ユーザーがUI操作によって選択を変更したときに発生します。
Type:
- object
Properties:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
sender |
object | このイベントを発生させたコントロールインスタンス。 |
|||||||||
args |
object | イベントに役立つ引数を提供します。 Properties
|