Spread.Views-Class: DataManager

dataManager.js, line 163

DataManagerの新しいインスタンスを初期化します。

Parameters:

Name	Type	Description
`sourceCollection`	Array	データソースの配列。
`columnDefs`	Array	オプションのDataView列定義を示すオブジェクトの配列。

Properties:

Name	Type	Argument	Description
`sourceCollection`	Array		データソースの配列。このプロパティは読み取り専用です。
`itemCount`	Number		項目数。このプロパティは読み取り専用です。
`expandedItemCount`	Number		展開されている項目の数。常にitemCount未満になります。このプロパティは読み取り専用です。
`collectionChanged`	Event		データコレクションの変更イベント。
`filterExpression`	string \| GC.Spread.Views.DataView.DataManager#filterCallback		フィルタに適用する数式文字列。
`filterDescriptors`	Array	<nullable>	GC.Spread.Views.DataView.DataManager.filterDescriptorの配列またはフィルタ記述子を含む文字列の配列。
`sortDescriptors`	Array	<nullable>	GC.Spread.Views.DataView.DataManager.sortDescriptorの配列またはソート記述子を含む文字列の配列。
`isSortStable`	boolean		安定ソートを使用するかどうかを示すフラグ。これはソートのパフォーマンスに影響を与える場合があります。
`groupDescriptors`	Array	<nullable>	GC.Spread.Views.DataView.DataManager.groupDescriptorの配列またはグループ記述子を含む文字列の配列。
`groups`	Array	<nullable>	グループツリーの最初のレベルにあるデータマネージャグループを含むGC.Spread.Views.DataView.DataManager.DataManagerGroupの配列。
`rootGroup`	GC.Spread.Views.DataView.DataManager.DataManagerGroup	<nullable>	グループツリーを含むダミーのルートグループ。
`hierarchyDescriptor`	GC.Spread.Views.DataView.DataManager.hierarchyDescriptor	<nullable>	階層記述子オブジェクト。
`nodes`	Array	<nullable>	ノードツリーの最初のレベルにあるデータマネージャノードを含むGC.Spread.Views.DataView.DataManager.DataManagerNodeの配列。
`rootNode`	GC.Spread.Views.DataView.DataManager.DataManagerNode	<nullable>	ノードツリーを含むダミーのルートノード。
`isHierarchical`	boolean		コレクションが階層的かどうかを示すフラグ。
`pageController`	GC.Spread.Views.DataView.DataManager.pageController	<nullable>	ページングコンポーネントの使用時にページの移動に使用されるコントローラー。

Classes

DataManagerGroup

DataManagerNode

Methods

dataManager.js, line 249

addCalculatedField(name, formula)

計算フィールドをコレクションに追加します。

Parameters:

Name	Type	Description
`name`	string	計算フィールドの名前。
`formula`	string	計算フィールドの数式。

dataManager.js, line 299

editCalculatedColumn(column, newFormula)

指定した計算列に新しい数式を設定します。

Parameters:

Name	Type	Description
`column`	string	計算列の名前。
`newFormula`	string	nullable 新しい数式の文字列。

dataManager.js, line 307

editCalculatedField(name, newFormula)

指定した計算フィールドに新しい数式を設定します。

Parameters:

Name	Type	Description
`name`	string	計算フィールドの名前。
`newFormula`	string	nullable 新しい数式の文字列。

dataManager.js, line 278

evaluate(formula, groupPath, hierarchyPath)

指定した評価コンテキストを使用して数式を評価します。

Parameters:

Name	Type	Description
`formula`	string	評価する数式。
`groupPath`	Array.<Number>	nullable 評価コンテキストとして使用するグループパス。
`hierarchyPath`	Array.<Number>	nullable 評価コンテキストとして使用する階層パス。

dataManager.js, line 227

filter(expression){Object}

指定した式を使用してデータ項目をフィルタリングします。

Parameters:

Name	Type	Description
`expression`	string	フィルタリング条件式。

Returns: {Object} フィルタの書き込みをサポートするフィルタオブジェクト。

dataManager.js, line 240

getCalculatedColumnValues(name)

