@refinitiv-ui/efx-grid 6.0.16 → 6.0.18

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

@@ -804,7 +804,8 @@ ColumnDefinition.prototype.getConfigObject = function(colOptions) {
 	}
 
 	value = core.isColumnVisible(colIndex);
-	if(!value) {
+	// If "hidden" property already available from core/extensions, don't override this property
+	if(!value && obj["hidden"] == null) {
 		obj["hidden"] = true;
 	}
 

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

@@ -141,6 +141,8 @@ declare class Grid extends EventDispatcher {
 
     public moveColumn(fromColIndex: number|(number)[]|null, toColIndex: number): boolean;
 
+    public moveColumnById(srcCol: number|string|null, destCol?: (number|string)|null): boolean;
+
     public hideColumn(colRef: Grid.ColumnReference|null, hidden?: boolean|null): void;
 
     public hideColumns(colRefs: (Grid.ColumnReference)[]|null, hidden?: boolean|null): void;
@@ -191,7 +193,7 @@ declare class Grid extends EventDispatcher {
 
     public hasHiddenRow(): boolean;
 
-    public setRic(rowRef: Grid.RowReference|null, str: string): void;
+    public setRic(rowRef: Grid.RowReference|null, str: string, options?: RowDefinition.Options|null): void;
 
     public unlinkChain(rowRef: Grid.RowReference|null): void;
 
@@ -213,6 +215,8 @@ declare class Grid extends EventDispatcher {
 
     public getColumnDefinition(colIndex: number): ColumnDefinition|null;
 
+    public getColumnDefinitions(): (ColumnDefinition)[];
+
     public getColumnDefinitionById(colId: string): ColumnDefinition|null;
 
     public getColumnDefinitionsById(colIds: (string)[]|null): ColumnDefinition|null;
@@ -221,7 +225,7 @@ declare class Grid extends EventDispatcher {
 
     public getRowDefinitions(): (RowDefinition)[];
 
-    public getAllRowDefinitions(inclAutoGenerate?: boolean|null): (RowDefinition)[];
+    public getAllRowDefinitions(inclAutoGenerated?: boolean|null): (RowDefinition)[];
 
     public getRowData(rowIndex: number): any;
 
@@ -241,10 +245,14 @@ declare class Grid extends EventDispatcher {
 
     public getColumnId(colIndex: number): string;
 
+    public getColumnIds(): (string)[];
+
     public getColumnField(colIndex: number): string;
 
     public getColumnFields(): (string)[];
 
+    public getColumnNames(): (string)[];
+
     public getAllFields(): (string)[];
 
     public freezeColumn(colIndex?: number|null, pinnedRightColumns?: number|null): void;
@@ -295,5 +303,7 @@ declare class Grid extends EventDispatcher {
 
 declare function borders(gridOptions?: any): any;
 
+declare function colCount(rowRef: number|string|null): RowDefinition|null;
+
 export { Grid };
 export default Grid;

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

@@ -227,6 +227,45 @@ var compareNumber = function(rowDefA, rowDefB, sortOrder, fieldName) { // edit n
 	return (rowDefA.getData(fieldName) - rowDefB.getData(fieldName)) * sortOrder; // for numeric comparison
 };
 
+/** @private
+* @param {ColumnDefinition} colDef
+* @return {string}
+*/
+var _getId = function(colDef) {
+	if(colDef) {
+		return colDef.getId();
+	}
+	return "";
+};
+/** @private
+* @param {ColumnDefinition} colDef
+* @return {string}
+*/
+var _getField = function(colDef) {
+	if(colDef) {
+		return colDef.getField();
+	}
+	return "";
+};
+/** @private
+* @param {ColumnDefinition} colDef
+* @return {string}
+*/
+var _getName = function(colDef) {
+	if(colDef) {
+		return colDef.getName();
+	}
+	return "";
+};
+/** @private
+* @param {ColumnDefinition} colDef
+* @param {string} str
+* @return {boolean}
+*/
+var _hasFieldOrId = function(colDef, str) {
+	return (colDef.getField() === str) || (colDef.getId() === str);
+};
+
 /** @constructor
 * @extends {EventDispatcher}
 * @param {(Element|null)=} placeholder
@@ -1213,7 +1252,7 @@ Grid.prototype._onFieldAdded = function(e) {
 
 	// JET
 	if (this._subs) {
-		var colDefs = this._getAllColumnDefinitions();
+		var colDefs = this.getColumnDefinitions();
 		var fields = colDefs.reduce(ColumnDefinition.getRealTimeFields, []);
 		this._subs["addFields"](fields);
 	}
@@ -1763,16 +1802,49 @@ Grid.prototype.removeAllColumns = function() {
 	}
 };
 
-/**
- * Move the column at the specified index to the target index.
- * @public
- * @param {number|Array.<number>} fromColIndex index or array of indices of the column(s) to be moved.
- * @param {number} toColIndex target column index
- * @return {boolean} Return true if there is any change, and false otherwise
- */
+/** Move the column at the specified index to the target index. When moving multiple columns, the original order of the source columns will be sorted by their index and the position of the columns will not be guaranteed to be exactly at the destination index.
+* @public
+* @param {number|Array.<number>} fromColIndex index or array of indices of the column(s) to be moved.
+* @param {number} toColIndex target column index
+* @return {boolean} Return true if there is any change, and false otherwise
+* @see {@link Grid#moveColumnById}
+*/
 Grid.prototype.moveColumn = function (fromColIndex, toColIndex) {
 	return this._grid.moveColumn(fromColIndex, toColIndex);
 };
+/** If source column is not found, no operation is performed. If destination column is not found, the source column will be moved to the last position.<br>
+* Note: this method behaves slightly different from moveColumn method in that it always put source column at the position before the specified destination column, while moveColumn method will put column at exactly at the destination index.
+* @public
+* @param {number|string} srcCol Column Id or index
+* @param {(number|string)=} destCol Column Id or index of the destination
+* @return {boolean} Return true if there is any change, and false otherwise
+* @see {@link Grid#moveColumn}
+* @example
+* grid.moveColumnById(3, 1); // Move column 3 to position before column 1
+* grid.moveColumnById(0, 2); // Move column 0 to position before column 2 (column index 1)
+* grid.moveColumnById(0, 1); // Nothing is moved
+* grid.moveColumnById("sourceColumnId", "anotherId");
+* grid.moveColumnById("sourceColumnId", ""); // move to the last position
+*/
+Grid.prototype.moveColumnById = function (srcCol, destCol) {
+	var colCount = this.getColumnCount();
+	var srcIndex = this.getColumnIndex(srcCol);
+	if(srcIndex < 0 || srcIndex >= colCount) {
+		return false;
+	}
+	var destIndex = this.getColumnIndex(destCol);
+	if(destIndex < 0) {
+		destIndex = colCount;
+	}
+	if(srcIndex < destIndex) { // Ensure that the source column is put in front of the destination index
+		--destIndex;
+	}
+	if(srcIndex === destIndex) {
+		return false;
+	}
+	return this.moveColumn(srcIndex, destIndex);
+};
+
 
 /** The hidden column still occupies the same index.
 * @public
@@ -2339,12 +2411,18 @@ Grid.prototype._removeRow = function(rowDef) {
 	}
 	this._dispatch("beforeRowRemoved", {});
 
-	var rowIds = rowDef.getAllDescendantIds(); // TODO: Support nested child
-	if(rowIds) { // Remove all children first
-		this._dt.removeRows(rowIds);
+	var connector = this._connector;
+	var dt = this._dt;
+	var childRowDefs = rowDef.getDescendants(); // TODO: Support nested child
+	if(childRowDefs) { // Remove all children first
+		for(var i = 0; i < childRowDefs.length; i++) {
+			connector.removeRic(childRowDefs[i]);
+		}
+		var rowIds = childRowDefs.map(RowDefinition.toRowId);
+		dt.removeRows(rowIds);
 	}
-	this._connector.removeRic(rowDef);
-	this._dt.removeRow(rowDef.getRowId()); // TODO: Merge this with the above removeRows() method
+	connector.removeRic(rowDef);
+	dt.removeRow(rowDef.getRowId()); // TODO: Merge this with the above removeRows() method
 	rowDef.dispose(); // WARNING: This does not remove child reference from its parent
 };
 
@@ -2399,19 +2477,35 @@ Grid.prototype.hasHiddenRow = function(){
 * @public
 * @param {Grid~RowReference} rowRef
 * @param {string} str
+* @param {RowDefinition~Options=} options
 */
-Grid.prototype.setRic = function(rowRef, str) {
+Grid.prototype.setRic = function(rowRef, str, options) {
 	if(this._mainGrid) {
 		this._mainGrid.setRic(this._toRowId(rowRef), str);
 		return;
 	}
 	var rowDef = this._getRowDefinition(rowRef);
 	if(rowDef) {
-		var oldRic = rowDef.getRic();
-		if(rowDef.setContent(str)) { // The given string may not be a RIC
-			this._connector.removeRic(rowDef, oldRic);
-			this._initDuplicateRicData(rowDef);
-			this._connector.addRic(rowDef);
+		options = options || {};
+		var newChain = false;
+		if(str.indexOf("0#") > 0 || options["asChain"]) {
+			newChain = true;
+		}
+		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.getRic();
+			if(rowDef.setContent(str)) { // The given string may not be a RIC
+				this._connector.removeRic(rowDef, oldRic);
+				this._initDuplicateRicData(rowDef);
+				this._connector.addRic(rowDef);
+			}
 		}
 	}
 };
@@ -2535,6 +2629,17 @@ Grid.prototype.getColumnDefinition = function(colIndex) {
 	}
 	return null;
 };
+/** @public
+* @return {!Array.<ColumnDefinition>}
+*/
+Grid.prototype.getColumnDefinitions = function() {
+	var colCount = this.getColumnCount();
+	var colDefs = new Array(colCount);
+	for(var i = 0; i < colCount; i++) {
+		colDefs[i] = this.getColumnDefinition(i);
+	}
+	return colDefs;
+};
 
 /** @public
 * @param {string} colId
@@ -2542,11 +2647,7 @@ Grid.prototype.getColumnDefinition = function(colIndex) {
 */
 Grid.prototype.getColumnDefinitionById = function(colId) {
 	if(typeof colId === "string") {
-		var colIndex = this.getColumnIndex(colId);
-		var colData = this._grid.getColumnData(colIndex);
-		if(colData) {
-			return /** @type{ColumnDefinition} */(colData[COL_DEF]) || null;
-		}
+		return this.getColumnDefinition(this.getColumnIndex(colId));
 	}
 	return null;
 };
@@ -2582,24 +2683,13 @@ Grid.prototype._getColumnDefinition = function(colRef) {
 		var colCount = this.getColumnCount();
 		for(var i = 0; i < colCount; ++i) {
 			var colDef = this.getColumnDefinition(i);
-			if(colDef.getField() === colRef || colDef.getId() === colRef) {
-				return colDef; // Return the first found field
+			if(_hasFieldOrId(colDef, colRef)) {
+				return colDef; // Return the first found column
 			}
 		}
 	}
 	return null;
 };
-/** @private
-* @return {Array.<ColumnDefinition>}
-*/
-Grid.prototype._getAllColumnDefinitions = function() {
-	var colCount = this.getColumnCount();
-	var colDefs = new Array(colCount);
-	for(var i = 0; i < colCount; i++) {
-		colDefs[i] = this.getColumnDefinition(i);
-	}
-	return colDefs;
-};
 
 /** @public
 * @param {number|string} rowRef Row index as shown in the view or row id (string)
@@ -2655,16 +2745,17 @@ Grid.prototype.getRowDefinitions = function() {
 Grid.prototype._getAllRowDefinitions = function() {
 	return this._dt.getColumnData(ROW_DEF); // no group header rows
 };
-/** Get all row definitions, including filtered and hidden rows, but without group header rows.
+
+/** Get all row definitions, including filtered and hidden rows, but without auto generated rows (i.e., group header and chain constituent).
 * @public
-* @param {boolean=} inclAutoGenerate=false means exclude auto generate rows
+* @param {boolean=} inclAutoGenerated=false Set to true to include auto generated rows. Default value is false (exclude auto generated rows)
 * @return {!Array.<RowDefinition>}
 */
-Grid.prototype.getAllRowDefinitions = function(inclAutoGenerate) {
-	if(!inclAutoGenerate) {
-		return this._dt.getColumnData(ROW_DEF).filter(excludeAutoGenerated);
+Grid.prototype.getAllRowDefinitions = function(inclAutoGenerated) {
+	if(inclAutoGenerated) {
+		return this._getAllRowDefinitions();
 	}
-	return this._getAllRowDefinitions();
+	return this._dt.getColumnData(ROW_DEF).filter(excludeAutoGenerated);
 };
 /** A shorthand to retrieve row data based on index of the specified row.
 * @public
@@ -2801,7 +2892,7 @@ Grid.prototype.getColumnIndex = function(colRef) {
 	} else if(typeof colRef === "string") {
 		for(i = 0; i < colCount; ++i) {
 			colDef = this.getColumnDefinition(i);
-			if(colDef.getField() === colRef || colDef.getId() === colRef) {
+			if(_hasFieldOrId(colDef, colRef)) {
 				return i; // Return the first found field
 			}
 		}
@@ -2834,8 +2925,14 @@ Grid.prototype.getColumnIndices = function(colRefs) {
 * @see {@link Grid#getColumnDefinition}
 */
 Grid.prototype.getColumnId = function(colIndex) {
-	var colDef = this.getColumnDefinition(colIndex);
-	return (colDef) ? colDef.getId() : "";
+	return _getId(this.getColumnDefinition(colIndex));
+};
+/** Get ids from each column definition.
+* @public
+* @return {!Array.<string>} New array is created
+*/
+Grid.prototype.getColumnIds = function() {
+	return this.getColumnDefinitions().map(_getId);
 };
 /** Return field defined in the column definition
 * @public
@@ -2844,20 +2941,21 @@ Grid.prototype.getColumnId = function(colIndex) {
 * @see {@link Grid#getColumnDefinition}
 */
 Grid.prototype.getColumnField = function(colIndex) {
-	var colDef = this.getColumnDefinition(colIndex);
-	return (colDef) ? colDef.getField() : "";
+	return _getField(this.getColumnDefinition(colIndex));
 };
 /** Get fields from each column definition. Note that this does not include any required field or data fields. Duplicates may exist.
 * @public
 * @return {!Array.<string>} New array is created
 */
 Grid.prototype.getColumnFields = function() {
-	var colCount = this.getColumnCount();
-	var ary = new Array(colCount);
-	for(var i = 0; i < colCount; ++i) {
-		ary[i] = this.getColumnField(i);
-	}
-	return ary;
+	return this.getColumnDefinitions().map(_getField);
+};
+/** Get column name from each column definition. Note that this does not include any required field or data fields. Duplicates may exist.
+* @public
+* @return {!Array.<string>} New array is created
+*/
+Grid.prototype.getColumnNames = function() {
+	return this.getColumnDefinitions().map(_getName);
 };
 /** Get all fields, including required fields and data fields, with no duplicate
 * @public

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

@@ -273,6 +273,10 @@ RowDefinition.prototype.setContent = function(userInput) {
 			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();
+			}
 		} else {
 			this._ric = this._userInput;
 			this._chainRic = "";

package/lib/tr-grid-column-grouping/es6/ColumnGrouping.d.ts

@@ -24,12 +24,12 @@ declare class ColumnGroupingPlugin extends GridPlugin {
 
     constructor(options?: ColumnGroupingPlugin.Options|null);
 
-    public beforeProcessOption(optionName: string, optionValue: any): any;
-
     public getName(): string;
 
     public initialize(host: any, options?: any): void;
 
+    public beforeProcessOption(optionName: string, optionValue: any): any;
+
     public unload(host: any): void;
 
     public config(options: any): void;
@@ -66,9 +66,9 @@ declare class ColumnGroupingPlugin extends GridPlugin {
 
     public getCellInfo(e: Element|Event|MouseEvent|null): any;
 
-    public moveColumnIntoGroup(from: number|string|null, to: number, groupId: string): void;
+    public moveColumnIntoGroup(colRef: number|string|null, to: number, groupId: string): void;
 
-    public setColumnParent(columnIndex: number|string|null, groupId: string): void;
+    public setColumnParent(colRef: number|string|null, groupId: string): void;
 
 }