@refinitiv-ui/efx-grid 6.0.39 → 6.0.40

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

@@ -25,6 +25,7 @@ declare namespace ColumnDefinition {
         rowSorting?: boolean|null,
         sortable?: boolean|null,
         sort?: string|null,
+        sortOrder?: string|null,
         styles?: any,
         width?: number|null,
         minWidth?: number|null,

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

@@ -30,7 +30,8 @@ import Engine from "../../tr-grid-util/es6/formula/Engine.js";
 * @property {ColumnDefinition~SortLogic=} sorter=null Alias to `sortLogic`
 * @property {boolean=} rowSorting=null If set to true, RowDefinition object will be used for sorting comparison. If set to false, data from the given `field` will be used for sorting comparison.
 * @property {boolean=} sortable=true If disabled, the column cannot be sorted by user click
-* @property {string=} sort="" This column will be sorted at the initialization in the specified order (e.g. "asc", "desc")
+* @property {string=} sort="" Deprecated Alias to `sortOrder`
+* @property {string=} sortOrder="" The column can be sorted in ascending and descending order by specifying the order "a", "d". This option will sort the column when it is initialized or inserted at runtime.
 * @property {Object=} styles=null Key/value pair Object specifying CSS styles
 * @property {number=} width=NaN If specified, column will have a fixed width in pixel
 * @property {number=} minWidth=NaN If specified, column will have a minimum width in pixel
@@ -408,7 +409,7 @@ ColumnDefinition.prototype.initialize = function(columnOption) {
 	}
 
 	// Deprecate
-	val = columnOption["sort"];
+	val = columnOption["sortOrder"] || columnOption["sort"];
 	if(val) {
 		this._initialOrder = val;
 	}
@@ -658,11 +659,13 @@ ColumnDefinition.prototype.isScalable = function() {
 	var colIndex = grid.getColumnIndex(this);
 	return core.getColumnScalability(colIndex);
 };
-/** @public
- * @deprecated
+/** Deprecated, this function will be return initial sort order of this column, The current sort state may be different from initial sort state.
+* @public
+* @deprecated
 * @return {string}
 */
 ColumnDefinition.prototype.getInitialSortOrder = function() {
+	// WARNING: This state is different from `sortOrder`, it is the state when grid is initialized.
 	return this._initialOrder;
 };
 /** @public
@@ -766,10 +769,6 @@ ColumnDefinition.prototype.getConfigObject = function(colOptions) {
 		obj["sortable"] = false;
 	}
 
-	if(this._initialOrder) {
-		obj["sort"] = this._initialOrder;
-	}
-
 	var classes = this._classes;
 	if(classes && classes.length > 0) {
 		obj["className"] = classes.join(" ");

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

@@ -318,6 +318,8 @@ declare class Grid extends EventDispatcher {
 
     public logDV(opt_options?: any): void;
 
+    public replaceRow(rowRef: Grid.RowReference|null, rowOption?: any): any;
+
 }
 
 declare function borders(gridOptions?: any): any;

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

@@ -1528,6 +1528,9 @@ Grid.prototype.replaceColumn = function (columnOption, colRef) {
 		colConfig["hidden"] = false;
 	}
 
+	if(colConfig.id == null) {
+		colConfig.id =  colDef.getId(); // retain ID
+	}
 	this._grid.startBatch("reset");
 	this.insertColumn(colConfig, colIndex);
 	this.removeColumn(colIndex + 1); // remove existing column after insert
@@ -1678,12 +1681,6 @@ Grid.prototype.restoreColumns = function(columns) {
 		}
 	}
 
-	var sortingStates;
-	var removeLen = removingFields.length;
-	if(removeLen > 0 && this._stp) {
-		sortingStates = this._stp.getSortingStates().slice(); // We need to clone array for avoid object reference in remove column
-	}
-
 	this.removeColumns(removingFields);
 
 	var keepingLen = keepingColumns.length;
@@ -1711,10 +1708,6 @@ Grid.prototype.restoreColumns = function(columns) {
 		this._grid.freezeLayout(prevState);
 	}
 
-	if(removeLen > 0 && this._stp) {
-		this._stp.sortColumns(sortingStates);
-	}
-
 	grid.reorderColumns(columnOrdering);
 	grid.stopBatch("reset");
 };
@@ -2601,37 +2594,35 @@ Grid.prototype.hasHiddenRow = function(){
 /** Set RIC to the specified row
 * @public
 * @param {Grid~RowReference} rowRef
-* @param {string} str
+* @param {string} str RIC to be set to a row
 * @param {RowDefinition~Options=} options
 */
 Grid.prototype.setRic = function(rowRef, str, options) {
 	if(this._mainGrid) {
-		this._mainGrid.setRic(this._toRowId(rowRef), str);
+		this._mainGrid.setRic(this._toRowId(rowRef), str, options);
 		return;
 	}
 	var rowDef = this._getRowDefinitionByRef(rowRef);
 	if(rowDef) {
 		options = options || {};
-		var newChain = false;
-		if(str.indexOf("0#") > 0 || options["asChain"]) {
-			newChain = true;
+		options["ric"] = str;
+		var extractedOptions = RowDefinition.extractRowOptions(options);
+		var oldRic = rowDef.getSymbol();
+		var permId = options["permId"];
+		var expanded = null;
+		var collapsed = options["collapsed"];
+		if(collapsed != null){
+			expanded = !extractedOptions["collapsed"];
+		}
+		if(rowDef.setContent(str, permId, extractedOptions["asChain"], expanded)) { // The given string may not be a RIC
+			this._connector.removeRic(rowDef, oldRic);
+			this._initDuplicateRicData(rowDef);
+			this._connector.addRic(rowDef);
 		}
-		if(rowDef.isChain() || newChain) {
-			if(rowDef.getRic() !== str.replace("0#", "")) {
-				var rowIndex = this._dv.getRowIndex(rowDef.getRowId());
-				this.removeRow(rowDef);
 
-				options["ric"] = str;
-				this.insertRow(options, rowIndex);
-			}
-		} else {
-			var oldRic = rowDef.getSymbol();
-			var permId = options["permId"] || "";
-			if(rowDef.setContent(str, permId)) { // The given string may not be a RIC
-				this._connector.removeRic(rowDef, oldRic);
-				this._initDuplicateRicData(rowDef);
-				this._connector.addRic(rowDef);
-			}
+		var values = options["values"];
+		if(values != null) {
+			rowDef.setStaticRowData(values, options["fields"]);
 		}
 	}
 };
@@ -3882,6 +3873,28 @@ Grid.prototype._logData = function(rowDefs, options) {
 
 	console.table(tbl); // eslint-disable-line
 };
+/** @public
+* @description Replace existing row with a new row. Row ID would be changed, after row is replaced.
+* @param {Grid~RowReference} rowRef Reference (i.e. row index, row id, or row definition) of the insert position
+* @param {Object=} rowOption
+* @returns {Object}
+*/
+Grid.prototype.replaceRow = function(rowRef, rowOption) {
+	var rowId = this._getRowId(rowRef);
+	var rowDef = this._getRowDefinitionByRef(rowRef);
+	if(rowDef.isAutoGenerated()) { // Users cannot replace auto-generated
+		return  null;
+	}
+	var configObj = rowDef.getConfigObject();
+
+	if(deepEqual(configObj, rowOption)){
+		return null;
+	} else {
+		var insertedRow = this.insertRow(rowOption, rowId);
+		this.removeRow(rowId);
+		return insertedRow;
+	}
+};
 
 export { Grid };
 export default Grid;

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

@@ -13,7 +13,8 @@ declare namespace RowDefinition {
         chainRic?: string|null,
         collapsed?: boolean|null,
         label?: (string|null)|null,
-        hidden?: boolean|null
+        hidden?: boolean|null,
+        realTime?: boolean|null
     };
 
     type RowTypes = {
@@ -37,8 +38,6 @@ declare class RowDefinition {
 
     public initialize(rowOptions?: RowDefinition.Options|null): void;
 
-    public setContent(userInput: string, permId?: string|null, asChain?: boolean|null, expanded?: boolean|null, realTime?: boolean|null): boolean;
-
     public getRowId(): string;
 
     public getConfigObject(rowOptions?: RowDefinition.Options|null): RowDefinition.Options|null;
@@ -143,7 +142,7 @@ declare const ROW_DEF: string;
 
 declare const ROW_TYPES: RowDefinition.RowTypes;
 
-declare function rowData(userInput: string, permId?: string|null, asChain?: boolean|null, expanded?: boolean|null, realTime?: boolean|null): boolean;
+declare function rowData(userInput: string, permId?: string|null, asChain?: boolean|null, expanded?: boolean|null): boolean;
 
 export {RowDefinition, ROW_DEF, ROW_TYPES};
 export default RowDefinition;

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

@@ -15,7 +15,7 @@ import { DataTable } from "../../core/es6/data/DataTable.js";
 * @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
+* @property {boolean=} realTime=true Realtime row, able to request for JET/RTK
 */
 
 /** @typedef {Object} RowDefinition~RowTypes
@@ -217,6 +217,8 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 		return;
 	}
 
+	var extractedOptions = RowDefinition.extractRowOptions(rowOptions);
+
 	var val = rowOptions["permId"];
 	if(val != null) {
 		this._permId = val;
@@ -234,13 +236,8 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 	if(val != null) {
 		this._chainRic = val;
 	}
-	val = rowOptions["values"];
-	// eslint-disable-next-line no-undefined
-	if(val !== undefined) {
-		this.setStaticRowData(val, rowOptions["fields"]);
-	}
 
-	val = rowOptions["asChain"];
+	val = extractedOptions["asChain"];
 	if(val !== null) {
 		this._isChain = val;
 	}
@@ -252,28 +249,22 @@ RowDefinition.prototype.initialize = function(rowOptions) {
 
 	val = rowOptions["collapsed"];
 	if(val != null){
-		this._expanded = !val;
+		this._expanded = extractedOptions["collapsed"];
 	}
 	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
+		this.setContent(symbol, this._permId, this._isChain, this._expanded); // this._dataId is modified
+	}
+
+	val = rowOptions["values"];
+	// eslint-disable-next-line no-undefined
+	if(val !== undefined) {
+		this.setStaticRowData(val, rowOptions["fields"]);
 	}
 };
 /** @private
@@ -300,11 +291,11 @@ RowDefinition.prototype._initializeAsConstituent = function(rowOptions) {
 	}
 };
 /** @public
+* @ignore
 * @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, asChain, expanded) {
@@ -327,33 +318,40 @@ RowDefinition.prototype.setContent = function(userInput, permId, asChain, expand
 		return false;
 	}
 
-	this.unsubscribeForUpdates();
+	if(!this.unsubscribeForUpdates()){
+		this._clearStaticData();
+	}
 	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._ric = this._chainRic = ""; // No ric for realtime request
 	} else {
-		if(this._userInput.indexOf("0#") >= 0) {
-			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();
-				}
-			}
+		if(asChain === true){
+			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;
 		} else {
 			this._ric = this._userInput;
-			if(asChain){
-				this._isChain = true;
+			this._isChain = asChain;
+		}
+	}
+
+	if(this._view) {
+		if(this._isChain){
+			var rid = this.getRowId();
+			var segmentId = this._view.getSegmentParentRowId(rid);
+			if(segmentId){
+				this._view.removeSegmentChild(segmentId, rid);
 			}
 		}
+		this._view.setSegmentSeparator(this._rowId, !!this._isChain);
+		if(this._expanded && this.isChainCollapsed()){
+			this.expandChain();
+		} else if (!this._expanded && this.isChainExpanded()){
+			this.collapseChain();
+		}
 	}
 
 	this._dataId = this._rowId + this.getSymbol(); // JET/RTK will generate data id to be rowId (given from this rowDef) + ric;
@@ -798,7 +796,7 @@ RowDefinition.prototype.unsubscribeForUpdates = function() {
 	this.resetUpdates();
 	// TODO: Reset only if this is the last ric
 	this._dc.setRowData(this._dataId, null); // Trigger data update immediately
-	// TODO: Handle static values
+	this._clearStaticData();
 	// eslint-disable-next-line consistent-return
 	return prevRowData;
 };
@@ -1210,6 +1208,40 @@ RowDefinition.prototype.getUserModel = function() {
 RowDefinition.toRowId = function(rowDef) {
 	return rowDef.getRowId();
 };
+/** For transforming row options into standard format
+* @public
+* @ignore
+* @function
+* @param {RowDefinition~Options} rowOptions
+* @return {RowDefinition~Options}
+*/
+RowDefinition.extractRowOptions = function(rowOptions) {
+	var ric = rowOptions["ric"];
+	var chainRic = rowOptions["chainRic"];
+	var collapsed = rowOptions["collapsed"];
+	var asChain = rowOptions["asChain"];
+	if(asChain == null && chainRic){
+		asChain = true;
+	}
+	var expanded = null;
+	if(ric && ric.indexOf("0#") >= 0){
+		if(asChain == null){
+			asChain = true;
+		}
+		expanded = true;
+	}
+
+	var extractedOptions = {};
+	if(collapsed == null) {
+		extractedOptions["collapsed"] = !expanded;
+	} else {
+		extractedOptions["collapsed"] = collapsed;
+	}
+	extractedOptions["ric"] = ric;
+	extractedOptions["chainRic"] = chainRic;
+	extractedOptions["asChain"] = asChain;
+	return extractedOptions;
+};
 /** For mapping row Id by Array.map()
 * @public
 * @function

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

@@ -8,39 +8,39 @@ import CellPainter from "../../tr-grid-util/es6/CellPainter.js";
 
 declare namespace ContextMenuPlugin {
 
-    type MenuItemEventCallback = (e: ContextMenuPlugin.MenuItemEvent) => void;
+    type MenuItemEventCallback = (e: ContextMenuPlugin.MenuItemEvent|null) => void;
 
-    type OnMenuEventCallback = (e: ContextMenuPlugin.OnMenuEvent) => void;
+    type OnMenuEventCallback = (e: ContextMenuPlugin.OnMenuEvent|null) => void;
 
-    type Context = "header" | "content" | "footer" | "filterRow";
+    type Context = "header" | "content" | "footer" | "filterRow"|null;
 
     type Options = {
-        items: { [key: string]:  ContextMenuPlugin.MenuItem },
-        onMenu?: ContextMenuPlugin.OnMenuEventCallback,
-        contextmenu?: ((...params: any[]) => any)
+        items: { [key: string]:  ContextMenuPlugin.MenuItem }|null,
+        onMenu?: ContextMenuPlugin.OnMenuEventCallback|null,
+        contextmenu?: ((...params: any[]) => any)|null
     };
 
     type MenuItem = {
-        text?: string,
-        value?: (string|number),
-        isDisabled?: boolean,
-        isVisible?: boolean,
-        isSeparator?: boolean,
-        items?: (ContextMenuPlugin.MenuItem)[],
-        renderer?: ((...params: any[]) => any),
-        callback?: ContextMenuPlugin.MenuItemEventCallback
+        text?: string|null,
+        value?: (string|number)|null,
+        isDisabled?: boolean|null,
+        isVisible?: boolean|null,
+        isSeparator?: boolean|null,
+        items?: (ContextMenuPlugin.MenuItem)[]|null,
+        renderer?: ((...params: any[]) => any)|null,
+        callback?: ContextMenuPlugin.MenuItemEventCallback|null
     };
 
     type MenuItemEvent = {
         altKey: boolean,
         cell: any,
         colIndex: number,
-        columnDef: object,
-        context: ContextMenuPlugin.Context,
+        columnDef: object|null,
+        context: ContextMenuPlugin.Context|null,
         ctrlKey: boolean,
-        item: ContextMenuPlugin.MenuItem,
-        items: { [key: string]:  ContextMenuPlugin.MenuItem },
-        menu: MenuEventAPI,
+        item: ContextMenuPlugin.MenuItem|null,
+        items: { [key: string]:  ContextMenuPlugin.MenuItem }|null,
+        menu: MenuEventAPI|null,
         rowIndex: number,
         section: any,
         shiftKey: boolean
@@ -49,21 +49,21 @@ declare namespace ContextMenuPlugin {
     type OnMenuEvent = {
         cell: any,
         colIndex: number,
-        columnDef: object,
-        context: ContextMenuPlugin.Context,
-        items: object,
-        menu: MenuEventAPI,
+        columnDef: object|null,
+        context: ContextMenuPlugin.Context|null,
+        items: object|null,
+        menu: MenuEventAPI|null,
         rowIndex: number,
         section: any,
-        selectedColumns: (number)[],
-        selectedRows: (number)[]
+        selectedColumns: (number)[]|null,
+        selectedRows: (number)[]|null
     };
 
 }
 
 declare class ContextMenuPlugin extends GridPlugin {
 
-    constructor(options?: (ContextMenuPlugin.Options|ContextMenuPlugin.OnMenuEvent));
+    constructor(options?: (ContextMenuPlugin.Options|ContextMenuPlugin.OnMenuEvent)|null);
 
     public getName(): string;
 
@@ -71,7 +71,7 @@ declare class ContextMenuPlugin extends GridPlugin {
 
     public unload(host: any): void;
 
-    public config(options?: ContextMenuPlugin.Options): void;
+    public config(options?: ContextMenuPlugin.Options|null): void;
 
     public getConfigObject(gridOptions?: any): any;