指定した計算列のすべての計算結果を含む配列を取得します。

Parameters:

Name	Type	Description
`name`	string	計算列の名前。

dataManager.js, line 262

getCalculatedFields()

すべての計算フィールドオブジェクトを含む配列を取得します。

dataManager.js, line 269

getCalculatedFieldValue(name)

指定した計算フィールドの値を取得します。

Parameters:

Name	Type	Description
`name`	string	計算フィールドの名前。

dataManager.js, line 194

getGroup(groupPath)

子グループのパスを取得します。

Parameters:

Name	Type	Description
`groupPath`	Array	グループのパスを示す配列。

dataManager.js, line 173

getItem(viewIndex, getAllInGroup, getAllInTree)

指定した表示行インデックスにある行項目オブジェクトを取得します。

Parameters:

Name	Type	Default	Description
`viewIndex`	Number		ビュー内の行インデックス。
`getAllInGroup`	boolean	false	optional falseの場合、折りたたまれたグループの項目はカウントされません。
`getAllInTree`	boolean	false	optional falseの場合、折りたたまれたツリーノードの項目はカウントされません。

dataManager.js, line 179

getItems()

コレクションに含まれるすべての表示項目を取得します。

dataManager.js, line 187

getNode(groupPath, nodePath)

パスによって子グループまたはノードを取得します。

Parameters:

Name	Type	Description
`groupPath`	Array	グループのパスを示す配列。
`nodePath`	Array	ノードのパスを示す配列。

dataManager.js, line 210

insertDataItems(dataItems, insertAt)

ソースコレクション内の指定した行インデックス位置に新しいデータ項目を追加し、DataManagerを更新します。

Parameters:

Name	Type	Description
`dataItems`	Object \| Array	追加するデータ項目を示すObjectまたはオブジェクトの配列。
`insertAt`	index	nullable データソース内の追加する位置を示す行インデックス。デフォルトは最後のインデックスです。

dataManager.js, line 285

isCalculatedColumn(column)

列が既存の計算列かどうかをチェックします。

Parameters:

Name	Type	Description
`column`	string	検査する列の名前。

dataManager.js, line 358

isModifiedRow(sourceIndex){Boolean}

行の値が変更されたかどうかを示します。

Parameters:

Name	Type	Description
`sourceIndex`	number	データソースでのインデックス。

Returns: {Boolean} 値が変更された場合はtrue、それ以外の場合はfalseを返します。

Example

// ソースインデックスを取得するには、まずDataViewインスタンスのgetItemメソッドを呼び出し、 
// 返されたitemInfoオブジェクトをチェックします。 
// itemInfo.itemがnullでない場合は、そこから直接sourceIndexを取得します。 
// itemInfo.itemがnullで、itemInfo.groupがnullでない場合は、 
// DataManagerGroupオブジェクトのgetSourceRowIndexメソッドを呼び出してソースインデックスを取得します。 
// itemInfo.nodeがnullでない場合は、DataManagerNodeオブジェクトのgetSourceRowIndexメソッドを呼び出して 
// ソースインデックスを取得します。

var hitInfo = dataView.hitTest(mouseEvent);
if(hitInfo){
    var rowId = dataView.getRowId(hitInfo);
    var itemInfo = dataView.getItem(rowId);
    if(itemInfo){
        // itemInfo.item.sourceIndexからソースインデックスを取得します。
    }
}

dataManager.js, line 332

isNewAddedRow(sourceIndex){Boolean}

行が新しく追加された行かどうかを示します。

Parameters:

Name	Type	Description
`sourceIndex`	number	データソースでのインデックス。

Returns: {Boolean} 新しく追加された行の場合はtrue、それ以外の場合はfalseを返します。

dataManager.js, line 325

isRefreshSuspended()

コレクションの更新が中断されているかどうかをチェックします。

dataManager.js, line 291

reCalculate()

コレクションに含まれるすべての計算ノード（すべての計算列または計算フィールドを含む）を再計算します。

dataManager.js, line 233

refresh()

コレクションを最新の状態に更新します。

dataManager.js, line 256

removeCalculatedField(name)

