@refinitiv-ui/efx-grid 6.0.4 → 6.0.6

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

@@ -8,51 +8,51 @@ declare namespace ColumnDefinition {
     type SortLogic = (valA: any, valB: any, order: number, ctx: any) => void;
 
     type Options = {
-        field?: string,
-        dataType?: string,
-        formulaReference?: string,
-        require?: (string)[],
-        name?: string,
-        notRealTimeField?: boolean,
-        tooltip?: (boolean|string|null),
-        headerBinding?: ((...params: any[]) => any),
-        headerRenderer?: ((...params: any[]) => any),
-        binding?: ((...params: any[]) => any),
-        renderer?: ((...params: any[]) => any),
-        sortLogic?: ColumnDefinition.SortLogic,
-        sortingLogic?: ColumnDefinition.SortLogic,
-        sorter?: ColumnDefinition.SortLogic,
-        rowSorting?: boolean,
-        sortable?: boolean,
-        sort?: string,
+        field?: string|null,
+        dataType?: string|null,
+        formulaReference?: string|null,
+        require?: (string)[]|null,
+        name?: string|null,
+        notRealTimeField?: boolean|null,
+        tooltip?: (boolean|string|null)|null,
+        headerBinding?: ((...params: any[]) => any)|null,
+        headerRenderer?: ((...params: any[]) => any)|null,
+        binding?: ((...params: any[]) => any)|null,
+        renderer?: ((...params: any[]) => any)|null,
+        sortLogic?: ColumnDefinition.SortLogic|null,
+        sortingLogic?: ColumnDefinition.SortLogic|null,
+        sorter?: ColumnDefinition.SortLogic|null,
+        rowSorting?: boolean|null,
+        sortable?: boolean|null,
+        sort?: string|null,
         styles?: any,
-        width?: number,
-        minWidth?: number,
-        scalable?: boolean,
-        className?: string,
-        class?: string,
-        textAlign?: string,
-        alignment?: string,
-        headerAlignment?: string,
-        titleAlignment?: string,
-        hidden?: boolean,
-        id?: string,
-        textSelect?: boolean,
-        keepModel?: boolean,
-        stationary?: boolean,
-        leftPinned?: boolean,
-        rightPinned?: boolean
+        width?: number|null,
+        minWidth?: number|null,
+        scalable?: boolean|null,
+        className?: string|null,
+        class?: string|null,
+        textAlign?: string|null,
+        alignment?: string|null,
+        headerAlignment?: string|null,
+        titleAlignment?: string|null,
+        hidden?: boolean|null,
+        id?: string|null,
+        textSelect?: boolean|null,
+        keepModel?: boolean|null,
+        stationary?: boolean|null,
+        leftPinned?: boolean|null,
+        rightPinned?: boolean|null
     };
 
 }
 
 declare class ColumnDefinition {
 
-    constructor(columnOption?: ColumnDefinition.Options|string, hostGrid?: any);
+    constructor(columnOption?: ColumnDefinition.Options|string|null, hostGrid?: any);
 
     public dispose(): void;
 
-    public initialize(columnOption?: ColumnDefinition.Options|string): void;
+    public initialize(columnOption?: ColumnDefinition.Options|string|null): void;
 
     public getId(): string;
 
@@ -74,6 +74,8 @@ declare class ColumnDefinition {
 
     public getDataType(): string;
 
+    public setDataType(dataType: string): void;
+
     public static getDataType(field: string): string;
 
     public getTooltip(): string;
@@ -92,7 +94,7 @@ declare class ColumnDefinition {
 
     public static isRealTimeField(field: string): boolean;
 
-    public static getRealTimeFields(fields: (string)[], colDef: ColumnDefinition): (string)[];
+    public static getRealTimeFields(fields: (string)[]|null, colDef: ColumnDefinition|null): (string)[];
 
     public isSortable(): boolean;
 
@@ -106,6 +108,8 @@ declare class ColumnDefinition {
 
     public getTextAlign(): string;
 
+    public isFieldEmpty(): boolean;
+
     public getHeaderAlignment(): string;
 
     public getClasses(): (string)[];
@@ -116,19 +120,19 @@ declare class ColumnDefinition {
 
     public isTextSelect(): boolean;
 
-    public hide(bool?: boolean): void;
+    public hide(bool?: boolean|null): void;
 
-    public setHeaderRenderer(func: ((...params: any[]) => any)): void;
+    public setHeaderRenderer(func: ((...params: any[]) => any)|null): void;
 
-    public setRenderer(func: ((...params: any[]) => any)): void;
+    public setRenderer(func: ((...params: any[]) => any)|null): void;
 
-    public addRenderer(func: ((...params: any[]) => any)): void;
+    public addRenderer(func: ((...params: any[]) => any)|null): void;
 
-    public activateRenderer(id?: string, func?: ((...params: any[]) => any)): boolean;
+    public activateRenderer(id?: string|null, func?: ((...params: any[]) => any)|null): boolean;
 
     public getSorter(): ((...params: any[]) => any)|null;
 
-    public setSorter(func?: ColumnDefinition.SortLogic): void;
+    public setSorter(func?: ColumnDefinition.SortLogic|null): void;
 
     public isRowSorting(): boolean;
 

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

@@ -69,7 +69,11 @@ var TYPE_MAPPING = {
 
 	PRICE: "number",
 	DOUBLE: "number",
-	MONEY: "number"
+	MONEY: "number",
+
+	INTEGER: "number",
+	FLOAT: "number",
+	SCORE: "number"
 };
 
 /** @type {string}
@@ -147,6 +151,10 @@ ColumnDefinition.prototype._name = "";
 * @private
 */
 ColumnDefinition.prototype._isDefaultName = true;
+/** @type {boolean}
+* @private
+*/
+ColumnDefinition.prototype._emptyField = false;
 /** @type {string|null}
 * @private
 */
@@ -467,6 +475,17 @@ ColumnDefinition.prototype.getDataType = function () {
 	}
 	return "";
 };
+/** set data type
+* @public
+* @param {string} dataType
+*/
+ColumnDefinition.prototype.setDataType = function (dataType) {
+	var val = TYPE_MAPPING[dataType.toUpperCase()];
+	if(val) {
+		dataType = val;
+	}
+	this._dataType = dataType;
+};
 /** get data type
 * @public
 * @param {string} field
@@ -629,6 +648,13 @@ ColumnDefinition.prototype.getTextAlign = function() {
 	var colIndex = grid.getColumnIndex(this);
 	return core.getColumnAlignment(colIndex);
 };
+/** @public
+* @return {boolean}
+*/
+ColumnDefinition.prototype.isFieldEmpty = function() {
+	return this._emptyField;
+};
+
 /** @public
 * @return {string}
 */
@@ -887,9 +913,11 @@ ColumnDefinition.prototype._setField = function(field, formulaStr) {
 	if(defaultField) {
 		this._field = "COLUMN_" + this._id;
 		this._name = "Column " + this._id;
+		this._emptyField = true;
 	} else {
 		this._field = field;
 		this._name = field;
+		this._emptyField = false;
 		this._realTimeField = field ? true : false;
 	}
 	this._isDefaultName = true;
@@ -945,6 +973,8 @@ ColumnDefinition.prototype._customRenderer = function(e) {
 	arg["rowIndex"] = e["rowIndex"];
 	if(rowData) {
 		arg["data"] = rowData[this._field];
+	} else {
+		arg["data"] = null;
 	}
 	arg["colIndex"] = e["colIndex"];
 	arg["cell"] = e["cell"];

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

@@ -17,15 +17,17 @@ declare class DataConnector extends EventDispatcher {
 
     public getRowDefByRic(ric: string): (RowDefinition)[]|null;
 
-    public addRic(rowDef: RowDefinition): boolean;
+    public addRic(rowDef: RowDefinition|null): boolean;
 
-    public removeRic(rowDef: RowDefinition, ric?: string): void;
+    public removeRic(rowDef: RowDefinition|null, ric?: string|null): void;
 
     public removeAllRics(): void;
 
-    public addFields(fieldRef: string|(string)[]|ColumnDefinition, referer?: string): void;
+    public addFields(fieldRef: string|(string)[]|ColumnDefinition|null, referer?: string|null): void;
 
-    public removeFields(fieldRef: ColumnDefinition|string, referer?: string): void;
+    public removeFields(fieldRef: ColumnDefinition|string|null, referer?: string|null): void;
+
+    public removeFieldReferrer(referrer: string): void;
 
     public removeAllFields(): void;
 

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

@@ -203,6 +203,14 @@ DataConnector.prototype.removeFields = function (fieldRef, referer) {
 	this._commitFieldsChanges();
 };
 
+/** @public
+* @param {string} referrer
+*/
+DataConnector.prototype.removeFieldReferrer = function (referrer) {
+	this._fields.removeReferer(referrer);
+	this._commitFieldsChanges();
+};
+
 /** @public
 */
 DataConnector.prototype.removeAllFields = function () {

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

@@ -10,9 +10,9 @@ declare namespace FieldDefinition {
 
     function remove(field: string): void;
 
-    function setSynapseConfig(config: Grid.SynapseConfig): void;
+    function setSynapseConfig(config: Grid.SynapseConfig|null): void;
 
-    function set(field: string, def: any): void;
+    function setFieldCaching(caching: boolean): void;
 
 }
 

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

@@ -171,6 +171,11 @@ FieldDefinition._synapse = '';
 * @const
 */
 FieldDefinition._lang = 'en';
+/**
+* @type {boolean}
+* @private
+*/
+FieldDefinition._caching = false;
 
 /**
  * @type {Object.<string, boolean>}
@@ -192,7 +197,10 @@ FieldDefinition.set = function(field, def) {
 * @return {Object}
 */
 FieldDefinition.get = function(field) {
-	return FieldDefinition._defs[field];
+	if(this._caching) {
+		return FieldDefinition._defs[field];
+	}
+	return null;
 };
 /** @public
 * @function
@@ -213,11 +221,10 @@ FieldDefinition.setSynapseConfig = function (config) {
 
 /** @public
 * @function
-* @param {string} field
-* @param {Object} def
+* @param {boolean} caching
 */
-FieldDefinition.set = function (field, def) {
-	FieldDefinition._defs[field] = def || null;
+FieldDefinition.setFieldCaching = function (caching) {
+	FieldDefinition._caching = caching;
 };
 
 /** to get more info about field via synapse service

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

@@ -26,65 +26,72 @@ declare namespace Grid {
     type SynapseConfig = {
         apiKey: string,
         contextApp: string,
-        auth?: string,
-        debug?: boolean
+        auth?: string|null,
+        debug?: boolean|null
+    };
+
+    type ADCOptions = {
+        productId?: string|null
     };
 
     type GridOptions = {
-        columns?: (ColumnDefinition.Options|string)[],
-        defaultColumnOptions?: ColumnDefinition.Options,
-        rows?: (RowDefinition.Options)[],
-        fields?: (string)[],
-        rics?: (string)[],
-        plugins?: any[],
-        extensions?: any[],
-        scrollbar?: boolean,
-        linearWheelScrolling?: boolean,
-        stepScroll?: boolean,
-        autoHideScrollbar?: boolean,
-        pageSize?: string,
-        rowHeight?: number,
-        headerRowHeight?: number,
-        noColumnDragging?: boolean,
-        columnReorder?: boolean,
-        rowHighlighting?: boolean,
-        autoLayoutUpdate?: (boolean|number),
-        columnFreezing?: number,
-        freezeColumn?: number,
-        pinnedRightColumns?: number,
-        staticDataRows?: any[],
-        dataFields?: (string)[],
-        rowVirtualization?: boolean,
-        columnVirtualization?: boolean,
-        topFreezingCount?: (number|null|boolean),
-        bottomFreezingCount?: (number|null),
-        borders?: boolean,
-        gridlines?: boolean,
-        verticalLines?: boolean,
-        horizontalLines?: boolean,
+        columns?: (ColumnDefinition.Options|string)[]|null,
+        defaultColumnOptions?: ColumnDefinition.Options|null,
+        rows?: (RowDefinition.Options)[]|null,
+        fields?: (string)[]|null,
+        rics?: (string)[]|null,
+        plugins?: any[]|null,
+        extensions?: any[]|null,
+        scrollbar?: boolean|null,
+        linearWheelScrolling?: boolean|null,
+        stepScroll?: boolean|null,
+        autoHideScrollbar?: boolean|null,
+        pageSize?: string|null,
+        rowHeight?: number|null,
+        headerRowHeight?: number|null,
+        noColumnDragging?: boolean|null,
+        columnReorder?: boolean|null,
+        rowHighlighting?: boolean|null,
+        autoLayoutUpdate?: (boolean|number)|null,
+        columnFreezing?: number|null,
+        freezeColumn?: number|null,
+        pinnedRightColumns?: number|null,
+        staticDataRows?: any[]|null,
+        dataFields?: (string)[]|null,
+        rowVirtualization?: boolean|null,
+        columnVirtualization?: boolean|null,
+        topFreezingCount?: (number|null|boolean)|null,
+        bottomFreezingCount?: (number|null)|null,
+        borders?: boolean|null,
+        gridlines?: boolean|null,
+        verticalLines?: boolean|null,
+        contentVerticalLines?: boolean|null,
+        horizontalLines?: boolean|null,
         RTK?: any,
-        synapse?: Grid.SynapseConfig,
-        contentRightPadding?: number,
-        contentBottomPadding?: number,
-        dataConflationRate?: number,
-        dataComposed?: ((...params: any[]) => any),
-        autoDateConversion?: boolean,
-        textSelect?: boolean,
-        lang?: string,
-        scrollbarParent?: Element,
-        formulaEngine?: boolean,
-        adcPollingInterval?: number
+        ADC?: Grid.ADCOptions|null,
+        synapse?: Grid.SynapseConfig|null,
+        contentRightPadding?: number|null,
+        contentBottomPadding?: number|null,
+        dataConflationRate?: number|null,
+        dataComposed?: ((...params: any[]) => any)|null,
+        autoDateConversion?: boolean|null,
+        textSelect?: boolean|null,
+        lang?: string|null,
+        scrollbarParent?: Element|null,
+        formulaEngine?: boolean|null,
+        adcPollingInterval?: number|null,
+        fieldCaching?: boolean|null
     };
 
-    type RowReference = number|string|RowDefinition;
+    type RowReference = number|string|RowDefinition|null;
 
-    type ColumnReference = number|string|ColumnDefinition;
+    type ColumnReference = number|string|ColumnDefinition|null;
 
 }
 
 declare class Grid extends EventDispatcher {
 
-    constructor(placeholder?: (Element|null), config?: Grid.GridOptions);
+    constructor(placeholder?: (Element|null)|null, config?: Grid.GridOptions|null);
 
     public dispose(): void;
 
@@ -92,101 +99,105 @@ declare class Grid extends EventDispatcher {
 
     public removeEventListeners(): void;
 
-    public listen(type: string, handler: ((...params: any[]) => any)): void;
+    public listen(type: string, handler: ((...params: any[]) => any)|null): void;
 
     public initSubscription(): void;
 
     public updateLayout(): void;
 
-    public updateRowData(opt_rowIndex?: number): void;
+    public updateRowData(opt_rowIndex?: number|null): void;
 
-    public addHeaderSection(sectionName?: string): any;
+    public addHeaderSection(sectionName?: string|null): any;
 
-    public addFooterSection(sectionName?: string): any;
+    public addFooterSection(sectionName?: string|null): any;
 
-    public setParent(elem: Element): void;
+    public setParent(elem: Element|null): void;
 
-    public insertBefore(elem: Element): void;
+    public insertBefore(elem: Element|null): void;
 
     public getRelativePosition(obj: ElementWrapper|Element|Event|MouseEvent): any;
 
     public getCoreGrid(): Core|null;
 
-    public initialize(gridOption?: Grid.GridOptions): void;
+    public initialize(gridOption?: Grid.GridOptions|null): void;
 
     public getConfigObject(gridOptions?: any): any;
 
     public setLocale(lang: string): void;
 
-    public insertColumn(columnOption: ColumnDefinition.Options|string, idx?: number): void;
+    public insertColumn(columnOption: ColumnDefinition.Options|string|null, idx?: number|null): void;
+
+    public replaceColumn(columnOption: ColumnDefinition.Options|string|null, colRef: Grid.ColumnReference|null): void;
 
-    public setColumns(columns: (any)[]): void;
+    public setColumns(columns: (any)[]|null): void;
 
-    public setFields(ary: (string)[]): void;
+    public setFields(ary: (string)[]|null): void;
 
-    public removeColumn(colRef: Grid.ColumnReference): void;
+    public removeColumn(colRef: Grid.ColumnReference|null): void;
 
-    public removeColumns(colRefs: (Grid.ColumnReference)[]): void;
+    public removeColumns(colRefs: (Grid.ColumnReference)[]|null): void;
 
     public removeAllColumns(): void;
 
-    public moveColumn(fromColIndex: number|(number)[], toColIndex: number): boolean;
+    public moveColumn(fromColIndex: number|(number)[]|null, toColIndex: number): boolean;
 
-    public hideColumn(colRef: Grid.ColumnReference, hidden?: boolean): void;
+    public hideColumn(colRef: Grid.ColumnReference|null, hidden?: boolean|null): void;
 
-    public hideColumns(colRefs: (Grid.ColumnReference)[], hidden?: boolean): void;
+    public hideColumns(colRefs: (Grid.ColumnReference)[]|null, hidden?: boolean|null): void;
 
     public showAllColumns(): void;
 
-    public addDataFields(fieldRef: string|(string)[], referrer?: string): boolean;
+    public addDataFields(fieldRef: string|(string)[]|null, referrer?: string|null): boolean;
 
-    public removeDataFields(fieldRef: string|(string)[], referrer?: string): boolean;
+    public removeDataFields(fieldRef: string|(string)[]|null, referrer?: string|null): boolean;
 
-    public sortColumn(colRef: Grid.ColumnReference, opt_order?: string): void;
+    public removeFieldReferrer(referrer: string): void;
+
+    public sortColumn(colRef: Grid.ColumnReference|null, opt_order?: string|null): void;
 
     public setColumnName(colIndex: number, str: string): void;
 
-    public setColumnRenderer(colRef: Grid.ColumnReference, func?: ((...params: any[]) => any)): void;
+    public setColumnRenderer(colRef: Grid.ColumnReference|null, func?: ((...params: any[]) => any)|null): void;
 
-    public activateColumnRenderer(colRef: Grid.ColumnReference, id?: string, func?: ((...params: any[]) => any)): void;
+    public activateColumnRenderer(colRef: Grid.ColumnReference|null, id?: string|null, func?: ((...params: any[]) => any)|null): void;
 
-    public setColumnFormatter(colIndex: number, formatter?: any|((...params: any[]) => any)): void;
+    public setColumnFormatter(colIndex: number, formatter?: any|((...params: any[]) => any)|null): void;
 
-    public setColumnSorter(colRef: Grid.ColumnReference, func?: ColumnDefinition.SortLogic): void;
+    public setColumnSorter(colRef: Grid.ColumnReference|null, func?: ColumnDefinition.SortLogic|null): void;
 
-    public _initDuplicateRicData(rowDef: RowDefinition): void;
+    public _initDuplicateRicData(rowDef: RowDefinition|null): void;
 
-    public insertRow(rowOption?: any, rowRef?: Grid.RowReference): any;
+    public insertRow(rowOption?: any, rowRef?: Grid.RowReference|null): any;
 
-    public insertRows(rowOptions: (any)[], rowRef?: Grid.RowReference, opt_fields?: (string)[]): void;
+    public insertRows(rowOptions: (any)[]|null, rowRef?: Grid.RowReference|null, opt_fields?: (string)[]|null): void;
 
-    public addStaticDataRows(dataRows: any[], fields?: (string)[]): void;
+    public addStaticDataRows(dataRows: any[]|null, fields?: (string)[]|null): void;
 
-    public updateDataSet(records: (any)[], rowIdentifier: string): void;
+    public updateDataSet(records: (any)[]|null, rowIdentifier: string): void;
 
-    public removeRow(rowRef: Grid.RowReference): RowDefinition|null;
+    public removeRow(rowRef: Grid.RowReference|null): RowDefinition|null;
 
-    public removeRows(rowRefs: (Grid.RowReference)[]): (RowDefinition)[]|null;
+    public removeRows(rowRefs: (Grid.RowReference)[]|null): (RowDefinition)[]|null;
 
     public removeAllRows(): void;
 
-    public hideRow(rowRef: Grid.RowReference, hidden?: boolean): void;
+    public hideRow(rowRef: Grid.RowReference|null, hidden?: boolean|null): void;
 
-    public hideRows(rowRefs: Grid.RowReference | (Grid.RowReference)[], hidden?: boolean): void;
+    public hideRows(rowRefs: Grid.RowReference | (Grid.RowReference)[]|null, hidden?: boolean|null): void;
 
-    public showRows(rowRefs: Grid.RowReference | (Grid.RowReference)[], shown?: boolean): void;
+    public showRows(rowRefs: Grid.RowReference | (Grid.RowReference)[]|null, shown?: boolean|null): void;
 
     public unhideAllRows(): void;
 
     public hasHiddenRow(): boolean;
 
-    public setRic(rowRef: Grid.RowReference, str: string): void;
+    public setRic(rowRef: Grid.RowReference|null, str: string): void;
 
-    public setRowContent(rowRef: Grid.RowReference, str: string): void;
+    public setRowContent(rowRef: Grid.RowReference|null, str: string): void;
 
-    public toggleRowExpansion(rid: string|number, force?: boolean): void;
+    public toggleRowExpansion(rid: string|number|null, force?: boolean|null): void;
 
-    public setRics(ary: (string)[]): void;
+    public setRics(ary: (string)[]|null): void;
 
     public getRowCount(): number;
 
@@ -200,11 +211,15 @@ declare class Grid extends EventDispatcher {
 
     public getColumnDefinition(colIndex: number): ColumnDefinition|null;
 
-    public getRowDefinition(rowRef: number|string): RowDefinition|null;
+    public getColumnDefinitionById(colId: string): ColumnDefinition|null;
+
+    public getColumnDefinitionsById(colIds: (string)[]|null): ColumnDefinition|null;
+
+    public getRowDefinition(rowRef: number|string|null): RowDefinition|null;
 
     public getRowDefinitions(): (RowDefinition)[];
 
-    public getAllRowDefinitions(inclAutoGenerate?: boolean): (RowDefinition)[];
+    public getAllRowDefinitions(inclAutoGenerate?: boolean|null): (RowDefinition)[];
 
     public getRowData(rowIndex: number): any;
 
@@ -212,11 +227,11 @@ declare class Grid extends EventDispatcher {
 
     public setRicData(ric: string, values: any): void;
 
-    public setRowData(rowRef: Grid.RowReference, values: any): void;
+    public setRowData(rowRef: Grid.RowReference|null, values: any): void;
 
-    public getColumnIndex(colRef: Grid.ColumnReference): number;
+    public getColumnIndex(colRef: Grid.ColumnReference|null): number;
 
-    public getColumnIndices(colRefs: (Grid.ColumnReference)[]): (number)[];
+    public getColumnIndices(colRefs: (Grid.ColumnReference)[]|null): (number)[];
 
     public getColumnId(colIndex: number): string;
 
@@ -226,7 +241,7 @@ declare class Grid extends EventDispatcher {
 
     public getAllFields(): (string)[];
 
-    public freezeColumn(colIndex?: number, pinnedRightColumns?: number): void;
+    public freezeColumn(colIndex?: number|null, pinnedRightColumns?: number|null): void;
 
     public updateColumnTitle(): void;
 
@@ -250,7 +265,7 @@ declare class Grid extends EventDispatcher {
 
     public getPageCount(): number;
 
-    public toggleChain(rowRef: Grid.RowReference): void;
+    public toggleChain(rowRef: Grid.RowReference|null): void;
 
     public focus(): void;
 
@@ -260,7 +275,7 @@ declare class Grid extends EventDispatcher {
 
     public getExtension(str: string): any;
 
-    public activateADCPolling(activated?: boolean): void;
+    public activateADCPolling(activated?: boolean|null): void;
 
     public refreshADCData(): boolean;