@refinitiv-ui/efx-grid 6.0.147 → 6.0.148

package/lib/core/es6/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/core/es6/data/DataTable.js

@@ -1016,64 +1016,65 @@ DataTable.prototype._initSegmentCollection = function() {
 		this._segments.addEventListener("subSegmentChanged", this._onSubSegmentChanged);
 	}
 };
-/**
+/** Add or remove all segments from the given row ids
 * @public
 * @param {Array.<string>} rids
 * @param {boolean=} enabled
 * @return {boolean} Return true if there is any change
 */
 DataTable.prototype.setSegmentSeparators = function(rids, enabled) {
-	let change = false;
-	if (rids) {
-		let len = rids.length;
-		let segmentChanged = false;
-		for (let i = 0; i < len; i++) {
-			if(enabled !== false) {
-				let rid = rids[i];
-				this._initSegmentCollection();
-				if(this._autoSegmentFilling) {
-					let parentId = this._segments.getParentRowId(rid);
-					if(parentId) {
-						this._segments.removeSegmentChild(parentId, rid);
-					}
+	if (!rids) {
+		return false;
+	}
+	let adding = (enabled !== false);
+	let segmentAdded = 0;
+	let segmentRemoved = 0;
+
+	let len = rids.length;
+	for (let i = 0; i < len; i++) {
+		let rid = rids[i];
+		if(adding) {
+			this._initSegmentCollection();
+			if(this._autoSegmentFilling) {
+				let parentId = this._segments.getParentRowId(rid);
+				if(parentId) {
+					this._segments.removeSegmentChild(parentId, rid);
 				}
-				segmentChanged = this._segments.addSegment(rid);
-			} else if (this._segments) { // remove case
-				let segment = this._segments.getSegment(rid);
-				if(segment) {
-					if(this._segments.removeSegment(rid)) {
-						change = true;
-						if(!this._segments.getSegmentCount()) {
-							this._segments = null;
-						}
+			}
+			segmentAdded |= this._segments.addSegment(rid);
+		} else if (this._segments) { // Removing
+			let segment = this._segments.getSegment(rid);
+			if(segment) {
+				if(this._segments.removeSegment(rid)) {
+					segmentRemoved = 1;
+					if(!this._segments.getSegmentCount()) {
+						this._segments = null;
 					}
 				}
 			}
-
-		}
-		if (enabled !== false && segmentChanged) {
-			this._segments.calcSegmentOrder(this._rids);
-			change = true;
-		}
-		if(change) {
-			this.dispatchGlobalChange();
 		}
 	}
-	return change;
-
+	if (segmentAdded) {
+		this._segments.calcSegmentOrder(this._rids);
+	}
+	let changed = segmentAdded || segmentRemoved;
+	if(changed && this._needFiring()) {
+		this.dispatchGlobalChange();
+	}
+	return changed ? true : false;
 };
 
 /**
 * @public
 * @param {string} rid
-* @param {boolean=} enabled
+* @param {*=} options=null Segment options. If the value is false, segment separator will be stripped off from the given rid
 * @return {boolean} Return true if there is any change
 */
-DataTable.prototype.setSegmentSeparator = function(rid, enabled) {
+DataTable.prototype.setSegmentSeparator = function(rid, options) {
 	let change = false;
 	let memberCount = 0;
 	if(rid && typeof rid === "string") {
-		if(enabled !== false) {
+		if(options !== false) {
 			this._initSegmentCollection();
 			if(this._autoSegmentFilling) {
 				let parentId = this._segments.getParentRowId(rid);
@@ -1081,11 +1082,12 @@ DataTable.prototype.setSegmentSeparator = function(rid, enabled) {
 					this._segments.removeSegmentChild(parentId, rid);
 				}
 			}
-			if(this._segments.addSegment(rid)) {
+			let children = (options && options["children"]) ? options["children"] : null;
+			if(this._segments.addSegment(rid, children)) {
 				this._segments.calcSegmentOrder(this._rids);
 				change = true;
 			}
-		} else if(this._segments) { // mean remove separator
+		} else if(this._segments) { // Remove the separator
 			let segment = this._segments.getSegment(rid);
 			if(segment) {
 				memberCount = segment.getChildCount();
@@ -1280,6 +1282,20 @@ DataTable.prototype.fillSegments = function() {
 	}
 	return false;
 };
+/** @private
+* @param {boolean=} adding This indicates that segment is changed by adding a new child
+*/
+DataTable.prototype._onSegmentChildChanged = function(adding) {
+	if(this._segments) {
+		this._segments.calcSegmentOrder(this._rids, true);
+	}
+	if(adding !== false) {
+		this._sort(null);
+	}
+	this._dispatchPositionChange(); // Force rerendering, even if there is no position change
+
+	this.requestClassifying();
+};
 /** @public
 * @param {string} segmentId Row id
 * @param {string} rid Row id
@@ -1290,10 +1306,7 @@ DataTable.prototype.addSegmentChild = function(segmentId, rid, dataId) {
 	if(this._segments) {
 		let dirty = this._segments.addSegmentChild(segmentId, rid, dataId);
 		if(dirty) {
-			this._sort(null);
-			this._dispatchPositionChange(); // Force rerendering, even if there is no position change
-
-			this.requestClassifying();
+			this._onSegmentChildChanged();
 			return true;
 		}
 	}
@@ -1309,17 +1322,15 @@ DataTable.prototype.addSegmentChildren = function(segmentId, rids, dataIds) {
 	if(this._segments) {
 		let dirty = this._segments.addSegmentChildren(segmentId, rids, dataIds);
 		if(dirty) {
-			this._sort(null);
-			this._dispatchPositionChange(); // Force rerendering, even if there is no position change
-
-			this.requestClassifying();
+			this._onSegmentChildChanged();
 			return true;
 		}
 	}
 	return false;
 };
 
-/** @public
+/** Deprecated. Remove all existing children and add new children according to the give array
+* @public
 * @param {Array.<Object>} segmentArr Segment array that contain "segmentId", "rowIds" to set segment children
 * @return {boolean} Return true if there is any change
 */
@@ -1327,20 +1338,16 @@ DataTable.prototype.setSegmentChildren = function(segmentArr) {
 	if(!this._segments) {
 		return false;
 	}
-	this.removeAllSegmentChildren();
+	let dirty = this._segments.removeAllSegmentChildren();
 	let len = segmentArr.length;
-	let dirty;
 	for (let i = 0; i < len; i++) {
 		let obj = segmentArr[i];
-		if(this._segments.addSegmentChildren(obj.segmentId, obj.rowIds)) {
+		if(this._segments.addSegmentChildren(obj["segmentId"], obj["rowIds"])) {
 			dirty = true;
 		}
 	}
 	if(dirty) {
-		this._sort(null);
-		this._dispatchPositionChange(); // Force rerendering, even if there is no position change
-
-		this.requestClassifying();
+		this._onSegmentChildChanged();
 		return true;
 	}
 
@@ -1355,8 +1362,7 @@ DataTable.prototype.removeSegmentChild = function(segmentId, rid) {
 	if(this._segments) {
 		let dirty = this._segments.removeSegmentChild(segmentId, rid);
 		if(dirty) {
-			this.dispatchGlobalChange();
-			this.requestClassifying();
+			this._onSegmentChildChanged(false);
 		}
 		return dirty;
 	}
@@ -1371,8 +1377,7 @@ DataTable.prototype.removeSegmentChildren = function(segmentId, rids) {
 	if(this._segments) {
 		let dirty = this._segments.removeSegmentChildren(segmentId, rids);
 		if(dirty) {
-			this.dispatchGlobalChange();
-			this.requestClassifying();
+			this._onSegmentChildChanged(false);
 		}
 		return dirty;
 	}
@@ -1385,7 +1390,7 @@ DataTable.prototype.removeAllSegmentChildren = function() {
 	if(this._segments) {
 		let dirty = this._segments.removeAllSegmentChildren(); // This immediately remove all sub segments
 		if (dirty) {
-			this.dispatchGlobalChange();
+			this._onSegmentChildChanged(false);
 		}
 		return dirty;
 	}

package/lib/core/es6/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/core/es6/data/DataView.js

@@ -2445,13 +2445,13 @@ DataView.prototype.setSegmentSeparators = function(rowIds, enabled) {
 	}
 	return false;
 };
-/** Set visible row as segment separator (hidden or filtered rows cannot be a segment separator)
+/** Set visible row as a segment separator (hidden or filtered rows cannot be a segment separator)
 * @public
 * @param {string|number} rowRef Row id or row index
-* @param {boolean=} enabled
+* @param {*=} options=null Segment options. If the value is false, segment separator will be stripped off from the given rid
 * @return {boolean} Return true if there is any change
 */
-DataView.prototype.setSegmentSeparator = function(rowRef, enabled) {
+DataView.prototype.setSegmentSeparator = function(rowRef, options) {
 	let rowId = "";
 	if(typeof rowRef === "number") {
 		rowId = this.getRowId(rowRef);
@@ -2460,12 +2460,11 @@ DataView.prototype.setSegmentSeparator = function(rowRef, enabled) {
 	}
 
 	if(rowId) {
-		enabled = enabled !== false;
-		if(enabled) {
+		if(options !== false) { // undefined, null, object, or true value
 			this.synchronizeRowOrder();
 		}
 		// TODO: Force expanding of segment before unsetting segment separator
-		return this._dt.setSegmentSeparator(rowId, enabled);
+		return this._dt.setSegmentSeparator(rowId, options);
 	}
 	return false;
 };

package/lib/core/es6/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)[];
 
 }