@refinitiv-ui/efx-grid 6.0.116 → 6.0.117

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

@@ -337,9 +337,12 @@ ColumnDefinition.prototype.initialize = function(columnOption) {
 
 	this._setField(field, columnOption); // Perform some field manipulation
 
-	val = columnOption["name"] || columnOption["title"]; // title is migrated from Composite Grid
+	val = columnOption["name"];
+	if(val == null) {
+		val = columnOption["title"]; // For backward compatability
+	}
 	if(val != null) { // Name can be empty string
-		this._name = val;
+		this._name = (typeof val === "string") ? val : (val + "");
 		this._defaultName = false;
 	}
 

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

@@ -11,6 +11,8 @@ declare class DataConnector extends EventDispatcher {
 
     public getAllRics(): (string)[]|null;
 
+    public hasRic(): boolean;
+
     public getAllRowDefs(): (RowDefinition)[]|null;
 
     public getAllFields(): (string)[];

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

@@ -53,6 +53,14 @@ DataConnector.prototype.getAllRics = function () {
 	return this._rics.getAllReferences();
 };
 
+/**
+ * @public
+ * @returns {boolean}
+*/
+DataConnector.prototype.hasRic = function () {
+	return this._rics.hasReference();
+};
+
 /** @public
  * @returns {Array.<RowDefinition>}
 */

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

@@ -256,6 +256,8 @@ declare class Grid extends EventDispatcher {
 
     public getAllRics(): (string)[]|null;
 
+    public hasRic(): boolean;
+
     public setRowData(rowRef: Grid.RowReference|null, values: any): void;
 
     public setStaticRowData(rowRef: Grid.RowReference|null, values: any): void;
@@ -296,6 +298,8 @@ declare class Grid extends EventDispatcher {
 
     public clearSort(): void;
 
+    public getSortingStates(): (any)[];
+
     public getDataView(): DataView|null;
 
     public setPage(pageIndex: number): boolean;

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

@@ -600,6 +600,12 @@ Grid.prototype._focusingArgs = null;
 * @private
 */
 Grid.prototype._scrolledRow = -1;
+/** @type {boolean}
+* @private
+*/
+Grid.prototype._unlinking = false;
+
+
 /** @public
 */
 Grid.prototype.dispose = function() {
@@ -2770,7 +2776,9 @@ Grid.prototype.unlinkChain = function(rowRef) {
 		return;
 	}
 
+	this._unlinking = true;
 	rowDef.unlinkChain();
+	this._unlinking = false;
 };
 
 /** Alias to setRic
@@ -3076,6 +3084,14 @@ Grid.prototype.setRicData = function(ric, values) {
 Grid.prototype.getAllRics = function() {
 	return this._connector.getAllRics();
 };
+
+/** Returns true if there is at least 1 RIC in the grid. This method includes RICs not in the row.
+* @public
+* @return {boolean}
+*/
+Grid.prototype.hasRic = function() {
+	return this._connector.hasRic();
+};
 /** A shorthand to set row data based on index of the specified row. It is better to keep rowDefinition object for updating data directly as row index can be changed by sorting and filtering.
 * @public
 * @param {Grid~RowReference} rowRef
@@ -3459,6 +3475,28 @@ Grid.prototype.getSortOrder = function() {
 Grid.prototype.clearSort = function() {
 	this._stp.clearSortState(); // WARNING: No event is dispatched
 };
+/** Get sorting states from sorting columns
+* @public
+* @return {!Array.<Object>} Array of sorting states ordered by priority. If there is no sorting column, an empty array is returned
+*/
+Grid.prototype.getSortingStates = function () { // This method is mainly for backward compatability
+	let ary = [];
+	let states = this._stp.getSortingStates();
+	let stateCount = states.length;
+
+	for (let i = 0; i < stateCount; i++) {
+		let state = states[i];
+		let colIndex = this._stp.getSortedColumnIndex(i);
+
+		ary.push({
+			"colId": this.getColumnId(colIndex),
+			"colIndex": colIndex,
+			"order": state["sortOrder"]
+		});
+	}
+
+	return ary;
+};
 
 /**
 * @private
@@ -3478,7 +3516,7 @@ Grid.prototype._onQuote2PostUpdate = function (e) {
 */
 Grid.prototype._onDataChanged = function(e) {
 	let rowData = e["rowData"]; // Use rowData to retrieve corresponding subscription object
-	if (!rowData) {
+	if (!rowData || this._unlinking) {
 		return; // This must be a global change
 	}
 	let rowDef = rowData[ROW_DEF];

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

@@ -10,6 +10,8 @@ declare class ReferenceCounter {
 
     public getAllReferences(): (string)[];
 
+    public hasReference(): boolean;
+
     public getAllReferers(): (string)[];
 
     public getAllReferrers(): (string)[];

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

@@ -40,6 +40,16 @@ ReferenceCounter.prototype.getAllReferences = function() {
 	return Object.keys(this._counter);
 };
 
+/** @public
+* @return {boolean}
+*/
+ReferenceCounter.prototype.hasReference = function() {
+	for (const key in this._counter) {
+		return true;
+	}
+	return false;
+};
+
 /** @public
 * @return {!Array.<string>}
 */

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

@@ -12,7 +12,7 @@ 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=true Chain or segment is collapsed by default
+* @property {boolean=} collapsed Chain is collapsed by default. Segment is expanded by default.
 * @property {(string|null)=} label=null
 * @property {boolean=} hidden=true When this row is hidden
 * @property {boolean=} realTime=true Realtime row, able to request for JET/RTK
@@ -139,7 +139,7 @@ RowDefinition.prototype._subId = "";
 /** @type {boolean|null}
 * @private
 */
-RowDefinition.prototype._expanded = null;
+RowDefinition.prototype._collapsed = null;
 /** @type {boolean}
 * @private
 */
@@ -271,17 +271,15 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 		this._realTime = val;
 	}
 
-	val = rowOptions["collapsed"];
-	let collapsed = extractedOptions["collapsed"];
-	if(val != null || !collapsed){
-		this._expanded = !collapsed;
-	}
-
 	val = rowOptions["asSegment"];
 	if(val != null) {
 		this._asSegment = val ? true : false;
 	}
 
+	if(this._isChain) {
+		this._collapsed = extractedOptions["collapsed"]; // Temporary state
+	}
+
 	val = rowOptions["keepModel"];
 	if(val) {
 		this._userModel = rowOptions;
@@ -403,12 +401,11 @@ RowDefinition.prototype.setContent = function(userInput, extractedOptions) {
 	this.resetUpdates(); // Remove all previous data updates because a new content is just entered
 
 	this._userInput = userInput;
+	let collapsed = extractedOptions["collapsed"];
 	if(realtimeRow) {
-		let expanded = !extractedOptions["collapsed"];
 		let chainRic = extractedOptions["chainRic"];
 		if(asChain === true){
-			this._ric = expanded === false ? userInput : userInput.replace("0#", "");
-			this._expanded = expanded; // Only chain can be expanded by 0#
+			this._ric = collapsed === true ? userInput : userInput.replace("0#", "");
 		} else {
 			this._ric = userInput;
 		}
@@ -435,15 +432,12 @@ RowDefinition.prototype.setContent = function(userInput, extractedOptions) {
 		if(this._isChain) {
 			dv.setSegmentSeparator(this._rowId, true);
 		}
-		if(this.isChainCollapsed()) {
-			if(this._expanded){
-				this.expandChain();
-			}
-		} else {
-			if (!this._expanded) {
-				this.collapseChain();
-			}
+
+		if(collapsed !== this.isChainCollapsed()) {
+			dv.collapseSegment(this._rowId, collapsed);
 		}
+		this._collapsed = null;
+
 		_stallSorting(dv, false, stalledSorting);
 		if(segmentId) { // If data id is changed and the row is a child of a segment, then segment child data id must be updated
 			dv.addSegmentChild(segmentId, this._rowId, this._dataId);
@@ -519,9 +513,9 @@ RowDefinition.prototype.getConfigObject = function(rowOptions) {
 		obj["asChain"] = val;
 	}
 
-	val = this._expanded;
+	val = this._collapsed;
 	if(val != null) {
-		obj["collapsed"] = !val;
+		obj["collapsed"] = val;
 	}
 
 	// check row hidden
@@ -1029,8 +1023,9 @@ RowDefinition.prototype.registerToView = function(view, rowId) {
 	if(isSegment) {
 		view.setSegmentSeparator(newRowId);
 		_stallSorting(view, false, stalledSorting);
-		if(!this._expanded) {
-			view.collapseSegment(newRowId);
+		if(this._collapsed != null) {
+			view.collapseSegment(newRowId, this._collapsed);
+			this._collapsed = null;
 		}
 	} else if(!this._parent && parentRowId) { // Constituent cannot be added to another segment
 		view.addSegmentChild(parentRowId, newRowId, this._dataId);
@@ -1148,23 +1143,22 @@ RowDefinition.prototype._toRealTimeRow = function() {
 	if(!this._ric) { // Empty row
 		return;
 	}
-	if(this.isRowHeader()) {
-		return;
+	if(this.isRowHeader() || !this._parent) {
+		return; // If the row is already a normal row or row header, it cannot be converted
 	}
 
-	this._realTimeField = true;
+	this._realTime = true;
+	this._dc.setRowData(this._dataId, null); // Remove existing data. WARNING: Trigger data update immediately
 	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;
 
-	// Add static value to the new allocated row
-	if(this._staticValues) {
+	this.subscribeForUpdates();
+	if(this._staticValues) { // Add static value to the new allocated row
 		this.setRowData(this._staticValues);
 	}
-
-	this.subscribeForUpdates();
 };
 
 /** @public
@@ -1198,7 +1192,7 @@ RowDefinition.prototype.unlinkChain = function() {
 		view.setSegmentSeparator(rid, false);
 	}
 
-	this._isChain = this._expanded = false;
+	this._isChain = false;
 	this._chainRic = "";
 	this._userInput = this._ric;
 	this._children = null;
@@ -1211,7 +1205,6 @@ RowDefinition.prototype.unlinkChain = function() {
 */
 RowDefinition.prototype.collapseChain = function() {
 	if(this._isChain && this._view) {
-		this._expanded = false;
 		return this._view.collapseSegment(this._rowId, true);
 	}
 	return false;
@@ -1227,7 +1220,6 @@ RowDefinition.prototype.collapseChain = function() {
 */
 RowDefinition.prototype.expandChain = function() {
 	if(this._isChain && this._view) {
-		this._expanded = true;
 		return this._view.collapseSegment(this._rowId, false);
 	}
 	return false;
@@ -1240,7 +1232,7 @@ RowDefinition.prototype.expandChain = function() {
 * @return {boolean} Returns true if there is a change in view
 */
 RowDefinition.prototype.toggleChain = function() {
-	if(this._expanded) {
+	if(this.isChainExpanded()) {
 		return this.collapseChain();
 	} else {
 		return this.expandChain();
@@ -1421,6 +1413,8 @@ RowDefinition.extractRowOptions = function(rowOptions) {
 			asChain = true;
 		}
 		expanded = true;
+	} else if(asChain) {
+		expanded = false;
 	}
 
 	let extractedOptions = {};

package/lib/tr-grid-contextmenu/es6/MenuEventAPI.d.ts

@@ -14,7 +14,7 @@ declare class MenuEventAPI {
 
     public getMenuItems(): any[]|null;
 
-    public findItem(id: number): (string)[] | any|null;
+    public findItem(id: number): any[]|null;
 
 }
 

package/lib/tr-grid-contextmenu/es6/MenuEventAPI.js

@@ -7,7 +7,7 @@
 * @param {Array} legacyColumnGroups
 */
 let MenuEventAPI = function (menuModel) {
-	this._model = menuModel;
+	this._model = menuModel || null; // for mapping string value
 	this._items = [];
 	this._runningId = 0;
 };
@@ -48,8 +48,10 @@ MenuEventAPI.prototype._addItem = function (item, level) {
 	if (typeof item === "string") { // The item is referencing another item
 		if (item === "SEPARATOR" || item.match(/-{3,}/)) { // Special keyword
 			this.addSeparator();
-		} else {
-			this._addItem(this._model.items[item], level + 1);
+		} else if(this._model) {
+			if(this._model.items) {
+				this._addItem(this._model.items[item], level + 1);
+			}
 		}
 	} else if (Array.isArray(item)) { // The item is an item list
 		let len = item.length;
@@ -67,7 +69,8 @@ MenuEventAPI.prototype.addSeparator = function () {
 	this._items.push({ type: "separator" });
 };
 
-/** @public
+/** Get immidiate child menu items
+* @public
 * @returns {Array}
 */
 MenuEventAPI.prototype.getMenuItems = function () {
@@ -76,7 +79,7 @@ MenuEventAPI.prototype.getMenuItems = function () {
 
 /** @public
 * @param {number} id
-* @returns {Array.<string> | Object}
+* @returns {Array} Array of items (ordered by leaf node to root node)
 */
 MenuEventAPI.prototype.findItem = function (id) { // For internal use
 	return this._findItem(id, this._items);
@@ -85,13 +88,15 @@ MenuEventAPI.prototype.findItem = function (id) { // For internal use
 /** @private
 * @param {number} id
 * @param {Array.<string> | Object} item
-* @returns {string}
+* @returns {Array}
 */
 MenuEventAPI.prototype._findItem = function (id, item) {
-	let foundItemPath;
 	if (!item) {
 		return null;
-	} else if (Array.isArray(item)) {
+	}
+
+	let foundItemPath;
+	if (Array.isArray(item)) {
 		let len = item.length;
 		for (let i = 0; i < len; ++i) {
 			foundItemPath = this._findItem(id, item[i]);

package/lib/tr-grid-contextmenu/es6/MenuItem.js

@@ -23,11 +23,31 @@ MenuItem.prototype._elem;
 /** @type {Object}
 * @private
 */
-MenuItem.prototype._options;
+MenuItem.prototype._options = null;
 /** @type {boolean}
 * @private
 */
 MenuItem.prototype._isSelectable = true;
+/** @type {string}
+* @private
+*/
+MenuItem.prototype._id = "";
+/** @type {string}
+* @private
+*/
+MenuItem.prototype._type = "";
+/** @type {string}
+* @private
+*/
+MenuItem.prototype._text = "";
+/** @type {*}
+* @private
+*/
+MenuItem.prototype._value = null;
+/** @type {Array}
+* @private
+*/
+MenuItem.prototype._items = null;
 
 /** @private
 * @param {Object} options
@@ -40,16 +60,20 @@ MenuItem.prototype._init = function(options) {
 	li.addEventListener("mouseover", t._onItemHovered);
 	li.addEventListener("click", t._onItemClicked);
 	t._elem = li;
-	t._options = options;
+	t._options = options || null;
 };
-
 /** @public */
 MenuItem.prototype.dispose = function() {
 	let t = this;
 	t.removeAllEventListeners();
 	t._elem.removeEventListener("mouseover", t._onItemHovered);
 	t._elem.removeEventListener("click", t._onItemClicked);
-	t._elem.parentNode.removeChild(t._elem);
+
+	let pn = t._elem.parentNode;
+	if(pn) {
+		pn.removeChild(t._elem);
+	}
+	t._elem = t._options = t._value = t._items = null;
 };
 
 /** @private
@@ -133,6 +157,17 @@ MenuItem.prototype._onItemClicked = function(e) {
 	t._dispatch("itemClicked", e);
 };
 
+/** @public
+* @ignore
+* @returns {Object}
+*/
+MenuItem.prototype._getEventHandlers = function() {
+	return {
+		mouseover: this._onItemHovered,
+		click: this._onItemClicked
+	};
+};
+
 /** @public
 * @param {*} id
 */
@@ -146,7 +181,7 @@ MenuItem.prototype.setId = function(id) {
 * @returns {*}
 */
 MenuItem.prototype.getId = function() {
-	return this._id;
+	return this._id || "";
 };
 
 /** @public
@@ -162,7 +197,7 @@ MenuItem.prototype.setText = function(text) {
 * @returns {string}
 */
 MenuItem.prototype.getText = function() {
-	return this._text;
+	return this._text || "";
 };
 
 /** @public
@@ -206,8 +241,13 @@ MenuItem.prototype.isSelectable = function() {
 */
 MenuItem.prototype.setItems = function(items) {
 	let t = this;
-	t._items = items;
-	t._elem.classList.add("has-child");
+	if(Array.isArray(items)) {
+		t._items = items;
+		t._elem.classList.add("has-child");
+	} else {
+		t._items = null;
+		t._elem.classList.remove("has-child");
+	}
 };
 
 /** @public
@@ -229,7 +269,7 @@ MenuItem.prototype.setType = function(type) {
 * @returns {string}
 */
 MenuItem.prototype.getType = function() {
-	return this._type;
+	return this._type || "";
 };
 
 /** @public

package/lib/tr-grid-contextmenu/es6/PopupMenu.js

@@ -107,19 +107,22 @@ PopupMenu.prototype.dispose = function () {
 	}
 };
 
-/** @private */
+/** @private
+* @function
+* @param {*} obj
+*/
+let _disposeObject = function(obj) {
+	if(obj) {
+		obj.dispose();
+	}
+};
+
+/** @private
+*/
 PopupMenu.prototype._disposeChildren = function () {
 	let t = this;
-	t._children.forEach(function (child) {
-		if (child) {
-			child.dispose();
-		}
-	});
-	t._childrenItem.forEach(function (child) {
-		if (child) {
-			child.dispose();
-		}
-	});
+	t._children.forEach(_disposeObject);
+	t._childrenItem.forEach(_disposeObject);
 	t._children.length = 0;
 	t._childrenItem.length = 0;
 };
@@ -162,9 +165,11 @@ PopupMenu.prototype.setPosition = function(positioning, x, y) {
 		let sx = (window.scrollX != null) ? window.scrollX : window.pageXOffset;
 		let sy = (window.scrollY != null) ? window.scrollY : window.pageYOffset;
 		let rb = ww + sx; // view port right bound
-		let bb = wh + sy; // view port bottom boundnd
-		let aw = t._popup._elem.offsetWidth;
-		let ah = t._popup._elem.offsetHeight;
+		let bb = wh + sy; // view port bottom bound
+
+		let popupElem = t._popup.getElement();
+		let aw = popupElem.offsetWidth;
+		let ah = popupElem.offsetHeight;
 
 		if (x + aw > rb) { // Do not overflow right bound
 			x = rb - aw;
@@ -173,8 +178,8 @@ PopupMenu.prototype.setPosition = function(positioning, x, y) {
 			y = bb - ah;
 		}
 
-		t._popup._elem.style.left = (x - sx) + "px"; // Due to fixed position we have to subtract window scrolling
-		t._popup._elem.style.top = (y - sy) + "px";
+		popupElem.style.left = (x - sx) + "px"; // Due to fixed position we have to subtract window scrolling
+		popupElem.style.top = (y - sy) + "px";
 	}
 };
 
@@ -230,17 +235,15 @@ PopupMenu.prototype.setMenu = function (menuItems) {
 * @param {Event} e
 */
 PopupMenu.prototype._hoveredChildItem = function (e) {
-	let t = this;
-	t._dispatch("itemHovered", e);
+	this._dispatch("itemHovered", e);
 };
 
 /** @private
 * @param {Event} e
 */
 PopupMenu.prototype._clickedChildItem = function (e) {
-	let t = this;
-	t._dispatch("itemClicked", e);
-	t.hide();
+	this._dispatch("itemClicked", e);
+	this.hide();
 };
 
 /** @private

package/lib/tr-grid-in-cell-editing/es6/InCellEditing.d.ts

@@ -6,6 +6,7 @@ import { ElfUtil } from "../../tr-grid-util/es6/ElfUtil.js";
 import { isTouchDevice, injectCss, prettifyCss } from "../../tr-grid-util/es6/Util.js";
 import { ElfDate } from "../../tr-grid-util/es6/ElfDate.js";
 import { CoralItems } from "../../tr-grid-util/es6/CoralItems.js";
+import { Conflator } from "../../tr-grid-util/es6/Conflator.js";
 
 declare namespace InCellEditingPlugin {
 
@@ -85,6 +86,8 @@ declare class InCellEditingPlugin extends GridPlugin {
 
     public showStarterText(bool?: boolean|null): void;
 
+    public _requestUpdateStarterText(): void;
+
     public isEditing(): boolean;
 
     public getTextBox(columnIndex?: number|null, grid?: any): Element|null;