@refinitiv-ui/efx-grid 6.0.1 → 6.0.4

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

@@ -0,0 +1,19 @@
+
+
+declare class RowDefSorter {
+
+    constructor();
+
+    public dispose(): void;
+
+    public getSorter(rowSorting?: boolean): ((...params: any[]) => any)|null;
+
+    public setSortLogic(func?: ((...params: any[]) => any)): void;
+
+    public setField(field: string): void;
+
+    public setContext(key: string, value: any): void;
+
+}
+
+export default RowDefSorter;

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

@@ -0,0 +1,137 @@
+/** @constructor
+*/
+var RowDefSorter = function() {
+	this._defaultSorter = this._defaultSorter.bind(this);
+	this._dataSorter = this._dataSorter.bind(this);
+	this._rowDefSorter = this._rowDefSorter.bind(this);
+
+	this._sortContext = {};
+};
+
+
+/** @type {string}
+* @private
+*/
+RowDefSorter.prototype._field = "";
+/** @type {!Object}
+* @private
+*/
+RowDefSorter.prototype._sortContext;
+/** @type {Function}
+* @private
+*/
+RowDefSorter.prototype._sortLogic = null;
+
+
+/** @public
+*/
+RowDefSorter.prototype.dispose = function() {
+	this._sortLogic = null;
+	this._sortContext = {}; // Clear any existing reference
+};
+
+/** @public
+* @param {boolean=} rowSorting=false
+* @return {Function}
+*/
+RowDefSorter.prototype.getSorter = function(rowSorting) {
+	if(this._sortLogic) {
+		return rowSorting ? this._rowDefSorter : this._dataSorter;
+	} else {
+		return this._defaultSorter;
+	}
+};
+/** @public
+* @param {Function=} func
+*/
+RowDefSorter.prototype.setSortLogic = function(func) {
+	this._sortLogic = (typeof func === "function") ? func : null;
+};
+
+
+/** @public
+* @param {string} field
+*/
+RowDefSorter.prototype.setField = function(field) {
+	if(!field) {
+		field = "";
+	}
+	this._sortContext["field"] = this._field = field;
+	this._sortContext["formattedField"] = field + "_FORMATTED";
+};
+/** @public
+* @param {string} key
+* @param {*} value
+*/
+RowDefSorter.prototype.setContext = function(key, value) {
+	this._sortContext[key] = value;
+};
+
+/** @private
+* @param {RowDefinition} rowDefA
+* @param {RowDefinition} rowDefB
+* @param {number} order
+* @return {number}
+*/
+RowDefSorter.prototype._defaultSorter = function(rowDefA, rowDefB, order) {
+	var orderA = rowDefA.getGroupOrder();
+	var orderB = rowDefB.getGroupOrder();
+	if(orderA !== orderB) {
+		return orderA - orderB; // Regardless of sort order
+	}
+
+	var a = rowDefA.getData(this._field);
+	var b = rowDefB.getData(this._field);
+
+	if(a == null || a !== a) {
+		if(b == null || b !== b) {
+			return 0;
+		}
+		return 1;
+	}
+	if(b == null || b !== b) {
+		return -1;
+	}
+
+	if(a < b) {
+		return -order;
+	}
+	if(b < a) {
+		return order;
+	}
+	return 0;
+};
+/** @private
+* @param {RowDefinition} rowDefA
+* @param {RowDefinition} rowDefB
+* @param {number} order
+* @return {number}
+*/
+RowDefSorter.prototype._dataSorter = function(rowDefA, rowDefB, order) {
+	var orderA = rowDefA.getGroupOrder();
+	var orderB = rowDefB.getGroupOrder();
+	if(orderA !== orderB) {
+		return orderA - orderB; // Regardless of sort order
+	}
+
+	var a = rowDefA.getData(this._field);
+	var b = rowDefB.getData(this._field);
+	return this._sortLogic(a, b, order, this._sortContext);
+};
+/** @private
+* @param {RowDefinition} rowDefA
+* @param {RowDefinition} rowDefB
+* @param {number} order
+* @return {number}
+*/
+RowDefSorter.prototype._rowDefSorter = function(rowDefA, rowDefB, order) {
+	var orderA = rowDefA.getGroupOrder();
+	var orderB = rowDefB.getGroupOrder();
+	if(orderA !== orderB) {
+		return orderA - orderB; // Regardless of sort order
+	}
+
+	return this._sortLogic(rowDefA, rowDefB, order, this._sortContext);
+};
+
+export default RowDefSorter;

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

