@refinitiv-ui/efx-grid 6.0.104 → 6.0.106

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

@@ -6,6 +6,8 @@ declare namespace FieldDefinition {
 
     function set(field: string, def: any): void;
 
+    function resetAll(): void;
+
     function get(field: string): any;
 
     function getFieldInfo(field: string): any;

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

@@ -19,15 +19,15 @@ const SYNAPSE_URL =
 * @constant
 * @description
 * ^TR.						=> start with TR.
-* [\w]+						=> any field with string and value
+* \w+						=> any field with string and value
 * [\(]						=> open bucket (
-* [\w\-\=\,]*			=> any property name and follow by = EX. SDATE=2011-11-11, PRIOD=123123
+* [\w\-=,]*				=> any property name and follow by = EX. SDATE=2011-11-11, PRIOD=123123
 * (?:EDATE|SDATE)	=> non-capturing group match EDATE or SDATE
-* [\w\-\=\,]+ 		=> another propertie param
+* [\w\-=,]+				=> another propertie param
 * [\)]$						=> end with only )
 * i								=> for match both upper and lower cases
 */
-const TimeSeriesRegEx = /^TR\.[\w]+\([\w\-\=\,]*(?:EDATE|SDATE)\=+[\w\-\=\,]*[ \w]*\)$/i;
+const TimeSeriesRegEx = /^TR\.\w+\([\w\-=,]*(?:EDATE|SDATE)=+[\w\-=,]*[ \w]*\)$/i;
 
 /* @namespace */
 let FieldDefinition = {};
@@ -35,7 +35,11 @@ let FieldDefinition = {};
 /** @type {Object.<string, Object>}
 * @private
 */
-FieldDefinition._defs = {
+FieldDefinition._defs = {};
+/** @type {Object.<string, Object>}
+* @private
+*/
+FieldDefinition._defaults = {
 	"CF_NAME": {
 		name: "Name",
 		rank: 2800003,
@@ -180,6 +184,17 @@ FieldDefinition.set = function(field, def) {
 /** Get field definition object
 * @public
 * @function
+*/
+FieldDefinition.resetAll = function() {
+	let defs = FieldDefinition._defs = {};
+	let defaultFields = FieldDefinition._defaults;
+	for(let key in defaultFields) {
+		defs[key] = defaultFields[key];
+	}
+};
+/** Get field definition object
+* @public
+* @function
 * @param {string} field
 * @return {Object}
 */
@@ -535,8 +550,9 @@ function onLoadEnd(e) {
 }
 
 (function() { // Add "field" property to all default field definitions. This reduces file size and redundancy
-	for(let key in FieldDefinition._defs) {
-		FieldDefinition._defs[key]["field"] = key;
+	for(let key in FieldDefinition._defaults) {
+		FieldDefinition._defaults[key]["field"] = key;
+		FieldDefinition._defs[key] = FieldDefinition._defaults[key];
 	}
 })();
 

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

@@ -208,7 +208,7 @@ declare class Grid extends EventDispatcher {
 
     public hasHiddenRow(): boolean;
 
-    public setRic(rowRef: Grid.RowReference|null, str: string, options?: RowDefinition.Options|null): void;
+    public setRic(rowRef: Grid.RowReference|null, str: string, options?: RowDefinition.Options|null): RowDefinition|null;
 
     public unlinkChain(rowRef: Grid.RowReference|null): void;
 

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

@@ -189,28 +189,6 @@ let toRowData = function(rowDef) {
 	return rowDef ? rowDef.getRowData() : null;
 };
 
-/** @private
-* @const
-* @type {Object.<string, number>}
-*/
-let _unclonableFields = {
-	"ROW_DEF": 1,
-	"SUB_ID": 1
-};
-/** @private
-* @param {RowDefinition} fromRowDef
-* @param {RowDefinition} toRowDef
-*/
-let cloneRowData = function(fromRowDef, toRowDef) {
-	let from = toRowData(fromRowDef);
-	let to = toRowData(toRowDef);
-	for(let key in from) {
-		if(!_unclonableFields[key]) {
-			to[key] = from[key];
-		}
-	}
-};
-
 /** @private
 * @param {RowDefinition} rowDef
 * @return {boolean}
@@ -391,7 +369,6 @@ let Grid = function(placeholder, config) {
 		t._dc = new DataCache();
 		t._dc.listen("dataChanged", t._onDataChanged);
 		t._dc.listen("dataComposed", t._onDataComposed);
-		t._dc.addStaticFields([ROW_DEF, SUB_ID]); // Static fields are deprecated, set fields to be ignore during clone in DataCache
 
 		t._dt = new DataTable();
 		t._dt.setSortingLogic(/** @type{Function} */(t._mainSorter));
@@ -1959,12 +1936,6 @@ Grid.prototype.removeColumn = function(colRef) {
 
 	let colDef = this.getColumnDefinition(colIndex);
 
-	if(!colDef.isRealTimeField()) {
-		if(this._dc) {
-			this._dc.removeStaticFields([colDef.getField()]);
-		}
-	}
-
 	this._grid.removeColumnAt(colIndex);
 	this._connector.removeFields(colDef);
 
@@ -1988,25 +1959,16 @@ Grid.prototype.removeColumns = function(colRefs) {
 	}
 	indices.sort(Grid._descendingOrder); // Removal must be done from the back
 
-	let staticFields = []; // For clearing any data stored in our cache
 	let prevState = this._grid.freezeLayout(); // To prevent multiple UI updates
 
 	for(let i = 0; i < len; ++i) {
 		let colIndex = indices[i];
 		let colDef = this.getColumnDefinition(colIndex);
-		if(!colDef.isRealTimeField()) {
-			staticFields.push(colDef.getField());
-		}
 		colDef.dispose();
 		this._grid.removeColumnAt(colIndex);
 		this._connector.removeFields(colDef);
 	}
 
-	if(staticFields.length) {
-		if(this._dc) {
-			this._dc.removeStaticFields(staticFields);
-		}
-	}
 	this._grid.freezeLayout(prevState);
 };
 /** Sorting is also cleared.
@@ -2036,9 +1998,6 @@ Grid.prototype.removeAllColumns = function() {
 
 	this._connector.removeAllFields();
 	this._grid.setColumnCount(0);
-	if(this._dc) {
-		this._dc.resetStaticFields();
-	}
 };
 
 /** Move the column at the specified index to the target index. When moving multiple columns, the original order of the source columns will be sorted by their index and the position of the columns will not be guaranteed to be exactly at the destination index.
@@ -2300,13 +2259,12 @@ Grid.prototype.setColumnSorter = function(colRef, func) {
 
 /** Initialize data for the given rowDef from another rowDef with the same RIC
 * @private
-* @param {RowDefinition} rowDef
+* @param {!RowDefinition} rowDef
 */
 Grid.prototype._initDuplicateRicData = function(rowDef) {
-	let ric = rowDef.getSymbol();
-	let rowDefs = this._connector.getRowDefByRic(ric);
-	if(rowDefs && rowDefs.length) {
-		cloneRowData(rowDefs[0], rowDef);
+	let rowDefs = this._connector.getRowDefByRic(rowDef.getSymbol());
+	if(rowDefs) {
+		rowDef.copyRowData(rowDefs[0]);
 	}
 };
 /** @public
@@ -2739,15 +2697,15 @@ Grid.prototype.hasHiddenRow = function(){
 * @param {Grid~RowReference} rowRef
 * @param {string} str RIC to be set to a row
 * @param {RowDefinition~Options=} options
+* @returns {RowDefinition} Returns modified Row Definition instance
 */
 Grid.prototype.setRic = function(rowRef, str, options) {
 	if(this._mainGrid) {
-		this._mainGrid.setRic(this._toRowId(rowRef), str, options);
-		return;
+		return this._mainGrid.setRic(this._toRowId(rowRef), str, options);
 	}
 	let rowDef = this._getRowDefinitionByRef(rowRef);
 	if(rowDef) {
-		var tempOpt = options || {};
+		let tempOpt = options || {};
 		if(typeof str === "string") {
 			tempOpt["ric"] = str;
 		} else {
@@ -2769,6 +2727,7 @@ Grid.prototype.setRic = function(rowRef, str, options) {
 			rowDef.setStaticRowData(values, tempOpt["fields"]);
 		}
 	}
+	return rowDef;
 };
 /** Unlink the chain and its constituents. When the chain is expanded,
  * the chain row and its members are converted from autogenerated to

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

@@ -56,12 +56,14 @@ declare class RowDefinition {
 
     public getData(field: string): any;
 
-    public setStaticRowData(data: { [key: string]:  any }|any[], opt_fields?: (string)[]|null): void;
-
-    public updateRowData(data: { [key: string]:  any }|any[], opt_fields?: (string)[]|null): void;
+    public setStaticRowData(data: { [key: string]:  any }|any[], indexToFieldMap?: (string)[]|null): void;
 
     public setStaticData(field: string, value: any): void;
 
+    public updateRowData(data: { [key: string]:  any }|any[], indexToFieldMap?: (string)[]|null): void;
+
+    public copyRowData(srcRowDef: RowDefinition|null): void;
+
     public setRowData(data: { [key: string]:  any }): void;
 
     public setData(field: string, value: any): void;

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

@@ -535,7 +535,7 @@ RowDefinition.prototype.getConfigObject = function(rowOptions) {
 		obj["info"] = this._info;
 	}
 
-	val = this._getStaticRowData();
+	val = this._cloneStaticRowData();
 	if(val) {
 		obj["values"] = val;
 	}
@@ -553,7 +553,7 @@ RowDefinition.prototype.getConfigObject = function(rowOptions) {
 			let i, rowDef, staticValues;
 			for(i = 0; i < len; i++) {
 				rowDef = children[i];
-				staticValues = rowDef._getStaticRowData();
+				staticValues = rowDef._cloneStaticRowData();
 				if(staticValues) {
 					dirty = true;
 					childValues[rowDef.getRic()] = staticValues;
@@ -656,15 +656,16 @@ RowDefinition.prototype.getData = function(field) {
 	return this._dc ? this._dc.getData(this._dataId, field) : null;
 };
 
-/** @public
+/** This method replaces all existing static data by the given data -- all existing static data are removed.
+* @public
 * @param {Object.<string, *>|Array} data
-* @param {Array.<string>=} opt_fields In case of the given data is an array, this param will be used for mapping index to field
+* @param {Array.<string>=} indexToFieldMap In case of the given data is an array, this param will be used for mapping index to field
 */
-RowDefinition.prototype.setStaticRowData = function(data, opt_fields) {
+RowDefinition.prototype.setStaticRowData = function(data, indexToFieldMap) {
 	this._clearStaticData();
 
 	if(Array.isArray(data)) { // Convert array to object
-		data = arrayToObject(data, opt_fields);
+		data = arrayToObject(data, indexToFieldMap);
 	}
 
 	this._staticValues = (typeof data === "object") ? data : null;
@@ -676,16 +677,28 @@ RowDefinition.prototype.setStaticRowData = function(data, opt_fields) {
 /** @private
 * @return {Object.<string, *>}
 */
-RowDefinition.prototype._getStaticRowData = function() {
+RowDefinition.prototype._cloneStaticRowData = function() {
 	return this._staticValues ? cloneObject(this._staticValues) : null;
 };
 /** @public
+* @param {string} field
+* @param {*} value
+*/
+RowDefinition.prototype.setStaticData = function(field, value) {
+	if(!this._staticValues) {
+		this._staticValues = {};
+	}
+	this._staticValues[field] = value;
+
+	this.setData(field, value);
+};
+/** @public
 * @param {Object.<string, *>|Array} data
-* @param {Array.<string>=} opt_fields In case of the given data is an array, this param will be used for mapping index to field
+* @param {Array.<string>=} indexToFieldMap In case of the given data is an array, this param will be used for mapping index to field
 */
-RowDefinition.prototype.updateRowData = function(data, opt_fields) {
+RowDefinition.prototype.updateRowData = function(data, indexToFieldMap) {
 	if(Array.isArray(data)) { // Convert array to object
-		data = arrayToObject(data, opt_fields);
+		data = arrayToObject(data, indexToFieldMap);
 	}
 
 	if(data) {
@@ -693,16 +706,32 @@ RowDefinition.prototype.updateRowData = function(data, opt_fields) {
 	}
 };
 /** @public
-* @param {string} field
-* @param {*} value
-*/
-RowDefinition.prototype.setStaticData = function(field, value) {
-	if(!this._staticValues) {
-		this._staticValues = {};
-	}
-	this._staticValues[field] = value;
+* @param {RowDefinition} srcRowDef Original source of row data to be copied from
+*/
+RowDefinition.prototype.copyRowData = function(srcRowDef) {
+	if(srcRowDef && srcRowDef !== this) {
+		let field;
+		let uncopiable_fields = {
+			"ROW_DEF": 1,
+			"SUB_ID": 1
+		};
+		let staticValues = this._staticValues;
+		for(field in staticValues) {
+			uncopiable_fields[field] = 1;
+		}
+		staticValues = srcRowDef._staticValues;
+		for(field in staticValues) {
+			uncopiable_fields[field] = 1;
+		}
 
-	this.setData(field, value);
+		let srcRowData = srcRowDef.getRowData();
+		let rowData = this.getRowData();
+		for(field in srcRowData) {
+			if(!uncopiable_fields[field]) {
+				rowData[field] = srcRowData[field]; // There is no dataChanged event fired
+			}
+		}
+	}
 };
 /** @public
 * @param {Object.<string, *>} data
@@ -1153,7 +1182,7 @@ RowDefinition.prototype.unlinkChain = function() {
 		}
 	}
 
-	let staticData = this._getStaticRowData();
+	let staticData = this._cloneStaticRowData();
 	this.unsubscribeForUpdates();
 
 	// Restore static data