@refinitiv-ui/efx-grid 6.0.4 → 6.0.5

package/lib/tr-grid-util/es6/ElfUtil.js

@@ -1,5 +1,6 @@
 import { nestedObjectToArray, rgb2Hex } from "./Util.js";
 import { Deferred } from "./Deferred.js";
+import { ElementObserver } from "./ElementObserver.js";
 
 /** Dialog supporting language (selection dialog, formater dialog and filter dialog)
 * @type {!Object.<string, boolean>}
@@ -63,6 +64,22 @@ ElfUtil._dummyIcon = null;
 * @private
 */
 ElfUtil._iconLoaded = false;
+/** @type {string|null}
+* @private
+*/
+ElfUtil._profileName = null;
+/** @type {Array}
+* @private
+*/
+ElfUtil._callbacks = [];
+/** @type {boolean}
+* @private
+*/
+ElfUtil._observed = false;
+/** @type {boolean}
+* @private
+*/
+ElfUtil._pendingResolve = false;
 
 /** @type {Object.<string, Object>}
 * @private
@@ -334,57 +351,146 @@ ElfUtil.getCssVariables = function (obj, optElem) {
 	return obj || null;
 };
 
+/** @public
+* @param {Object} rtk
+*/
+ElfUtil.setRTK = function(rtk) {
+	if(rtk != null) {
+		ElfUtil._rtk = rtk;
+	}
+};
+
+/** Get current profile name set on the root html element (document.documentElement)
+* @public
+* @return {string} Current profile name
+*/
+ElfUtil.getMovementColorProfile = function() {
+	return document.documentElement.getAttribute("movement-color-profile");
+};
+
+/** @private
+* @param {Function} cb
+*/
+ElfUtil._addThemeChangedCallback = function(cb) {
+	var callbacks = ElfUtil._callbacks;
+	if(callbacks.indexOf(cb) < 0) {
+		callbacks.push(cb);
+	}
+};
+
 /** Gets current theme colors from the document and returns a promise. <br>
-* WANRING: This method sets movement color profile to html tag automatically, if JET.Settings exists. <br>
+* WANRING: This method sets movement color profile to html tag automatically, if JET.Settings exists or RTK is available. <br>
 * To re-request/reset theme colors, set ElfUtil.themeReady variable to null
 * @public
+* @param {Function=} themeChangedCb
 * @return {Promise<Object>} A promise of object of theme colors
 */
