@refinitiv-ui/efx-grid 6.0.140 → 6.0.142

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

@@ -88,6 +88,8 @@ declare class DataTable extends DataCache {
 
     public hasSegmentation(): boolean;
 
+    public hasSegmentClassification(): boolean;
+
     public isSegmentSeparator(rid: string): boolean;
 
     public getSegment(rid: string): Segment|null;
@@ -132,6 +134,8 @@ declare class DataTable extends DataCache {
 
     public requestClassifying(): void;
 
+    public setSegmentDefaultCollapsing(bool: boolean): boolean;
+
     public dispatchGlobalChange(suppressEvent?: boolean|null): void;
 
     public static getSortingDefinitions(): void;
@@ -144,7 +148,7 @@ declare function prevFrozen(ary: (any)[][], opt_cidList?: (string)[]|null, opt_r
 
 declare function cid(): null;
 
-declare function removalList(sortingDefs: (any[])[]|null): boolean;
+declare function removalList(bool: boolean): boolean;
 
 declare function logic(a: number, b: number, order: number, sortingDefs: (any[])[]|null): number;
 

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

@@ -91,6 +91,10 @@ DataTable.prototype._clsSource = null;
 * @type {number}
 */
 DataTable.prototype._classifyingTimer = 0;
+/** @private
+* @type {boolean}
+*/
+DataTable.prototype._segmentDefaultCollapsing = false;
 
 
 /** @typedef {Function} DataTable~SortLogic
@@ -1003,6 +1007,15 @@ DataTable.prototype.isFrozen = function() {
 	return this._frozen;
 };
 
+/** @private
+*/
+DataTable.prototype._initSegmentCollection = function() {
+	if (!this._segments) {
+		this._segments = new SegmentCollection();
+		this._segments.setDefaultCollapsing(this._segmentDefaultCollapsing);
+		this._segments.addEventListener("subSegmentChanged", this._onSubSegmentChanged);
+	}
+};
 /**
 * @public
 * @param {Array.<string>} rids
@@ -1017,10 +1030,7 @@ DataTable.prototype.setSegmentSeparators = function(rids, enabled) {
 		for (let i = 0; i < len; i++) {
 			if(enabled !== false) {
 				let rid = rids[i];
-				if (!this._segments) {
-					this._segments = new SegmentCollection();
-					this._segments.addEventListener("subSegmentChanged", this._onSubSegmentChanged);
-				}
+				this._initSegmentCollection();
 				if(this._autoSegmentFilling) {
 					let parentId = this._segments.getParentRowId(rid);
 					if(parentId) {
@@ -1064,10 +1074,7 @@ DataTable.prototype.setSegmentSeparator = function(rid, enabled) {
 	let memberCount = 0;
 	if(rid && typeof rid === "string") {
 		if(enabled !== false) {
-			if(!this._segments) {
-				this._segments = new SegmentCollection();
-				this._segments.addEventListener("subSegmentChanged", this._onSubSegmentChanged);
-			}
+			this._initSegmentCollection();
 			if(this._autoSegmentFilling) {
 				let parentId = this._segments.getParentRowId(rid);
 				if(parentId) {
@@ -1131,6 +1138,13 @@ DataTable.prototype.hasSegmentation = function() {
 };
 /**
 * @public
+* @return {boolean}
+*/
+DataTable.prototype.hasSegmentClassification = function() {
+	return this._segments ? this._segments.hasClassification() : false;
+};
+/**
+* @public
 * @param {string} rid
 * @return {boolean}
 */
@@ -1627,6 +1641,22 @@ DataTable.prototype._onSubSegmentChanged = function(e) {
 	}
 };
 
+/**
+* @public
+* @param {boolean} bool
+* @return {boolean}
+*/
+DataTable.prototype.setSegmentDefaultCollapsing = function(bool) {
+	if(this._segmentDefaultCollapsing !== bool) {
+		this._segmentDefaultCollapsing = bool;
+		if(this._segments) {
+			this._segments.setDefaultCollapsing(bool);
+		}
+		return true;
+	}
+	return false;
+};
+
 
 /**
 * @public

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

@@ -304,6 +304,8 @@ declare class DataView extends EventDispatcher {
 
     public setSegmentClassification(segmentRef: string|number|null, fields: string|(string)[]|null): boolean;
 
+    public setSegmentDefaultCollapsing(bool: boolean): boolean;
+
     public getWrapSize(): number;
 
     public getWrappedViews(): (WrappedView)[]|null;

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

@@ -2746,6 +2746,14 @@ DataView.prototype.enableSeparatorFiltering = function (enabled) {
 DataView.prototype.setSegmentClassification = function(segmentRef, fields) {
 	return this._dt.setSegmentClassification(this._toRowId(segmentRef), fields);
 };
+/**
+* @public
+* @param {boolean} bool
+* @return {boolean}
+*/
+DataView.prototype.setSegmentDefaultCollapsing = function(bool) {
+	return this._dt.setSegmentDefaultCollapsing(bool);
+};
 
 /** @public
 * @ignore

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

@@ -65,7 +65,7 @@ declare class Segment extends EventDispatcher {
 
     public setOrder(val: number): void;
 
-    public log(lines: (string)[]|null): (string)[]|null;
+    public log(lines?: (string)[]|null): (string)[];
 
 }
 

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

@@ -10,6 +10,9 @@ let Segment = function(rid, sharedObj) {
 	this._rid = rid;
 	this._children = {};
 	this._shared = sharedObj;
+	if(sharedObj.defaultCollapsing) {
+		this._collapsed = true;
+	}
 };
 Ext.inherits(Segment, EventDispatcher);
 
@@ -124,9 +127,12 @@ Segment.prototype.dispose = function() {
 		this._subSegMap = this._subSegNames = null;
 	}
 	if(this._collapsed) {
-		this._shared.dirtyCollapsingState = true;
+		if(this._childCount || this._subSegDef) {
+			this._shared.dirtyCollapsingState = true;
+		}
 	}
 
+	this._childCount = 0;
 	this._shared = null;
 	this._subSegParent = this._subSegDef = this._subSegVal = null;
 };
@@ -627,7 +633,9 @@ Segment.prototype.collapse = function(bool) {
 	bool = (bool !== false);
 	if(this._collapsed !== bool) {
 		this._collapsed = bool;
-		this._shared.dirtyCollapsingState = true;
+		if(this._childCount || this._subSegDef) {
+			this._shared.dirtyCollapsingState = true;
+		}
 		return true;
 	}
 	return false;
@@ -734,10 +742,14 @@ Segment.prototype.setOrder = function(val) {
 */
 Segment._tabs = null;
 /** @public
-* @param {Array.<string>} lines
-* @return {Array.<string>} lines
+* @param {Array.<string>=} lines
+* @return {!Array.<string>} lines
 */
 Segment.prototype.log = function(lines) {
+	if(!lines) {
+		lines = [];
+	}
+
 	let i;
 	let tabs = Segment._tabs;
 	if(!tabs) {

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

@@ -70,6 +70,8 @@ declare class SegmentCollection extends EventDispatcher {
 
     public classify(rows: { [key: string]:  any }|null): boolean;
 
+    public setDefaultCollapsing(bool: boolean): boolean;
+
 }
 
 export default SegmentCollection;

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

@@ -15,7 +15,8 @@ let SegmentCollection = function() {
 
 	this._shared = {
 		childToSegment: {}, // child Id to segment Id
-		dirtyCollapsingState: false
+		dirtyCollapsingState: false,
+		defaultCollapsing: false
 	};
 };
 Ext.inherits(SegmentCollection, EventDispatcher);
@@ -214,19 +215,17 @@ SegmentCollection.prototype.getSegmentIds = function() {
 * @return {boolean} Returns true if there is any change. Otherwise, returns false
 */
 SegmentCollection.prototype.collapseSegments = function(segmentIds, bool) {
+	let dirty = 0;
 	if(this._segmentCount) {
-		let dirty = 0;
 		let len = segmentIds.length;
 		for (let i = 0; i < len; i++) {
-			let rowId = segmentIds[i];
-			dirty |= this._segments[rowId].collapse(bool);
-
-		}
-		if(dirty) {
-			return true;
+			let segment = this._segments[segmentIds[i]];
+			if(segment) {
+				dirty |= segment.collapse(bool);
+			}
 		}
 	}
-	return false;
+	return dirty ? true : false;
 };
 
 /** @public
@@ -547,7 +546,6 @@ SegmentCollection.prototype.logRowIdMap = function() {
 	return lines.join("\n");
 };
 
-
 /** @public
 * @param {string} segmentId
 * @param {string|Array.<string>} fields
@@ -638,6 +636,19 @@ SegmentCollection.prototype._onSubSegmentRemoved = function(e) {
 	this.removeSegment(rid);
 };
 
+/** @public
+* @param {boolean} bool
+* @return {boolean}
+*/
+SegmentCollection.prototype.setDefaultCollapsing = function(bool) {
+	let newVal = bool ? true : false;
+	if(this._shared.defaultCollapsing !== newVal) {
+		this._shared.defaultCollapsing = newVal;
+		return true;
+	}
+	return false;
+};
+
 
 export default SegmentCollection;
 export { SegmentCollection };

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

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

package/lib/core/es6/grid/components/Cell.js

@@ -739,11 +739,17 @@ Cell.prototype.updateTooltip = function() {
 	}
 
 	if(customizedTooltip) {
-		if(this.getAttribute("title") !== customizedTooltip) {
+		let curTooltip = this.hasAttribute("tooltip") ? this.getAttribute("tooltip") : this.getAttribute("title");
+		if(curTooltip !== customizedTooltip) {
 			this.setAttribute("title", customizedTooltip);
 		}
-	} else if(this.getAttribute("title") != null) {
-		this.removeAttribute("title");
+	} else {
+		if(this.hasAttribute("title")) {
+			this.removeAttribute("title");
+		}
+		if(this.hasAttribute("tooltip")) {
+			this.removeAttribute("tooltip");
+		}
 	}
 };
 /** @public

package/lib/core/es6/grid/components/ElementWrapper.d.ts

@@ -51,6 +51,8 @@ declare class ElementWrapper extends EventDispatcher {
 
     public getAttribute(str: string): string;
 
+    public hasAttribute(str: string): boolean;
+
     public setAttribute(str: string, val: string): void;
 
     public setAttributes(json: any): void;

package/lib/core/es6/grid/components/ElementWrapper.js

@@ -436,12 +436,16 @@ ElementWrapper.prototype.getClass = function () { return this._element.className
 */
 ElementWrapper.prototype.setClass = function (str) { this._element.className = str; };
 
-/**
-* @public
+/** @public
 * @param {string} str
 * @return {string}
 */
 ElementWrapper.prototype.getAttribute = function (str) { return this._element.getAttribute(str); };
+/** @public
+* @param {string} str
+* @return {boolean}
+*/
+ElementWrapper.prototype.hasAttribute = function (str) { return this._element.hasAttribute(str); };
 /** Sets attribute to DOM element
 * @public
 * @param {string} str

package/lib/grid/index.js

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

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

@@ -22,9 +22,16 @@ declare namespace RowSegmentingPlugin {
         sortingLogic?: ((...params: any[]) => any)|null,
         rowSpanningField?: string|null,
         segmentIdField?: string|null,
+        collapsingField?: string|null,
+        defaultCollapsing?: boolean|null,
         displayColumn?: (string|number)|null
     };
 
+    type SegmentDefinition = {
+        children?: (string)[]|null,
+        collapsed?: boolean|null
+    };
+
 }
 
 declare class RowSegmentingPlugin extends GridPlugin {
@@ -51,7 +58,7 @@ declare class RowSegmentingPlugin extends GridPlugin {
 
     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 setSegmentClassification(rowRef: string|number|null, fields: string|(string)[]|null): boolean;
 

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

@@ -18,8 +18,10 @@ import { Conflator } from "../../tr-grid-util/es6/Conflator.js";
 * @property {Function=} nonSegmentSeparatorBinding=null Logic that will be executed for all non segment separator row
 * @property {Function=} sortingLogic=null Logic to be used by sortSegments method
 * @property {string=} rowSpanningField="ROW_SPANNING" Field to be used for spanning segment header rows based on the field values
-* @property {string=} segmentIdField="" Field to be used for initializing segments based on text id
-* @property {(string|number)=} displayColumn=null Render tags in the given column. It can be either the column index, column ID, or field.
+* @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 {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
 */
 
 /** @callback RowSegmentingPlugin~SortingLogic
@@ -29,6 +31,12 @@ import { Conflator } from "../../tr-grid-util/es6/Conflator.js";
 * @return {number}
 */
 
+/** @typedef {Object} RowSegmentingPlugin~SegmentDefinition
+* @description An object that can be passed to setSegmentSeparator method
+* @property {Array.<string>=} children=null Array of child row ids
+* @property {boolean=} collapsed Initial expanding/colapssing state of the segment
+*/
+
 /** @constructor
 * @param {RowSegmentingPlugin~Options=} options
 * @extends {GridPlugin}
@@ -93,6 +101,10 @@ RowSegmentingPlugin.prototype._rowSpanningField = "ROW_SPANNING";
 * @private
 */
 RowSegmentingPlugin.prototype._segmentIdField = "";
+/** @type {string}
+* @private
+*/
+RowSegmentingPlugin.prototype._collapsingField = "";
 /** @type {number}
 * @private
 */
@@ -117,6 +129,10 @@ RowSegmentingPlugin._controlClass = "predefined-color-tag";
 * @private
 */
 RowSegmentingPlugin.prototype._collapsingMap = null;
+/** @type {boolean}
+* @private
+*/
+RowSegmentingPlugin.prototype._defaultCollapsing = false;
 
 /** @public
 * @return {string}
@@ -154,6 +170,10 @@ RowSegmentingPlugin.prototype.initialize = function (host, options) {
 	host.listen("preSectionDataBinding", this._onPreSectionDataBinding);
 
 	this.config(options);
+	let dv = host.getDataSource();
+	if(dv && dv.setSegmentDefaultCollapsing) {
+		dv.setSegmentDefaultCollapsing(this._defaultCollapsing);
+	}
 
 	let enabled = this._colorTag != null ? this._colorTag : ElfUtil.isHaloTheme();
 	RowPainter.disableColorTag(host, enabled === false);
@@ -216,10 +236,11 @@ RowSegmentingPlugin.prototype.requestSeparatorRefresh = function () {
 
 	let rowIds = dt.getAllRowIds();
 	let rowCount = rowIds.length;
-	let separatorMap = {};
+	let segmentMap = {};
 	let segmentArr = [];
 	let separatorArr = [];
-	let collapseArr = [];
+	let collapsingAry = [];
+	let expandingAry = [];
 	for(let i = 0; i < rowCount; i++) {
 		rowId = rowIds[i];
 		rowData = this._rowGetter(dt.getRowData(rowId));
@@ -227,25 +248,39 @@ RowSegmentingPlugin.prototype.requestSeparatorRefresh = function () {
 		if(segmentId == null) {
 			continue;
 		}
-		if(separatorMap[segmentId] == null) {
-			separatorMap[segmentId] = {
+		let segmentInfo = segmentMap[segmentId];
+		if(segmentInfo) {
+			segmentInfo.rowIds.push(rowId);
+		} else {
+			segmentInfo = segmentMap[segmentId] = {
 				rowIds: [],
-				segmentId: rowId // Row id of parent
+				segmentId: rowId
 			};
-			segmentArr.push(separatorMap[segmentId]);
+			segmentArr.push(segmentInfo);
 			separatorArr.push(rowId);
-			if (collapsingMap[segmentId] === true) { // TODO: Currenly is expand by default, then it need to only collapse some row from prev segment id
-				collapseArr.push(rowId);
+
+			let collapsed = (this._collapsingField) ? rowData[this._collapsingField] : collapsingMap[segmentId];
+			if(collapsed != null) {
+				if(collapsed) {
+					collapsingAry.push(rowId);
+				} else {
+					expandingAry.push(rowId);
+				}
 			}
-		} else {
-			// Add rowId to set segment separator
-			separatorMap[segmentId].rowIds.push(rowId);
 		}
 		this._prevSegmentBySegmentId = true;
 	}
-	this.setSegmentSeparators(separatorArr);
-	this.setSegmentChildren(segmentArr);
-	this.collapseSegments(collapseArr);
+	if(segmentArr.length) {
+		this.setSegmentSeparators(separatorArr); // TODO: This method can be merged into setSegmentChildren
+		this.setSegmentChildren(segmentArr);
+	}
+
+	if(collapsingAry.length) {
+		this.collapseSegments(collapsingAry, true);
+	}
+	if(expandingAry.length) {
+		this.collapseSegments(expandingAry, false);
+	}
 };
 /** @public
 * @param {Object=} host core grid instance
@@ -297,12 +332,21 @@ RowSegmentingPlugin.prototype.config = function (options) {
 	if (option.segmentIdField != null) {
 		this._segmentIdField = option.segmentIdField;
 	}
+	if (option.collapsingField != null) {
+		this._collapsingField = option.collapsingField;
+	}
 	if (option.predefinedColors != null && typeof option.predefinedColors === "object") {
 		this._predefinedColors = option.predefinedColors;
 	}
 	if(option.displayColumn != null) {
 		this._displayColumn = option.displayColumn;
 	}
+	if(option.defaultCollapse != null) {
+		this._defaultCollapsing = option.defaultCollapse;
+	}
+	if(option.defaultCollapsing != null) {
+		this._defaultCollapsing = option.defaultCollapsing;
+	}
 
 	this._rowPainter = new RowPainter({
 		clickableCell: false,
@@ -371,6 +415,12 @@ RowSegmentingPlugin.prototype.getConfigObject = function (gridOptions) {
 	if(this._segmentIdField) {
 		extOptions.segmentIdField = this._segmentIdField;
 	}
+	if(this._collapsingField) {
+		extOptions.collapsingField = this._collapsingField;
+	}
+	if(this._defaultCollapsing) {
+		extOptions.defaultCollapsing = true;
+	}
 
 	if(this._displayColumn != null) {
 		// WANRING: display column use colId and colIndex for internal, but give field and colIndex for user
@@ -415,14 +465,18 @@ RowSegmentingPlugin.prototype.getRowConfigObject = function (rowData, rowId) {
 	}
 
 	if(this.isSegmentSeparator(rowId)) {
-		if(obj["collapsed"] == null) { // Avoid overriding value from real-time grid
-			obj["collapsed"] = this.isSegmentCollapsed(rowId);
-		}
-
 		if(!obj.values) {
 			obj.values = {};
 		}
 		obj.values[this._segmentIdField] = ++this._runningId;
+
+		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) {
@@ -750,13 +804,24 @@ RowSegmentingPlugin.prototype.setSegmentSeparators = function(rowIds, enabled) {
 /** Set specified row as a segment separator
 * @public
 * @param {string|number} rowRef Row id or row index
-* @param {boolean=} enabled
+* @param {*=} options The segment will be created and initialized according to the given option. If the value is false, the specified segment is removed.
 * @return {boolean} Return true if there is any change
 */
-RowSegmentingPlugin.prototype.setSegmentSeparator = function(rowRef, enabled) {
+RowSegmentingPlugin.prototype.setSegmentSeparator = function(rowRef, options) {
 	let dv = this._getDataView();
 	if(dv) {
-		return dv.setSegmentSeparator(rowRef, enabled);
+		if(options) {
+			dv.setSegmentSeparator(rowRef, true);
+
+			if(Array.isArray(options.children)) {
+				dv.addSegmentChildren(rowRef, options.children);
+			}
+			if(options.collapsed != null) {
+				dv.collapseSegment(rowRef, options.collapsed);
+			}
+		} else {
+			return dv.setSegmentSeparator(rowRef, options == null);
+		}
 	}
 	return false;
 };