@refinitiv-ui/efx-grid 6.0.1 → 6.0.4

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

@@ -38,7 +38,10 @@ declare namespace ColumnDefinition {
         hidden?: boolean,
         id?: string,
         textSelect?: boolean,
-        keepModel?: boolean
+        keepModel?: boolean,
+        stationary?: boolean,
+        leftPinned?: boolean,
+        rightPinned?: boolean
     };
 
 }
@@ -59,9 +62,7 @@ declare class ColumnDefinition {
 
     public getRenderer(): ((...params: any[]) => any);
 
-    public getHeaderRenderer(): ((...params: any[]) => any);
-
-    public getSorter(): ((...params: any[]) => any);
+    public getHeaderRenderer(): ((...params: any[]) => any)|null;
 
     public getName(): string;
 
@@ -125,8 +126,12 @@ declare class ColumnDefinition {
 
     public activateRenderer(id?: string, func?: ((...params: any[]) => any)): boolean;
 
+    public getSorter(): ((...params: any[]) => any)|null;
+
     public setSorter(func?: ColumnDefinition.SortLogic): void;
 
+    public isRowSorting(): boolean;
+
     public setName(str: string): void;
 
     public getUserModel(): any;

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

@@ -45,6 +45,9 @@ import Engine from "../../tr-grid-util/es6/formula/Engine.js";
 * @property {string=} id Id for unique identifier
 * @property {boolean=} textSelect=false If enabled, user can select text in this column
 * @property {boolean=} keepModel If enabled, initial column's options will be kept
+* @property {boolean=} stationary=false If enabled, the column order cannot be changed (i.e., this column and any column to its left cannot be moved)
+* @property {boolean=} leftPinned=false If enabled, the column will not be part of the scrollable area and is pinned to the left side
+* @property {boolean=} rightPinned=false If enabled, the column will not be part of the scrollable area and is pinned to the right side
 */
 
 /** mapping of field type to javascript type
@@ -102,16 +105,12 @@ var _toAlignment = function(str) {
 var ColumnDefinition = function(columnOption, hostGrid) {
 	this._defaultRenderer = this._defaultRenderer.bind(this);
 	this._customRenderer = this._customRenderer.bind(this);
-	this._defaultSorter = this._defaultSorter.bind(this);
-	this._dataSorter = this._dataSorter.bind(this);
-	this._rowDefSorter = this._rowDefSorter.bind(this);
 
 	this._id = "" + ColumnDefinition._runningId++;
 	this._internalRenderer = this._defaultRenderer;
 	this._internalSorter = this._defaultSorter;
 
 	this._eventArg = {"colDef": this}; // WARNING: Circular reference
-	this._sortContext = {"colDef": this};
 	if(hostGrid) {
 		this._updateContext("grid", hostGrid);
 		this._updateContext("core", hostGrid["getCoreGrid"]()); // TODO: Handle multiple core grids
@@ -180,15 +179,6 @@ ColumnDefinition.prototype._activatedRenderer = null;
 * @private
 */
 ColumnDefinition.prototype._rendererMap = null;
-/** @type {!Function}
-* @private
-*/
-ColumnDefinition.prototype._internalSorter;
-/** Workaround to provide user a context during the sorting process
-* @type {Object}
-* @private
-*/
-ColumnDefinition.prototype._sortContext = null;
 /** @type {Function}
 * @private
 */
@@ -434,25 +424,6 @@ ColumnDefinition.prototype.getRenderer = function() {
 ColumnDefinition.prototype.getHeaderRenderer = function() {
 	return this._headerRenderer;
 };
-/** @public
-* @return {!Function}
-*/
-ColumnDefinition.prototype.getSorter = function() {
-	return this._internalSorter;
-};
-/** Internal method for preparing sort context
-* @public
-* @ignore
-* @param {number} colIndex
-* @return {!Function}
-*/
-ColumnDefinition.prototype._prepareSortContext = function(colIndex) {
-	// TODO: Context does not get updated when column is moved or removed
-	this._sortContext["colIndex"] = colIndex;
-	this._sortContext["field"] = this._field;
-
-	return this._internalSorter;
-};
 
 /** @public
 * @return {string}
@@ -850,21 +821,27 @@ ColumnDefinition.prototype.activateRenderer = function(id, func) {
 	this.setRenderer(renderer);
 	return this._activatedRenderer ? true : false;
 };
+
+/** @public
+* @return {Function}
+*/
+ColumnDefinition.prototype.getSorter = function() {
+	return this._userSorter;
+};
 /** @public
 * @param {ColumnDefinition~SortLogic=} func
 */
 ColumnDefinition.prototype.setSorter = function(func) {
-	if(typeof func === "function") {
-		this._userSorter = func;
-		if(this._rowSorting == null) {
-			this._internalSorter = this._realTimeField ? this._dataSorter : this._rowDefSorter;
-		} else {
-			this._internalSorter = !this._rowSorting ? this._dataSorter : this._rowDefSorter;
-		}
-	} else {
-		this._userSorter = null;
-		this._internalSorter = this._defaultSorter;
+	this._userSorter = (typeof func === "function") ? func : null;
+};
+/** @public
+* @return {boolean}
+*/
+ColumnDefinition.prototype.isRowSorting = function() {
+	if(this._rowSorting == null) {
+		return !this._realTimeField;
 	}
+	return this._rowSorting ? true : false;
 };
 
 /** To allow user change column name in run-time (language change or localization)
@@ -983,78 +960,13 @@ ColumnDefinition.prototype._customRenderer = function(e) {
 		}
 	}
 };
-/** @private
-* @param {RowDefinition} rowDefA
-* @param {RowDefinition} rowDefB
-* @param {number} order
-* @return {number}
-*/
-ColumnDefinition.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}
-*/
-ColumnDefinition.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._userSorter(a, b, order, this._sortContext);
-};
-/** @private
-* @param {RowDefinition} rowDefA
-* @param {RowDefinition} rowDefB
-* @param {number} order
-* @return {number}
-*/
-ColumnDefinition.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._userSorter(rowDefA, rowDefB, order, this._sortContext);
-};
 /** @private
 * @param {string} propName
 * @param {*} val
 */
 ColumnDefinition.prototype._updateContext = function(propName, val) {
-	this._eventArg[propName] = this._sortContext[propName] = val;
+	this._eventArg[propName] = val;
 };
 
 /** @public

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

@@ -9,13 +9,13 @@ declare class DataConnector extends EventDispatcher {
 
     constructor();
 
-    public getAllRics(): (string)[];
+    public getAllRics(): (string)[]|null;
 
-    public getAllRowDefs(): (RowDefinition)[];
+    public getAllRowDefs(): (RowDefinition)[]|null;
 
     public getAllFields(): (string)[];
 
-    public getRowDefByRic(ric: string): (RowDefinition)[];
+    public getRowDefByRic(ric: string): (RowDefinition)[]|null;
 
     public addRic(rowDef: RowDefinition): boolean;
 

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

@@ -1,21 +1,21 @@
-import {Dom} from "../../tr-grid-util/es6/Dom.js";
-import {Conflator} from "../../tr-grid-util/es6/Conflator.js";
-import {Ext} from "../../tr-grid-util/es6/Ext.js";
+import { Dom } from "../../tr-grid-util/es6/Dom.js";
+import { Conflator } from "../../tr-grid-util/es6/Conflator.js";
+import { Ext } from "../../tr-grid-util/es6/Ext.js";
 import { EventDispatcher } from "../../tr-grid-util/es6/EventDispatcher.js";
 import { Engine } from "../../tr-grid-util/es6/formula/Engine.js";
 import { cloneObject, extendObject, arrayToObject } from "../../tr-grid-util/es6/Util.js";
 import { DateTime } from "../../tr-grid-util/es6/DateTime.js";
 
-import {RowDefinition, ROW_DEF} from "./RowDefinition.js";
-import {ColumnDefinition, COL_DEF} from "./ColumnDefinition.js";
+import { RowDefinition, ROW_DEF } from "./RowDefinition.js";
+import { ColumnDefinition, COL_DEF } from "./ColumnDefinition.js";
 import SnapshotFiller from "./SnapshotFiller.js";
 import StyleLoader from "./StyleLoader.js";
 import FieldDefinition from "./FieldDefinition.js";
 import DataConnector from "./DataConnector.js";
+import RowDefSorter from "./RowDefSorter.js";
 
 import { Core } from "../../core/es6/grid/Core.js";
 import { SortableTitlePlugin } from "../../core/es6/grid/plugins/SortableTitlePlugin.js";
-import { DragAndDropTitlePlugin } from "../../core/es6/grid/plugins/DragAndDropTitlePlugin.js";
 import { DataCache } from "../../core/es6/data/DataCache.js";
 import { DataTable } from "../../core/es6/data/DataTable.js";
 import { DataView } from "../../core/es6/data/DataView.js";
@@ -70,7 +70,10 @@ declare namespace Grid {
         dataComposed?: ((...params: any[]) => any),
         autoDateConversion?: boolean,
         textSelect?: boolean,
-        lang?: string
+        lang?: string,
+        scrollbarParent?: Element,
+        formulaEngine?: boolean,
+        adcPollingInterval?: number
     };
 
     type RowReference = number|string|RowDefinition;
@@ -85,7 +88,7 @@ declare class Grid extends EventDispatcher {
 
     public dispose(): void;
 
-    public getElement(): Element;
+    public getElement(): Element|null;
 
     public removeEventListeners(): void;
 
@@ -107,12 +110,14 @@ declare class Grid extends EventDispatcher {
 
     public getRelativePosition(obj: ElementWrapper|Element|Event|MouseEvent): any;
 
-    public getCoreGrid(): Core;
+    public getCoreGrid(): Core|null;
 
     public initialize(gridOption?: Grid.GridOptions): void;
 
     public getConfigObject(gridOptions?: any): any;
 
+    public setLocale(lang: string): void;
+
     public insertColumn(columnOption: ColumnDefinition.Options|string, idx?: number): void;
 
     public setColumns(columns: (any)[]): void;
@@ -159,9 +164,9 @@ declare class Grid extends EventDispatcher {
 
     public updateDataSet(records: (any)[], rowIdentifier: string): void;
 
-    public removeRow(rowRef: Grid.RowReference): RowDefinition;
+    public removeRow(rowRef: Grid.RowReference): RowDefinition|null;
 
-    public removeRows(rowRefs: (Grid.RowReference)[]): (RowDefinition)[];
+    public removeRows(rowRefs: (Grid.RowReference)[]): (RowDefinition)[]|null;
 
     public removeAllRows(): void;
 
@@ -193,12 +198,14 @@ declare class Grid extends EventDispatcher {
 
     public getColumnDataType(colIndex: number): string;
 
-    public getColumnDefinition(colIndex: number): ColumnDefinition;
+    public getColumnDefinition(colIndex: number): ColumnDefinition|null;
 
-    public getRowDefinition(rowRef: number|string): RowDefinition;
+    public getRowDefinition(rowRef: number|string): RowDefinition|null;
 
     public getRowDefinitions(): (RowDefinition)[];
 
+    public getAllRowDefinitions(inclAutoGenerate?: boolean): (RowDefinition)[];
+
     public getRowData(rowIndex: number): any;
 
     public getMultipleRowData(obj?: any): (any)[];
@@ -219,7 +226,7 @@ declare class Grid extends EventDispatcher {
 
     public getAllFields(): (string)[];
 
-    public freezeColumn(opt_colIndex?: number, pinnedRightColumns?: number): void;
+    public freezeColumn(colIndex?: number, pinnedRightColumns?: number): void;
 
     public updateColumnTitle(): void;
 
@@ -231,7 +238,7 @@ declare class Grid extends EventDispatcher {
 
     public clearSort(): void;
 
-    public getDataView(): DataView;
+    public getDataView(): DataView|null;
 
     public setPage(pageIndex: number): boolean;
 
@@ -249,6 +256,14 @@ declare class Grid extends EventDispatcher {
 
     public requestRowRefresh(): void;
 
+    public updateLayout(): void;
+
+    public getExtension(str: string): any;
+
+    public activateADCPolling(activated?: boolean): void;
+
+    public refreshADCData(): boolean;
+
     public logDT(opt_options?: any): void;
 
     public logDV(opt_options?: any): void;