@refinitiv-ui/efx-grid 6.0.1 → 6.0.2

package/lib/core/es6/data/DataView.d.ts

@@ -1,11 +1,18 @@
 import Ext from "../../../tr-grid-util/es6/Ext.js";
 import DataCache from "./DataCache.js";
 import DataTable from "./DataTable.js";
+import WrappedView from "./WrappedView.js"; // eslint-disable-line
 import ColumnStats from "./ColumnStats.js";
 import EventDispatcher from "../grid/event/EventDispatcher.js";
 import Util from "../grid/util/util.js";
 import { Conflator } from "../../../tr-grid-util/es6/Conflator.js";
 
+declare namespace DataView {
+
+    type IDataView = DataTable|WrappedView|DataView;
+
+}
+
 declare class DataView extends EventDispatcher {
 
     constructor(source?: DataTable|DataView);
@@ -22,7 +29,9 @@ declare class DataView extends EventDispatcher {
 
     public getAllRowIds(shallowCopy?: boolean, inclNonDataRow?: boolean): (string)[];
 
-    public getSortedRowIds(opt_shallowCopy?: boolean): (string)[];
+    public getVisibleRowIds(shallowCopy?: boolean): (string)[];
+
+    public getSortedRowIds(shallowCopy?: boolean): (string)[];
 
     public getRowIndex(rid: string): number;
 
@@ -52,9 +61,9 @@ declare class DataView extends EventDispatcher {
 
     public removeRow(rowRef: number|string): void;
 
-    public removeRows(refs: (number|string)[]): void;
+    public removeRows(rowRefs: (number|string)[]): void;
 
-    public moveRow(fromIndex: (number)[]|number, toIndex: number): (string)[]|string;
+    public moveRow(fromRef: (number|string)[]|number|string, toRef: number|string): (string)[]|string;
 
     public swapRow(fromIndex: number, toIndex: number): void;
 
@@ -62,7 +71,7 @@ declare class DataView extends EventDispatcher {
 
     public getDataSource(): DataTable|DataView;
 
-    public setDataSource(source?: DataTable|DataView): void;
+    public setDataSource(source?: (DataTable|DataView)): void;
 
     public setConflationRate(milliSecond: number): void;
 
@@ -172,6 +181,8 @@ declare class DataView extends EventDispatcher {
 
     public isHidden(): boolean;
 
+    public isHiddenRow(rowId: string): boolean;
+
     public collapse(opt_collapsed?: boolean): void;
 
     public collapseAllGroups(opt_collapsed?: boolean): void;
@@ -182,8 +193,6 @@ declare class DataView extends EventDispatcher {
 
     public enableContentAsHeader(bool?: boolean): void;
 
-    public getVisibleRowIds(opt_shallowCopy?: boolean): (string)[];
-
     public getVisibleRowCount(): number;
 
     public isRowDataInGroup(rowData: any, groupID?: string): boolean;
@@ -260,6 +269,12 @@ declare class DataView extends EventDispatcher {
 
     public sortSegments(compare: ((...params: any[]) => any)): void;
 
+    public getWrapSize(): number;
+
+    public getWrappedViews(): (WrappedView)[];
+
+    public wrapView(wrapSize?: number): void;
+
     public dump(opt_options?: any): (any)[];
 
     public log(opt_options?: any): void;
@@ -268,7 +283,7 @@ declare class DataView extends EventDispatcher {
 
 }
 
-declare function len(fromIndex: number, toIndex: number): void;
+declare function fromRids(fromIndex: number, toIndex: number): void;
 
 declare function criteria(value: any|any[]): void;
 

package/lib/core/es6/data/DataView.js

@@ -1,11 +1,16 @@
 import Ext from "../../../tr-grid-util/es6/Ext.js";
 import DataCache from "./DataCache.js";
 import DataTable from "./DataTable.js";
+import WrappedView from "./WrappedView.js"; // eslint-disable-line
 import ColumnStats from "./ColumnStats.js";
 import EventDispatcher from "../grid/event/EventDispatcher.js";
 import Util from "../grid/util/util.js";
 import { Conflator } from "../../../tr-grid-util/es6/Conflator.js";
 
+/** @typedef {DataTable|WrappedView|DataView} DataView~IDataView
+* @description DataView like classes
+*/
+
 /** @event DataView#dataChanged
 * @description Trigger when data within the data view has been changed. Not only actual change in data, but also position change will trigger this event.
 * @property {boolean} globalChange Indicates a big change. User should expect all data has been change. With active sorting or filtering, this flag will always be true due to multiple changes in row position.
@@ -40,6 +45,14 @@ import { Conflator } from "../../../tr-grid-util/es6/Conflator.js";
 * @description Fired once before actual row filtering (before multiple execution of filter logic). This allow optimization by preparing data needed for the filtering
 * @type {Object}
 */
+/** @event DataView#wrapCountChanged
+* @property {number} prevCount
+* @property {number} newCount
+*/
+/** @event DataView#wrapSizeChanged
+* @property {number} wrapSize
+* @property {Array.<string>} rids
+*/
 
 /** DataView doesn't hold the actual data. It is just a transform view (by applying filtering or sorting) of the data from the {@link DataTable}
 * @constructor
@@ -56,6 +69,7 @@ var DataView = function(source) {
 	t._onGroupAdded = t._onGroupAdded.bind(t);
 	t._onBeforeGroupAdded = t._onBeforeGroupAdded.bind(t);
 	t._onRefreshTimeout = t._onRefreshTimeout.bind(t);
+	t._updateWrapCount = t._updateWrapCount.bind(t);
 
 	t._rids = [];
 	t._sortingDefs = [];
@@ -72,7 +86,9 @@ var DataView = function(source) {
 		"groupAdded",
 		"beforeGroupAdded",
 		"groupCriteriaChanged",
-		"beforeFiltering"
+		"beforeFiltering",
+		"wrapCountChanged",
+		"wrapSizeChanged"
 	);
 
 	t.setDataSource(source);
@@ -251,9 +267,21 @@ DataView.prototype._showOnlyFirstMember = false;
 */
 DataView.prototype._beingAdded = false;
 /** @private
-* @type {Conflator | null}
+* @type {Conflator}
 */
 DataView.prototype._conflator = null;
+/** @private
+* @type {Array.<WrappedView>}
+*/
+DataView.prototype._wrappedViews = null;
+/** @private
+* @type {number}
+*/
+DataView.prototype._wrapSize = 0;
+/** @private
+* @type {number}
+*/
+DataView.prototype._wrapTimerId = 0;
 
 /** @public
 * @fires DataView#preDisposed
@@ -262,6 +290,8 @@ DataView.prototype.dispose = function() {
 	this._dispatch("preDisposed", {});
 
 	this.unlistenAll();
+	this.wrapView(0);
+
 	this.setDataSource(null); // Remove this._dt and this._parent. WARNING: an event is fired
 	this.groupBy(null); // Remove this._groupCriteria, this._groupRows and all of its children. WARNING: an event is fired
 
@@ -271,6 +301,10 @@ DataView.prototype.dispose = function() {
 
 	this._userFilter = this._groupSortingLogic = null;
 
+	if(this._wrapTimerId) {
+		clearTimeout(this._wrapTimerId);
+		this._wrapTimerId = 0;
+	}
 	if(this._refreshTimerId) {
 		clearTimeout(this._refreshTimerId);
 		this._refreshTimerId = 0;
@@ -344,7 +378,7 @@ DataView.prototype._toRowId = function(rowRef) {
 };
 /** @private
 * @param {Array.<number|string>} rowRefs
-* @return {Array.<string>}
+* @return {!Array.<string>}
 */
 DataView.prototype._toRowIds = function(rowRefs) {
 	var rowCount = Array.isArray(rowRefs) ? rowRefs.length : 0;
@@ -361,14 +395,15 @@ DataView.prototype._toRowIds = function(rowRefs) {
 	}
 	return ary;
 };
-/** Return all row ids with row data, excluding the group header rows (auto generated rows).<br>
-* Do use getAllRowData to retrieve all data
+/** Return all row ids with row data, excluding the group header rows (auto generated rows).
 * @public
-* @param {boolean=} shallowCopy Default value is false. Set to true for speed
-* @param {boolean=} inclNonDataRow=false If enabled, group header rows are included
+* @param {boolean=} shallowCopy=false If enabled, no new copy of Array is created (better for performance).
+* @param {boolean=} inclNonDataRow=false If enabled, group header rows are included. In pagination mode, this flag will always be true.
 * @return {!Array.<string>}
 * @see {@link DataView#getAllRowData}
 * @see {@link DataView#getMultipleRowData}
+* @see {@link DataView#getSortedRowIds}
+* @see {@link DataView#getVisibleRowIds}
 */
 DataView.prototype.getAllRowIds = function(shallowCopy, inclNonDataRow) {
 	this._rebuildRowIdsFromChildren();
@@ -378,17 +413,26 @@ DataView.prototype.getAllRowIds = function(shallowCopy, inclNonDataRow) {
 
 	return (shallowCopy) ? rids : rids.slice(0); // Fastest way to clone an array is Array.slice()
 };
+/** This method returns current visible rows (i.e. Rows in other pages or in collapsed groups are excluded). Group header rows may be included in the results.
+* @public
+* @param {boolean=} shallowCopy=false If enabled, no new copy of Array is created (better for performance).
+* @return {!Array.<string>}
+* @see {@link DataView#getAllRowData}
+*/
+DataView.prototype.getVisibleRowIds = function(shallowCopy) {
+	this._rebuildRowIdsFromChildren();
+	var rids = this._getRids();
+	return shallowCopy ? rids : rids.slice(0); // Fastest way to clone an array
+};
 /** Return all data rows that is filtered and sorted, excluding header rows or paging. This method ignores pagination.
 * @public
-* @param {boolean=} opt_shallowCopy Default value is false. Set to true for speed
+* @param {boolean=} shallowCopy=false If enabled, no new copy of Array is created (better for performance).
 * @return {!Array.<string>}
+* @see {@link DataView#getAllRowData}
 */
-DataView.prototype.getSortedRowIds = function(opt_shallowCopy) {
+DataView.prototype.getSortedRowIds = function(shallowCopy) {
 	this._rebuildRowIdsFromChildren();
-	if(opt_shallowCopy) {
-		return this._rids;
-	}
-	return this._rids.slice(0); // Fastest way to clone an array
+	return shallowCopy ? this._rids : this._rids.slice(0); // Fastest way to clone an array
 };
 /** This method is quite slow
 * @public
@@ -532,7 +576,7 @@ DataView.prototype.insertRow = function(rowRef, opt_values, opt_rid) { // Data c
 	return "";
 };
 
-/** Permanently remove the specified row by row id or DataView's row index. If you want to temporarily remove the row, use {@link DataView.hideRows} instead
+/** Permanently remove the specified row by row id or DataView's row index. If you want to temporarily remove the row, use {@link DataView#hideRows} instead
 * @public
 * @param {number|string} rowRef
 * @fires DataView#dataChanged
@@ -542,42 +586,30 @@ DataView.prototype.removeRow = function(rowRef) {
 		this._dt.removeRow(this._toRowId(rowRef)); // Trigger dataChanged
 	}
 };
-/** Permanently remove the specified rows by row id or DataView's row index. If you want to temporarily remove the rows, use {@link DataView.hideRows} instead
+/** Permanently remove the specified rows by row id or DataView's row index. If you want to temporarily remove the rows, use {@link DataView#hideRows} instead
 * @public
-* @param {Array.<number|string>} refs
+* @param {Array.<number|string>} rowRefs
 */
-DataView.prototype.removeRows = function(refs) {
-	if(!this._dt) { return; }
-	for(var i = refs.length; --i >= 0;) {
-		var rowRef = refs[i];
-		if(typeof rowRef === "number") {
-			refs[i] = this.getRowId(rowRef);
-		}
+DataView.prototype.removeRows = function(rowRefs) {
+	if(this._dt) {
+		this._dt.removeRows(this._toRowIds(rowRefs)); // Trigger dataChanged
 	}
-	this._dt.removeRows(refs); // Trigger dataChanged
 };
-/** Move a single row or multiple rows to the position BEFORE the specified index (toIndex).
+/** Move a single row or multiple rows to the position BEFORE the specified target row.
 * @public
-* @param {Array.<number>|number} fromIndex fromIndex could be a rowIndex or array of rowIndex.
-* @param {number} toIndex
+* @param {Array.<number|string>|number|string} fromRef The value could be row index, row id, or array of row indices or row ids.
+* @param {number|string} toRef Destination target could be row index or row id
 * @return {Array.<string>|string} rid rowId or array of the rowId of the moved row(s)
 * @example
 * ary = [0, 1, 2];
 * move(ary, 0, 1); // [0, 1, 2] Move index 0 to the position before index 1 (nothing is changed)
 * move(ary, 1, 0); // [1, 0, 2] Move index 1 to the position before index 0
 */
-DataView.prototype.moveRow = function(fromIndex, toIndex) {
-	this._rebuildRowIdsFromChildren();
-	var rids = this._getRids();
+DataView.prototype.moveRow = function(fromRef, toRef) {
+	var toRid = this._toRowId(toRef);
 
-	var toRid = (toIndex >= 0 && toIndex < rids.length) ? rids[toIndex] : "";
-
-	var fromIndices = /** @type{Array.<number>} */(Array.isArray(fromIndex) ? fromIndex : [fromIndex]);
-	var len = fromIndices.length;
-	var fromRids = new Array(len);
-	for(var i = 0; i < len; ++i) {
-		fromRids[i] = rids[fromIndices[i]];
-	}
+	var fromIndices = /** @type{!Array.<number|string>} */(Array.isArray(fromRef) ? fromRef : [fromRef]);
+	var fromRids = this._toRowIds(fromIndices);
 
 	if(this._dt.hasSegmentation()) {
 		this.synchronizeRowOrder();
@@ -611,7 +643,7 @@ DataView.prototype.getDataSource = function() {
 	return this._parent;
 };
 /** @public
-* @param {DataTable|DataView=} source
+* @param {(DataTable|DataView)=} source
 * @fires DataView#dataChanged
 */
 DataView.prototype.setDataSource = function(source) {
@@ -1095,7 +1127,7 @@ DataView.prototype.setPageSize = function (pageSize) {
 	this._dispatchGlobalChange();
 };
 
-/** string|function(Object.<string, *>):string|null
+/** Group all rows by the specified criteria. The criteria can be field name (field value will be used as a group id) or a function that takes row data and returns group id.
 * @public
 * @param {string|Function|Array.<string|Function>} cid Column id or grouper method that take one parameter for row data in JSON format, and returns groupId (string)
 * @param {Array=} opt_predefinedGroups
@@ -1606,6 +1638,17 @@ DataView.prototype.hide = function(opt_hidden) {
 DataView.prototype.isHidden = function() {
 	return this._hidden;
 };
+/** @public
+* @param {string} rowId
+* @return {boolean} Returns true when this row is hidden
+*/
+DataView.prototype.isHiddenRow = function(rowId) {
+	if(this._hiddenRids) {
+		return this._hiddenRids[rowId] === true;
+	}
+	return false;
+};
+
 /** @private
 * @return {boolean}
 */
@@ -1714,14 +1757,7 @@ DataView.prototype._getFirstHiddenRids = function() {
 	}
 	return null;
 };
-/** This method returns current visible rows (i.e. it excludes rows that are not in current page, and are in collapsed groups). Group header rows are also includes in the results.
-* @public
-* @param {boolean=} opt_shallowCopy Default value is false. Set to true for speed
-* @return {!Array.<string>}
-*/
-DataView.prototype.getVisibleRowIds = function(opt_shallowCopy) {
-	return this.getAllRowIds(opt_shallowCopy, true);
-};
+
 /** This will not include collapsed group and rows
 * @public
 * @return {number}
@@ -2454,6 +2490,95 @@ DataView.prototype.sortSegments = function (compare) {
 	this._dt.sortSegments(compare);
 };
 
+/** @public
+* @ignore
+* @return {Object}
+*/
+DataView.prototype._getSharedObject = function () {
+	return this._shared;
+};
+/** Return 0, if there is no wrapping
+* @public
+* @return {number}
+*/
+DataView.prototype.getWrapSize = function () {
+	return this._wrapSize;
+};
+/** Return null, if there is no wrapping
+* @public
+* @return {Array.<WrappedView>}
+*/
+DataView.prototype.getWrappedViews = function () {
+	return this._wrappedViews;
+};
+/**
+* @public
+* @param {number=} wrapSize
+* @fires DataView#wrapCountChanged
+*/
+DataView.prototype.wrapView = function (wrapSize) {
+	if(wrapSize != null) {
+		if(!wrapSize || wrapSize < 0) {
+			wrapSize = 0;
+		}
+		if(this._wrapSize !== wrapSize) {
+			this._wrapSize = wrapSize;
+			this._dispatch("wrapSizeChanged", {
+				"wrapSize": wrapSize,
+				"rids": this.getVisibleRowIds(true)
+			});
+		}
+	}
+	this._updateWrapCount();
+};
+
+/** @private
+* @fires DataView#wrapCountChanged
+*/
+DataView.prototype._updateWrapCount = function () {
+	this._wrapTimerId = 0;
+	var wrapSize = this._wrapSize;
+
+	var i;
+	var views = this._wrappedViews;
+	var viewCount = views ? views.length : 0;
+	var targetCount = 0;
+	if(wrapSize) {
+		var rids = this.getVisibleRowIds(true);
+		var rowCount = rids.length;
+		targetCount = Math.ceil(rowCount / wrapSize);
+		if(viewCount < targetCount) {
+			if(!views) {
+				views = this._wrappedViews = [];
+			}
+			for(i = viewCount; i < targetCount; ++i) {
+				this._wrappedViews[i] = new WrappedView({
+					"dataView": this,
+					"wrapIndex": i,
+					"rids": rids
+				});
+			}
+		}
+	}
+
+	if(targetCount < viewCount) {
+		for(i = viewCount; --i >= targetCount;) {
+			this._wrappedViews[i].dispose();
+		}
+		this._wrappedViews.length = targetCount;
+	}
+	if(!wrapSize) {
+		this._wrappedViews = null;
+	}
+
+	if(viewCount !== targetCount) {
+		this._dispatch("wrapCountChanged", {
+			"prevCount": viewCount,
+			"newCount": targetCount
+		});
+	}
+};
+
 /** Construct a JSON object that is compatible with console.table()
 * @public
 * @param {Object=} opt_options {@link DataCache#dump}
@@ -3291,6 +3416,9 @@ DataView.prototype._dispatchGlobalChange = function() {
 */
 DataView.prototype._dispatchDataChange = function(evtArgument) {
 	this._dispatch("dataChanged", evtArgument);
+	if(this._wrapSize && !this._wrapTimerId) {
+		this._wrapTimerId = setTimeout(this._updateWrapCount);
+	}
 };
 
 /** @private
@@ -3648,7 +3776,6 @@ DataView._defaultGroupSortingLogic = function(strA, strB) {
 	return (strA < strB) ? -1 : 1;
 };
 
-DataView._proto = DataView.prototype;
 
 export default DataView;
 export { DataView };