@refinitiv-ui/efx-grid 6.0.41 → 6.0.43

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

@@ -83,7 +83,8 @@ declare namespace Grid {
         fieldCaching?: boolean|null,
         timeSeriesExpansion?: boolean|null,
         childDataField?: string|null,
-        topSection?: boolean|null
+        topSection?: boolean|null,
+        sorting?: SortableTitlePlugin.Options|null
     };
 
     type RowReference = number|string|RowDefinition|null;
@@ -320,6 +321,28 @@ declare class Grid extends EventDispatcher {
 
     public replaceRow(rowRef: Grid.RowReference|null, rowOption?: any): any;
 
+    public scrollToColumn(colIndex: number, leftOfView?: boolean|null): boolean;
+
+    public scrollToRow(rowIndex: number, topOfView?: boolean|null): void;
+
+    public getScrollLeft(): number;
+
+    public getScrollTop(): number;
+
+    public setScrollLeft(pixels: number): void;
+
+    public setScrollTop(pixels: number): void;
+
+    public scrollRight(pixels: number): void;
+
+    public scrollDown(pixels: number): void;
+
+    public getScrollWidth(): number;
+
+    public getScrollHeight(): number;
+
+    public getVScrollView(): any;
+
 }
 
 declare function borders(gridOptions?: any): any;

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

@@ -87,6 +87,7 @@ import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js
 * @property {boolean=} timeSeriesExpansion=true If disabled, the time series field will be treated as a normal field and not expanded.
 * @property {string=} childDataField=CHILD_VALUES The given field will be used to store children's static data, such as row color assignment.
 * @property {boolean=} topSection=true If disabled, title section will not be rendered
+* @property {SortableTitlePlugin~Options=} sorting Options for sorting
 */
 
 /** @typedef {number|string|RowDefinition} Grid~RowReference
@@ -140,21 +141,17 @@ import { ElementWrapper } from "../../core/es6/grid/components/ElementWrapper.js
 * @description Fired after ADC data or response received from the server
 * @property {Array.<Array>} data Data part of the server response
 */
-
 /** @event Grid#pageIndexChanged
 * @description Fired after page index in the data view is changed during the active pagination mode
 */
-
 /** @event Grid#pageCountChanged
 * @description Fired after page count in the data view is changed during the active pagination mode
 */
-
 /** @event Grid#dataComposed
 * @description Trigger before dataChanged. Perform any data update during the event will NOT cause more dataChanged events
 * @property {Grid} grid
 * @property {RowDefinition} rowDef
 */
-
 /** @event Grid#beforeRowRemoved
 * @description Fired only when a row will be removed through Grid's API and before occurring of the actual removal
 */
@@ -3921,6 +3918,7 @@ 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
@@ -3944,5 +3942,95 @@ Grid.prototype.replaceRow = function(rowRef, rowOption) {
 	}
 };
 
