@refinitiv-ui/efx-grid 6.0.36 → 6.0.38

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

@@ -14,40 +14,6 @@ var SYNAPSE_URL =
 	+ 'hits=1' // search only 1 result
 	+ '&profile=' + encodeURIComponent('Field Selector');
 
-/** @function
-* @private
-* @param {Object} e
-*/
-function xRicNameRenderer(e) {
-	e.cell.setContent(e.rowDef.getDisplayText());
-}
-/** @function
-* @private
-* @param {RowDefinition} rowA
-* @param {RowDefinition} rowB
-* @param {number} order
-* @returns {number}
-*/
-function xRicNameSorter(rowA, rowB, order) {
-	var A = rowA.getDisplayText();
-	var B = rowB.getDisplayText();
-	if(A === B) {
-		return 0;
-	}
-	if(!A) {
-		return 1;
-	}
-	if(!B) {
-		return -1;
-	}
-	if(A < B) {
-		return -order;
-	}
-
-	return order;
-}
-
-
 /* @namespace */
 var FieldDefinition = {};
 
@@ -55,13 +21,6 @@ var FieldDefinition = {};
 * @private
 */
 FieldDefinition._defs = {
-	"X_RIC_NAME": {
-		name: "RIC",
-		IsRealtimeField: false,
-		width: 100,
-		binding: xRicNameRenderer,
-		sortLogic: xRicNameSorter
-	},
 	"CF_NAME": {
 		name: "Name",
 		rank: 2800003,

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

@@ -266,7 +266,7 @@ declare class Grid extends EventDispatcher {
 
     public freezeColumn(colIndex?: number|null, pinnedRightColumns?: number|null): void;
 
-    public pinColumn(colRef: Grid.ColumnReference|(Grid.ColumnReference)[]|null): boolean;
+    public pinColumn(colRef: Grid.ColumnReference|(Grid.ColumnReference)[]|null, side?: string|null): boolean;
 
     public unpinColumn(colRef: Grid.ColumnReference|(Grid.ColumnReference)[]|null, dest?: Grid.ColumnReference|null): boolean;
 

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

@@ -3101,50 +3101,72 @@ Grid.prototype.freezeColumn = function(colIndex, pinnedRightColumns) {
 	}
 	this._grid.freezeColumn(colIndex, pinnedRightColumns);
 };
+
 /** Pin column to the left side by moving the specified column to the rightmost of the frozen columns. <br>
 * The method will do nothing if the specified column is already pinned to the left side
 * @public
 * @param {Grid~ColumnReference|Array.<Grid~ColumnReference>} colRef
+* @param {string=} side Available values are: left|right. If no value is supplied, the column will be pinned to the left.
 * @return {boolean}
 */
-Grid.prototype.pinColumn = function(colRef) {
+Grid.prototype.pinColumn = function(colRef, side) {
 	if(Array.isArray(colRef)) {
 		var ary = colRef;
 		var len = ary.length;
 
 		var dirty = 0;
 		for(var i = 0; i < len; ++i) {
-			dirty |= this._pinColumn(ary[i]);
+			dirty |= this._pinColumn(ary[i], side);
 		}
 		return dirty ? true : false;
 	}
-	return this._pinColumn(colRef);
+	return this._pinColumn(colRef, side);
 };
 /** @private
 * @param {Grid~ColumnReference} colRef
+* @param {string=} side Available values are: left|right. If no value is supplied, the column will be pinned to the left.
 * @return {boolean}
 */
-Grid.prototype._pinColumn = function(colRef) {
+Grid.prototype._pinColumn = function(colRef, side) {
 	var colIndex = this.getColumnIndex(colRef);
-	if(colIndex < 0) {
+	var colCount = this.getColumnCount();
+	if(colIndex < 0 || colIndex > colCount) {
 		return false;
 	}
-	var pinnedCount = this._grid.getFrozenColumnCount();
-	if(colIndex < pinnedCount) {
-		return false; // The column is already pinned area
-	}
-	if(!pinnedCount) {
-		var stationaryIdx = this._grid.getStationaryColumnIndex();
-		if(stationaryIdx >= 0) {
-			pinnedCount = stationaryIdx;
-			if(colIndex > stationaryIdx) {
-				pinnedCount++;
+
+	var leftPinnedCount = this._grid.getPinnedLeftColumnCount();
+	var rightPinnedCount = this._grid.getPinnedRightColumnCount();
+	var stationaryIdx = this._grid.getStationaryColumnIndex();
+
+	if(side && side.toLowerCase() === "right") {
+		var rightPinnedIndex = this._grid.getFirstPinnedRightIndex();
+		if(colIndex >= rightPinnedIndex) {
+			return false; // The column is already pinned area
+		}
+
+		if(stationaryIdx >= 0 && colIndex <= stationaryIdx) {
+			return false;
+		}
+
+		this.moveColumnById(colIndex, rightPinnedIndex);
+		rightPinnedCount += 1;
+		leftPinnedCount -= 1;
+	} else {
+		if(colIndex < leftPinnedCount) {
+			return false; // The column is already pinned area
+		}
+		if(!leftPinnedCount) {
+			if(stationaryIdx >= 0) {
+				leftPinnedCount = stationaryIdx;
+				if(colIndex > stationaryIdx) {
+					leftPinnedCount++;
+				}
 			}
 		}
+		this.moveColumnById(colIndex, leftPinnedCount);
 	}
 
-	this.moveColumnById(colIndex, pinnedCount);
-	this._grid.freezeColumn(pinnedCount);
+	this._grid.freezeColumn(leftPinnedCount, rightPinnedCount);
 	return true;
 };
 /** Unpin column from the left side by moving the specified column to the end of the frozen columns. <br>
@@ -3177,13 +3199,16 @@ Grid.prototype._unpinColumn = function(colRef, dest) {
 	if(colIndex < 0) {
 		return false;
 	}
-	var pinnedCount = this._grid.getFrozenColumnCount();
-	if(!pinnedCount) {
+
+	var leftPinnedCount = this._grid.getPinnedLeftColumnCount();
+	var rightPinnedCount = this._grid.getPinnedRightColumnCount();
+	var colCount = this.getColumnCount();
+	var firstRightPinnedIndex = colCount - rightPinnedCount;
+
+	if(colIndex >= leftPinnedCount && colIndex < firstRightPinnedIndex) {
 		return false;
 	}
-	if(colIndex >= pinnedCount) {
-		return false; // The column is outside of frozen area
-	}
+
 	var srcId = null;
 	var destId = null;
 	if(dest != null) {
@@ -3194,11 +3219,19 @@ Grid.prototype._unpinColumn = function(colRef, dest) {
 
 	var stationaryIdx = this._grid.getStationaryColumnIndex();
 
-	if(colIndex > stationaryIdx) {
-		this.moveColumnById(colIndex, pinnedCount);
-	}
+	if(colIndex < leftPinnedCount) {
+		if(colIndex > stationaryIdx) {
+			this.moveColumnById(colIndex, leftPinnedCount);
+		}
 
-	this._grid.freezeColumn(pinnedCount - 2); // Column index is used for freezing
+		this._grid.freezeColumn(leftPinnedCount - 2, rightPinnedCount); // Column index is used for freezing
+	} else if(colIndex >= firstRightPinnedIndex) {
+		if(colIndex > stationaryIdx) {
+			this.moveColumnById(colIndex, firstRightPinnedIndex);
+		}
+
+		this._grid.freezeColumn(leftPinnedCount - 1, rightPinnedCount - 1); // Column index is used for freezing
+	}
 
 	if(colIndex > stationaryIdx) {
 		if(destId != null) {
@@ -3213,11 +3246,12 @@ Grid.prototype._unpinColumn = function(colRef, dest) {
 * @return {boolean}
 */
 Grid.prototype.unpinAllColumns = function() {
-	var pinnedCount = this._grid.getFrozenColumnCount();
-	if(!pinnedCount) {
+	var leftPinnedCount = this._grid.getPinnedLeftColumnCount();
+	var rightPinnedCount = this._grid.getPinnedRightColumnCount();
+	if(!leftPinnedCount && !rightPinnedCount) {
 		return false;
 	}
-	this._grid.freezeColumn(-1); // Column index is used for freezing
+	this._grid.freezeColumn(-1, 0); // Column index is used for left freezing and column count is used for right freezing
 	return true;
 };
 

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

@@ -37,7 +37,7 @@ declare class RowDefinition {
 
     public initialize(rowOptions?: RowDefinition.Options|null): void;
 
-    public setContent(userInput: string, permId?: string|null): boolean;
+    public setContent(userInput: string, permId?: string|null, asChain?: boolean|null, expanded?: boolean|null, realTime?: boolean|null): boolean;
 
     public getRowId(): string;
 
@@ -143,7 +143,7 @@ declare const ROW_DEF: string;
 
 declare const ROW_TYPES: RowDefinition.RowTypes;
 
-declare function rowData(userInput: string, permId?: string|null): boolean;
+declare function rowData(userInput: string, permId?: string|null, asChain?: boolean|null, expanded?: boolean|null, realTime?: boolean|null): boolean;
 
 export {RowDefinition, ROW_DEF, ROW_TYPES};
 export default RowDefinition;

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

@@ -12,9 +12,10 @@ import { DataTable } from "../../core/es6/data/DataTable.js";
 * @property {Array.<string>=} fields=null Field that corresponds to the given static values
 * @property {boolean=} asChain=false The given ric will be treated as a chain
 * @property {string=} chainRic="" RIC to be used for chain request (overiding ric property)
-* @property {boolean=} collapsed=false Chain is expanded by default
+* @property {boolean=} collapsed=true Chain is collapsed by default
 * @property {(string|null)=} label=null
 * @property {boolean=} hidden=true When this row is hidden
+* @pro // realTime
 */
 
 /** @typedef {Object} RowDefinition~RowTypes
@@ -90,18 +91,18 @@ RowDefinition.prototype._ric = ""; // Contains no 0#
 * @private
 */
 RowDefinition.prototype._permId = "";
-/** @type {string}
+/** @type {string|null}
 * @private
 */
-RowDefinition.prototype._displayText = "";
-/** @type {string|null}
+RowDefinition.prototype._label = null; // Label overrides _ric and _permId
+/** @type {boolean|null}
 * @private
 */
-RowDefinition.prototype._label = null; // Label overrides _ric and _displayText
+RowDefinition.prototype._isChain = null;
 /** @type {boolean}
 * @private
 */
-RowDefinition.prototype._isChain = false;
+RowDefinition.prototype._realTime = true;
 
 /** @type {string}
 * @private
@@ -125,10 +126,10 @@ RowDefinition.prototype._view = null;
 */
 RowDefinition.prototype._subId = "";
 
-/** @type {boolean}
+/** @type {boolean|null}
 * @private
 */
-RowDefinition.prototype._expanded = false;
+RowDefinition.prototype._expanded = null;
 /** @type {boolean}
 * @private
 */
@@ -216,18 +217,19 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 		return;
 	}
 
-	var val = rowOptions["ric"];
+	var val = rowOptions["permId"];
 	if(val != null) {
-		this._ric = val;
+		this._permId = val;
 	}
-	val = rowOptions["permId"];
+	val = rowOptions["ric"];
 	if(val != null) {
-		this._permId = val;
+		this._ric = val;
 	}
-	if(this._ric || this._permId){
-		this.setContent(this._ric, this._permId); // this._dataId is modified
+	val = rowOptions["label"];
+	// eslint-disable-next-line no-undefined
+	if(val !== undefined) { // Empty string and null are allowed
+		this._label = val;
 	}
-
 	val = rowOptions["chainRic"];
 	if(val != null) {
 		this._chainRic = val;
@@ -239,26 +241,40 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 	}
 
 	val = rowOptions["asChain"];
-	if(val) {
-		this._isChain = true;
-		this._expanded = !rowOptions["collapsed"];
-	} else if(this._isChain) {
-		var collapsed = rowOptions["collapsed"];
-		if(collapsed != null) {
-			this._expanded = !collapsed;
-		}
+	if(val !== null) {
+		this._isChain = val;
 	}
 
-	val = rowOptions["label"];
-	// eslint-disable-next-line no-undefined
-	if(val !== undefined) { // Empty string and null are allowed
-		this._label = val;
+	val = rowOptions["realTime"];
+	if(val != null) {
+		this._realTime = val;
 	}
 
+	val = rowOptions["collapsed"];
+	if(val != null){
+		this._expanded = !val;
+	}
 	val = rowOptions["keepModel"];
 	if(val) {
 		this._userModel = rowOptions;
 	}
+
+	var expanded = this._expanded;
+	var symbol = this._ric || this._chainRic;
+	var asChain = this._isChain || !!this._chainRic;
+	if(this._ric && this._ric.indexOf("0#") >= 0){
+		asChain = true;
+		expanded = true;
+	}
+	if(this._isChain === false){
+		asChain = false;
+	}
+	if(this._expanded === false){
+		expanded = false;
+	}
+	if(symbol || this._permId){
+		this.setContent(symbol, this._permId, asChain, expanded); // this._dataId is modified
+	}
 };
 /** @private
 * @param {!Object} rowOptions
@@ -268,8 +284,7 @@ RowDefinition.prototype._initializeAsConstituent = function(rowOptions) {
 	var parentDef = /** @type{RowDefinition} */(rowOptions["parent"]);
 	if(this.setParent(parentDef)) {
 		this._dataId = /** @type{string} */(rowOptions["dataId"]); // Constituent will have the same subId as its parent but with different ric
-		this._displayText = this._ric = /** @type{string} */(rowOptions["ric"]);
-
+		this._ric = /** @type{string} */(rowOptions["ric"]);
 		this._dc = parentDef._dc; // Parent chain must have data cache
 		if(this._dc) {
 			var rowData = this.getRowData(); // Do not trigger any data update
@@ -287,9 +302,12 @@ RowDefinition.prototype._initializeAsConstituent = function(rowOptions) {
 /** @public
 * @param {string} userInput RIC
 * @param {string=} permId=null Organization PermId, which use for getting ADC data for private  company
+* @param {boolean=} asChain
+* @param {boolean=} expanded
+* @param {boolean=} realTime
 * @return {boolean} True if there is any change otherwise false
 */
-RowDefinition.prototype.setContent = function(userInput, permId) {
+RowDefinition.prototype.setContent = function(userInput, permId, asChain, expanded) {
 	if(this._autoGenerated) { // AutoGenerated RowDefinition cannot be changed by user input
 		return false;
 	}
@@ -303,10 +321,7 @@ RowDefinition.prototype.setContent = function(userInput, permId) {
 	var dirty = (this._userInput !== userInput);
 	if(this._permId !== permId){
 		this._permId = permId || "";
-		if(!userInput){
-			this._displayText = this._permId;
-			dirty = true;
-		}
+		dirty = true;
 	}
 	if(!dirty) {
 		return false;
@@ -315,34 +330,44 @@ RowDefinition.prototype.setContent = function(userInput, permId) {
 	this.unsubscribeForUpdates();
 	this.resetUpdates(); // Remove all previous data updates because a new content is just entered
 
+	// TODO: handle changing between chain and ric row
 	this._userInput = userInput;
 	if(this._userInput.charAt(0) === "'") { // This is a row header
-		this._displayText = this._userInput.substr(1);
 		this._ric = this._chainRic = ""; // No ric for realtime request
 	} else {
 		if(this._userInput.indexOf("0#") >= 0) {
-			this._ric = this._userInput.replace("0#", "");
-			this._isChain = this._expanded = true; // Only chain can be expanded by 0# TODO: RIC with 0# is not necessarily a chain
-			this._chainRic = this._userInput;
-			if(this._view) {
-				this._view.setSegmentSeparator(this._rowId);
-				this.expandChain();
+			if(asChain === false){
+				this._ric = this._userInput;
+			} else {
+				this._ric = expanded === false ? this._userInput : this._userInput.replace("0#", "");
+				this._expanded = expanded;
+				this._isChain = true; // Only chain can be expanded by 0#
+				this._chainRic = this._userInput;
+				if(this._view) {
+					this._view.setSegmentSeparator(this._rowId);
+					this.expandChain();
+				}
 			}
 		} else {
 			this._ric = this._userInput;
-			this._chainRic = "";
+			if(asChain){
+				this._isChain = true;
+			}
 		}
-		this._displayText = this._ric; // No 0#
 	}
 
 	this._dataId = this._rowId + this.getSymbol(); // 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.
+
 	if(!this.subscribeForUpdates()) {
-		// Avoid losing the ROW_DEF pointer.
-		var rowData = {};
-		rowData[ROW_DEF] = this; // Enable tracking back and updating data
-		this.setRowData(rowData);
+		if(this._dc) {
+			// This will work for runtime ric modification, but not for first initilization.
+			// Avoid losing the ROW_DEF pointer.
+			var rowData = {};
+			rowData[ROW_DEF] = this; // Enable tracking back and updating data
+			rowData["X_RIC_NAME"] = this.getDisplayText();
+			this.setRowData(rowData);
+		}
 	}
 	return true;
 };
@@ -363,6 +388,16 @@ RowDefinition.prototype.getConfigObject = function(rowOptions) {
 		obj["ric"] = val;
 	}
 
+	// The user passed a single quote (') case
+	if(!this._ric && this._userInput.charAt(0) === "'") {
+		obj["ric"] = this._userInput;
+	}
+
+	val = this._realTime;
+	if(val !== true) {
+		obj["realTime"] = val;
+	}
+
 	val = this._permId;
 	if(val) {
 		obj["permId"] = val;
@@ -384,12 +419,12 @@ RowDefinition.prototype.getConfigObject = function(rowOptions) {
 	}
 
 	val = this._isChain;
-	if(val) {
+	if(val != null) {
 		obj["asChain"] = val;
 	}
 
 	val = this._expanded;
-	if(val) {
+	if(val != null) {
 		obj["collapsed"] = !val;
 	}
 
@@ -487,6 +522,7 @@ RowDefinition.prototype.setDataSource = function(dataSource) {
 	if(!rowData) {
 		rowData = {};
 		rowData[ROW_DEF] = this; // Enable tracking back and updating data
+		rowData["X_RIC_NAME"] = this.getDisplayText();
 		this.setRowData(rowData); // TODO: This will dispatch dataChanged event and caused update to be added, which should not happen
 	}
 
@@ -629,7 +665,16 @@ RowDefinition.prototype.getDisplayText = function() {
 	if(this._label != null) { // Empty string is allowed
 		return this._label;
 	}
-	return this._displayText;
+
+	if(this._ric) {
+		return this._ric;
+	}
+
+	if(this._permId) {
+		return this._permId;
+	}
+
+	return this._userInput;
 };
 /** @public
 * @return {string|null}
@@ -693,13 +738,18 @@ RowDefinition.prototype.isRealTimeRow = function() {
 	if(!this.getRic()) { // Empty row
 		return false;
 	}
-	if(this.isRowHeader()) {
+	if(!this._realTime) {
 		return false;
 	}
+
 	if(this._autoGenerated) { // Constituents in chain are not real-time row
 		return false;
 	}
 
+	if(this.isRowHeader()) {
+		return false;
+	}
+
 	return true;
 };
 
@@ -728,7 +778,7 @@ RowDefinition.prototype.subscribeForUpdates = function() {
 	if(prevRowData) {
 		this._dc.setRowData(this._dataId, prevRowData); // TODO: We may need to create a new object instead of prevRowData for data correctness
 	} else {
-		this._dc.setRowData(this._dataId, {"X_RIC_NAME": this.getSymbol(), "ROW_DEF": this}); // Trigger data update immediately
+		this._dc.setRowData(this._dataId, {"X_RIC_NAME": this.getDisplayText(), "ROW_DEF": this}); // Trigger data update immediately
 	}
 	return true;
 };