@refinitiv-ui/efx-grid 6.0.24 → 6.0.26

package/lib/rt-grid/es6/ColumnDefinition.js

@@ -42,7 +42,7 @@ import Engine from "../../tr-grid-util/es6/formula/Engine.js";
 * @property {string=} headerAlignment="" Text alignment for column header. This will override `textAlign` option for column header.
 * @property {string=} titleAlignment="" Alias to `headerAlignment`
 * @property {boolean=} hidden=false
-* @property {string=} id Id for unique identifier
+* @property {string=} id A unique identifier for the column
 * @property {boolean=} textSelect=false If enabled, user can select text in this column
 * @property {boolean=} keepModel If enabled, initial column's options will be kept
 * @property {boolean=} stationary=false If enabled, the column order cannot be changed (i.e., this column and any column to its left cannot be moved)

package/lib/rt-grid/es6/FieldDefinition.d.ts

@@ -8,6 +8,8 @@ declare namespace FieldDefinition {
 
     function get(field: string): any;
 
+    function hasFieldInfo(field: string): boolean;
+
     function getTimeSeriesChildren(field: string): any;
 
     function addTimeSeriesChild(tsDef: string, childDef: any): void;

package/lib/rt-grid/es6/FieldDefinition.js

@@ -214,6 +214,17 @@ FieldDefinition.get = function(field) {
 	}
 	return null;
 };
+
+/** @public
+* @function
+* @param {string} field
+* @return {boolean}
+*/
+FieldDefinition.hasFieldInfo = function(field) {
+	var val = FieldDefinition.get(field);
+	return val && val.field; // Already preventing an error caused by accessing a property on a null value
+};
+
 /** @public
 * @function
 * @param {string} field
@@ -376,8 +387,8 @@ FieldDefinition.loadFieldInfo = function (field) {
 		defer.resolve(null);
 	}
 	// already have field definition then return
-	else if (FieldDefinition._defs[field]) {
-		defer.resolve(FieldDefinition._defs[field]);
+	else if (FieldDefinition.hasFieldInfo(field)) {
+		defer.resolve(FieldDefinition.get(field));
 	}
 	// in debug using mock data instead
 	else if (synapse.debug) {

package/lib/rt-grid/es6/Grid.d.ts

@@ -224,6 +224,8 @@ declare class Grid extends EventDispatcher {
 
     public getColumnDefinitionsById(colIds: (string)[]|null): ColumnDefinition|null;
 
+    public getRowType(rowRef: number|string|null): string;
+
     public getRowDefinition(rowRef: number|string|null): RowDefinition|null;
 
     public getRowDefinitions(): (RowDefinition)[];
@@ -312,7 +314,7 @@ declare class Grid extends EventDispatcher {
 
 declare function borders(gridOptions?: any): any;
 
-declare function colCount(rowRef: number|string|null): RowDefinition|null;
+declare function colCount(rowRef: number|string|null): string;
 
 export { Grid };
 export default Grid;

package/lib/rt-grid/es6/Grid.js

@@ -1264,7 +1264,9 @@ Grid.prototype._onFieldAdded = function(e) {
 	// JET
 	if (this._subs) {
 		var realtimeFields = addedFields.filter(FieldDefinition.isRealTimeField);
-		this._subs["addFields"](realtimeFields);
+		if(realtimeFields.length > 0) {
+			this._subs["addFields"](realtimeFields);
+		}
 	}
 
 	this._dispatch(e.type, e);
@@ -1556,19 +1558,31 @@ Grid.prototype._setScrollbarParent = function (host) {
 /**
 * @private
 * @param {string} field
-* @param {boolean} isRealTime
 * @returns {boolean}
 */