コレクションから計算フィールドを削除します。

Parameters:

Name	Type	Description
`name`	string	削除する計算フィールドの名前。

dataManager.js, line 219

removeDataItems(removeAt, count)

ソースコレクション内の指定したソース行インデックスからデータ項目を削除します。

Parameters:

Name	Type	Description
`removeAt`	Number	ソースコレクション内の行インデックス。
`count`	Number	nullable 削除する行数。

dataManager.js, line 363

removeEmptyGroup()

古いグループ構造をクリアします。

dataManager.js, line 319

resumeRefresh()

コレクションの更新を再開します。

dataManager.js, line 313

suspendRefresh()

コレクションの更新を中断します。

dataManager.js, line 202

updateItem(sourceIndex, newItem)

指定したインデックスにある項目を更新します。

Parameters:

Name	Type	Description
`sourceIndex`	number	ソースインデックス。
`newItem`	object	古い項目を置き換える新しいオブジェクト。

Type Definitions

GC.Spread.Views.DataView.DataManager.filterDescriptor

Properties:

Name	Type	Description
`field`	string	ソートするフィールド。
`operator`	string	フィルタタイプを示します。'equal'、'notEqual'、'greaterThan'、'greaterThanAndEqual'、'lessThan'、'lessThanAndEqual'、'memberOf'、'notMemberOf'のいずれかを指定できます。
`value`	Object \| Array \| string \| number	'memberOf'または'notMemberOf'の使用時に比較する値。配列（不連続な集合）または文字列（連続的な集合）を指定できます。たとえば、[1,2,3,4]は左辺の値が1、2、3、4のいずれかに一致する場合を意味し、'(1, 4]'は左辺の値が1より大きくて4以下である場合を意味します。

GC.Spread.Views.DataView.DataManager.groupDescriptor

GC.Spread.Views.DataView.DataManager.hierarchyDescriptor

GC.Spread.Views.DataView.DataManager.itemArg

GC.Spread.Views.DataView.DataManager~filterCallbackおよびGC.Spread.Views.DataView.DataManager~sortCallbackに使用される項目オブジェクト

Properties:

Name	Type	Argument	Description
`dataItem`	Object		項目引数のデータ部分。
`calculatedItem`	Object	<nullable>	項目引数の計算される部分。

GC.Spread.Views.DataView.DataManager.pageController

Properties:

Name	Type	Description
`first`	function	最初のページに移動します。
`previous`	function	前のページに移動します。
`next`	function	次のページに移動します。
`last`	function	最後のページに移動します。
`goToPage`	function	特定のページに移動します。必要なパラメーターはページインデックスのみです。
`getStatus`	function	pageIndex、pageSize、maxPages、maxItemsを含む現在のページステータスを返します。
`statusChanged`	Event	pageControllerのステータスが変更されたときに発生します。イベント引数は最新ステータスです。

GC.Spread.Views.DataView.DataManager.sortDescriptor

Properties:

Name	Type	Argument	Default	Description
`field`	string			ソートするフィールド。
`ascending`	boolean	<optional> <nullable>	true	ソート順序を示します。デフォルト値はtrueです。
`converter`	GC.Spread.Views.DataView.DataManager~sortConverter	<optional> <nullable>		ソート用のコンバータコールバック（GC.Spread.Views.DataView.DataManager#sortConverter）。

dataManager.js, line 434

filterCallback(value){boolean}

このコールバックはRequesterクラスの一部として表示されています。フィルタのカスタマイズに使用されます。

Parameters:

Name	Type	Description
`value`	GC.Spread.Views.DataView.DataManager.itemArg	フィルタリングする行項目。

Returns: {boolean} フィルタのステータス。

dataManager.js, line 451

groupConverter(value){*}

このコールバックはRequesterクラスの一部として表示されています。

Parameters:

Name	Type	Description
`value`	*	グループ化する生の値。

Returns: {*} 変換後の値。

dataManager.js, line 443

sortConverter(value){*}

このコールバックはRequesterクラスの一部として表示されています。

Parameters:

Name	Type	Description
`value`	*	ソートする生の値。