@refinitiv-ui/efx-grid 6.0.158 → 6.0.159

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

@@ -1,6 +1,6 @@
 import Ext from "../../../tr-grid-util/es6/Ext.js";
 import EventDispatcher from "../../../tr-grid-util/es6/EventDispatcher.js";
-import Segment from "./Segment.js";
+import { Segment, UNCATEGORY } from "./Segment.js";
 
 /** @constructor
 * @extends {EventDispatcher}
@@ -42,7 +42,7 @@ SegmentCollection.prototype._shared;
 /** @type {Array.<Segment>}
 * @private
 */
-SegmentCollection.prototype._segmentList = null; // Array of main segments
+SegmentCollection.prototype._segmentList = null; // Array of main/root segments
 /** @type {Array.<Segment>}
 * @private
 */
@@ -59,6 +59,10 @@ SegmentCollection.prototype._classification = false;
 * @private
 */
 SegmentCollection.prototype._classifierChanged = false;
+/** @type {Object.<string, number>}
+* @private
+*/
+SegmentCollection.prototype._rowOrders = null;
 
 /** @public
 */
@@ -66,7 +70,7 @@ SegmentCollection.prototype.dispose = function() {
 	this.removeAllSegments();
 	this.removeAllEventListeners();
 	this._collapsedRids = null;
-	this._segmentList = this._insertionList = this._removalList = null;
+	this._segmentList = this._rowOrders = this._insertionList = this._removalList = null;
 };
 /** @public
 * @param {string} rid
@@ -79,7 +83,7 @@ SegmentCollection.prototype.addSegment = function(rid, childRids) {
 		segment.addEventListener("subSegmentAdded", this._onSubSegmentAdded);
 		segment.addEventListener("subSegmentRemoved", this._onSubSegmentRemoved);
 		++this._segmentCount;
-		this._segmentList = null; // order could be changed
+		this.invalidateSegmentOrder(); // order could be changed
 
 		if(childRids && childRids.length) {
 			segment.addChildren(childRids);
@@ -155,6 +159,7 @@ SegmentCollection.prototype.removeSegment = function(rid) {
 
 	delete this._segments[rid]; // Slow
 	--this._segmentCount;
+	this.invalidateSegmentOrder();
 	return true;
 };
 /** @public
@@ -167,7 +172,7 @@ SegmentCollection.prototype.removeAllSegments = function() {
 		}
 		this._segments = {};
 		this._segmentCount = 0;
-		this._segmentList = null;
+		this._segmentList = this._rowOrders = null;
 		this._shared.segments = this._segments;
 		this._shared.childToSegment = {};
 
@@ -228,6 +233,7 @@ SegmentCollection.prototype.sortSegments = function(comparer) {
 		}
 	}
 	rootSegments.sort(comparer);
+	this.invalidateSegmentOrder();
 	return rootSegments;
 };
 
@@ -323,28 +329,14 @@ SegmentCollection.prototype.getCollapsedRows = function() {
 	return this._collapsedRids;
 };
 
-/** Invalidate segment order cache, if the given row id is a segment separator
-* @private
-* @param {string|Array.<string>} segmentIds
+/** Invalidate segment order cache
+* @public
 * @returns {boolean} Returns true if there is any change
 */