-Grid.prototype._shouldLoadFieldInfo = function (field, isRealTime) {
-	var fieldDef = FieldDefinition.get(field);
-	if (!fieldDef &&
-		field !== 'X_RIC_NAME' && // ignore X_RIC_NAME
-		(isRealTime || FieldDefinition.isAdc(field)) && // realtime field or adc field (Without static field)
-		(this._RTK || window["JET"]) // have rtk instance or window jet sub
-	) {
-		return true;
+Grid.prototype._shouldLoadFieldInfo = function (field) {
+
+	var val = this._RTK || window["JET"]; // Fastest checking can be performed by checking the first condition.
+	if(!val) {
+		return false;
 	}
-	return false;
+
+	// WARNING: If field caching is disabled, it shouldn't load field info
+	if(!this._fieldCaching) {
+		return false;
+	}
+
+	val = FieldDefinition.hasFieldInfo(field);
+	if(val) {
+		return false;
+	}
+
+	val = FieldDefinition.isAdc(field) || FieldDefinition.isRealTimeField(field);
+	if(!val) {
+		return false;
+	}
+
+	return true;
 };
 /** Remove all existing columns and add new columns based on the given objects
 * @public
@@ -1670,11 +1684,10 @@ Grid.prototype._onColumnAdded = function(e) {
 	var fields = colDef.getAllFields();
 	var referrer = colDef.getId();
 	var len = fields.length;
-	var field, dataType, prom, isRealTimeField, onLoaded;
+	var field, dataType, prom, onLoaded;
 	for(i = 0; i < len; i++) {
 		field = fields[i];
-		isRealTimeField = FieldDefinition.isRealTimeField(field);
-		if(this._shouldLoadFieldInfo(field, isRealTimeField)) {
+		if(this._shouldLoadFieldInfo(field)) {
 			if(field === colField) {
 				dataType = colDef.getDataType(); // Data-type from user's column options
 			} else { // Other required fields
@@ -1843,6 +1856,15 @@ Grid.prototype.moveColumnById = function (srcCol, destCol) {
 	if(destIndex < 0) {
 		destIndex = colCount;
 	}
+	return this._moveColumnByIndex(srcIndex, destIndex);
+};
+/** Move column without verification for better performance
+* @private
+* @param {number} srcIndex Column index
+* @param {number} destIndex Column index of the destination
+* @return {boolean} Return true if there is any change, and false otherwise
+*/
+Grid.prototype._moveColumnByIndex = function (srcIndex, destIndex) {
 	if(srcIndex < destIndex) { // Ensure that the source column is put in front of the destination index
 		--destIndex;
 	}
@@ -1864,23 +1886,31 @@ Grid.prototype.reorderColumns = function (colRefs, destCol) {
 		var srcLen = colRefs.length;
 		if(srcLen > 1) {
 			var colIds = this.getColumnIds();
+			var colCount = colIds.length;
 			var srcIds = [];
 			var invalidDest = false;
-			var i;
+			var i, srcId, srcIdx;
 			for(i = 0; i < srcLen; ++i) {
 				var colRef = colRefs[i];
-				var srcId = (typeof colRef === "number") ? colIds[colRef] : colRef;
-				if(srcId) {
+				if(typeof colRef === "number") {
+					srcIdx = colRef;
+					srcId = colIds[colRef] || "";
+				} else {
+					srcId = colRef;
+					srcIdx = colIds.indexOf(srcId);
+				}
+				if(srcId && srcIdx >= 0) {
 					srcIds.push(srcId);
 					if(destId === srcId) {
 						invalidDest = true; // Destination must not exist in source columns
 					}
 				}
 			}
+
+			var destIdx;
 			srcLen = srcIds.length;
 			if(invalidDest) { // Find the next valid destination where it is not contained in the source columns
-				var colCount = colIds.length;
-				var destIdx = this.getColumnIndex(destId);
+				destIdx = this.getColumnIndex(destId);
 				if(destIdx >= 0) {
 					while(++destIdx < colCount) {
 						destId = colIds[destIdx];
@@ -1895,10 +1925,16 @@ Grid.prototype.reorderColumns = function (colRefs, destCol) {
 			}
 
 			var dirty = 0;
-			for(i = 0; i < srcLen; ++i) {
-				dirty |= this.moveColumnById(srcIds[i], destId);
+			for(i = srcLen; --i >= 0;) {
+				srcId = srcIds[i]; // Only valid source columns are left at this point
+				srcIdx = this.getColumnIndex(srcId);
+				destIdx = this.getColumnIndex(destId);
+				if(destIdx < 0) { // Insert to the back when id is not found
+					destIdx = colCount;
+				}
+				dirty |= this._moveColumnByIndex(srcIdx, destIdx);
+				destId = srcId;
 			}
-			// TODO: Handle the case where all columns stay in the same place
 			return dirty ? true : false;
 		} else {
 			return this.moveColumnById(colRefs[0], destId);
@@ -1975,11 +2011,10 @@ Grid.prototype.addDataFields = function(fieldRef, referrer) {
 
 	var fields = Array.isArray(fieldRef) ? fieldRef : [fieldRef];
 	var len = fields.length;
-	var i, field, dataType, prom, isRealTimeField, onLoaded;
+	var i, field, dataType, prom, onLoaded;
 	for(i = 0; i < len; i++) {
 		field = fields[i];
-		isRealTimeField = FieldDefinition.isRealTimeField(field);
-		if(this._shouldLoadFieldInfo(field, isRealTimeField)) {
+		if(this._shouldLoadFieldInfo(field)) {
 			dataType = ColumnDefinition.getDataType(field);
 			prom = FieldDefinition.loadFieldInfo(field)
 				.catch(this._onFieldLoadedError);
@@ -2753,7 +2788,14 @@ Grid.prototype._getColumnDefinition = function(colRef) {
 	}
 	return null;
 };
-
+/** @public
+* @param {number|string} rowRef Row index as shown in the view or row id (string)
+* @return {string}
+*/
+Grid.prototype.getRowType = function(rowRef) {
+	var rowDef = this.getRowDefinition(rowRef);
+	return rowDef ? rowDef.getType() : "";
+};
 /** @public
 * @param {number|string} rowRef Row index as shown in the view or row id (string)
 * @return {RowDefinition}
@@ -2943,20 +2985,22 @@ Grid.prototype.getColumnIndex = function(colRef) {
 		return colRef;
 	}
 
-	var colCount = this.getColumnCount();
-	var i, colDef;
-	if(colRef instanceof ColumnDefinition) {
-		for(i = 0; i < colCount; ++i) {
-			colDef = this.getColumnDefinition(i);
-			if(colDef === colRef) {
-				return i;
+	if(colRef) {
+		var colCount = this.getColumnCount();
+		var i, colDef;
+		if(colRef instanceof ColumnDefinition) {
+			for(i = 0; i < colCount; ++i) {
+				colDef = this.getColumnDefinition(i);
+				if(colDef === colRef) {
+					return i;
+				}
 			}
-		}
-	} else if(typeof colRef === "string") {
-		for(i = 0; i < colCount; ++i) {
-			colDef = this.getColumnDefinition(i);
-			if(_hasFieldOrId(colDef, colRef)) {
-				return i; // Return the first found field
+		} else if(typeof colRef === "string") {
+			for(i = 0; i < colCount; ++i) {
+				colDef = this.getColumnDefinition(i);
+				if(_hasFieldOrId(colDef, colRef)) {
+					return i; // Return the first found field
+				}
 			}
 		}
 	}

package/lib/rt-grid/es6/RowDefinition.d.ts

@@ -15,6 +15,15 @@ declare namespace RowDefinition {
         hidden?: boolean|null
     };
 
+    type RowTypes = {
+        CONTENT: string,
+        CHAIN: string,
+        CONSTITUENT: string,
+        GROUP_HEADER: string,
+        SUBGROUP_HEADER: string,
+        GROUP_MEMBER: string
+    };
+
 }
 
 declare class RowDefinition {
@@ -35,6 +44,8 @@ declare class RowDefinition {
 
     public getDataId(): string;
 
+    public getType(): string;
+
     public setDataSource(dataSource: DataCache|null): void;
 
     public getDataSource(): DataCache|null;
@@ -125,7 +136,9 @@ declare class RowDefinition {
 
 declare const ROW_DEF: string;
 
+declare const ROW_TYPES: RowDefinition.RowTypes|null;
+
 declare function rowData(userInput: string): boolean;
 
-export {RowDefinition, ROW_DEF};
+export {RowDefinition, ROW_DEF, ROW_TYPES};
 export default RowDefinition;

package/lib/rt-grid/es6/RowDefinition.js

@@ -16,12 +16,34 @@ import { DataTable } from "../../core/es6/data/DataTable.js";
 * @property {boolean=} hidden=true When this row is hidden
 */
 
+/** @typedef {Object} RowDefinition~RowTypes
+* @property {string} CONTENT="CONTENT"
+* @property {string} CHAIN="CHAIN"
+* @property {string} CONSTITUENT="CONSTITUENT"
+* @property {string} GROUP_HEADER="GROUP_HEADER"
+* @property {string} SUBGROUP_HEADER="SUBGROUP_HEADER"
+* @property {string} GROUP_MEMBER="GROUP_MEMBER"
+*/
+
 /** @type {string}
 * @public
 * @const
 */
 var ROW_DEF = "ROW_DEF";
 
+/** @type {RowDefinition~RowTypes}
+* @public
+* @const
+*/
+var ROW_TYPES = {
+	CONTENT: "CONTENT",
+	CHAIN: "CHAIN",
+	CONSTITUENT: "CONSTITUENT",
+	GROUP_HEADER: "GROUP_HEADER",
+	SUBGROUP_HEADER: "SUBGROUP_HEADER",
+	GROUP_MEMBER: "GROUP_MEMBER"
+};
+
 /** @constructor
 * @param {RowDefinition~Options=} rowOptions
 */
@@ -394,7 +416,37 @@ RowDefinition.prototype.getConfigObject = function(rowOptions) {
 RowDefinition.prototype.getDataId = function() {
 	return this._dataId;
 };
-
+/** @public
+* @return {string}
+*/
+RowDefinition.prototype.getType = function() {
+	if(this._isChain) {
+		return ROW_TYPES.CHAIN;
+	} else if(this._parent) {
+		return ROW_TYPES.CONSTITUENT;
+	} else {
+		var dv = this._view;
+		if(dv) {
+			var rid = this.getRowId();
+			var separator = dv.isSegmentSeparator(rid);
+			var level = dv.getSegmentLevel(rid);
+			if(separator) {
+				if(level === 1) {
+					return ROW_TYPES.GROUP_HEADER;
+				} else {
+					return ROW_TYPES.SUBGROUP_HEADER;
+				}
+			} else {
+				if(dv.getSegmentParentRowId(rid)) {
+					return ROW_TYPES.GROUP_MEMBER;
+				}
+			}
+		} else {
+			return "";
+		}
+	}
+	return ROW_TYPES.CONTENT;
+};
 /** This method should always be called right after the initialization
 * @public
 * @param {DataCache} dataSource
@@ -1079,5 +1131,5 @@ RowDefinition.dispose = function(rowDef) {
 	rowDef.dispose();
 };
 
-export {RowDefinition, ROW_DEF};
+export {RowDefinition, ROW_DEF, ROW_TYPES};
 export default RowDefinition;

package/lib/tr-grid-column-grouping/es6/ColumnGrouping.d.ts

@@ -1,6 +1,7 @@
 import { Ext } from "../../tr-grid-util/es6/Ext.js";
 import { cloneObject } from "../../tr-grid-util/es6/Util.js";
 import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
+import { GroupDefinitions } from "../../tr-grid-util/es6/GroupDefinitions.js";
 import { injectCss, prettifyCss } from "../../tr-grid-util/es6/Util.js";
 
 declare namespace ColumnGroupingPlugin {
@@ -42,7 +43,7 @@ declare class ColumnGroupingPlugin extends GridPlugin {
 
     public addColumnGrouping(groupDef: ColumnGroupingPlugin.GroupDefinition|null): void;
 
-    public removeGroup(groupId: string): ColumnGroupingPlugin.GroupDefinition|null;
+    public removeGroup(groupId: string): boolean;
 
     public getGroupDefinition(groupId: string): ColumnGroupingPlugin.GroupDefinition|null;
 
@@ -52,7 +53,7 @@ declare class ColumnGroupingPlugin extends GridPlugin {
 
     public setGroupDefinitions(groupDefs: ColumnGroupingPlugin.GroupDefinitions|null): void;
 
-    public setGroupChildren(groupId: string, newChildList: (string)[]|null): void;
+    public setGroupChildren(groupId: string, newChildList: (string)[]|null): boolean;
 
     public getGroupChildren(groupId: string): (string)[]|null;