@refinitiv-ui/efx-grid 6.0.14 → 6.0.16

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

@@ -53,6 +53,8 @@ declare class ColumnDefinition {
 
     public dispose(): void;
 
+    public _initializeTimeSeriesChild(columnOption?: ColumnDefinition.Options|string|null): void;
+
     public initialize(columnOption?: ColumnDefinition.Options|string|null): void;
 
     public getId(): string;
@@ -87,6 +89,8 @@ declare class ColumnDefinition {
 
     public isRealTimeField(): boolean;
 
+    public isTimeSeriesField(): boolean;
+
     public isFormulaField(): boolean;
 
     public static isFormulaField(field: string): boolean;
@@ -127,6 +131,10 @@ declare class ColumnDefinition {
 
     public setRenderer(func: ((...params: any[]) => any)|null): void;
 
+    public getParent(): ColumnDefinition|null;
+
+    public getChildren(): (ColumnDefinition)[]|null;
+
     public addRenderer(func: ((...params: any[]) => any)|null): void;
 
     public activateRenderer(id?: string|null, func?: ((...params: any[]) => any)|null): boolean;
@@ -137,6 +145,8 @@ declare class ColumnDefinition {
 
     public isRowSorting(): boolean;
 
+    public isAutoGenerated(): boolean;
+
     public setName(str: string): void;
 
     public getUserModel(): any;

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

@@ -123,8 +123,17 @@ var ColumnDefinition = function(columnOption, hostGrid) {
 
 	this._classes = [];
 	this._requiredFields = [];
+	this._children = [];
+	this._parent = [];
+
+	if(columnOption) {
+		if(columnOption["parent"]) { // WARNING: This assume time series child, when have a parent
+			this._initializeTimeSeriesChild(columnOption);
+		} else {
+			this.initialize(columnOption);
+		}
+	}
 
-	this.initialize(columnOption);
 };
 //#region Private Members
 /** @type {string}
@@ -205,6 +214,10 @@ ColumnDefinition.prototype._eventArg;
 * @private
 */
 ColumnDefinition.prototype._realTimeField = false;
+/** @type {boolean}
+* @private
+*/
+ColumnDefinition.prototype._autoGenerated = false;
 
 /** @type {!Array.<string>}
 * @private
@@ -241,6 +254,19 @@ ColumnDefinition.prototype._textSelect = false;
 * @private
 */
 ColumnDefinition.prototype._userModel = null;
+
+/** @type {Grid~ColumnDefinition}
+* @private
+*/
+ColumnDefinition.prototype._parent = null;
+/** @type {Array<ColumnDefinition>}
+* @private
+*/
+ColumnDefinition.prototype._children = null;
+/** @type {boolean}
+* @private
+*/
+ColumnDefinition.prototype._timeSeriesField = false;
 /** @type {Object}
 * @private
 */
@@ -256,8 +282,20 @@ ColumnDefinition.prototype.dispose = function() {
 	this.setRenderer(null); // this._userRenderers are removed
 	this.setSorter(null);
 	this._userModel = null;
+	this._parent = null;
+	this._children = null;
 	// TODO: Remove any related reference from this._fnEngine
 };
+
+/** @public
+* @param {ColumnDefinition~Options|string=} columnOption
+*/
+ColumnDefinition.prototype._initializeTimeSeriesChild = function(columnOption) {
+	this._autoGenerated = true;
+	var parentDef = /** @type{ColumnDefinition} */(columnOption["parent"]);
+	this._setParent(parentDef);
+	this.initialize(columnOption);
+};
 /** @public
 * @param {ColumnDefinition~Options|string=} columnOption
 */
@@ -556,6 +594,12 @@ ColumnDefinition.prototype.isRealTimeField = function() {
 /** @public
 * @return {boolean}
 */
+ColumnDefinition.prototype.isTimeSeriesField = function() {
+	return this._timeSeriesField;
+};
+/** @public
+* @return {boolean}
+*/
 ColumnDefinition.prototype.isFormulaField = function() {
 	return this._formula ? true : false;
 };
@@ -741,6 +785,10 @@ ColumnDefinition.prototype.getConfigObject = function(colOptions) {
 		obj["headerAlignment"] = this._headerAlignment;
 	}
 
+	if(this._autoGenerated) {
+		obj["autoGenerated"] = this._autoGenerated;
+	}
+
 	var core = this._eventArg["core"];
 	var grid = this._eventArg["grid"];
 	var colIndex = grid.getColumnIndex(this);
@@ -818,6 +866,53 @@ ColumnDefinition.prototype.setRenderer = function(func) {
 		this._userRenderers = null;
 	}
 };
+
+
+/** @public
+* @return {ColumnDefinition}
+*/
+ColumnDefinition.prototype.getParent = function() {
+	return this._parent;
+};
+
+
+/**
+* @private
+* @param {ColumnDefinition} parentDef
+* @return {boolean}=true if have any change
+*/
+ColumnDefinition.prototype._setParent = function(parentDef) {
+	if(this._parent === parentDef || parentDef === this) { // The same parent is given
+		return false;
+	}
+
+	if(parentDef) {
+		this._parent = parentDef;
+		this._parent._addChild(this); // sync child and parent
+	}
+	return false;
+};
+
+
+/**
+* @public
+* @return {Array.<ColumnDefinition>}
+*/
+ColumnDefinition.prototype.getChildren = function() {
+	return this._children;
+};
+
+/**
+* @private
+* @param {string} colDef Child column definition
+*/
+ColumnDefinition.prototype._addChild = function(colDef) {
+	if(this === colDef || this._children.indexOf(colDef) > -1) {
+		return;
+	}
+	this._children.push(colDef);
+};
+
 /** Add more renderer to the existing list
 * @public
 * @param {Function} func
@@ -884,6 +979,13 @@ ColumnDefinition.prototype.isRowSorting = function() {
 	return this._rowSorting ? true : false;
 };
 
+/** @public
+* @return {boolean}
+*/
+ColumnDefinition.prototype.isAutoGenerated = function() {
+	return this._autoGenerated;
+};
+
 /** To allow user change column name in run-time (language change or localization)
 * @public
 * @param {string} str
@@ -934,6 +1036,13 @@ ColumnDefinition.prototype._setField = function(field, formulaStr) {
 		this._emptyField = false;
 		this._realTimeField = field ? true : false;
 	}
+
+	if(FieldDefinition.isTimeSeriesField(field)) {
+		// children will be clone the config from parent too
+		this._realTimeField = false;
+		this._timeSeriesField = true;
+	}
+
 	this._isDefaultName = true;
 	this._updateContext("field", field);
 	if(this.isRealTimeField()) { // Only realtime field will have a formatted field

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

@@ -8,12 +8,18 @@ declare namespace FieldDefinition {
 
     function get(field: string): any;
 
+    function getTimeSeriesChildren(field: string): any;
+
+    function addTimeSeriesChild(tsDef: string, childDef: any): void;
+
     function remove(field: string): void;
 
     function setSynapseConfig(config: Grid.SynapseConfig|null): void;
 
     function setFieldCaching(caching: boolean): void;
 
+    function isTimeSeriesField(field: string): boolean;
+
 }
 
 export {FieldDefinition};

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

@@ -159,6 +159,12 @@ FieldDefinition._defs = {
 		description: "The latest Ask price."
 	}
 };
+
+/** @type {Object.<string, Object>}
+* @private
+*/
+FieldDefinition._timeSeriesChildren = {};
+
 /** api-key to call synapse service
 * @type {string}
 * @private
@@ -205,6 +211,25 @@ FieldDefinition.get = function(field) {
 /** @public
 * @function
 * @param {string} field
+* @return {Object}
+*/
+FieldDefinition.getTimeSeriesChildren = function(field) {
+	return FieldDefinition._timeSeriesChildren[field];
+};
+/** @public
+* @function
+* @param {string} tsDef
+* @param {Object} childDef
+*/
+FieldDefinition.addTimeSeriesChild = function(tsDef, childDef) {
+	if(!FieldDefinition._timeSeriesChildren[tsDef]) {
+		FieldDefinition._timeSeriesChildren[tsDef] = [];
+	}
+	FieldDefinition._timeSeriesChildren[tsDef].push(childDef);
+};
+/** @public
+* @function
+* @param {string} field
 */
 FieldDefinition.remove = function(field) {
 	delete FieldDefinition._defs[field];
@@ -227,6 +252,24 @@ FieldDefinition.setFieldCaching = function (caching) {
 	FieldDefinition._caching = caching;
 };
 
+/** @public
+* @param {string} field
+* @return {boolean}=true if field is time series field
+*/
+FieldDefinition.isTimeSeriesField = function (field) {
+	/*
+		^TR.                    => start with TR.
+		[\w]+                   => any field with string and value
+		[\(]                    => open bucket (
+		[\w\-\=\,]*             => any property name and follow by = EX. SDATE=2011-11-11, PRIOD=123123
+		EDATE\=+                => EDATE in bucket
+		[\w\-\=\,]+             => another propertie param
+		[\)]$                   => end with only )
+	*/
+
+	return !!field.toUpperCase().match(/^TR.[\w]+[\(][\w\-\=\,]*EDATE\=+[\w\-\=\,]+[\)]$/g);
+};
+
 /** to get more info about field via synapse service
 * @private
 * @param {string} field

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

@@ -193,6 +193,8 @@ declare class Grid extends EventDispatcher {
 
     public setRic(rowRef: Grid.RowReference|null, str: string): void;
 
+    public unlinkChain(rowRef: Grid.RowReference|null): void;
+
     public setRowContent(rowRef: Grid.RowReference|null, str: string): void;
 
     public toggleRowExpansion(rid: string|number|null, force?: boolean|null): void;

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

@@ -209,6 +209,13 @@ var excludeAutoGenerated = function (rowDef) {
 	return !rowDef.isAutoGenerated();
 };
 
+/** @private
+* @param {Object} colConfig column config
+* @return {boolean}
+*/
+var _byNonAutoGeneratedColumn = function (colConfig) {
+	return !colConfig.autoGenerated;
+};
 /** @private
 * @param {string} rowDefA
 * @param {string} rowDefB
@@ -234,6 +241,8 @@ var Grid = function(placeholder, config) {
 	t._recalculateFormulas = t._recalculateFormulas.bind(t);
 	t._updateStreamingData = t._updateStreamingData.bind(t);
 	t.updateColumnTitle = t.updateColumnTitle.bind(t);
+	t._insertTimeSeriesChildren = t._insertTimeSeriesChildren.bind(t);
+
 
 	t._onPostSectionDataBinding = t._onPostSectionDataBinding.bind(t);
 	t._asyncClearDataUpdates = t._asyncClearDataUpdates.bind(t);
@@ -257,6 +266,8 @@ var Grid = function(placeholder, config) {
 	t._formulaConflator = new Conflator(300, t._onFormulaDataChanged);
 	t._chainConflator = new Conflator(100, t._addMemberOfChain);
 	t._columnTitleConflator = new Conflator(0, t.updateColumnTitle);
+	t._timeSeriesChildConflator = new Conflator(0, t._insertTimeSeriesChildren);
+
 
 	t._defaultColumnOptions = {};
 
@@ -1003,8 +1014,8 @@ Grid.prototype.getConfigObject = function (gridOptions) {
 		grid.getConfigObject(obj);
 	}
 
-	var i;
-	var len = this.getColumnCount();
+	var i, len;
+	len = this.getColumnCount();
 	for (i = 0; i < len; ++i) {
 		var column = columns[i];
 		if(!column) {
@@ -1015,6 +1026,8 @@ Grid.prototype.getConfigObject = function (gridOptions) {
 		colDef.getConfigObject(column);
 	}
 
+	obj.columns = columns = columns.filter(_byNonAutoGeneratedColumn);
+
 	if(this._topNode.style.overflow === "") {
 		obj["scrollbar"] = false;
 	}
@@ -1255,6 +1268,116 @@ Grid.prototype.insertColumn = function (columnOption, idx) {
 	this._grid.insertColumn(idx, configObj); // columnAdded is fired
 };
 
+/** @private
+* @param {Object} e snapshort change event object
+*/
+Grid.prototype._updateTimeSeriesFields = function (e) {
+	var snapShortData = e.data;
+	var childFields;
+	for (var ric in snapShortData) {
+		childFields = snapShortData[ric];
+		this.setRicData(ric, snapShortData[ric]);
+	}
+	var parentField, field, colIndex, parentColDef, childColIndex;
+
+	var firstField;
+	for (field in childFields) {
+		firstField = field;
+		break;
+	}
+
+	parentField = e.childrenFieldToParent[firstField];
+	colIndex = this.getColumnIndex(parentField);
+	this._grid.setColumnVisibility(colIndex);
+	parentColDef = this._getColumnDefinition(colIndex);
+
+
+	var children = parentColDef.getChildren();
+	var i, len, childDef, childField;
+	len = children.length;
+	if(len > 0){
+		for (i = 0; i < len; i++) {
+			childDef = children[i];
+			childField = childDef.getField();
+			if(!childFields[childField]) {
+				this.removeColumn(childField);
+			}
+		}
+	}
+
+	for (childField in childFields) {
+		parentField = e.childrenFieldToParent[childField];
+		colIndex = this.getColumnIndex(parentField);
+		parentColDef = this._getColumnDefinition(colIndex);
+		childColIndex = this.getColumnIndex(childField);
+		if(childColIndex < 0) { // not found column index in view tried to clone from parent
+			this._cloneTimeSeriesColumn(parentColDef, childField, colIndex);
+			FieldDefinition.addTimeSeriesChild(parentField, childField);
+		}
+	}
+
+};
+
+
+/** @private
+* @param {ColumnDefinition} colDef
+*/
+Grid.prototype._insertTimeSeriesChildren = function (colDef) {
+	if(this._timeSeriesChildConflator.conflate(colDef) ) {
+		return;
+	}
+
+	var colDefs  = this._timeSeriesChildConflator.popAllData();
+	var i, j, len, childField, idx;
+
+	for (i = 0; i < colDefs.length; i++) {
+		colDef = colDefs[i];
+		idx = this.getColumnIndex(colDef);
+		this._grid.setColumnVisibility(idx); // hide parent field
+
+		if(!colDef) {
+			continue;
+		}
+		var childFields = FieldDefinition.getTimeSeriesChildren(colDef.getField());
+		if(!childFields) { // not found time series field
+			return;
+		}
+
+		len = childFields.length;
+		if(len < 1) {
+			return; // normal field
+		}
+
+		for (j = 0; j < len; j++) {
+			idx = this.getColumnIndex(colDef);
+			childField = childFields[j];
+			this._cloneTimeSeriesColumn(colDef, childField, idx);
+		}
+	}
+
+};
+
+/** @private
+* @param {ColumnDefinition} parentColDef Parent definition
+* @param {string} childField field
+* @param {number} idx index of insertion column
+*/
+Grid.prototype._cloneTimeSeriesColumn = function (parentColDef, childField, idx) {
+	var parentConfig, columnOption, obj, key;
+	parentConfig = parentColDef.getConfigObject();
+	obj = {};
+	for (key in parentConfig) {
+		if(key !== "hidden") {
+			obj[key] = parentConfig[key];
+		}
+	}
+	columnOption = cloneObject(obj);
+	columnOption["field"] = childField.replace("TR.", "");
+	columnOption["name"] = childField.split("_")[1].split("T")[0]; // Currently, response server format utc date ex "2022-11-23T00:00:00"
+	columnOption["parent"] = parentColDef;
+	this.insertColumn(columnOption, idx++);
+
+};
 
 /** @public
 * @param {ColumnDefinition~Options|string} columnOption String will be treated as field, while object is treated as the column options
@@ -1316,6 +1439,10 @@ Grid.prototype.replaceColumn = function (columnOption, colRef) {
 		colConfig["width"] = 1;
 	}
 
+	var colDef = this.getColumnDefinition(colIndex);
+	if(colDef.getChildren()) { // Parent time series field doesn't provide hidden property
+		colConfig["hidden"] = false;
+	}
 	this.insertColumn(colConfig, colIndex);
 	this.removeColumn(colIndex + 1); // remove existing column after insert
 };
@@ -1352,7 +1479,15 @@ Grid.prototype._onFieldLoadedError = function (err) {
  * @param {string} referrer
  */
 Grid.prototype._onFieldLoaded = function (field, referrer) {
-	this._connector.addFields(field, referrer);
+	// async process, the field can be remove before column added
+	var colIndex = this.getColumnIndex(field);
+	if(colIndex > -1) {
+		var colDef = this._getColumnDefinition(field);
+		if(colDef.isTimeSeriesField()) {
+			this._insertTimeSeriesChildren(colDef);
+		}
+		this._connector.addFields(field, referrer);
+	}
 };
 
 /**
@@ -1381,8 +1516,8 @@ Grid.prototype._shouldLoadFieldInfo = function (field, isRealTime) {
 	var fieldDef = FieldDefinition.get(field);
 	if (!fieldDef &&
 		field !== 'X_RIC_NAME' && // ignore X_RIC_NAME
-		(isRealTime || ColumnDefinition.isAdcField(field)) &&
-		(this._RTK || window["JET"])
+		(isRealTime || ColumnDefinition.isAdcField(field)) && // realtime field or adc field (Without static field)
+		(this._RTK || window["JET"]) // have rtk instance or window jet sub
 	) {
 		return true;
 	}
@@ -1508,9 +1643,15 @@ Grid.prototype._onColumnAdded = function(e) {
 				onLoaded = this._onFieldLoaded.bind(this, field, referrer);
 				prom = prom.then(onLoaded).catch(onLoaded);
 			} else {
+				if(colDef.isTimeSeriesField()) {
+					this._insertTimeSeriesChildren(colDef);
+				}
 				this._connector.addFields(field, referrer);
 			}
 		} else {
+			if(colDef.isTimeSeriesField()) {
+				this._insertTimeSeriesChildren(colDef);
+			}
 			this._connector.addFields(field, referrer);
 		}
 	}
@@ -1528,6 +1669,19 @@ Grid.prototype.removeColumn = function(colRef) {
 	}
 
 	var colDef = this.getColumnDefinition(colIndex);
+	var children = colDef.getChildren();
+	if(children) {
+		var len = children.length;
+		if(len > 0) { // remove time series child
+			var i, childDef;
+			for (i = 0; i < len; i++) {
+				childDef = children[i];
+				this.removeColumn(childDef);
+			}
+			colIndex = this.getColumnIndex(colRef); // children in parent will be remove the parent should be get new index
+		}
+	}
+
 	if(!colDef.isRealTimeField()) {
 		if(this._dc) {
 			this._dc.removeStaticFields([colDef.getField()]);
@@ -1600,6 +1754,7 @@ Grid.prototype.removeAllColumns = function() {
 	// TODO: Remove fields that are related to the column (e.g. fields for coloring)
 
 	this._columnTitleConflator.reset();
+	this._timeSeriesChildConflator.reset();
 
 	this._connector.removeAllFields();
 	this._grid.setColumnCount(0);
@@ -1628,7 +1783,22 @@ Grid.prototype.moveColumn = function (fromColIndex, toColIndex) {
 */
 Grid.prototype.hideColumn = function(colRef, hidden) {
 	var colIndex = this.getColumnIndex(colRef);
-	this._grid.hideColumn(colIndex, hidden);
+	if(colIndex < 0) { // not found
+		return;
+	}
+	var colDef = this.getColumnDefinition(colIndex);
+	var children = colDef.getChildren();
+	var len = children.length;
+	if(len > 0) { // remove time series child, and parent shouldn't unHide
+		var i, childDef;
+		for (i = 0; i < len; i++) {
+			childDef = children[i];
+			this.hideColumn(childDef, hidden);
+		}
+	} else {
+		this._grid.hideColumn(colIndex, hidden);
+	}
+
 };
 /** Hide multiple columns at once. The hidden columns still occupy the same index.
 * @public
@@ -2245,6 +2415,28 @@ Grid.prototype.setRic = function(rowRef, str) {
 		}
 	}
 };
+/** Unlink the chain and its constituents. When the chain is expanded,
+ * the chain row and its members are converted from autogenerated to
+ * regular real-time rows. Only the chain row will be transformed to
+ * a conventional real-time row if the chain is collapsed.
+ * All converted rows will continue to have their data updated.
+ *
+ * @public
+ * @param {Grid~RowReference} rowRef
+ */
+Grid.prototype.unlinkChain = function(rowRef) {
+	var rowDef = this._getRowDefinition(rowRef);
+	if(!rowDef) {
+		return;
+	}
+
+	if(!rowDef.isChain()) {
+		return;
+	}
+
+	rowDef.unlinkChain();
+};
+
 /** Alias to setRic
 * @public
 * @function
@@ -2408,6 +2600,7 @@ Grid.prototype._getAllColumnDefinitions = function() {
 	}
 	return colDefs;
 };
+
 /** @public
 * @param {number|string} rowRef Row index as shown in the view or row id (string)
 * @return {RowDefinition}
@@ -3163,9 +3356,14 @@ Grid.prototype._snapshotFillerDataChanged = function (e) {
 	if (!this._dt) return;
 
 	var data = e.data;
-	for (var ric in data) {
-		this.setRicData(ric, data[ric]);
+	if(e.timeSeries) {
+		this._updateTimeSeriesFields(e); // Increase or decrease time series field
+	} else {
+		for (var ric in data) {
+			this.setRicData(ric, data[ric]);
+		}
 	}
+
 	if(!this._lastPollingRequest) { // This is the first time we receive successful ADC response
 		this._lastPollingRequest = 1; // Allow polling to be started
 	}

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

@@ -91,6 +91,10 @@ declare class RowDefinition {
 
     public static deregisterFromView(rowIds: (string)[]|null, rowDef: RowDefinition|null): (string)[]|null;
 
+    public _toRealTimeRow(): void;
+
+    public unlinkChain(): void;
+
     public collapseChain(): boolean;
 
     public expandChain(): boolean;

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

@@ -764,6 +764,63 @@ RowDefinition.prototype.addConstituent = function(ric) {
 
 	return newChild ? childDef : null;
 };
+
+/** Used to convert autogenerated row to regular real-time row
+* @public
+*/
+RowDefinition.prototype._toRealTimeRow = function() {
+	if(!this._ric) { // Empty row
+		return;
+	}
+	if(this.isRowHeader()) {
+		return;
+	}
+
+	this._realTimeField = true;
+	this._dataId = this._rowId + this._ric; // JET/RTK will generate data id to be rowId (given from this rowDef) + ric;
+
+	this._autoGenerated = false;
+	this._parent = null;
+	this._depthLevel = 0;
+
+	this.subscribeForUpdates();
+};
+
+/** @public
+*/
+RowDefinition.prototype.unlinkChain = function() {
+	if(!this._isChain) {
+		return;
+	}
+
+	if(this.isChainExpanded()) {
+		var rowDefs = this.getDescendants();
+		var len = rowDefs.length;
+		for(var i = 0; i < len; i++) {
+			rowDefs[i]._toRealTimeRow();
+		}
+	}
+
+	this.unsubscribeForUpdates();
+
+	var view = this._view;
+	if(view) {
+		var rid = this.getRowId();
+		var segment = view.getSegment(rid);
+		if(segment) {
+			segment.setClassification(null);
+		}
+		view.setSegmentSeparator(rid, false);
+	}
+
+	this._isChain = this._expanded = false;
+	this._chainRic = "";
+	this._userInput = this._ric;
+	this._children = null;
+
+	this.subscribeForUpdates();
+};
+
 /** @public
 * @return {boolean} Returns true if there is a change in view
 */