@@ -11,7 +11,8 @@ declare namespace RowDefinition {
         asChain?: boolean,
         chainRic?: string,
         collapsed?: boolean,
-        label?: (string|null)
+        label?: (string|null),
+        hidden?: boolean
     };
 
 }
@@ -30,10 +31,14 @@ declare class RowDefinition {
 
     public getRowId(): string;
 
+    public getConfigObject(rowOptions?: RowDefinition.Options): RowDefinition.Options|null;
+
     public getDataId(): string;
 
     public setDataSource(dataSource: DataCache): void;
 
+    public getDataSource(): DataCache|null;
+
     public getRowData(): any;
 
     public getData(field: string): any;
@@ -54,7 +59,7 @@ declare class RowDefinition {
 
     public getDisplayText(): string;
 
-    public getLabel(): string|null;
+    public getLabel(): string|null|null;
 
     public isRowHeader(): boolean;
 
@@ -78,13 +83,13 @@ declare class RowDefinition {
 
     public addUpdate(e: any): boolean;
 
-    public getUpdates(): { [key: string]:  number };
+    public getUpdates(): { [key: string]:  number }|null;
 
     public resetUpdates(): void;
 
     public registerToView(view: DataTable, rowId?: string): void;
 
-    public static deregisterFromView(rowIds: (string)[], rowDef: RowDefinition): (string)[];
+    public static deregisterFromView(rowIds: (string)[], rowDef: RowDefinition): (string)[]|null;
 
     public collapseChain(): boolean;
 
@@ -92,15 +97,15 @@ declare class RowDefinition {
 
     public toggleChain(): boolean;
 
-    public getChildren(): (RowDefinition)[];
+    public getChildren(): (RowDefinition)[]|null;
 
     public getDescendants(ary?: (RowDefinition)[]): (RowDefinition)[];
 
-    public getAllDescendantIds(): (string)[];
+    public getAllDescendantIds(): (string)[]|null;
 
     public getChildCount(): number;
 
-    public getParent(): RowDefinition;
+    public getParent(): RowDefinition|null;
 
     public getDepthLevel(): number;
 

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

@@ -13,6 +13,7 @@ import { DataTable } from "../../core/es6/data/DataTable.js";
 * @property {string=} chainRic="" RIC to be used for chain request (overiding ric property)
 * @property {boolean=} collapsed=false Chain is expanded by default
 * @property {(string|null)=} label=null
+* @property {boolean=} hidden=true When this row is hidden
 */
 
 /** @type {string}
@@ -280,6 +281,55 @@ RowDefinition.prototype.setContent = function(userInput) {
 RowDefinition.prototype.getRowId = function() {
 	return this._rowId;
 };
+/** @public
+* @param {RowDefinition~Options=} rowOptions
+* @return {RowDefinition~Options}
+*/
+RowDefinition.prototype.getConfigObject = function(rowOptions) {
+	var obj = rowOptions || {};
+	var val = this._ric;
+	if(val) {
+		obj["ric"] = val;
+	}
+
+	val = this._staticValues;
+	if(val) {
+		obj["values"] = val;
+	}
+
+	val = this._chainRic;
+	if(val) {
+		obj["chainRic"] = val;
+	}
+
+	val = this._label;
+	if(val) {
+		obj["label"] = val;
+	}
+
+	val = this._userModel;
+	if(val) {
+		obj["keepModel"] = obj;
+	}
+
+	val = this._isChain;
+	if(val) {
+		obj["asChain"] = val;
+	}
+
+	val = this._expanded;
+	if(val) {
+		obj["collapsed"] = !val;
+	}
+
+	// check row hidden
+	val = this._view.isHiddenRow(this._rowId);
+	if(val) {
+		obj["hidden"] = val;
+	}
+
+	return obj;
+};
 /** Since an index chain (e.g. .FTSE) can automatically produce rows for its constituent, we need to separate rowId and dataId, so that the constituents still use the same data Id as that of its parent.
 * @public
 * @return {string} Data Id will never be empty string unless the row has been removed
@@ -313,19 +363,25 @@ RowDefinition.prototype.setDataSource = function(dataSource) {
 	// This will work for runtime row insertion, but not for first initilization.
 	this.subscribeForUpdates();
 };
+/** @public
+* @return {DataCache} dataSource
+*/
+RowDefinition.prototype.getDataSource = function() {
+	return this._dc;
+};
 
 /** @public
 * @return {Object} rowData
 */
 RowDefinition.prototype.getRowData = function() {
-	return this._dc.getRowData(this._dataId);
+	return this._dc ? this._dc.getRowData(this._dataId) : {};
 };
 /** @public
 * @param {string} field
 * @return {*} data
 */
 RowDefinition.prototype.getData = function(field) {
-	return this._dc.getData(this._dataId, field);
+	return this._dc ? this._dc.getData(this._dataId, field) : null;
 };
 
 /** @public

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

@@ -9,9 +9,11 @@ declare class SnapshotFiller extends EventDispatcher {
 
     public addRic(ric: string): void;
 
+    public addRics(rics: (string)[]): boolean;
+
     public addField(str: string): void;
 
-    public addFields(fields: (string)[]): void;
+    public addFields(fields: (string)[]): boolean;
 
     public static isValidField(str: string): boolean;
 

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

@@ -68,6 +68,26 @@ SnapshotFiller.prototype.addRic = function (ric) {
 	}
 };
 /** @public
+* @param {Array.<string>} rics
+* @return {boolean}
+*/
+SnapshotFiller.prototype.addRics = function (rics) {
+	var len = rics ? rics.length : 0;
+	var dirty = false;
+	for(var i = 0; i < len; ++i) {
+		var ric = rics[i];
+		if (ric && !this._rics[ric]) {
+			this._rics[ric] = 1;
+			dirty = true;
+		}
+	}
+	if(dirty) {
+		this._request();
+		return true;
+	}
+	return false;
+};
+/** @public
 * @param {string} str
 */
 SnapshotFiller.prototype.addField = function (str) {
@@ -77,6 +97,7 @@ SnapshotFiller.prototype.addField = function (str) {
 };
 /** @public
 * @param {Array.<string>} fields
+* @return {boolean}
 */
 SnapshotFiller.prototype.addFields = function (fields) {
 	var len = fields.length;
@@ -86,7 +107,9 @@ SnapshotFiller.prototype.addFields = function (fields) {
 	}
 	if(dirty) {
 		this._request();
+		return true;
 	}
+	return false;
 };
 
 /** @private

package/lib/tr-grid-cell-selection/es6/CellSelection.d.ts

@@ -53,7 +53,7 @@ declare class CellSelectionPlugin extends GridPlugin {
 
     public getAnchorInfo(): any;
 
-    public getSelectedCells(): (any)[];
+    public getSelectedCells(): (any[])[];
 
     public disableSelection(opt_disable?: boolean): void;
 

package/lib/tr-grid-cell-selection/es6/CellSelection.js

@@ -29,29 +29,11 @@ import { isIE, cloneObject, prepareTSVContent } from "../../tr-grid-util/es6/Uti
 * @property {boolean=} cancel Set to true to cancel operation.
 */
 
-/** Active cell selected.
-* @private
-* @param {Object} cell
-*/
-
-var selectCell = function selectCell(cell) {
-  if (cell) cell.enableClass("selection", true);
-};
-/** Deactive cell selected.
-* @private
-* @param {Object} cell
-*/
-
-
-var deselectCell = function deselectCell(cell) {
-  if (cell) cell.enableClass("selection", false);
-};
 /** @constructor
 * @param {Object=} options
 * @extends {GridPlugin}
 */
 
-
 var CellSelectionPlugin = function CellSelectionPlugin(options) {
   this._textRange = document.createRange();
   this._isIE = isIE();
@@ -876,8 +858,7 @@ CellSelectionPlugin.prototype._onColumnMoved = function (e) {
 
   for (var rowIndex = rect.top; rowIndex < rect.bottom; rowIndex++) {
     var rowObj = this._map[rowIndex];
-    var cell = rowObj.section.getCell(clearColIndex, rowObj.rowIndex);
-    deselectCell(cell);
+    rowObj.section.selectCell(clearColIndex, rowObj.rowIndex, false);
   } // NOTED: No need to reselect after clear selection UI.
   // postSectionDataBinding will do this job
 
@@ -991,19 +972,17 @@ CellSelectionPlugin.prototype._onPostSectionDataBinding = function (e) {
     var selectionRowEnd = this._curRect.bottom - rowOffset;
     var selectionColStart = this._curRect.left;
     var selectionColEnd = this._curRect.right;
-    var cell, rowIndex, colIndex;
+    var rowIndex, colIndex;
 
     for (rowIndex = e.fromRowIndex; rowIndex < e.toRowIndex; rowIndex++) {
       if (rowIndex >= selectionRowStart && rowIndex < selectionRowEnd) {
         // if row inside selection range
         for (colIndex = selectionColStart; colIndex < selectionColEnd; colIndex++) {
-          cell = e.section.getCell(colIndex, rowIndex);
-          selectCell(cell);
+          e.section.selectCell(colIndex, rowIndex, true);
         }
       } else {
         for (colIndex = selectionColStart; colIndex < selectionColEnd; colIndex++) {
-          cell = e.section.getCell(colIndex, rowIndex);
-          deselectCell(cell);
+          e.section.selectCell(colIndex, rowIndex, false);
         }
       }
     }
@@ -1025,8 +1004,8 @@ CellSelectionPlugin.prototype._isString = function (elem) {
 CellSelectionPlugin.prototype._cacheSectionMap = function () {
   var sectionCount = this._hosts[0].getSectionCount();
 
-  var totalRow = 0,
-      rowCount = 0;
+  var totalRow = 0;
+  var rowOffset = 0;
   this._hasCellSpan = false;
 
   var activeGrid = this._getActiveGrid();
@@ -1035,7 +1014,7 @@ CellSelectionPlugin.prototype._cacheSectionMap = function () {
     var sectionSettings = activeGrid.getSectionSettings(i);
     var section = sectionSettings.getSection();
     var hasCellSpan = section.hasCellSpan();
-    rowCount = section.getRowCount();
+    var rowCount = section.getRowCount();
 
     for (var j = 0; j < rowCount; ++j) {
       var obj = {};
@@ -1043,11 +1022,13 @@ CellSelectionPlugin.prototype._cacheSectionMap = function () {
       obj.hasCellSpan = hasCellSpan;
       obj.sectionIndex = i;
       obj.rowIndex = j;
+      obj.rowOffset = rowOffset;
       obj.type = sectionSettings.getType();
       this._map[totalRow] = obj;
       totalRow++;
     }
 
+    rowOffset += rowCount;
     this._hasCellSpan |= hasCellSpan;
   }
 
@@ -1263,6 +1244,29 @@ CellSelectionPlugin.prototype._updateSelection = function (tgtRect) {
   this._updateRowSelection(this._curRect.bottom, tgtRect.bottom);
 
   this._curRect.bottom = tgtRect.bottom;
+
+  var activeGrid = this._getActiveGrid();
+
+  if (activeGrid) {
+    var x = this._curRect.left;
+    var y = this._curRect.top;
+    var mapInfo = this._map[y];
+    var contentType = mapInfo ? mapInfo.type === "content" : false;
+    var w = 0;
+    var h = 0;
+
+    if (contentType) {
+      w = this._curRect.right - x;
+      h = this._curRect.bottom - y;
+      y -= mapInfo.rowOffset;
+    }
+
+    var contentSect = activeGrid.getSection("content");
+
+    if (contentSect) {
+      contentSect.setCellBounds(x, y, w, h);
+    }
+  }
 };
 /** Update all column that mouse draged over.
 * @private
@@ -1331,13 +1335,9 @@ CellSelectionPlugin.prototype._updateRowSelection = function (from, to) {
 
 CellSelectionPlugin.prototype._selectAsPosition = function (rowIndex, colIndex, isSelect) {
   var mapInfo = this._map[rowIndex];
-  if (!mapInfo || this._unselectables[mapInfo.type] === true) return;
-  var cell = mapInfo.section.getCell(colIndex, mapInfo.rowIndex);
 
-  if (isSelect) {
-    selectCell(cell);
-  } else {
-    deselectCell(cell);
+  if (mapInfo && !this._unselectables[mapInfo.type]) {
+    mapInfo.section.selectCell(colIndex, mapInfo.rowIndex, isSelect);
   }
 };
 /** Check mouse is draging over cell that already selected.
@@ -1471,11 +1471,20 @@ CellSelectionPlugin.prototype.deselectAll = function () {
 
   var activeGrid = this._getActiveGrid();
 
-  var selectedCells = activeGrid.getElement().querySelectorAll("div.cell.selection");
-  var c = selectedCells.length;
+  if (activeGrid) {
+    var selectedCells = activeGrid.getElement().querySelectorAll("div.cell.selection"); // TODO: Move this logic to core grid
+
+    var c = selectedCells.length;
 
-  for (var i = 0; i < c; i++) {
-    selectedCells[i].classList.remove('selection');
+    for (var i = 0; i < c; i++) {
+      selectedCells[i].classList.remove('selection');
+    }
+
+    var contentSect = activeGrid.getSection("content");
+
+    if (contentSect) {
+      contentSect.setCellBounds(0, 0, 0, 0);
+    }
   }
 
   this._lastSelection = this.getSelectionBounds();
@@ -1601,7 +1610,11 @@ CellSelectionPlugin.prototype.selectSingleCell = function (anchor) {
 };
 /** Use to select multiple cells, can be selected by rectangle area.
 * @public
-* @param {Object} rect
+* @param {Object} rect Object with rowIndex, colIndex, width, and height properties
+* @example
+* ext.selectCells({
+*   colIndex: 1, rowIndex: 1, width: 2, height: 2
+* });
 */
 
 
@@ -1724,7 +1737,7 @@ CellSelectionPlugin.prototype.getAnchorInfo = function () {
 };
 /** Use to get selected cells.
 * @public
-* @return {Array.<Object>} array of cell
+* @return {Array.<Array>} 2D array of cells
 */
 
 

package/lib/tr-grid-checkbox/es6/Checkbox.d.ts

@@ -1,7 +1,7 @@
 import {Ext} from '../../tr-grid-util/es6/Ext.js';
 import {GridPlugin} from '../../tr-grid-util/es6/GridPlugin.js';
 import {ElfUtil} from '../../tr-grid-util/es6/ElfUtil.js';
-import {injectCss, prettifyCss, extendObject} from "../../tr-grid-util/es6/Util.js";
+import {injectCss, prettifyCss} from "../../tr-grid-util/es6/Util.js";
 
 declare namespace CheckboxPlugin {
 
@@ -12,7 +12,8 @@ declare namespace CheckboxPlugin {
         checkboxCreated?: ((...params: any[]) => any),
         checkboxBinding?: ((...params: any[]) => any),
         clicked?: ((...params: any[]) => any),
-        width?: number
+        width?: number,
+        topCheckboxHandler?: boolean
     };
 
     type ColumnOptions = {
@@ -41,7 +42,7 @@ declare class CheckboxPlugin extends GridPlugin {
 
     public getDisplayColumn(): number;
 
-    public getCheckbox(sectionRef: any, rowIndex: number): Element;
+    public getCheckbox(sectionRef: any, rowIndex: number): Element|null;
 
     public selectAll(): void;
 
@@ -51,6 +52,8 @@ declare class CheckboxPlugin extends GridPlugin {
 
     public setAllCheckStates(checked: boolean): void;
 
+    public selectAllPages(checked?: boolean): void;
+
     public disableCheckbox(rowRef: number|string, disabled: boolean): void;
 
     public enableCheckbox(rowRef: number|string): void;