-SegmentCollection.prototype._invalidateSegmentOrder = function(segmentIds) {
+SegmentCollection.prototype.invalidateSegmentOrder = function() {
 	if(this._segmentList) {
-		if(typeof segmentIds === "string") {
-			if(this._segments[segmentIds]) {
-				this._segmentList = null;
-				return true;
-			}
-		} else if(Array.isArray(segmentIds)) {
-			let len = segmentIds.length;
-			for(let i = 0; i < len; ++i) {
-				let segmentId = segmentIds[i];
-				if(this._segments[segmentId]) {
-					this._segmentList = null;
-					return true;
-				}
-			}
-		}
+		this._segmentList = this._rowOrders = null;
+		return true;
 	}
 	return false;
 };
@@ -358,7 +350,7 @@ SegmentCollection.prototype.addSegmentChild = function(segmentId, rid, dataId) {
 	let segment = this._segments[segmentId];
 	if(segment && !segment.isSubSegment()) {
 		// If a segment becomes a child of other segment, then the segment order needs to be recalculated
-		this._invalidateSegmentOrder(rid);
+		this.invalidateSegmentOrder();
 		return segment.addChild(rid, dataId);
 	}
 	return false;
@@ -373,7 +365,7 @@ SegmentCollection.prototype.addSegmentChildren = function(segmentId, rids, dataI
 	let segment = this._segments[segmentId];
 	if(segment && !segment.isSubSegment()) {
 		// If a segment becomes a child of other segment, then the segment order needs to be recalculated
-		this._invalidateSegmentOrder(rids);
+		this.invalidateSegmentOrder();
 		return segment.addChildren(rids, dataIds);
 	}
 	return false;
@@ -399,7 +391,7 @@ SegmentCollection.prototype.containsSegmentChild = function(segmentId, rid) {
 SegmentCollection.prototype.removeSegmentChild = function(segmentId, rid) {
 	let segment = this._segments[segmentId];
 	if(segment) {
-		this._invalidateSegmentOrder(rid);
+		this.invalidateSegmentOrder();
 		return segment.removeChild(rid);
 	}
 	return false;
@@ -412,7 +404,7 @@ SegmentCollection.prototype.removeSegmentChild = function(segmentId, rid) {
 SegmentCollection.prototype.removeSegmentChildren = function(segmentId, rids) {
 	let segment = this._segments[segmentId];
 	if(segment) {
-		this._invalidateSegmentOrder(rids);
+		this.invalidateSegmentOrder();
 		return segment.removeChildren(rids);
 	}
 	return false;
@@ -432,7 +424,7 @@ SegmentCollection.prototype.removeAllSegmentChildren = function() {
 	}
 
 	if(dirty) {
-		this._segmentList = null; // WARNING: not optimized
+		this.invalidateSegmentOrder();
 		this.classify(null);
 	}
 
@@ -462,6 +454,7 @@ SegmentCollection.prototype.fillSegment = function(segmentId, rids) {
 				}
 				curSegment.addChild(rid);
 			}
+			this.invalidateSegmentOrder();
 		}
 	}
 };
@@ -487,8 +480,19 @@ SegmentCollection.prototype.fillSegments = function(rids) {
 			change = true;
 		}
 	}
+	if(change) {
+		this.invalidateSegmentOrder();
+	}
 	return change;
 };
+
+/** The number represent maximum nested segments that can be created in a single segment
+* @private
+* @type {number}
+* @constant
+*/
+const SEGMENT_STEP = 10000;
+
 /** @public
 * @param {Array.<string>} rids
 * @param {boolean=} useCache=false If this is true, skip the calculation when there is already a cache for segment order
@@ -504,21 +508,29 @@ SegmentCollection.prototype.calcSegmentOrder = function(rids, useCache) {
 		segmentList = this._segmentList = [];
 	}
 
-	let ridCount = rids ? rids.length : 0;
+	this._rowOrders = {};
+	let rowOrders = this._rowOrders;
 	let segmentSeparators = this._segments;
-	let segmentCount = this._segmentCount;
+	let childToSegmentId = this._shared.childToSegment;
+	let prevSeg = UNCATEGORY;
+	let ridCount = rids ? rids.length : 0;
 	let order = 0;
 	for(let i = 0; i < ridCount; ++i) {
 		let rid = rids[i];
-		let segment = segmentSeparators[rid];
-		if(segment) {
-			if(segment.isRootSegment()) {
-				this._segmentList.push(segment);
-				segment.setOrder(++order); // WARNING: Segments and sub segments start with 1
-				segment.updateTreeStructure(0);
+		if(!childToSegmentId[rid]) {
+			let segment = segmentSeparators[rid];
+			let segmentId = (segment) ? segment.getId() : UNCATEGORY;
+			if(prevSeg !== segmentId) {
+				++order; // WARNING: Segments and sub segments start with 1
+				prevSeg = segmentId;
 			}
-			if(--segmentCount <= 0) {
-				break;
+
+			let rootOrder = order * SEGMENT_STEP;
+			rowOrders[rid] = rootOrder;
+			if(segment) {
+				this._segmentList.push(segment);
+				segment.setOrder(rootOrder);
+				segment.updateTreeStructure(0, rootOrder, rowOrders);
 			}
 		}
 	}
@@ -527,57 +539,33 @@ SegmentCollection.prototype.calcSegmentOrder = function(rids, useCache) {
 * @param {!Array.<string>} rids Array of row ids
 * @param {boolean=} partial Indicating that the given ids are not the whole list
 * @return {Array.<number>} Returns Array of segment values, if there are at least one segment, otherwise returns null
-*/ //
+*/
 SegmentCollection.prototype.getSegmentValues = function(rids, partial) {
 	let rowCount = rids ? rids.length : 0;
 	if(!rowCount) {
 		return null;
 	}
-	let segmentSeparators = this._segments;
-	let childToSegmentId = this._shared.childToSegment;
-	let curSegment = null;
-	let prevSegment = null;
+	let rowOrders = this._rowOrders;
+	if(!rowOrders) { // calcSegmentOrder has not been called (no cache detected)
+		return null;
+	}
+
 	let segmentValues = new Array(rowCount);
-	let segmentVal = 0;
 	let highestVal = 0;
-	let offset = 0;
 	for(let r = 0; r < rowCount; ++r) {
 		let rid = rids[r];
-		curSegment = segmentSeparators[rid];
-		if(curSegment) { // segment separator
-			segmentVal = curSegment.getOrder() * 100;
-			offset = 0;
-			if(curSegment.isRootSegment()) {
-				if(prevSegment !== curSegment) {
-					prevSegment = curSegment;
-					highestVal = curSegment.getLastOrder() * 100;
-				}
+		let segmentVal = rowOrders[rid];
+		if(segmentVal != null) {
+			if(highestVal < segmentVal) {
+				highestVal = segmentVal;
 			}
 		} else {
-			let parentId = childToSegmentId[rid];
-			if(parentId) { // segment member
-				curSegment = segmentSeparators[parentId];
-				segmentVal = curSegment.getOrder() * 100;
-				offset = 1;
-				if(partial) { // This fixes the out of order sub segment
-					highestVal = curSegment.getLastOrder() * 100;
-				}
-			} else { // row outside of segments
-				if(highestVal) {
-					if(segmentVal < highestVal) {
-						segmentVal = highestVal;
-					}
-					offset = 10;
-				} else {
-					segmentVal = offset = 0;
-				}
-			}
+			segmentVal = highestVal ? highestVal + SEGMENT_STEP : 0;
 		}
-
-		segmentValues[r] = segmentVal + offset;
+		segmentValues[r] = segmentVal;
 	}
 
-	return prevSegment ? segmentValues : null;
+	return highestVal ? segmentValues : null;
 };
 /** @public
 * @return {string}
@@ -666,6 +654,7 @@ SegmentCollection.prototype.classify = function(rows) {
 		}
 	}
 	if(this._insertionList.length || this._removalList.length) {
+		this.invalidateSegmentOrder();
 		this._dispatch("subSegmentChanged", {
 			"insertionList": this._insertionList,
 			"removalList": this._removalList

package/lib/core/es6/grid/Core.js

@@ -622,7 +622,7 @@ Core.prototype._hasPendingRowChange = false;
 * @return {string}
 */
 Core.getVersion = function () {
-	return "5.1.140";
+	return "5.2.2";
 };
 /** {@link ElementWrapper#dispose}
 * @override
@@ -4292,6 +4292,9 @@ Core.prototype.initSimpleTable = function (columns) {
 		colCount = columns.length;
 		this.setColumnCount(colCount);
 		this.setDataColumnMap(columns);
+		for(let c = 0; c < colCount; ++c) {
+			this.setColumnField(c, columns[c]);
+		}
 	}
 
 	let titleSect = this.addSection("title");

package/lib/core/es6/grid/plugins/SortableTitlePlugin.js

@@ -40,6 +40,12 @@ import { isEmptyObject } from "../../../../tr-grid-util/es6/Util.js";
 * @property {Array.<string>} sortedFields An array of sortedField
 */
 
+/** @private
+* @type {string}
+*@constant
+*/
+const ROW_DEF = "ROW_DEF";
+
 /** @constructor
 * @extends {EventDispatcher}
 * @param {SortableTitlePlugin.Options=} options
@@ -55,6 +61,7 @@ let SortableTitlePlugin = function (options) { // TODO: Extract SortableTitlePlu
 	_t._onColumnRemoved = _t._onColumnRemoved.bind(_t);
 	_t._onItemSortingClicked = _t._onItemSortingClicked.bind(_t);
 	_t.refresh = _t.refresh.bind(_t);
+	_t._rowDefSorter = _t._rowDefSorter.bind(_t);
 
 	_t._hosts = [];
 	_t._sortLogic = {};
@@ -216,6 +223,11 @@ SortableTitlePlugin.prototype._frozenIndicator = false;
 * @type {boolean}
 */
 SortableTitlePlugin.prototype._rowDefMode = false;
+/**
+* @private
+* @type {Function}
+*/
+SortableTitlePlugin.prototype._userComparer = null;
 
 /** @private
 * @type {!Object.<string, string>}
@@ -1392,6 +1404,21 @@ SortableTitlePlugin.prototype.setSortingSequence = function (sequence, colRef) {
 SortableTitlePlugin.prototype.clearAllColumnSortingSequences = function () {
 	this._sortingSequenceMap = null;
 };
+/** @private
+* @param {Object} rowA
+* @param {Object} rowB
+* @param {number} sortOrder
+* @param {*} context
+* @returns {number}
+*/
+SortableTitlePlugin.prototype._rowDefSorter = function (rowA, rowB, sortOrder, context) {
+	return this._userComparer(
+		rowA[ROW_DEF].getRowData(),
+		rowB[ROW_DEF].getRowData(),
+		sortOrder,
+		context
+	);
+};
 /** @public
 * @description Sorting all separators according to compare function. If compare function is not specified, separators will will be sort by current sorting states.
 * @param {Function} comparer Compare function
@@ -1400,16 +1427,21 @@ SortableTitlePlugin.prototype.sortSeparators = function (comparer) {
 	let host = this._hosts[0];
 	let dv = host.getDataSource();
 	if(comparer){
-		dv.sortSeparators(comparer);
+		if(this._rowDefMode) {
+			this._userComparer = comparer;
+			dv.sortSeparators(this._rowDefSorter);
+			this._userComparer = null;
+		} else {
+			dv.sortSeparators(comparer);
+		}
 	} else {
 		let sortLogics = dv.getSortingLogics();
 		let sortOrders = [];
 		let sortFields = [];
 		let sortStateCount = this._sortStates.length;
-		let rowDefField = SortableTitlePlugin._toRowDefField();
 		for(let i = 0; i < sortStateCount; i++){
 			let sortState = this._sortStates[i];
-			let field = this._rowDefMode ? rowDefField : sortState["field"];
+			let field = this._rowDefMode ? ROW_DEF : sortState["field"];
 			sortOrders.push(sortState["sortOrder"]);
 			sortFields.push(field);
 		}
@@ -1659,11 +1691,10 @@ SortableTitlePlugin.prototype._onColumnRemoved = function (e) {
 };
 
 /** @private
-* @param {Object=} sortState
 * @return {string}
 */
-SortableTitlePlugin._toRowDefField = function(sortState) {
-	return "ROW_DEF";
+SortableTitlePlugin._toRowDefField = function() {
+	return ROW_DEF;
 };
 /** @private
 * @param {Object=} opt_action Action that raised the sort. This is optional

package/lib/grid/index.js

@@ -1,3 +1,3 @@
 import {Grid} from "./lib/efx-grid.js";
 export {Grid}
-window.EFX_GRID = { version: "6.0.158" };
+window.EFX_GRID = { version: "6.0.159" };