@refinitiv-ui/efx-grid 6.0.13 → 6.0.14

package/lib/tr-grid-column-stack/es6/ColumnStack.d.ts

@@ -30,7 +30,14 @@ declare namespace ColumnStackPlugin {
         spreading?: boolean|null,
         collapsed?: boolean|null,
         children: (string)[]|null,
-        name?: string|null
+        name?: string|null,
+        activeColumn?: string|null
+    };
+
+    type StackConfiguration = {
+        spreading?: boolean|null,
+        collapsed?: boolean|null,
+        activeColumn?: string|null
     };
 
 }
@@ -75,9 +82,9 @@ declare class ColumnStackPlugin extends GridPlugin {
 
     public getStackId(colIndex: number): string;
 
-    public stackColumns(colRefs?: (number|string)[]|null, stackId?: string|null, options?: any, sort?: boolean|null): boolean;
+    public stackColumns(colRefs?: (number|string)[]|null, stackId?: string|null, options?: ColumnStackPlugin.StackConfiguration|null): boolean;
 
-    public setStack(colRefs?: (number|string)[]|null): boolean;
+    public setStack(colRefs?: (number|string)[]|null, activeColRef?: number|string|null): boolean;
 
     public unstackColumns(colIndices?: (number)[]|null): boolean;
 

package/lib/tr-grid-column-stack/es6/ColumnStack.js

@@ -33,6 +33,14 @@ import { preventDefault } from "../../tr-grid-util/es6/EventDispatcher.js";
 * @property {boolean=} collapsed=true If disabled, this group will be expanded at the first time
 * @property {Array.<string>} children Children column ID
 * @property {string=} name="" Name defined for specific stack
+* @property {string=} activeColumn="" Column Id of active column in stack
+*/
+
+/** @typedef {Object} ColumnStackPlugin~StackConfiguration
+* @description Available options describing grouped column displaying
+* @property {boolean=} spreading=false If specified true, this group will be running in collapsing mode
+* @property {boolean=} collapsed=true If disabled, this group will be expanded at the first time
+* @property {string=} activeColumn="" Column index or field for set as active column
 */
 
 /** @constructor
@@ -256,9 +264,17 @@ ColumnStackPlugin.prototype.config = function (options) {
 	}
 
 	if(this._initializedGrid) {
-		this.removeAllStacks(false);
+		if(Object.keys(stacks).length){
+			this.removeAllStacks(false);
+		} else {
+			this.removeAllStacks();
+		}
 		for(sid in stacks) {
-			this.stackColumns(stacks[sid].colRefs, sid, stacks[sid]);
+			var config = stacks[sid];
+			if(!config.colRefs){
+				this._transformStackConfig(config);
+			}
+			this.stackColumns(config.colRefs, sid, config);
 		}
 	} else {
 		this._pendingStacks = this._pendingStacks || stacks;
@@ -281,9 +297,11 @@ ColumnStackPlugin.prototype.getConfigObject = function (gridOptions) {
 
 		for (var stackKey in stacks) {
 			var stackOption = stacks[stackKey];
+			var activeColIndex = this._getColumnIndex(stackOption.activeColumn);
 			var stackConfigObj = {
 				id: stackOption.stackId,
-				children: this.getStackMemberIds(stackOption.stackId)
+				children: this.getStackMemberIds(stackOption.stackId),
+				activeColumn: this.getColumnId(activeColIndex)
 			};
 			var name = stackOption.name;
 			var collapsed = stackOption.collapsed;
@@ -314,6 +332,9 @@ ColumnStackPlugin.prototype._afterInit = function () {
 		this.removeAllStacks(false);
 		for(var sid in this._pendingStacks) {
 			var stackOpt = this._pendingStacks[sid];
+			if(!stackOpt.colRefs){
+				this._transformStackConfig(stackOpt);
+			}
 			this.stackColumns(stackOpt.colRefs, sid, stackOpt);
 		}
 		this._pendingStacks = null;
@@ -363,6 +384,37 @@ ColumnStackPlugin.prototype._setColumnStackOptions = function(colIndex, stackOpt
 	}
 };
 /** @private
+* @param {object} stackConfig
+* @return {object} stack config object
+*/
+ColumnStackPlugin.prototype._transformStackConfig = function(stackConfig) {
+	stackConfig.colRefs = [];
+	var children = stackConfig.children;
+	var activeColumn = stackConfig.activeColumn;
+	var field;
+	if(children){
+		var childLen = stackConfig.children.length;
+		for(var j = 0; j < childLen; j++){
+			var colIndex = this.getColumnIndex(children[j]);
+			if(colIndex !== -1){
+				field = this._getField(colIndex);
+				stackConfig.colRefs.push(field);
+			}
+		}
+	}
+	if(activeColumn){
+		var activeColIndex = this.getColumnIndex(activeColumn);
+		if(activeColIndex !== -1){
+			field = this._getField(colIndex);
+			if(field){
+				stackConfig.activeColumn;
+			}
+
+		}
+	}
+	return stackConfig;
+};
+/** @private
 * @param {number} colIndex
 * @return {*}
 */
@@ -803,20 +855,16 @@ ColumnStackPlugin.prototype.getStackId = function(colIndex) {
 /** @public
 * @param {Array.<number|string>=} colRefs Names of fields or column indices. If not specified, selected columns will be used.
 * @param {string=} stackId Must be unique
-* @param {Object=} options
-* @param {boolean=} sort Default to true. If enable and colRefs are column indices, column in stack will be sorted
+* @param {ColumnStackPlugin~StackConfiguration=} options
 * @return {boolean} Return true if all of the given columns is stacked together
 */
-ColumnStackPlugin.prototype.stackColumns = function(colRefs, stackId, options, sort) {
-	if(options.children && options.children.length > 1) {
-		colRefs = this.getColumnIndicesByColumnIds(options.children);
-	}
+ColumnStackPlugin.prototype.stackColumns = function(colRefs, stackId, options) {
+	var needSorting = true;
 
 	if(!colRefs) {
 		colRefs = this._getSelectedColumns();
 	}
 
-	var needSorting = sort !== null ? sort : true;
 	if(colRefs.length) {
 		if(typeof colRefs[0] === "string") {// Do not sort in the case of field stack
 			needSorting = false;
@@ -847,7 +895,13 @@ ColumnStackPlugin.prototype.stackColumns = function(colRefs, stackId, options, s
 
 	options = options || {};
 
-	var activeIndex = colRefs[0];
+	var activeIndex = options.activeColumn ? this.getColumnIndices(options.activeColumn) : colRefs[0];
+	if (activeIndex.length){
+		activeIndex = activeIndex[0];
+	}
+	if(activeIndex == null || colRefs.indexOf(activeIndex) == -1){
+		activeIndex = colRefs[0];
+	}
 	// Collecting data
 	var stack = {};
 	stack.stackId = sid;
@@ -864,6 +918,10 @@ ColumnStackPlugin.prototype.stackColumns = function(colRefs, stackId, options, s
 		this._setColumnStackOptions(colIndex, stack);
 		stack.stackRefs[i] = this._getColumnStacking(colIndex);
 
+		if(colIndex == activeIndex){
+			stack.activeColumn = stack.stackRefs[i];
+		}
+
 		// Prevent from flashing in stack mode
 		if(colIndex !== activeIndex && stack.collapsed !== false) {
 			this._setColumnVisibility(colIndex, false);
@@ -876,7 +934,6 @@ ColumnStackPlugin.prototype.stackColumns = function(colRefs, stackId, options, s
 	if(stack.spreading) {
 		stack.activeColumn = stack.stackRefs[stack.stackRefs.length - 1]; // Right most column is the active column
 	} else {
-		stack.activeColumn = stack.stackRefs[0]; // Left most column is the active column
 		var csp = this._getPlugin("ColumnSelectionPlugin");
 		if(csp && csp.isEnabled()) {
 			csp.selectSingleColumn(activeIndex);
@@ -899,9 +956,10 @@ ColumnStackPlugin.prototype.stackColumns = function(colRefs, stackId, options, s
 *  When adding columns, Grid will attempt to restore stacking
 *  if there are at least two visible columns that match to the retained fields.
 * @param {Array.<number|string>=} colRefs Field names or column indices
+* @param {number|string=} activeColRef Field names or column index  of active column
 * @return {boolean} If the stack has been updated, return true.
 */
-ColumnStackPlugin.prototype.setStack = function(colRefs) {
+ColumnStackPlugin.prototype.setStack = function(colRefs, activeColRef) {
 	// Keep state
 	var i, colRef, type;
 	var fields = [];
@@ -916,6 +974,9 @@ ColumnStackPlugin.prototype.setStack = function(colRefs) {
 			}
 		}
 	}
+	if(activeColRef && typeof activeColRef === "number") {
+		activeColRef = this._getField(activeColRef);
+	}
 
 	if(fields.length > 1) {
 		if(!this._columnStack) {
@@ -949,29 +1010,19 @@ ColumnStackPlugin.prototype.setStack = function(colRefs) {
 		return this.removeAllStacks();
 	}
 
-	// Check old data stacking
-	var count = 0;
-
-	if(this._stacks[sid]) {
-		var stackRefs = this._stacks[sid].stackRefs;
-		if(stackRefs.length === colRefs.length) {
-			for (i = 0; i < colRefs.length; i++) {
-				var stacking = this._getColumnStacking(colRefs[i]);
-				var oldStacking = stackRefs[i];
-				if(stacking === oldStacking) {
-					count++;
-				}
-			}
-			if(count === colRefs.length) {
-				return false;
+	var activeIndex = colRefs[0]; // For the active index, choose the first element.
+	if(activeColRef){
+		var indices = this.getColumnIndices(activeColRef);
+		if(indices.length){
+			var index = indices[0];
+			if(colRefs.indexOf(index) !== -1){
+				activeIndex = indices[0];
 			}
 		}
 	}
 
 	this.removeAllStacks(false); // Remove the stack without updating the UI (UI will only update when column is stacked)
 
-	var activeIndex = colRefs[0]; // For the active index, choose the first element.
-
 	// Collecting data
 	var stack = {};
 	stack.stackId = sid;
@@ -982,6 +1033,10 @@ ColumnStackPlugin.prototype.setStack = function(colRefs) {
 		stack.stackRefs[i] = this._getColumnStacking(colIndex);
 		this._setColumnStackOptions(colIndex, stack);
 
+		if(colIndex == activeIndex){
+			stack.activeColumn = stack.stackRefs[i];
+		}
+
 		// Prevent from flashing in stack mode
 		if(colIndex !== activeIndex && stack.collapsed !== false) {
 			this._setColumnVisibility(colIndex, false);
@@ -991,7 +1046,7 @@ ColumnStackPlugin.prototype.setStack = function(colRefs) {
 	// Make sure that all columns stay packed together
 	this._moveStackedColumns(stack.stackRefs);
 
-	stack.activeColumn = stack.stackRefs[0]; // The first stacking (the first given columns) is the active column
+	// stack.activeColumn = stack.stackRefs[0]; // The first stacking (the first given columns) is the active column
 	this._stacks[sid] = stack;
 	var cfp = this._getPlugin("ColumnFilterPlugin");
 	if(cfp) {
@@ -1136,8 +1191,6 @@ ColumnStackPlugin.prototype.swapColumn = function(colRef, swappingIndex) {
 		return false; // The given index is already active stacked column
 	}
 
-	colData.stackRefs.splice(swappingIndex, 1);
-	colData.stackRefs.unshift(newActiveColumn); // Move data to front
 	var prevActiveColumnIndex = this._getColumnIndex(colData.activeColumn);
 	var newActiveColumnIndex = this._getColumnIndex(newActiveColumn);
 	colData.activeColumn = newActiveColumn; // Change active column
@@ -1145,8 +1198,6 @@ ColumnStackPlugin.prototype.swapColumn = function(colRef, swappingIndex) {
 	this._setColumnVisibility(newActiveColumnIndex, true);
 	this._setColumnVisibility(prevActiveColumnIndex, false); // Hide current active column
 
-	this._moveColumn(newActiveColumnIndex, prevActiveColumnIndex); // Move UI to front
-
 	var csp = this._getPlugin("ColumnSelectionPlugin");
 	if(csp && csp.isEnabled()) {
 		csp.selectSingleColumn(newActiveColumnIndex);
@@ -1158,6 +1209,7 @@ ColumnStackPlugin.prototype.swapColumn = function(colRef, swappingIndex) {
 
 	colData = this._getColumnStackOptions(prevActiveColumnIndex);
 	this._updateIcon(prevActiveColumnIndex, colData);
+	this._updateIcon(newActiveColumnIndex, colData);
 
 	return true;
 };
@@ -1380,6 +1432,7 @@ ColumnStackPlugin.prototype._onStackButtonClicked = function(e) {
 
 	var stackRefs = colData.stackRefs;
 	var activeIndex = stackRefs.indexOf(colData.activeColumn);
+
 	var len = stackRefs.length;
 	var colIndices = new Array(len);
 	var menuData = new Array(len);
@@ -1639,8 +1692,12 @@ ColumnStackPlugin.prototype.reorderStackColumns = function(colRefs, stackId) {
 		collapsed: stack.collapsed
 	};
 
+	for(i = 0; i < newStackMembers.length; i++){
+		newStackMembers[i] = this._getField(newStackMembers[i]);
+	}
+
 	this.unstackColumns(stackMemberIndices);
-	this.stackColumns(newStackMembers, stackId, options, false);
+	this.stackColumns(newStackMembers, stackId, options);
 
 };
 

package/lib/tr-grid-util/es6/RowPainter.d.ts

@@ -26,7 +26,8 @@ declare namespace RowPainter {
         groupLevel?: number|null,
         nonGroupRow?: boolean|null,
         colorTagClass?: string|null,
-        indentSize?: number|null
+        indentSize?: number|null,
+        content: any
     };
 
 }

package/lib/tr-grid-util/es6/RowPainter.js

@@ -25,6 +25,7 @@ import { Icon } from "./Icon.js";
 * @property {boolean=} nonGroupRow
 * @property {string=} colorTagClass CSS class for custom coloring
 * @property {number=} indentSize
+* @property {*} content Content to be rendered on the first cell. If null or undefined value is given, no content will be changed.
 */
 
 /**
@@ -335,7 +336,12 @@ RowPainter.prototype.applyHeaderStyle = function(e) {
 		if (this._clickableCell) {
 			cell.listen("click", this._onCellClicked); // WARNING: content row share this same listener with this header cell
 		}
-		if (!this._segmentMode) {
+		if (this._segmentMode) {
+			var content = e.content;
+			if(content != null) {
+				cell.setContent(content);
+			}
+		} else {
 			cell.setContent(e.groupId || "");
 		}
 	}

package/lib/tr-grid-util/es6/jet/mockDataAPI.d.ts

@@ -1,4 +1,5 @@
 import { DataGenerator } from "./DataGenerator.js";
+import { DateTime } from "../DateTime.js";
 
 declare namespace DataGrid {
 

package/lib/tr-grid-util/es6/jet/mockDataAPI.js

@@ -1,4 +1,5 @@
 import { DataGenerator } from "./DataGenerator.js";
+import { DateTime } from "../DateTime.js";
 
 /**
 * @private
@@ -24,6 +25,7 @@ function setInvalidFields(fields) {
 	}
 }
 
+
 var dataGen = new DataGenerator();
 
 /** @private
@@ -125,70 +127,207 @@ Adc.request = function (payload, mockResponse) {
 		return Promise.resolve(JSON.stringify(mockResponse));
 	}
 
-	var i, f, len, row;
-	var identifiers = payload.identifiers;
-	var formula = payload.formula.split(",");
-	var fields = [];
+	// build row header
+	var rows = [];
+	var i, f, len, row, j;
+	var identifiers, formula, fields, invalidDict;
+	if(payload.output === "Col,date|,Row,In|,va,T,NoEmptyTickers") {
 
-	// _invalidFieldDict is a dictionary of non exist field
-	// so we must remove invalid field to make "mocking api" return result more like a "real api".
-	var invalidDict = _invalidFieldDict;
-	for (i = 0; i < formula.length; i++) {
-		f = formula[i];
-		if (!invalidDict[f]) {
-			fields.push(f);
+		identifiers = payload.identifiers;
+		formula =  payload.formula.trim().split(/(?=,TR.)/);// TODO: check each field with another way, this doesn't work when user use some comma (,) formula
+		fields = [];
+
+		// _invalidFieldDict is a dictionary of non exist field
+		// so we must remove invalid field to make "mocking api" return result more like a "real api".
+		invalidDict = _invalidFieldDict;
+		for (i = 0; i < formula.length; i++) {
+			f = formula[i];
+			if (!invalidDict[f]) {
+				fields.push(f);
+			}
 		}
-	}
 
-	// build row header
-	var rows = [];
-	rows[0] = [{
-		"h": true,
-		"i": "instrument",
-		"v": "Instrument"
-	}];
-	for (i = 0; i < fields.length; i++) {
-		f = fields[i];
-		rows[0].push({
+		var fieldCount = fields.length;
+		// formula = payload.formula.trim().split(",TR"); // TODO: split wit
+
+		rows.push([
+			{
+				"h": true,
+				"i": "instrument",
+				"v": "Instrument"
+			},
+			{
+				"h": true,
+				"i": "date",
+				"v": "Date"
+			}
+		]);
+
+		for (var index = 0; index < fieldCount; index++) {
+			var timeSeriesField = fields[index];
+
+			var regex = /TR.(.*)(?=\()/;
+			var result = timeSeriesField.match(regex);
+			var field = result[0].replace("TR.", "");
+			var phrase = timeSeriesField.toLowerCase();
+			var startDateRegex = /sdate=(.*)[,]/;
+			var endDateRegex = /edate=(.*)[)]/;
+			var startDateMatch = phrase.match(startDateRegex);
+			var endDateMatch = phrase.match(endDateRegex);
+
+			var startDate = startDateMatch ? startDateMatch[1] : DateTime.format(new Date(), "YYYY-MM-DD");
+			var endDate = endDateMatch[1];
+
+			var swapDateTmp;
+			if(startDate > endDate) {
+				swapDateTmp = startDate;
+				startDate = endDate;
+				endDate = swapDateTmp;
+			}
+
+			var msBetweenDate = (+new Date(endDate)) - (+new Date(startDate));
+
+			var msInDay = 1000 * 60 * 60 * 24;
+			var betweenDay = msBetweenDate / msInDay;
+			// var betweenDay = Math.floor(Math.random() * 10); // For random length
+
+
+			for (i = 0; i <= betweenDay; i++) {
+				var date = new Date(new Date(startDate).setDate(new Date(startDate).getDate() + i));
+				var fieldValue = {
+					"h": true,
+					"v": DateTime.format(date, "YYYY-MM-DDT00:00:00")
+				};
+				if(index === 0) { // add header 1 time
+					rows[0].push(fieldValue);
+				}
+			}
+
+			var rics = identifiers;
+			for (i = 0; i < rics.length; i++) {
+
+				var ric = rics[i];
+				var rowValue = [
+					ric,
+					field
+				];
+				for (j = 1; j <= betweenDay + 1; j++) {
+					var generatedValue = DataGenerator.generateRecord(field);
+					rowValue.push(generatedValue[field]);
+
+				}
+				rows.push(rowValue);
+			}
+			// The example rows should be look like
+			/*
+			[
+				[
+				{
+					"h": true,
+					"i": "instrument",
+					"v": "Instrument"
+				},
+				{
+					"h": true,
+					"i": "date",
+					"v": "Date"
+				},
+				{
+					"h": true,
+					"v": "2011-08-11T00:00:00"
+				},
+				{
+					"h": true,
+					"v": "2011-08-12T00:00:00"
+				},
+				{
+					"h": true,
+					"v": "2011-08-15T00:00:00"
+				}
+				],
+				[
+				"IBM",
+				"Price Close", // NOTE: this cannot be detech we join it with space Ex. PriceClose
+				159.25449372,
+				160.6585848,
+				165.23382036
+				],
+				[
+				"GOOGL.O",
+				"Price Close",
+				14.066881653,
+				14.107921423,
+				13.944262828
+				]
+			]
+			*/
+		}
+
+	} else {
+
+		identifiers = payload.identifiers;
+		formula = payload.formula.trim().split(","); // TODO: check each field with another way, this doesn't work when user use some comma (,) formula
+		fields = [];
+
+		// _invalidFieldDict is a dictionary of non exist field
+		// so we must remove invalid field to make "mocking api" return result more like a "real api".
+		invalidDict = _invalidFieldDict;
+		for (i = 0; i < formula.length; i++) {
+			f = formula[i];
+			if (!invalidDict[f]) {
+				fields.push(f);
+			}
+		}
+
+		rows[0] = [{
 			"h": true,
-			"r": f.toUpperCase()
-			// "v": "Price Close", // Doesn't use
-			// "p": "I_TRP_PH_PriceClose" // Doesn't use this property
-		});
-	}
+			"i": "instrument",
+			"v": "Instrument"
+		}];
+		for (i = 0; i < fields.length; i++) {
+			f = fields[i];
+			rows[0].push({
+				"h": true,
+				"r": f.toUpperCase().trim()
+				// "v": "Price Close", // Doesn't use
+				// "p": "I_TRP_PH_PriceClose" // Doesn't use this property
+			});
+		}
 
-	// build data
-	var rowMap = {};
+		// build data
+		var rowMap = {};
 
-	len = identifiers.length;
-	var rowData = dataGen.generate(fields, len);
-	for (i = 0; i < len; ++i) {
-		var inst = identifiers[i];
-		row = rowMap[inst];
-		if (!row) {
-			row = rowMap[inst] = rowData[i];
-			row.unshift(inst); // prepend instrument on each row
+		len = identifiers.length;
+		var rowData = dataGen.generate(fields, len);
+		for (i = 0; i < len; ++i) {
+			var inst = identifiers[i];
+			row = rowMap[inst];
+			if (!row) {
+				row = rowMap[inst] = rowData[i];
+				row.unshift(inst); // prepend instrument on each row
+			}
+			rows.push(row);
 		}
-		rows.push(row);
-	}
 
-	// There is a chance that rtk will return multiple row data per instrument
-	// so we must create mock up for this case
-	if (rows.length > 0) {
-		var chance = dataGen.randInt(1, 10);
-		if (chance <= 3) { // chance 30%
-			var pos = dataGen.randInt(0, rows.length - 1); // random row pos
-			row = rows[pos];
-			len = row.length;
-			var mockupRow = new Array(len);
-			mockupRow[0] = row[0]; // 1st index is for instrument
-			for (i = 1; i < len; i++) {
-				mockupRow[i] = ''; // real case will return null or empty string
+		// There is a chance that rtk will return multiple row data per instrument
+		// so we must create mock up for this case
+		if (rows.length > 0) {
+			var chance = dataGen.randInt(1, 10);
+			if (chance <= 3) { // chance 30%
+				var pos = dataGen.randInt(0, rows.length - 1); // random row pos
+				row = rows[pos];
+				len = row.length;
+				var mockupRow = new Array(len);
+				mockupRow[0] = row[0]; // 1st index is for instrument
+				for (i = 1; i < len; i++) {
+					mockupRow[i] = ''; // real case will return null or empty string
+				}
+				rows.splice(pos + 1, 0, mockupRow);
 			}
-			rows.splice(pos + 1, 0, mockupRow);
 		}
 	}
 
+
 	/*
 	response type is :
 	{

package/lib/types/es6/ColumnGrouping.d.ts

@@ -1,4 +1,5 @@
 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 { injectCss, prettifyCss } from "../../tr-grid-util/es6/Util.js";
 

package/lib/types/es6/ColumnStack.d.ts

@@ -30,7 +30,14 @@ declare namespace ColumnStackPlugin {
         spreading?: boolean|null,
         collapsed?: boolean|null,
         children: (string)[]|null,
-        name?: string|null
+        name?: string|null,
+        activeColumn?: string|null
+    };
+
+    type StackConfiguration = {
+        spreading?: boolean|null,
+        collapsed?: boolean|null,
+        activeColumn?: string|null
     };
 
 }
@@ -75,9 +82,9 @@ declare class ColumnStackPlugin extends GridPlugin {
 
     public getStackId(colIndex: number): string;
 
-    public stackColumns(colRefs?: (number|string)[]|null, stackId?: string|null, options?: any, sort?: boolean|null): boolean;
+    public stackColumns(colRefs?: (number|string)[]|null, stackId?: string|null, options?: ColumnStackPlugin.StackConfiguration|null): boolean;
 
-    public setStack(colRefs?: (number|string)[]|null): boolean;
+    public setStack(colRefs?: (number|string)[]|null, activeColRef?: number|string|null): boolean;
 
     public unstackColumns(colIndices?: (number)[]|null): boolean;