@refinitiv-ui/efx-grid 6.0.4 → 6.0.6

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

@@ -31,6 +31,11 @@ import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js
 * @property {boolean=} debug=false If true, Synapse response will be mock
 */
 
+/** @typedef {Object} Grid~ADCOptions
+* @description ADC requesting level config from adc team
+* @property {string=} productId=001 required parameter, it specifies the product for which you request data. Contact the adc staff to create one.
+*/
+
 /** @typedef {Object} Grid~GridOptions
 * @description Configuration object that can be provided directly at the initialization phase
 * @property {Array.<ColumnDefinition~Options|string>=} columns Collection of the column definitions
@@ -63,8 +68,10 @@ import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js
 * @property {boolean=} borders=true Lines around grid element
 * @property {boolean=} gridlines=true Horizontal and Vertical lines for ONLY content sections
 * @property {boolean=} verticalLines=true Vertical lines for all sections
+* @property {boolean=} contentVerticalLines=true Vertical lines for all content section
 * @property {boolean=} horizontalLines=true Horizontal lines for all sections
 * @property {*=} RTK=null rtk toolkit instance
+* @property {Grid~ADCOptions=} ADC=null ADC requesting level config object from adc team
 * @property {Grid~SynapseConfig=} synapse=null synapse config object
 * @property {number=} contentRightPadding=0 Padding that is added next to the right most column. The padding is still a part of scrollable content.
 * @property {number=} contentBottomPadding=0 Padding that is added below the last section. The padding is still a part of scrollable content.
@@ -76,6 +83,7 @@ import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js
 * @property {Element=} scrollbarParent=null Element to be attached by grid's scrollbars, allowing them to move outside and avoid overlapping with the content.
 * @property {boolean=} formulaEngine=false If enabled, field with leading equal sign will be treated as a formula and rows will be filled with the calculated values.
 * @property {number=} adcPollingInterval=0 Length of polling interval for refreshing ADC data in milliseconds. The default value (0) means no polling.
+* @property {boolean=} fieldCaching=false If enabled, field definition will be caching internal mechanism
 */
 
 /** @typedef {number|string|RowDefinition} Grid~RowReference
@@ -88,7 +96,7 @@ import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js
 /** @typedef {number|string|ColumnDefinition} Grid~ColumnReference
 * @description A column in Grid can be referred by the following values:<br>
 * <b>number</b> : Column index including all invisible (hidden) columns<br>
-* <b>string</b> : Field name of the column<br>
+* <b>string</b> : Field name or column id of the column<br>
 * <b>ColumnDefinition</b> : Column definition object<br>
 */
 
@@ -184,25 +192,6 @@ var cloneRowData = function(fromRowDef, toRowDef) {
 	}
 };
 
-/** @private
-* @param {number} a
-* @param {number} b
-* @return {number}
-*/
-var ascNumberSorter = function (a, b) {
-	return a - b;
-};
-
-/** @private
-* @param {number} min
-* @param {number} max
-* @param {number} elem
-* @return {boolean}
-*/
-var inRangeFilter = function (min, max, elem) {
-	return elem >= min && elem <= max;
-};
-
 /** @private
 * @param {string} sortField
 * @param {Object} elemData
@@ -455,6 +444,10 @@ Grid.prototype._defaultColumnOptions = null;
 * @type {*}
 */
 Grid.prototype._RTK = null;
+/** @private
+* @type {Grid~ADCOptions}
+*/
+Grid.prototype._ADCOptions = null;
 /** use for synapse service
 * @private
 * @type {string}
@@ -496,6 +489,10 @@ Grid.prototype._lastPollingRequest = 0;
 * @private
 */
 Grid.prototype._pollingEnabled = true;