+/** Scroll the view to the specified column. If the column is already in the view, nothing happens. If the column is outside of the view, the view will be moved to the column with some additional offsets
+* @public
+* @param {number} colIndex
+* @param {boolean=} leftOfView Default is false. If true, the specified column will be put at the leftmost of the view (no offset)
+* @returns {boolean} Return true, if there is any change
+*/
+Grid.prototype.scrollToColumn = function (colIndex, leftOfView) {
+	return this._grid.scrollToColumn(colIndex, leftOfView);
+};
+/** Scroll the view to the specified row. If the row is already in the view, nothing happens. If the row is outside of the view, the view will be moved to the row with some additional offsets
+* @public
+* @param {number} rowIndex
+* @param {boolean=} topOfView=false If true, the specified row will be put at the top of the view (no offset)
+*/
+Grid.prototype.scrollToRow = function (rowIndex, topOfView) {
+	this._grid.scrollToRow("content", rowIndex, topOfView);
+};
+
+/** Get scroll value in pixel from the horizontal scrollbar
+* @public
+* @returns {number} pixels
+*/
+Grid.prototype.getScrollLeft = function () {
+	return this._grid.getScrollLeft();
+};
+/** Get scroll value in pixel from the vertical scrollbar
+* @public
+* @returns {number} pixels
+*/
+Grid.prototype.getScrollTop = function () {
+	return this._grid.getScrollTop();
+};
+
+/** Set scroll value to the horizontal scrollbar. This will move the scrollbar to specific position
+* @public
+* @param {number} pixels
+* @see {@link Grid.scrollRight}
+*/
+Grid.prototype.setScrollLeft = function (pixels) {
+	this._grid.setScrollLeft(pixels);
+};
+/**  Set scroll value to the vertical scrollbar. This will move the scrollbar to specific position
+* @public
+* @param {number} pixels
+* @see {@link Grid.scrollDown}
+*/
+Grid.prototype.setScrollTop = function (pixels) {
+	this._grid.setScrollTop(pixels);
+};
+
+/** Scroll the view to the right by the specified value. Use negative value to scroll the view to the left
+* @public
+* @param {number} pixels
+* @see {@link Grid.setScrollLeft}
+*/
+Grid.prototype.scrollRight = function (pixels) {
+	this._grid.scrollRight(pixels);
+};
+/** Scroll the view down by the specified value. Use negative value to scroll the view to the top
+* @public
+* @param {number} pixels
+* @see {@link Grid.setScrollTop}
+*/
+Grid.prototype.scrollDown = function (pixels) {
+	this._grid.scrollDown(pixels);
+};
+
+/** Get width of scrollable area from the horizontal scrollbar. This is useful for determining the end of scrollbar
+* @public
+* @returns {number}
+*/
+Grid.prototype.getScrollWidth = function () {
+	return this._grid.getScrollWidth();
+};
+/** Get height of scrollable area from the vertical scrollbar. This is useful for determining the end of scrollbar
+* @public
+* @returns {number}
+*/
+Grid.prototype.getScrollHeight = function () {
+	return this._grid.getScrollHeight();
+};
+
+/** Get information about current grid's view and the vertical scrollbar
+* @public
+* @returns {Object} Returns null, if vertical scrollbar does not exists
+*/
+Grid.prototype.getVScrollView = function () {
+	return this._grid.getVScrollView();
+};
+
 export { Grid };
 export default Grid;

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

@@ -93,6 +93,10 @@ declare class ColumnGroupingPlugin extends GridPlugin {
 
     public unpinGroup(groupId: string, dest?: (number|string)|null): void;
 
+    public static getObjectIndex(column: any): number;
+
+    public static getObjectId(column: any): string;
+
 }
 
 export default ColumnGroupingPlugin;

package/lib/tr-grid-column-grouping/es6/ColumnGrouping.js