-ElfUtil.getThemeColors = function() {
+ElfUtil.getThemeColors = function(themeChangedCb) {
+	if(typeof themeChangedCb === "function") {
+		ElfUtil._addThemeChangedCallback(themeChangedCb);
+	}
+
 	if(ElfUtil.themeReady) {
 		return ElfUtil.themeReady;
 	}
+
 	var d = ElfUtil._deferred = new Deferred();
 	ElfUtil.themeReady = d.promise;
 
-	var jet = window ? window.JET : null;
-	if(jet && jet.Settings) {
-		try {
-			jet.Settings.read(ElfUtil._onColorProfile, {
-				providerName: "Configuration",
-				settingName: "RDE_USER_CURRENT_TICK_COLOR"
-			});
-		} catch (err) {
-			d.reject("Cannot read JET's settings");
+	var profileName = ElfUtil.getMovementColorProfile();
+	if(profileName) {
+		if(profileName !== ElfUtil._profileName) {
+			setTimeout(ElfUtil._profileNameRetrieved, 100); // TODO: Find a proper way to ensure that theme is ready
+		} else {
+			ElfUtil._deferred.resolve(ElfUtil.themeColors);
 		}
 	} else {
-		setTimeout(ElfUtil._retrieveThemeColors, 100); // TODO: Find a proper way to ensure that theme is ready
+		var options = {
+			providerName: "Configuration",
+			settingName: "RDE_USER_CURRENT_TICK_COLOR"
+		};
+
+		var jet = window ? window.JET : null;
+		if(ElfUtil._rtk && ElfUtil._rtk.Settings) {
+			ElfUtil._rtk.Settings.getAsync(options).then(ElfUtil._loadingProfileSuccess, ElfUtil._loadingProfileFailure);
+		} else if(jet && jet.Settings) {
+			try {
+				jet.Settings.read(ElfUtil._loadingProfileSuccess, options);
+			} catch (err) {
+				ElfUtil._loadingProfileFailure();
+			}
+		} else {
+			setTimeout(ElfUtil._profileNameRetrieved, 100); // TODO: Find a proper way to ensure that theme is ready
+		}
 	}
+
 	return d.promise;
 };
 
-/** Get user's color profile from JET and set it to html tag (document.documentElement)
+/** @private
+* @param {string} profileName
+*/
+var movementColorProfileChanged = function(profileName) {
+	if(profileName && profileName !== ElfUtil._profileName) {
+		ElfUtil._retrieveThemeColors(profileName);
+
+		if(ElfUtil._pendingResolve) {
+			ElfUtil._pendingResolve = false;
+			ElfUtil._deferred.resolve(ElfUtil.themeColors);
+		}
+
+		var callbacks = ElfUtil._callbacks;
+		for (var i = 0; i < callbacks.length; i++) {
+			callbacks[i]();
+		}
+	}
+};
+
+/** Get user's color profile from JET or TRK and set it to html tag (document.documentElement)
 * @private
-* @param {string} colorProfile Returned from JET.Settings
+* @param {string} profileName Returned from JET.Settings or RTK.Settings
 */
-ElfUtil._onColorProfile = function (colorProfile) {
-	if(colorProfile) {
-		document.documentElement.setAttribute("movement-color-profile", colorProfile.toLowerCase());
+ElfUtil._loadingProfileSuccess = function(profileName) {
+	if(profileName) {
+		document.documentElement.setAttribute("movement-color-profile", profileName.toLowerCase());
+	}
+
+	if(ElfUtil._observed) { // Let attribute listener does the job
+		ElfUtil._pendingResolve = true;
+	} else {
+		ElfUtil._profileNameRetrieved(profileName);
 	}
-	ElfUtil._retrieveThemeColors();
 };
-/** Get current profile name set on the root html element (document.documentElement)
-* @public
-* @return {string} Current profile name
+
+/** @private
 */
-ElfUtil.getMovementColorProfile = function() {
-	return document.documentElement.getAttribute("movement-color-profile");
+ElfUtil._loadingProfileFailure = function() {
+	if(!ElfUtil._observed) {
+		ElfUtil._observed = true;
+		ElementObserver.addAttributeListener(document.documentElement, movementColorProfileChanged, "movement-color-profile");
+	}
+	ElfUtil._deferred.reject("Failed to get movement color profile from settings.");
+};
+
+/** @private
+*/
+ElfUtil._profileNameRetrieved = function() {
+	var profileName = ElfUtil.getMovementColorProfile();
+	ElfUtil._retrieveThemeColors(profileName);
+	if(!ElfUtil._observed) {
+		ElfUtil._observed = true;
+		ElementObserver.addAttributeListener(document.documentElement, movementColorProfileChanged, "movement-color-profile");
+	}
+	ElfUtil._deferred.resolve(ElfUtil.themeColors);
 };
 
 /** Get theme colors from document
 * @private
+* @param {string} profileName Movement color profile name
 */
-ElfUtil._retrieveThemeColors = function() {
+ElfUtil._retrieveThemeColors = function(profileName) {
+	ElfUtil._profileName = profileName;
+
 	var colors = ElfUtil.themeColors = ElfUtil.getCssVariables({
 		"primary": "--color-scheme-primary", // Usually used in headers, and selection
 		"secondary": "--color-scheme-secondary",
@@ -449,10 +555,7 @@ ElfUtil._retrieveThemeColors = function() {
 	colors["baseGrid"] = colors["tableBg"];
 	colors["baseText"] = colors["tableText"];
 	colors["trackColor"] = colors["primary"] || ElfUtil._defaultColors["trackColor"];
-
-	ElfUtil._deferred.resolve(colors);
 };
 
-
 export default ElfUtil;
 export { ElfUtil };

package/lib/types/es6/ConditionalColoring.d.ts

@@ -3,6 +3,7 @@ import { GridPlugin } from '../../tr-grid-util/es6/GridPlugin.js';
 import { extendObject } from '../../tr-grid-util/es6/Util.js';
 import {CellPainter} from '../../tr-grid-util/es6/CellPainter.js';
 import {FilterBuilder} from '../../tr-grid-util/es6/FilterBuilder.js';
+import {ElfUtil} from '../../tr-grid-util/es6/ElfUtil.js';
 
 declare namespace ConditionalColoringPlugin {
 
@@ -54,7 +55,7 @@ declare class ConditionalColoringPlugin extends GridPlugin {
 
     public blinkRow(rowIndex: number, blinkSignal: number, host?: any): void;
 
-    public getColumnPainter(colIndex: number): CellPainter;
+    public getColumnPainter(colIndex: number): CellPainter|null;
 
     public applyColor(colIndex: number, cell: any, rowData?: any): void;
 
@@ -62,7 +63,7 @@ declare class ConditionalColoringPlugin extends GridPlugin {
 
     public static setThemeColors(colors: { [key: string]:  string }): void;
 
-    public reloadThemeColors(): Promise<any>;
+    public reloadThemeColors(): Promise<any>|null;
 
 }
 

package/lib/types/es6/Core/grid/Core.d.ts

@@ -328,6 +328,8 @@ declare class Core extends ElementWrapper {
 
     public getScrollHeight(): number;
 
+    public restoreScrollbars(): void;
+
     public getRowVirtualizer(): Virtualizer;
 
     public getColumnVirtualizer(): Virtualizer;

package/lib/types/es6/Core/grid/components/Scrollbar.d.ts

@@ -55,6 +55,8 @@ declare class Scrollbar extends ElementWrapper {
 
     public freezeScrolling(frozen?: boolean): boolean;
 
+    public restoreTrackPosition(): void;
+
 }
 
 export default Scrollbar;

package/lib/types/es6/RealtimeGrid/Grid.d.ts

@@ -32,6 +32,10 @@ declare namespace Grid {
         debug?: boolean
     };
 
+    type ADCOptions = {
+        productId?: string
+    };
+
     type GridOptions = ExtensionOptions & {
         columns?: (ColumnDefinition.Options|string)[],
         defaultColumnOptions?: ColumnDefinition.Options,
@@ -65,6 +69,7 @@ declare namespace Grid {
         verticalLines?: boolean,
         horizontalLines?: boolean,
         RTK?: any,
+        ADC?: Grid.ADCOptions,
         synapse?: Grid.SynapseConfig,
         contentRightPadding?: number,
         contentBottomPadding?: number,
@@ -122,6 +127,8 @@ declare class Grid extends EventDispatcher {
 
     public insertColumn(columnOption: ColumnDefinition.Options|string, idx?: number): void;
 
+    public replaceColumn(columnOption: ColumnDefinition.Options|string, colRef: Grid.ColumnReference): void;
+
     public setColumns(columns: (any)[]): void;
 
     public setFields(ary: (string)[]): void;

package/lib/types/es6/RealtimeGrid/SnapshotFiller.d.ts

@@ -1,3 +1,4 @@
+import Grid from "./Grid.js";
 import {Ext} from '../../../tr-grid-util/es6/Ext.js';
 import {EventDispatcher} from '../../../tr-grid-util/es6/EventDispatcher.js';
 
@@ -7,6 +8,8 @@ declare class SnapshotFiller extends EventDispatcher {
 
     public setRTK(rtk: any): void;
 
+    public setADCOptions(adcOptions: Grid.ADCOptions): void;
+
     public addRic(ric: string): void;
 
     public addRics(rics: (string)[]): boolean;

package/lib/versions.json

@@ -1,5 +1,5 @@
 {
-	"tr-grid-util": "1.3.56",
+	"tr-grid-util": "1.3.58",
 	"@grid/column-dragging": "1.0.6",
 	"@grid/row-segmenting": "1.0.14",
 	"@grid/statistics-row": "1.0.13",
@@ -13,20 +13,20 @@
 	"tr-grid-column-resizing": "1.0.25",
 	"tr-grid-column-selection": "1.0.24",
 	"tr-grid-column-stack": "1.0.34",
-	"tr-grid-conditional-coloring": "1.0.52",
+	"tr-grid-conditional-coloring": "1.0.53",
 	"tr-grid-content-wrap": "1.0.18",
 	"tr-grid-contextmenu": "1.0.37",
 	"tr-grid-filter-input": "0.9.28",
 	"tr-grid-heat-map": "1.0.27",
 	"tr-grid-in-cell-editing": "1.0.66",
 	"tr-grid-pagination": "1.0.23",
-	"tr-grid-percent-bar": "1.0.20",
+	"tr-grid-percent-bar": "1.0.21",
 	"tr-grid-printer": "1.0.15",
 	"tr-grid-range-bar": "1.0.8",
 	"tr-grid-row-dragging": "1.0.21",
 	"tr-grid-row-filtering": "1.0.49",
 	"tr-grid-row-grouping": "1.0.76",
-	"tr-grid-row-selection": "1.0.18",
+	"tr-grid-row-selection": "1.0.20",
 	"tr-grid-rowcoloring": "1.0.19",
 	"tr-grid-textformatting": "1.0.44",
 	"tr-grid-titlewrap": "1.0.19",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@refinitiv-ui/efx-grid",
-	"version": "6.0.4",
+	"version": "6.0.5",
 	"description": "Grid Components Library",
 	"author": "Refinitiv",
 	"license": "SEE LICENSE IN LICENSE",