+/** @type {boolean}
+* @private
+*/
+Grid.prototype._fieldCaching = false;
 
 
 /** @public
@@ -729,11 +726,22 @@ Grid.prototype.initialize = function(gridOption) {
 		t._RTK = gridOption["RTK"];
 		t._snapshot.setRTK(t._RTK);
 	}
+
+	if (gridOption["ADC"]) {
+		t._ADCOptions = gridOption["ADC"];
+		t._snapshot.setADCOptions(t._ADCOptions);
+	}
+
 	if (gridOption["synapse"]) {
 		t._synapse = gridOption["synapse"];
 		FieldDefinition.setSynapseConfig(t._synapse);
 	}
 
+	if (gridOption["fieldCaching"]) {
+		t._fieldCaching = gridOption["fieldCaching"];
+		FieldDefinition.setFieldCaching(t._fieldCaching);
+	}
+
 	if (gridOption["icons"] && gridOption["icons"]["rowGrouping"] && gridOption["icons"]["rowGrouping"]["expander"]) {
 		StyleLoader.chainIcon = gridOption["icons"]["rowGrouping"]["expander"];
 	}
@@ -756,6 +764,10 @@ Grid.prototype.initialize = function(gridOption) {
 	if (vLines != null) {
 		grid.toggleVerticalLines(vLines);
 	}
+	var cvLines = gridOption["contentVerticalLines"];
+	if (cvLines != null) {
+		grid.toggleContentVerticalLines(cvLines);
+	}
 	var hLines = gridOption["horizontalLines"];
 	if (hLines != null) {
 		grid.toggleHorizontalLines(hLines);
@@ -1044,11 +1056,14 @@ Grid.prototype.getConfigObject = function (gridOptions) {
 	if(this._pollingInterval) {
 		obj["adcPollingInterval"] = this._pollingInterval;
 	}
+	if(this._fieldCaching) {
+		obj["fieldCaching"] = this._fieldCaching;
+	}
 
 	// get all rows config
 	var rowDefs = this.getAllRowDefinitions();
 	var rows = obj["rows"] = [];
-	var rowDef, rowConfig, pluginInstance, retObj, row;
+	var rowDef, rowConfig;
 	len = rowDefs.length;
 	for (i = 0; i < len; i++) {
 		rowDef = rowDefs[i];
@@ -1058,6 +1073,7 @@ Grid.prototype.getConfigObject = function (gridOptions) {
 
 	// get row config from extensions
 	var extensions = grid.getPlugins();
+	var pluginInstance, row;
 	for(var key in extensions) {
 		pluginInstance = extensions[key];
 		if(typeof pluginInstance["getRowConfigObject"] === "function") {
@@ -1065,15 +1081,7 @@ Grid.prototype.getConfigObject = function (gridOptions) {
 			for (i = 0; i < len; i++) {
 				rowDef = rowDefs[i];
 				row = rows[i];
-				retObj = pluginInstance["getRowConfigObject"](rowDef.getRowId());
-				if(retObj) {
-					if(row.values) {
-						// eslint-disable-next-line es5/no-es6-static-methods
-						Object.assign(row.values, retObj); // Ignore lint
-					} else {
-						row.values = retObj;
-					}
-				}
+				pluginInstance["getRowConfigObject"](row, rowDef.getRowId());
 			}
 		}
 	}
@@ -1084,7 +1092,7 @@ Grid.prototype.getConfigObject = function (gridOptions) {
 	// topFreezingCount, bottomFreezingCount
 	// scrollbarParent
 
-	// NOTE: no need to export synapseApiKey and RTK
+	// NOTE: no need to export synapseApiKey, ADC and RTK
 
 	return obj;
 };
@@ -1245,6 +1253,70 @@ Grid.prototype.insertColumn = function (columnOption, idx) {
 };
 
 
+/** @public
+* @param {ColumnDefinition~Options|string} columnOption String will be treated as field, while object is treated as the column options
+* @param {Grid~ColumnReference} colRef
+*/
+Grid.prototype.replaceColumn = function (columnOption, colRef) {
+	var colIndex = this.getColumnIndex(colRef);
+	if(colIndex < 0) {
+		return;
+	}
+	var colConfig = {};
+	var core = this._grid;
+	var columnDef = core._getColumnDef(colIndex);
+
+	var value = core.getColumnScalability(colIndex);
+	colConfig["scalable"] = value;
+
+	value = core.getColumnCustomLaneSize(colIndex);
+	colConfig["width"] = value;
+
+	value = core.getMinimumColumnWidth(colIndex);
+	if(value !== 32) {
+		colConfig["minWidth"] = value;
+	}
+
+	value = core.isColumnVisible(colIndex);
+	if(!value) {
+		colConfig["hidden"] = true;
+	}
+
+	value = columnDef["stationary"];
+	if (value) {
+		colConfig["stationary"] = value;
+	}
+
+	value = columnDef["leftPinned"];
+	if (value) {
+		colConfig["leftPinned"] = value;
+	}
+
+	value = columnDef["rightPinned"];
+	if (value) {
+		colConfig["rightPinned"] = value;
+	}
+
+	if(typeof columnOption === "string") {
+		colConfig["field"] = columnOption;
+	} else { // type object from user
+		for (var key in columnOption) {
+			colConfig[key] = columnOption[key];
+		}
+	}
+
+	if(columnOption["width"] && !columnOption["scalable"]) {
+		colConfig["scalable"] = false;
+	}
+
+	if(columnOption["scalable"] && !columnOption["width"]) {
+		colConfig["width"] = 1;
+	}
+
+	this.insertColumn(colConfig, colIndex);
+	this.removeColumn(colIndex + 1); // remove existing column after insert
+};
+
 /** to update column name when field info is loaded
  * @private
  * @param {string} field
@@ -1541,78 +1613,7 @@ Grid.prototype.removeAllColumns = function() {
  * @return {boolean} Return true if there is any change, and false otherwise
  */
 Grid.prototype.moveColumn = function (fromColIndex, toColIndex) {
-	//Wrap single index to array
-	if (!Array.isArray(fromColIndex)) {
-		fromColIndex = [fromColIndex];
-	}
-
-	var columnCount = this._grid.getColumnCount();
-	var lastColIndex = columnCount - 1;
-	fromColIndex.sort(ascNumberSorter);
-	fromColIndex = fromColIndex.filter(inRangeFilter.bind(null, 0, lastColIndex));
-
-	if (!this._grid.isColumnMoveAllowed(fromColIndex, toColIndex)) {
-		return false;
-	}
-
-	var frozen = this._grid.isLayoutFrozen();
-	this._grid.freezeLayout(true);
-
-	var marker = [];
-	var runner = 0;
-	var i;
-	for (i = 0; i < columnCount; i++) {
-		if (i == fromColIndex[runner]) {
-			marker.push(true);
-			runner++;
-		} else {
-			marker.push(false);
-		}
-	}
-	//Find the index to be moved to
-	var counter = -1;
-	var toMoveTo = -1;
-
-	for (i = 0; i < columnCount; i++) {
-		if (marker[i] === false) {
-			counter++;
-		}
-
-		if (counter === toColIndex) {
-			toMoveTo = i;
-			break;
-		}
-	}
-
-	//If toMoveTo == -1, it means the target column index is beyond the last colmn so just move the columns
-	//to the end of the table
-	if (toMoveTo === -1) {
-		toMoveTo = columnCount;
-	}
-
-	//Perform moving
-	var leftList = [], rightList = [];
-
-	for (i = 0; i < fromColIndex.length; i++) {
-		if (fromColIndex[i] < toMoveTo) {
-			leftList.push(fromColIndex[i]);
-		} else if (fromColIndex[i] > toMoveTo) {
-			rightList.push(fromColIndex[i]);
-		}
-	}
-
-	for (i = 0; i < rightList.length; i++) {
-		this._grid.moveColumn(rightList[i], toMoveTo + i);
-	}
-
-	for (i = leftList.length - 1; i >= 0; i--) {
-		toMoveTo--;
-
-		this._grid.moveColumn(leftList[i], toMoveTo);
-	}
-
-	this._grid.freezeLayout(frozen);
-	return true;
+	return this._grid.moveColumn(fromColIndex, toColIndex);
 };
 
 /** The hidden column still occupies the same index.
@@ -1677,7 +1678,7 @@ Grid.prototype.addDataFields = function(fieldRef, referrer) {
 
 			if(!dataType) {
 				// wait field-info to be loaded before adding field
-				onLoaded = this._onFieldLoaded.bind(this, field);
+				onLoaded = this._onFieldLoaded.bind(this, field, referrer);
 				prom = prom.then(onLoaded).catch(onLoaded);
 			} else {
 				this._connector.addFields(field, referrer || "grid");
@@ -1703,6 +1704,16 @@ Grid.prototype.removeDataFields = function(fieldRef, referrer) {
 	this._connector.removeFields(fieldRef, referrer || "grid");
 	return true;
 };
+/** @public
+* @param {string} referrer
+*/
+Grid.prototype.removeFieldReferrer = function(referrer) {
+	if(!referrer) {
+		return;
+	}
+
+	this._connector.removeFieldReferrer(referrer);
+};
 
 /** @public
 * @param {Grid~ColumnReference} colRef
@@ -2329,6 +2340,40 @@ Grid.prototype.getColumnDefinition = function(colIndex) {
 	}
 	return null;
 };
+
+/** @public
+* @param {string} colId
+* @return {ColumnDefinition}
+*/
+Grid.prototype.getColumnDefinitionById = function(colId) {
+	if(typeof colId === "string") {
+		var colIndex = this.getColumnIndex(colId);
+		var colData = this._grid.getColumnData(colIndex);
+		if(colData) {
+			return /** @type{ColumnDefinition} */(colData[COL_DEF]) || null;
+		}
+	}
+	return null;
+};
+
+/** @public
+* @param {Array.<string>} colIds
+* @return {ColumnDefinition}
+*/
+Grid.prototype.getColumnDefinitionsById = function(colIds) {
+	var colCount = Array.isArray(colIds) ? colIds.length : 0;
+	if(colCount > 0) {
+		var i, colId;
+		var colDefs = new Array(colCount);
+		for(i = 0; i < colCount; i++) {
+			colId = colIds[i];
+			colDefs[i] = this.getColumnDefinitionById(colId);
+		}
+		return colDefs;
+	}
+	return null;
+
+};
 /** @private
 * @param {Grid~ColumnReference} colRef
 * @return {ColumnDefinition}
@@ -2342,7 +2387,7 @@ Grid.prototype._getColumnDefinition = function(colRef) {
 		var colCount = this.getColumnCount();
 		for(var i = 0; i < colCount; ++i) {
 			var colDef = this.getColumnDefinition(i);
-			if(colDef.getField() === colRef) {
+			if(colDef.getField() === colRef || colDef.getId() === colRef) {
 				return colDef; // Return the first found field
 			}
 		}
@@ -2534,7 +2579,7 @@ Grid.prototype.getColumnIndex = function(colRef) {
 	} else if(typeof colRef === "string") {
 		for(i = 0; i < colCount; ++i) {
 			colDef = this.getColumnDefinition(i);
-			if(colDef.getField() === colRef) {
+			if(colDef.getField() === colRef || colDef.getId() === colRef) {
 				return i; // Return the first found field
 			}
 		}

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

@@ -16,19 +16,19 @@ declare class ReferenceCounter {
 
     public getSession(): any;
 
-    public addReference(key: string, referer?: string): boolean;
+    public addReference(key: string, referer?: string|null): boolean;
 
     public addRef(key: string): boolean;
 
-    public removeReference(key: string, referer?: string, count?: number): boolean;
+    public removeReference(key: string, referer?: string|null, count?: number|null): boolean;
 
     public release(key: string): void;
 
-    public addReferences(keys: (string|(string)[]|any), referer?: string): number;
+    public addReferences(keys: (string|(string)[]|any)|null, referer?: string|null): number;
 
-    public removeReferer(referer?: string): number;
+    public removeReferer(referer?: string|null): number;
 
-    public removeReferrer(referer?: string): number;
+    public removeReferrer(referer?: string|null): number;
 
     public log(): void;
 

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

@@ -6,9 +6,9 @@ declare class RowDefSorter {
 
     public dispose(): void;
 
-    public getSorter(rowSorting?: boolean): ((...params: any[]) => any)|null;
+    public getSorter(rowSorting?: boolean|null): ((...params: any[]) => any)|null;
 
-    public setSortLogic(func?: ((...params: any[]) => any)): void;
+    public setSortLogic(func?: ((...params: any[]) => any)|null): void;
 
     public setField(field: string): void;
 

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

@@ -1,41 +1,41 @@
-import { arrayToObject } from "../../tr-grid-util/es6/Util.js";
+import { arrayToObject, cloneObject } from "../../tr-grid-util/es6/Util.js";
 import { DataCache } from "../../core/es6/data/DataCache.js";
 import { DataTable } from "../../core/es6/data/DataTable.js";
 
 declare namespace RowDefinition {
 
     type Options = {
-        ric?: string,
-        values?: (any[]|any),
-        fields?: (string)[],
-        asChain?: boolean,
-        chainRic?: string,
-        collapsed?: boolean,
-        label?: (string|null),
-        hidden?: boolean
+        ric?: string|null,
+        values?: (any[]|any)|null,
+        fields?: (string)[]|null,
+        asChain?: boolean|null,
+        chainRic?: string|null,
+        collapsed?: boolean|null,
+        label?: (string|null)|null,
+        hidden?: boolean|null
     };
 
 }
 
 declare class RowDefinition {
 
-    constructor(rowOptions?: RowDefinition.Options);
+    constructor(rowOptions?: RowDefinition.Options|null);
 
     public dispose(): void;
 
     public isDisposed(): boolean;
 
-    public initialize(rowOptions?: RowDefinition.Options): void;
+    public initialize(rowOptions?: RowDefinition.Options|null): void;
 
     public setContent(userInput: string): boolean;
 
     public getRowId(): string;
 
-    public getConfigObject(rowOptions?: RowDefinition.Options): RowDefinition.Options|null;
+    public getConfigObject(rowOptions?: RowDefinition.Options|null): RowDefinition.Options|null;
 
     public getDataId(): string;
 
-    public setDataSource(dataSource: DataCache): void;
+    public setDataSource(dataSource: DataCache|null): void;
 
     public getDataSource(): DataCache|null;
 
@@ -43,9 +43,9 @@ declare class RowDefinition {
 
     public getData(field: string): any;
 
-    public setStaticRowData(data: { [key: string]:  any }|any[], opt_fields?: (string)[]): void;
+    public setStaticRowData(data: { [key: string]:  any }|any[], opt_fields?: (string)[]|null): void;
 
-    public updateRowData(data: { [key: string]:  any }|any[], opt_fields?: (string)[]): void;
+    public updateRowData(data: { [key: string]:  any }|any[], opt_fields?: (string)[]|null): void;
 
     public setStaticData(field: string, value: any): void;
 
@@ -65,7 +65,7 @@ declare class RowDefinition {
 
     public isChain(): boolean;
 
-    public static hasChain(rowDef: RowDefinition): boolean;
+    public static hasChain(rowDef: RowDefinition|null): boolean;
 
     public isChainCollapsed(): boolean;
 
@@ -75,7 +75,7 @@ declare class RowDefinition {
 
     public isRealTimeRow(): boolean;
 
-    public subscribeForUpdates(): void;
+    public subscribeForUpdates(): boolean;
 
     public unsubscribeForUpdates(): any;
 
@@ -87,9 +87,9 @@ declare class RowDefinition {
 
     public resetUpdates(): void;
 
-    public registerToView(view: DataTable, rowId?: string): void;
+    public registerToView(view: DataTable|null, rowId?: string|null): void;
 
-    public static deregisterFromView(rowIds: (string)[], rowDef: RowDefinition): (string)[]|null;
+    public static deregisterFromView(rowIds: (string)[]|null, rowDef: RowDefinition|null): (string)[]|null;
 
     public collapseChain(): boolean;
 
@@ -99,7 +99,7 @@ declare class RowDefinition {
 
     public getChildren(): (RowDefinition)[]|null;
 
-    public getDescendants(ary?: (RowDefinition)[]): (RowDefinition)[];
+    public getDescendants(ary?: (RowDefinition)[]|null): (RowDefinition)[];
 
     public getAllDescendantIds(): (string)[]|null;
 
@@ -111,9 +111,9 @@ declare class RowDefinition {
 
     public getUserModel(): any;
 
-    public static toRowId(rowDef: RowDefinition): string;
+    public static toRowId(rowDef: RowDefinition|null): string;
 
-    public static dispose(rowDef: RowDefinition): void;
+    public static dispose(rowDef: RowDefinition|null): void;
 
 }
 

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

@@ -1,4 +1,4 @@
-import { arrayToObject } from "../../tr-grid-util/es6/Util.js";
+import { arrayToObject, cloneObject } from "../../tr-grid-util/es6/Util.js";
 /* eslint-disable */
 import { DataCache } from "../../core/es6/data/DataCache.js";
 import { DataTable } from "../../core/es6/data/DataTable.js";
