@refinitiv-ui/efx-grid 6.0.147 → 6.0.149

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

@@ -58,7 +58,7 @@ declare class SegmentCollection extends EventDispatcher {
 
     public fillSegments(rids: (string)[]|null): boolean;
 
-    public calcSegmentOrder(rids: (string)[]|null): void;
+    public calcSegmentOrder(rids: (string)[]|null, useCache?: boolean|null): void;
 
     public logStructure(): string;
 

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

@@ -14,6 +14,7 @@ let SegmentCollection = function() {
 	this._removalList = [];
 
 	this._shared = {
+		segments: this._segments,
 		childToSegment: {}, // child Id to segment Id
 		dirtyCollapsingState: false,
 		defaultCollapsing: false
@@ -74,10 +75,6 @@ SegmentCollection.prototype.dispose = function() {
 */
 SegmentCollection.prototype.addSegment = function(rid, childRids) {
 	if(rid && !this._segments[rid]) {
-		if(this.getParentRowId(rid)) {
-			console.log("child of a segment cannot be set as a segment separator");
-			return false;
-		}
 		let segment = this._segments[rid] = new Segment(rid, this._shared);
 		segment.addEventListener("subSegmentAdded", this._onSubSegmentAdded);
 		segment.addEventListener("subSegmentRemoved", this._onSubSegmentRemoved);
@@ -124,33 +121,41 @@ SegmentCollection.prototype.getParentRowId = function(rid) {
 */
 SegmentCollection.prototype.removeSegment = function(rid) {
 	let segment = this._segments[rid];
-	if(segment) {
-		if(this._segmentCount <= 1) {
-			return this.removeAllSegments();
-		}
-		if(segment.isSubSegment()) {
-			this._removalList.push(segment.getId());
-		}
-		let subSegIds = segment.getSubSegmentIds();
-		if(subSegIds) {
-			let len = subSegIds.length;
-			for(let i = 0; i < len; ++i) {
-				let subSegId = subSegIds[i];
-				if(this._segments[subSegId]) {
-					this._removalList.push(subSegId);
-					delete this._segments[subSegId]; // Slow
-					--this._segmentCount;
-				}
+	if(!segment) {
+		return false;
+	}
+
+	if(this._segmentCount <= 1) {
+		return this.removeAllSegments();
+	}
+	let subSegment = segment.isSubSegment();
+	if(subSegment) {
+		this._removalList.push(segment.getId());
+	}
+	let subSegIds = segment.getSubSegmentIds();
+	if(subSegIds) {
+		let len = subSegIds.length;
+		for(let i = 0; i < len; ++i) {
+			let subSegId = subSegIds[i];
+			if(this._segments[subSegId]) {
+				this._removalList.push(subSegId);
+				delete this._segments[subSegId]; // Slow
+				--this._segmentCount;
 			}
 		}
-		segment.removeAllChildren(); // This is important for updating childToSegment
-		segment.dispose();
-
-		delete this._segments[rid]; // Slow
-		--this._segmentCount;
-		return true;
 	}
-	return false;
+	if(!subSegment) {
+		let parentSeg = segment.getParent();
+		if(parentSeg) { // Move existing children to its parent
+			parentSeg.addChildren(segment.getChildIds()); // WARNING: passing private member
+		}
+	}
+	segment.removeAllChildren(); // This is important for updating childToSegment
+	segment.dispose();
+
+	delete this._segments[rid]; // Slow
+	--this._segmentCount;
+	return true;
 };
 /** @public
 * @return {boolean} Returns true if there is any change. Otherwise, returns false
@@ -163,6 +168,7 @@ SegmentCollection.prototype.removeAllSegments = function() {
 		this._segments = {};
 		this._segmentCount = 0;
 		this._segmentList = null;
+		this._shared.segments = this._segments;
 		this._shared.childToSegment = {};
 
 		this._classification = this._classifierChanged = false;
@@ -288,7 +294,7 @@ SegmentCollection.prototype.getCollapsedRows = function() {
 			collapsedRids = {};
 			for(let rid in segmentSeparators) {
 				let segment = segmentSeparators[rid];
-				if(!segment.isSubSegment()) {
+				if(segment.isRootSegment()) {
 					if(segment.getCollapsingStates(collapsedRids)) {
 						++count;
 					}
@@ -300,6 +306,31 @@ 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
+* @returns {boolean} Returns true if there is any change
+*/
+SegmentCollection.prototype._invalidateSegmentOrder = function(segmentIds) {
+	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;
+				}
+			}
+		}
+	}
+	return false;
+};
 /** @public
 * @param {string} segmentId
 * @param {string} rid
@@ -309,6 +340,8 @@ SegmentCollection.prototype.getCollapsedRows = function() {
 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);
 		return segment.addChild(rid, dataId);
 	}
 	return false;
@@ -322,11 +355,14 @@ SegmentCollection.prototype.addSegmentChild = function(segmentId, rid, dataId) {
 SegmentCollection.prototype.addSegmentChildren = function(segmentId, rids, dataIds) {
 	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);
 		return segment.addChildren(rids, dataIds);
 	}
 	return false;
 };
-/** @public
+/** This only works for immediate children of the specified segment
+* @public
 * @param {string} segmentId
 * @param {string} rid
 * @return {boolean} Returns true if there is any change. Otherwise, returns false
@@ -346,6 +382,7 @@ SegmentCollection.prototype.containsSegmentChild = function(segmentId, rid) {
 SegmentCollection.prototype.removeSegmentChild = function(segmentId, rid) {
 	let segment = this._segments[segmentId];
 	if(segment) {
+		this._invalidateSegmentOrder(rid);
 		return segment.removeChild(rid);
 	}
 	return false;
@@ -358,6 +395,7 @@ SegmentCollection.prototype.removeSegmentChild = function(segmentId, rid) {
 SegmentCollection.prototype.removeSegmentChildren = function(segmentId, rids) {
 	let segment = this._segments[segmentId];
 	if(segment) {
+		this._invalidateSegmentOrder(rids);
 		return segment.removeChildren(rids);
 	}
 	return false;
@@ -377,6 +415,7 @@ SegmentCollection.prototype.removeAllSegmentChildren = function() {
 	}
 
 	if(dirty) {
+		this._segmentList = null; // WARNING: not optimized
 		this.classify(null);
 	}
 
@@ -435,10 +474,14 @@ SegmentCollection.prototype.fillSegments = function(rids) {
 };
 /** @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
 */
-SegmentCollection.prototype.calcSegmentOrder = function(rids) {
+SegmentCollection.prototype.calcSegmentOrder = function(rids, useCache) {
 	let segmentList = this._segmentList;
 	if(segmentList) {
+		if(useCache) {
+			return; // Use previous cache for segment order
+		}
 		segmentList.length = 0;
 	} else {
 		segmentList = this._segmentList = [];
@@ -452,9 +495,10 @@ SegmentCollection.prototype.calcSegmentOrder = function(rids) {
 		let rid = rids[i];
 		let segment = segmentSeparators[rid];
 		if(segment) {
-			if(!segment.isSubSegment()) {
+			if(segment.isRootSegment()) {
 				this._segmentList.push(segment);
 				segment.setOrder(++order); // WARNING: Segments and sub segments start with 1
+				segment.updateTreeStructure(0);
 			}
 			if(--segmentCount <= 0) {
 				break;
@@ -478,7 +522,7 @@ SegmentCollection.prototype.getSegmentValues = function(rids, partial) {
 	let prevSegment = null;
 	let segmentValues = new Array(rowCount);
 	let segmentVal = 0;
-	let highestVal = -10;
+	let highestVal = 0;
 	let offset = 0;
 	for(let r = 0; r < rowCount; ++r) {
 		let rid = rids[r];
@@ -486,7 +530,7 @@ SegmentCollection.prototype.getSegmentValues = function(rids, partial) {
 		if(curSegment) { // segment separator
 			segmentVal = curSegment.getOrder() * 100;
 			offset = 0;
-			if(!curSegment.isSubSegment()) {
+			if(curSegment.isRootSegment()) {
 				if(prevSegment !== curSegment) {
 					prevSegment = curSegment;
 					highestVal = curSegment.getLastOrder() * 100;
@@ -498,12 +542,14 @@ SegmentCollection.prototype.getSegmentValues = function(rids, partial) {
 				curSegment = segmentSeparators[parentId];
 				segmentVal = curSegment.getOrder() * 100;
 				offset = 1;
-				if(partial) {
+				if(partial) { // This fixes the out of order sub segment
 					highestVal = curSegment.getLastOrder() * 100;
 				}
 			} else { // row outside of segments
 				if(highestVal) {
-					segmentVal = highestVal;
+					if(segmentVal < highestVal) {
+						segmentVal = highestVal;
+					}
 					offset = 10;
 				} else {
 					segmentVal = offset = 0;
@@ -527,7 +573,10 @@ SegmentCollection.prototype.logStructure = function() {
 	let segmentCount = segmentList.length;
 	let lines = [];
 	for(let i = 0; i < segmentCount; ++i) {
-		segmentList[i].log(lines);
+		let segment = segmentList[i];
+		if(segment.isRootSegment()) {
+			segment.log(lines);
+		}
 	}
 
 	return lines.join("\n");
@@ -537,10 +586,14 @@ SegmentCollection.prototype.logStructure = function() {
 */
 SegmentCollection.prototype.logRowIdMap = function() {
 	let lines = [];
+	let segmentSeparators = this._segments;
 	let childToSegmentId = this._shared.childToSegment;
 	for(let rid in childToSegmentId) {
 		let segmentId = childToSegmentId[rid];
-		lines.push(rid + " > " + segmentId);
+		let segment = segmentSeparators[segmentId];
+		if(!segment || !segment.isSubSegment()) {
+			lines.push(rid + " > " + segmentId);
+		}
 	}
 
 	return lines.join("\n");

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

@@ -622,7 +622,7 @@ Core.prototype._hasPendingRowChange = false;
 * @return {string}
 */
 Core.getVersion = function () {
-	return "5.1.137";
+	return "5.1.139";
 };
 /** {@link ElementWrapper#dispose}
 * @override

package/lib/grid/index.js

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

package/lib/row-segmenting/es6/RowSegmenting.d.ts

@@ -23,6 +23,7 @@ declare namespace RowSegmentingPlugin {
         rowSpanningField?: string|null,
         segmentIdField?: string|null,
         collapsingField?: string|null,
+        parentIdField?: string|null,
         defaultCollapsing?: boolean|null,
         displayColumn?: (string|number)|null
     };

package/lib/row-segmenting/es6/RowSegmenting.js

@@ -20,6 +20,7 @@ import { Conflator } from "../../tr-grid-util/es6/Conflator.js";
 * @property {string=} rowSpanningField="ROW_SPANNING" Field to be used for spanning segment header rows based on the field values
 * @property {string=} segmentIdField="" Field used for initializing segments based on text id
 * @property {string=} collapsingField="" Field used for indicating that the corresponding segment row is collapsed
+* @property {string=} parentIdField="" Field used for specifying parent segment of the row
 * @property {boolean=} defaultCollapsing=false If enabled, any newly created segment will be collapsed by default
 * @property {(string|number)=} displayColumn=null Render tags in the given column. It can be either the column index, column ID, or field
 */
@@ -105,6 +106,10 @@ RowSegmentingPlugin.prototype._segmentIdField = "";
 * @private
 */
 RowSegmentingPlugin.prototype._collapsingField = "";
+/** @type {string}
+* @private
+*/
+RowSegmentingPlugin.prototype._parentIdField = "";
 /** @type {number}
 * @private
 */
@@ -241,17 +246,26 @@ RowSegmentingPlugin.prototype.requestSeparatorRefresh = function () {
 	let separatorArr = [];
 	let collapsingAry = [];
 	let expandingAry = [];
+	let parentId = "";
 	for(let i = 0; i < rowCount; i++) {
 		rowId = rowIds[i];
 		rowData = this._rowGetter(dt.getRowData(rowId));
 		segmentId = rowData[this._segmentIdField];
-		if(segmentId == null) {
+		parentId = rowData[this._parentIdField];
+		if(segmentId == null && parentId == null) {
 			continue;
 		}
+		this._prevSegmentBySegmentId = true;
+
 		let segmentInfo = segmentMap[segmentId];
+		let parentInfo = parentId !== segmentId ? segmentMap[parentId] : null; // WARNING: parent must exist beforehand
 		if(segmentInfo) {
+			if(parentInfo) {
+				segmentInfo = parentInfo;
+				parentInfo = null;
+			}
 			segmentInfo.rowIds.push(rowId);
-		} else {
+		} else if(segmentId) {
 			segmentInfo = segmentMap[segmentId] = {
 				rowIds: [],
 				segmentId: rowId
@@ -268,7 +282,10 @@ RowSegmentingPlugin.prototype.requestSeparatorRefresh = function () {
 				}
 			}
 		}
-		this._prevSegmentBySegmentId = true;
+
+		if(parentInfo) {
+			parentInfo.rowIds.push(rowId);
+		}
 	}
 	if(segmentArr.length) {
 		this.setSegmentSeparators(separatorArr); // TODO: This method can be merged into setSegmentChildren
@@ -335,6 +352,9 @@ RowSegmentingPlugin.prototype.config = function (options) {
 	if (option.collapsingField != null) {
 		this._collapsingField = option.collapsingField;
 	}
+	if (option.parentIdField != null) {
+		this._parentIdField = option.parentIdField;
+	}
 	if (option.predefinedColors != null && typeof option.predefinedColors === "object") {
 		this._predefinedColors = option.predefinedColors;
 	}
@@ -418,6 +438,9 @@ RowSegmentingPlugin.prototype.getConfigObject = function (gridOptions) {
 	if(this._collapsingField) {
 		extOptions.collapsingField = this._collapsingField;
 	}
+	if(this._parentIdField) {
+		extOptions.parentIdField = this._parentIdField;
+	}
 	if(this._defaultCollapsing) {
 		extOptions.defaultCollapsing = true;
 	}
@@ -445,7 +468,32 @@ RowSegmentingPlugin.prototype.getConfigObject = function (gridOptions) {
 	return obj;
 };
 
-
+/** @private
+* @function
+* @param {!Object} obj
+* @param {string} field
+* @param {*} val
+*/
+let _setObjectValue = function(obj, field, val) {
+	if(field) {
+		if(!obj.values) {
+			obj.values = {};
+		}
+		obj.values[field] = val;
+	}
+};
+/** @private
+* @function
+* @param {!Object} obj
+* @param {string} field
+*/
+let _deleteObjectValue = function(obj, field) {
+	if(field && obj.values) {
+		if(obj.values[field]) {
+			delete obj.values[field]; // Slow
+		}
+	}
+};
 /** @public
 * @param {Object} rowData row config object
 * @param {string} rowId
@@ -453,37 +501,35 @@ RowSegmentingPlugin.prototype.getConfigObject = function (gridOptions) {
 */
 RowSegmentingPlugin.prototype.getRowConfigObject = function (rowData, rowId) {
 	let obj = rowData || {};
-
-	if(!this._segmentIdField) {
+	let segmentIdField = this._segmentIdField;
+	if(!segmentIdField) {
 		return obj;
 	}
 
-	if(obj.values) {
-		if(obj.values[this._segmentIdField]) {
-			delete obj.values[this._segmentIdField]; // clear only segmentIdField
-		}
-	}
+	_deleteObjectValue(obj, segmentIdField);
+	_deleteObjectValue(obj, this._parentIdField);
 
-	if(this.isSegmentSeparator(rowId)) {
-		if(!obj.values) {
-			obj.values = {};
-		}
-		obj.values[this._segmentIdField] = ++this._runningId;
+	let dv = this._getDataView();
+	let segment = dv.getSegment(rowId);
+	if(segment) {
+		_setObjectValue(obj, segmentIdField, ++this._runningId);
+		segment.runningId = this._runningId; // WANRING: Add
+
+		let collapsed = segment.isCollapsed();
+		_setObjectValue(obj, this._collapsingField, collapsed);
 
-		let collapsed = this.isSegmentCollapsed(rowId);
-		if(this._collapsingField) {
-			obj.values[this._collapsingField] = collapsed;
-		}
 		if(obj["collapsed"] == null) { // Avoid overriding value from real-time grid
 			obj["collapsed"] = collapsed;
 		}
-	} else {
-		let parentId = this.getSegmentParentRowId(rowId);
-		if(parentId) {
-			if(!obj.values) {
-				obj.values = {};
-			}
-			obj.values[this._segmentIdField] = this._runningId;
+	}
+
+	let parentSegment = dv.getSegmentParent(rowId);
+	if(parentSegment) {
+		if(this._parentIdField) {
+			// WARNING: this assumes the parent segment is always appeared before this row id
+			_setObjectValue(obj, this._parentIdField, parentSegment.runningId || this._runningId);
+		} else if(!segment) {
+			_setObjectValue(obj, segmentIdField, this._runningId);
 		}
 	}
 
@@ -601,12 +647,8 @@ RowSegmentingPlugin.prototype._hasSegmentation = function (settings) {
 RowSegmentingPlugin.prototype.getSegmentParentRowId = function (rowRef) {
 	let dv = this._getDataView();
 	if(dv) {
-		let rowId = "";
-		if(typeof rowRef === "number") {
-			rowId = dv.getRowId(rowRef); // WARNING: This is very slow
-		} else {
-			rowId = rowRef;
-		}
+		// WARNING: getRowId is slow
+		let rowId = (typeof rowRef === "number") ? dv.getRowId(rowRef) : rowRef;
 		return dv.getSegmentParentRowId(rowId);
 	}
 	return "";
@@ -711,9 +753,10 @@ RowSegmentingPlugin.prototype._updateHeader = function (settings, firstRowIndex,
 		} else {
 			arg.groupLevel = 0;
 			let indentLevel = 0;
-			let parentId = this.getSegmentParentRowId(rowId);
+			let parentId = dv.getSegmentParentRowId(rowId);
 			if(parentId) {
-				indentLevel = 1; // TODO: Provide a way for segmenting multiple levels. Currently, just one level is supported.
+				let parentSegment = dv.getSegment(parentId);
+				indentLevel = parentSegment ? parentSegment.getSegmentLevel() + 1 : 1;
 				arg.nonGroupRow = false;
 				let parentRowData = parentRows[parentId];
 				if (!parentRowData) {

package/lib/types/es6/Core/data/DataTable.d.ts

@@ -82,7 +82,7 @@ declare class DataTable extends DataCache {
 
     public setSegmentSeparators(rids: (string)[]|null, enabled?: boolean|null): boolean;
 
-    public setSegmentSeparator(rid: string, enabled?: boolean|null): boolean;
+    public setSegmentSeparator(rid: string, options?: any): boolean;
 
     public unsetAllSegmentSeparators(): boolean;
 

package/lib/types/es6/Core/data/DataView.d.ts

@@ -248,7 +248,7 @@ declare class DataView extends EventDispatcher {
 
     public setSegmentSeparators(rowIds: (string)[]|null, enabled?: boolean|null): boolean;
 
-    public setSegmentSeparator(rowRef: string|number|null, enabled?: boolean|null): boolean;
+    public setSegmentSeparator(rowRef: string|number|null, options?: any): boolean;
 
     public unsetAllSegmentSeparators(): boolean;
 

package/lib/types/es6/Core/data/Segment.d.ts

@@ -11,6 +11,8 @@ declare class Segment extends EventDispatcher {
 
     public getParentId(): string;
 
+    public getParent(): Segment|null;
+
     public getSubSegmentIds(out_ary?: (string)[]|null): (string)[]|null;
 
     public addChild(rid: string, dataId?: string|null): boolean;
@@ -19,6 +21,8 @@ declare class Segment extends EventDispatcher {
 
     public containsChild(rid: string): boolean;
 
+    public getChildIndex(rid: string): number;
+
     public removeChild(rid: string): boolean;
 
     public removeChildren(rids: (string)[]|null): boolean;
@@ -31,6 +35,8 @@ declare class Segment extends EventDispatcher {
 
     public getChildCount(): number;
 
+    public markCollapsingStateDirty(): void;
+
     public getClassification(): (string)[]|null;
 
     public setClassification(fields: string|(string)[]|null): boolean;
@@ -41,10 +47,16 @@ declare class Segment extends EventDispatcher {
 
     public isSubSegment(): boolean;
 
+    public isRootSegment(): boolean;
+
     public getFirstAncestor(): Segment|null;
 
     public getAllSubSegments(out_ary?: (Segment)[]|null): (Segment)[]|null;
 
+    public updateTreeStructure(counter: number): number;
+
+    public calcSubSegmentOrder(counter: number): number;
+
     public getSegmentLevel(): number;
 
     public setRowData(rows?: any, clsSource?: any): void;
@@ -65,7 +77,9 @@ declare class Segment extends EventDispatcher {
 
     public setOrder(val: number): void;
 
-    public log(lines?: (string)[]|null): (string)[];
+    public setLastOrder(val: number): number;
+
+    public log(lines?: (string)[]|null, tabLevel?: number|null): (string)[];
 
 }
 

package/lib/types/es6/Core/data/SegmentCollection.d.ts

@@ -58,7 +58,7 @@ declare class SegmentCollection extends EventDispatcher {
 
     public fillSegments(rids: (string)[]|null): boolean;
 
-    public calcSegmentOrder(rids: (string)[]|null): void;
+    public calcSegmentOrder(rids: (string)[]|null, useCache?: boolean|null): void;
 
     public logStructure(): string;
 

package/lib/versions.json

@@ -2,7 +2,7 @@
 	"tr-grid-util": "1.3.174",
 	"tr-grid-printer": "1.0.18",
 	"@grid/column-dragging": "1.0.21",
-	"@grid/row-segmenting": "2.0.1",
+	"@grid/row-segmenting": "2.0.2",
 	"@grid/statistics-row": "1.0.17",
 	"@grid/zoom": "1.0.13",
 	"tr-grid-auto-tooltip": "1.1.9",

package/package.json

@@ -69,5 +69,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"version": "6.0.147"
+	"version": "6.0.149"
 }