@@ -483,7 +483,7 @@ ColumnGroupingPlugin.prototype._applyGrouping = function () {
         for (r = 0; r < rowCount; r++) {
           cell = section.getCell(c, r, false);
           if (cell) {
-            cell.reset();
+            // TODO: The style and class from the user will not be reset, for example, the color or background
             cell.removeClass("no-sort");
             cell.removeAttribute("group-id");
           }
@@ -1122,14 +1122,13 @@ ColumnGroupingPlugin.prototype.setGroupDefinition = function (groupId, groupDef)
   if (this._groupDefs.setGroup(groupId, groupDef)) {
     var newDef = this._groupDefs.getGroup(groupId);
     if (newDef) {
-      var chdr = newDef.children;
+      var host = this._hosts[0];
+      var chdr = host.getValidColumnList(newDef.children).map(ColumnGroupingPlugin.getObjectId); //this return only valid columns without group
       var len = chdr.length;
-      // TODO: Filter out group id
       if (len > 1) {
-        this.reorderColumns(chdr, chdr[0]); // WARNING: group id doesn't work
+        this.reorderColumns(chdr, chdr[0]);
       }
     }
-
     this._applyGrouping();
     return groupId;
   }
@@ -1192,16 +1191,17 @@ ColumnGroupingPlugin.prototype._getAvaliableChildren = function (groupId) {
   var childCount = chdr ? chdr.length : 0;
   var validChildren = [];
   if (childCount) {
+    var host = this._hosts[0];
+    var validCols = host.getValidColumnList(chdr);
+    validChildren = validCols.map(ColumnGroupingPlugin.getObjectId);
     var groupMap = this._groupDefs.getGroupMap();
-    // Filter out columns that do not exist
     for (var i = 0; i < childCount; i++) {
       var childId = chdr[i];
-      if (groupMap[childId] || this.getColumnIndex(childId) > -1) {
-        validChildren.push(childId); // TODO: This is slow
+      if (groupMap[childId]) {
+        validChildren.push(childId);
       }
     }
   }
-
   return validChildren;
 };
 
@@ -1223,19 +1223,14 @@ ColumnGroupingPlugin.prototype.getGroupChildren = function (groupId) {
 * @return {Array.<number>}
 */
 ColumnGroupingPlugin.prototype.getChildColumnIndices = function (groupId) {
+  var colIndices = [];
+  var host = this._hosts[0];
   var colIds = this._groupDefs.getLeafDescendants(groupId);
   if (colIds) {
-    var colIndices = [];
-    var leafCount = colIds.length;
-    for (var i = 0; i < leafCount; i++) {
-      var index = this.getColumnIndex(colIds[i]);
-      if (index >= 0) {
-        colIndices.push(index);
-      }
-    }
-    return colIndices.sort(ColumnGroupingPlugin._ascSortLogic); // TODO: This could be unnecessary
+    var validColList = host.getValidColumnList(colIds);
+    colIndices = validColList.map(ColumnGroupingPlugin.getObjectIndex);
+    return colIndices;
   }
-
   return null;
 };
 
@@ -1715,5 +1710,25 @@ ColumnGroupingPlugin.prototype.unpinGroup = function (groupId, dest) {
     this.moveGroup(groupId, destId);
   }
 };
+
+/** Get column index from column object
+* @public
+* @function
+* @param {Object} column
+* @return {number}
+*/
+ColumnGroupingPlugin.getObjectIndex = function (column) {
+  return column["index"];
+};
+
+/** Get column id from column object
+* @public
+* @function
+* @param {Object} column
+* @return {string}
+*/
+ColumnGroupingPlugin.getObjectId = function (column) {
+  return column["id"];
+};
 export default ColumnGroupingPlugin;
 export { ColumnGroupingPlugin, ColumnGroupingPlugin as ColumnGrouping, ColumnGroupingPlugin as ColumnGroupingExtension };

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

@@ -32,8 +32,8 @@ declare namespace ColumnStackPlugin {
         id: string,
         spreading?: boolean|null,
         collapsed?: boolean|null,
-        children: (string)[]|null,
-        fields: (string)[]|null,
+        children?: (string)[]|null,
+        fields?: (string)[]|null,
         name?: string|null,
         activeColumn?: string|null
     };
@@ -88,7 +88,11 @@ declare class ColumnStackPlugin extends GridPlugin {
 
     public stackColumns(colRefs?: (number|string)[]|null, stackId?: string|null, options?: ColumnStackPlugin.StackConfiguration|null): boolean;
 
-    public setStack(colRefs?: (number|string)[]|null, activeColRef?: number|string|null): boolean;
+    public setStack(colRefs?: (number|string)[]|null, activeColRef?: (number|string)|null): boolean;
+
+    public setStacks(stacks: (ColumnStackPlugin.StackDefinition)[]|null): void;
+
+    public getStacks(): (ColumnStackPlugin.StackDefinition)[];
 
     public unstackColumns(colIndices?: (number)[]|null): boolean;
 
@@ -120,6 +124,8 @@ declare class ColumnStackPlugin extends GridPlugin {
 
     public getStackName(stackId: string): string;
 
+    public getActiveColumnId(stackId: string): string;
+
     public getActiveColumnField(stackId: string): string;
 
     public getActiveColumnIndex(stackId: string): number;