@@ -272,7 +272,12 @@ RowDefinition.prototype.setContent = function(userInput) {
 	this._dataId = this._rowId + this._ric; // JET/RTK will generate data id to be rowId (given from this rowDef) + ric;
 
 	// This will work for runtime ric modification, but not for first initilization.
-	this.subscribeForUpdates();
+	if(!this.subscribeForUpdates()) {
+		// Avoid losing the ROW_DEF pointer.
+		var rowData = {};
+		rowData[ROW_DEF] = this; // Enable tracking back and updating data
+		this.setRowData(rowData);
+	}
 	return true;
 };
 /** @public
@@ -294,7 +299,7 @@ RowDefinition.prototype.getConfigObject = function(rowOptions) {
 
 	val = this._staticValues;
 	if(val) {
-		obj["values"] = val;
+		obj["values"] = cloneObject(val);
 	}
 
 	val = this._chainRic;
@@ -551,15 +556,16 @@ RowDefinition.prototype.isRealTimeRow = function() {
 };
 
 /** @public
+* @return {boolean} If a subscription is made, return true.
 */
 RowDefinition.prototype.subscribeForUpdates = function() {
 	if(!this.isRealTimeRow()) {
-		return;
+		return false;
 	}
 
 	var subs = this._dc ? this._dc.getSubscriptions() : null;
 	if(!subs) {
-		return;
+		return false;
 	}
 	// TODO: Check if the same subscription is being made.
 	var prevRowData = this.unsubscribeForUpdates();
@@ -576,6 +582,7 @@ RowDefinition.prototype.subscribeForUpdates = function() {
 	} else {
 		this._dc.setRowData(this._dataId, {"X_RIC_NAME": this._ric, "ROW_DEF": this}); // Trigger data update immediately
 	}
+	return true;
 };
 /** @public
  * @returns {*}

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

@@ -1,3 +1,4 @@
+import Grid from "./Grid.js";
 import {Ext} from "../../tr-grid-util/es6/Ext.js";
 import {EventDispatcher} from "../../tr-grid-util/es6/EventDispatcher.js";
 
@@ -7,13 +8,15 @@ declare class SnapshotFiller extends EventDispatcher {
 
     public setRTK(rtk: any): void;
 
+    public setADCOptions(adcOptions: Grid.ADCOptions|null): void;
+
     public addRic(ric: string): void;
 
-    public addRics(rics: (string)[]): boolean;
+    public addRics(rics: (string)[]|null): boolean;
 
     public addField(str: string): void;
 
-    public addFields(fields: (string)[]): boolean;
+    public addFields(fields: (string)[]|null): boolean;
 
     public static isValidField(str: string): boolean;