@refinitiv-ui/efx-grid 6.0.16 → 6.0.18

package/lib/tr-grid-row-grouping/es6/RowGrouping.d.ts

@@ -10,47 +10,47 @@ declare namespace RowGroupingPlugin {
     type GroupSortLogic = (grpValA: any, grpValB: any, grpDataViewA?: any, grpDataViewB?: any) => number;
 
     type Options = {
-        autoGroupRemoval?: boolean,
-        autoGroupHiding?: boolean,
-        predefinedGroups?: (any[]|(any[])[]),
-        groupBy?: RowGroupingPlugin.GroupCriteria,
-        groupCriteria?: RowGroupingPlugin.GroupCriteria,
-        displayColumn?: number,
-        fixedDisplayColumn?: boolean,
-        noCollapsible?: boolean,
-        clickableCell?: boolean,
-        hiddenArrow?: (boolean|number|(number)[]),
-        contentAsHeader?: boolean,
-        headerSpanning?: boolean,
-        footerSpanning?: boolean,
-        groupSortLogic?: RowGroupingPlugin.GroupSortLogic,
-        autoGroupSorting?: boolean,
-        indentSize?: (boolean|number|(number)[]),
-        colorTag?: boolean,
+        autoGroupRemoval?: boolean|null,
+        autoGroupHiding?: boolean|null,
+        predefinedGroups?: (any[]|(any[])[])|null,
+        groupBy?: RowGroupingPlugin.GroupCriteria|null,
+        groupCriteria?: RowGroupingPlugin.GroupCriteria|null,
+        displayColumn?: number|null,
+        fixedDisplayColumn?: boolean|null,
+        noCollapsible?: boolean|null,
+        clickableCell?: boolean|null,
+        hiddenArrow?: (boolean|number|(number)[])|null,
+        contentAsHeader?: boolean|null,
+        headerSpanning?: boolean|null,
+        footerSpanning?: boolean|null,
+        groupSortLogic?: RowGroupingPlugin.GroupSortLogic|null,
+        autoGroupSorting?: boolean|null,
+        indentSize?: (boolean|number|(number)[])|null,
+        colorTag?: boolean|null,
         predefinedColors?: any,
         groupColors?: any,
-        clicked?: ((...params: any[]) => any),
-        groupAdded?: ((...params: any[]) => any),
-        beforeGroupAdded?: ((...params: any[]) => any),
-        groupHeaderBinding?: ((...params: any[]) => any),
-        groupFooterBinding?: ((...params: any[]) => any),
-        headerBinding?: ((...params: any[]) => any),
-        footerBinding?: ((...params: any[]) => any),
-        nonGroupBinding?: ((...params: any[]) => any)
+        clicked?: ((...params: any[]) => any)|null,
+        groupAdded?: ((...params: any[]) => any)|null,
+        beforeGroupAdded?: ((...params: any[]) => any)|null,
+        groupHeaderBinding?: ((...params: any[]) => any)|null,
+        groupFooterBinding?: ((...params: any[]) => any)|null,
+        headerBinding?: ((...params: any[]) => any)|null,
+        footerBinding?: ((...params: any[]) => any)|null,
+        nonGroupBinding?: ((...params: any[]) => any)|null
     };
 
-    type GroupCriteria = string|(string|((...params: any[]) => any))[];
+    type GroupCriteria = string|(string|((...params: any[]) => any))[]|null;
 
     type GroupingState = {
         collapsed: boolean,
-        groupId?: (number|string)
+        groupId?: (number|string)|null
     };
 
 }
 
 declare class RowGroupingPlugin extends GridPlugin {
 
-    constructor(options?: RowGroupingPlugin.Options);
+    constructor(options?: RowGroupingPlugin.Options|null);
 
     public beforeProcessOption(optionName: string, optionVal: any): any;
 
@@ -70,17 +70,17 @@ declare class RowGroupingPlugin extends GridPlugin {
 
     public hasGroupingCriteria(): boolean;
 
-    public setGroupingCriteria(criteria: RowGroupingPlugin.GroupCriteria): void;
+    public setGroupingCriteria(criteria: RowGroupingPlugin.GroupCriteria|null): void;
 
-    public groupBy(criteria: RowGroupingPlugin.GroupCriteria): void;
+    public groupBy(criteria: RowGroupingPlugin.GroupCriteria|null): void;
 
     public getDataView(): any;
 
-    public setGroupSortingLogic(sortFunction: RowGroupingPlugin.GroupSortLogic): void;
+    public setGroupSortingLogic(sortFunction: RowGroupingPlugin.GroupSortLogic|null): void;
 
     public getGroupSortingLogic(): ((...params: any[]) => any)|null;
 
-    public setPredefinedGroups(predefinedGroups: any[]|(any[])[]): void;
+    public setPredefinedGroups(predefinedGroups: any[]|(any[])[]|null): void;
 
     public setPredefinedColors(predefinedColors: any): void;
 
@@ -88,23 +88,23 @@ declare class RowGroupingPlugin extends GridPlugin {
 
     public updateHeaders(): void;
 
-    public expandAll(opt_expanded?: boolean): void;
+    public expandAll(opt_expanded?: boolean|null): void;
 
-    public collapseAll(opt_collapsed?: boolean): void;
+    public collapseAll(opt_collapsed?: boolean|null): void;
 
-    public expand(groupRowId: string, opt_expanded?: boolean): void;
+    public expand(groupRowId: string, opt_expanded?: boolean|null): void;
 
-    public collapse(groupRowId: string, opt_collapsed?: boolean): void;
+    public collapse(groupRowId: string, opt_collapsed?: boolean|null): void;
 
-    public disableClicking(opt_disabled?: boolean): void;
+    public disableClicking(opt_disabled?: boolean|null): void;
 
     public getGroupingStates(): (RowGroupingPlugin.GroupingState)[]|null;
 
-    public setGroupingStates(states: (RowGroupingPlugin.GroupingState)[]|string): void;
+    public setGroupingStates(states: (RowGroupingPlugin.GroupingState)[]|string|null): void;
 
-    public enableFixedDisplayColumn(opt_enabled?: boolean): void;
+    public enableFixedDisplayColumn(opt_enabled?: boolean|null): void;
 
-    public enableFooterRow(opt_num?: (boolean|number)): void;
+    public enableFooterRow(opt_num?: (boolean|number)|null): void;
 
 }
 

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

@@ -24,12 +24,12 @@ declare class ColumnGroupingPlugin extends GridPlugin {
 
     constructor(options?: ColumnGroupingPlugin.Options|null);
 
-    public beforeProcessOption(optionName: string, optionValue: any): any;
-
     public getName(): string;
 
     public initialize(host: any, options?: any): void;
 
+    public beforeProcessOption(optionName: string, optionValue: any): any;
+
     public unload(host: any): void;
 
     public config(options: any): void;
@@ -66,9 +66,9 @@ declare class ColumnGroupingPlugin extends GridPlugin {
 
     public getCellInfo(e: Element|Event|MouseEvent|null): any;
 
-    public moveColumnIntoGroup(from: number|string|null, to: number, groupId: string): void;
+    public moveColumnIntoGroup(colRef: number|string|null, to: number, groupId: string): void;
 
-    public setColumnParent(columnIndex: number|string|null, groupId: string): void;
+    public setColumnParent(colRef: number|string|null, groupId: string): void;
 
 }
 

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

@@ -11,7 +11,8 @@ declare namespace ColumnStackPlugin {
 
     type Options = {
         fields: (string)[]|null,
-        stacks: (ColumnStackPlugin.StackDefinition)[]|null
+        stacks: (ColumnStackPlugin.StackDefinition)[]|null,
+        autoStacking?: boolean|null
     };
 
     type ColumnOptions = {
@@ -30,6 +31,7 @@ declare namespace ColumnStackPlugin {
         spreading?: boolean|null,
         collapsed?: boolean|null,
         children: (string)[]|null,
+        fields: (string)[]|null,
         name?: string|null,
         activeColumn?: string|null
     };
@@ -100,6 +102,8 @@ declare class ColumnStackPlugin extends GridPlugin {
 
     public getColumnIndicesByColumnIds(columnId: string|(string)[]|null): (string)[];
 
+    public getColumnIdsByFields(field: string|(string)[]|null): (string)[];
+
     public addColumnToStack(colRef: number|string|null, stackId: string): void;
 
     public removeColumnFromStack(colRef: number|string|null): void;
@@ -110,6 +114,8 @@ declare class ColumnStackPlugin extends GridPlugin {
 
     public getStackName(stackId: string): string;
 
+    public getActiveColumnField(stackId: string): string;
+
 }
 
 export default ColumnStackPlugin;

package/lib/types/es6/Core/data/Segment.d.ts

@@ -1,7 +1,7 @@
 import Ext from "../../../../tr-grid-util/es6/Ext.js";
 import EventDispatcher from "../../../../tr-grid-util/es6/EventDispatcher.js";
 
-declare class Segment {
+declare class Segment extends EventDispatcher {
 
     constructor(rid: string, sharedObj: any);
 
@@ -23,7 +23,7 @@ declare class Segment {
 
     public removeChildren(rids: (string)[]|null): boolean;
 
-    public removeAllChildren(objMap?: any): boolean;
+    public removeAllChildren(): boolean;
 
     public getChildIds(): (string)[];
 
@@ -55,7 +55,7 @@ declare class Segment {
 
     public isCollapsed(): boolean;
 
-    public getCollapsingStates(objMap?: any, parentState?: boolean|null): number;
+    public getCollapsingStates(objMap?: any, parentState?: boolean|null): boolean;
 
     public getOrder(): number;
 

package/lib/types/es6/Core/data/SegmentCollection.d.ts

@@ -2,7 +2,7 @@ import Ext from "../../../../tr-grid-util/es6/Ext.js";
 import EventDispatcher from "../../../../tr-grid-util/es6/EventDispatcher.js";
 import Segment from "./Segment.js";
 
-declare class SegmentCollection {
+declare class SegmentCollection extends EventDispatcher {
 
     constructor();
 

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

@@ -10,50 +10,51 @@ import { CoralItems } from "../../tr-grid-util/es6/CoralItems.js";
 declare namespace InCellEditingPlugin {
 
     type Options = {
-        balloonMode?: boolean,
-        editableTitle?: boolean,
-        editableContent?: boolean,
-        autoCommitText?: boolean,
-        dataBinding?: boolean,
-        popupElement?: Element,
-        doubleClick?: boolean,
-        tabToMove?: boolean,
-        contentSource?: boolean,
-        inlineStyling?: boolean,
-        disablingScroll?: boolean,
-        uiBlocking?: boolean,
-        preEditorOpening?: ((...params: any[]) => any),
-        editorOpened?: ((...params: any[]) => any),
-        beforeCommit?: ((...params: any[]) => any),
-        editorClosed?: ((...params: any[]) => any),
-        keyUp?: ((...params: any[]) => any),
-        beforeRowCommit?: ((...params: any[]) => any),
-        rowEditorClosed?: ((...params: any[]) => any),
-        autoSuggest?: Element,
-        closingOnScroll?: boolean
+        balloonMode?: boolean|null,
+        editableTitle?: boolean|null,
+        editableContent?: boolean|null,
+        autoCommitText?: boolean|null,
+        dataBinding?: boolean|null,
+        popupElement?: Element|null,
+        doubleClick?: boolean|null,
+        tabToMove?: boolean|null,
+        contentSource?: boolean|null,
+        inlineStyling?: boolean|null,
+        disablingScroll?: boolean|null,
+        uiBlocking?: boolean|null,
+        preEditorOpening?: ((...params: any[]) => any)|null,
+        editorOpened?: ((...params: any[]) => any)|null,
+        beforeCommit?: ((...params: any[]) => any)|null,
+        editorClosed?: ((...params: any[]) => any)|null,
+        keyUp?: ((...params: any[]) => any)|null,
+        beforeRowCommit?: ((...params: any[]) => any)|null,
+        rowEditorClosed?: ((...params: any[]) => any)|null,
+        autoSuggest?: Element|null,
+        closingOnScroll?: boolean|null
     };
 
     type Cache = {
-        editor: Element,
-        balloonPopup: Element,
-        inputElement: Element
+        editor: Element|null,
+        balloonPopup: Element|null,
+        inputElement: Element|null
     };
 
     type EditorOptions = {
-        type?: string,
-        entries?: any[]
+        type?: string|null,
+        entries?: any[]|null,
+        attributes?: any
     };
 
     type ColumnOptions = {
-        editableContent?: boolean,
-        inCellEditing?: InCellEditingPlugin.EditorOptions
+        editableContent?: boolean|null,
+        inCellEditing?: InCellEditingPlugin.EditorOptions|null
     };
 
 }
 
 declare class InCellEditingPlugin extends GridPlugin {
 
-    constructor(options?: InCellEditingPlugin.Options);
+    constructor(options?: InCellEditingPlugin.Options|null);
 
     public initialize(host: any, options: any): void;
 
@@ -65,23 +66,23 @@ declare class InCellEditingPlugin extends GridPlugin {
 
     public openEditor(colIndex: number, rowIndex: number, sectionRef?: any, grid?: any): void;
 
-    public closeCellEditor(opt_forceCommit?: boolean): void;
+    public closeCellEditor(opt_forceCommit?: boolean|null): void;
 
-    public enableBalloonMode(opt_enabled?: boolean): void;
+    public enableBalloonMode(opt_enabled?: boolean|null): void;
 
-    public enableTitleEditing(opt_enabled?: boolean): void;
+    public enableTitleEditing(opt_enabled?: boolean|null): void;
 
-    public disableTitleEditing(opt_disabled?: boolean): void;
+    public disableTitleEditing(opt_disabled?: boolean|null): void;
 
-    public disableCellEditing(cell: any, opt_disabled?: boolean): void;
+    public disableCellEditing(cell: any, opt_disabled?: boolean|null): void;
 
-    public disableDataBinding(opt_disabled?: boolean): void;
+    public disableDataBinding(opt_disabled?: boolean|null): void;
 
-    public disableDblClick(opt_disabled?: boolean): void;
+    public disableDblClick(opt_disabled?: boolean|null): void;
 
     public isEditing(): boolean;
 
-    public getTextBox(columnIndex?: number, grid?: any): Element|null;
+    public getTextBox(columnIndex?: number|null, grid?: any): Element|null;
 
     public getInitialText(): string;
 
@@ -97,17 +98,17 @@ declare class InCellEditingPlugin extends GridPlugin {
 
     public getInputElementPosition(): any;
 
-    public enableAutoCommitText(opt_enable?: boolean): void;
+    public enableAutoCommitText(opt_enable?: boolean|null): void;
 
     public isColumnEditable(colIndex: number): boolean;
 
     public openRowEditor(rowIndex: number, grid?: any): void;
 
-    public closeRowEditor(isCommit?: boolean): void;
+    public closeRowEditor(isCommit?: boolean|null): void;
 
-    public toggleRowEditor(rowIndex: number, isCommit?: boolean, grid?: any): void;
+    public toggleRowEditor(rowIndex: number, isCommit?: boolean|null, grid?: any): void;
 
-    public setPopupElement(elm: Element): void;
+    public setPopupElement(elm: Element|null): void;
 
     public setText(content: any): void;
 
@@ -119,13 +120,13 @@ declare class InCellEditingPlugin extends GridPlugin {
 
     public appendText(word: string): void;
 
-    public commitText(word?: string): void;
+    public commitText(word?: string|null): void;
 
     public getBalloonPopup(): Popup|null|null;
 
     public getAutoSuggest(): Element|null;
 
-    public setDisablingScroll(disabled?: boolean): boolean;
+    public setDisablingScroll(disabled?: boolean|null): boolean;
 
     public requestShowEditorPopup(): void;
 

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

@@ -55,6 +55,8 @@ declare class ColumnDefinition {
 
     public dispose(): void;
 
+    public _initializeTimeSeriesChild(columnOption?: ColumnDefinition.Options|string|null): void;
+
     public initialize(columnOption?: ColumnDefinition.Options|string|null): void;
 
     public getId(): string;
@@ -89,6 +91,8 @@ declare class ColumnDefinition {
 
     public isRealTimeField(): boolean;
 
+    public isTimeSeriesField(): boolean;
+
     public isFormulaField(): boolean;
 
     public static isFormulaField(field: string): boolean;
@@ -129,6 +133,10 @@ declare class ColumnDefinition {
 
     public setRenderer(func: ((...params: any[]) => any)|null): void;
 
+    public getParent(): ColumnDefinition|null;
+
+    public getChildren(): (ColumnDefinition)[]|null;
+
     public addRenderer(func: ((...params: any[]) => any)|null): void;
 
     public activateRenderer(id?: string|null, func?: ((...params: any[]) => any)|null): boolean;
@@ -139,6 +147,8 @@ declare class ColumnDefinition {
 
     public isRowSorting(): boolean;
 
+    public isAutoGenerated(): boolean;
+
     public setName(str: string): void;
 
     public getUserModel(): any;

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

@@ -8,12 +8,18 @@ declare namespace FieldDefinition {
 
     function get(field: string): any;
 
+    function getTimeSeriesChildren(field: string): any;
+
+    function addTimeSeriesChild(tsDef: string, childDef: any): void;
+
     function remove(field: string): void;
 
     function setSynapseConfig(config: Grid.SynapseConfig|null): void;
 
     function setFieldCaching(caching: boolean): void;
 
+    function isTimeSeriesField(field: string): boolean;
+
 }
 
 export {FieldDefinition};

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

@@ -143,6 +143,8 @@ declare class Grid extends EventDispatcher {
 
     public moveColumn(fromColIndex: number|(number)[]|null, toColIndex: number): boolean;
 
+    public moveColumnById(srcCol: number|string|null, destCol?: (number|string)|null): boolean;
+
     public hideColumn(colRef: Grid.ColumnReference|null, hidden?: boolean|null): void;
 
     public hideColumns(colRefs: (Grid.ColumnReference)[]|null, hidden?: boolean|null): void;
@@ -195,6 +197,8 @@ declare class Grid extends EventDispatcher {
 
     public setRic(rowRef: Grid.RowReference|null, str: string): void;
 
+    public unlinkChain(rowRef: Grid.RowReference|null): void;
+
     public setRowContent(rowRef: Grid.RowReference|null, str: string): void;
 
     public toggleRowExpansion(rid: string|number|null, force?: boolean|null): void;
@@ -213,6 +217,8 @@ declare class Grid extends EventDispatcher {
 
     public getColumnDefinition(colIndex: number): ColumnDefinition|null;
 
+    public getColumnDefinitions(): (ColumnDefinition)[];
+
     public getColumnDefinitionById(colId: string): ColumnDefinition|null;
 
     public getColumnDefinitionsById(colIds: (string)[]|null): ColumnDefinition|null;
@@ -221,7 +227,7 @@ declare class Grid extends EventDispatcher {
 
     public getRowDefinitions(): (RowDefinition)[];
 
-    public getAllRowDefinitions(inclAutoGenerate?: boolean|null): (RowDefinition)[];
+    public getAllRowDefinitions(inclAutoGenerated?: boolean|null): (RowDefinition)[];
 
     public getRowData(rowIndex: number): any;
 
@@ -241,10 +247,14 @@ declare class Grid extends EventDispatcher {
 
     public getColumnId(colIndex: number): string;
 
+    public getColumnIds(): (string)[];
+
     public getColumnField(colIndex: number): string;
 
     public getColumnFields(): (string)[];
 
+    public getColumnNames(): (string)[];
+
     public getAllFields(): (string)[];
 
     public freezeColumn(colIndex?: number|null, pinnedRightColumns?: number|null): void;
@@ -295,5 +305,7 @@ declare class Grid extends EventDispatcher {
 
 declare function borders(gridOptions?: any): any;
 
+declare function colCount(rowRef: number|string|null): RowDefinition|null;
+
 export { Grid };
 export default Grid;

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

@@ -91,6 +91,10 @@ declare class RowDefinition {
 
     public static deregisterFromView(rowIds: (string)[]|null, rowDef: RowDefinition|null): (string)[]|null;
 
+    public _toRealTimeRow(): void;
+
+    public unlinkChain(): void;
+
     public collapseChain(): boolean;
 
     public expandChain(): boolean;

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

@@ -1,6 +1,7 @@
 import Grid from "./Grid.js";
 import {Ext} from '../../../tr-grid-util/es6/Ext.js';
 import {EventDispatcher} from '../../../tr-grid-util/es6/EventDispatcher.js';
+import {FieldDefinition} from './FieldDefinition.js';
 
 declare class SnapshotFiller extends EventDispatcher {
 

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

@@ -5,20 +5,22 @@ import {injectCss, prettifyCss} from "../../tr-grid-util/es6/Util.js";
 declare namespace RowColoringPlugin {
 
     type Options = {
-        bgColoring?: boolean,
-        textColoring?: boolean,
-        bgColorField?: string,
-        textColorField?: string,
-        cssField?: string,
+        bgColoring?: boolean|null,
+        textColoring?: boolean|null,
+        bgColorField?: string|null,
+        textColorField?: string|null,
+        cssField?: string|null,
+        cssRangeField?: string|null,
+        altCssField?: string|null,
         predefinedColors?: any,
-        predefinedColoring?: boolean
+        predefinedColoring?: boolean|null
     };
 
 }
 
 declare class RowColoringPlugin extends GridPlugin {
 
-    constructor(options?: RowColoringPlugin.Options);
+    constructor(options?: RowColoringPlugin.Options|null);
 
     public getName(): string;
 
@@ -30,25 +32,25 @@ declare class RowColoringPlugin extends GridPlugin {
 
     public getConfigObject(gridOptions?: any): any;
 
-    public setRowColor(rowRef: string|number, bgColor?: (string|null), txtColor?: (string|null)): void;
+    public setRowColor(rowRef: string|number|null, bgColor?: (string|null)|null, txtColor?: (string|null)|null): void;
 
-    public getRowColor(rowRef: string|number): string;
+    public getRowColor(rowRef: string|number|null): string;
 
-    public removeRowColor(rowRef: string|number): void;
+    public removeRowColor(rowRef: string|number|null): void;
 
-    public toggleRowColor(rowRef: string|number, bgColor?: (string|null), txtColor?: (string|null), state?: boolean): boolean;
+    public toggleRowColor(rowRef: string|number|null, bgColor?: (string|null)|null, txtColor?: (string|null)|null, state?: boolean|null): boolean;
 
-    public setRowPredefinedColor(rowRef: string|number, color?: (string|null)): void;
+    public setRowPredefinedColor(rowRef: string|number|null, color?: (string|null)|null, range?: (number)[]|null, altColor?: (string|null)|null): void;
 
     public getPredefinedColors(): any;
 
     public setPredefinedColors(predefinedColors: any): void;
 
-    public disableTextColoring(opt_bool?: boolean): void;
+    public disableTextColoring(opt_bool?: boolean|null): void;
 
-    public disableBgColoring(opt_bool?: boolean): void;
+    public disableBgColoring(opt_bool?: boolean|null): void;
 
-    public disableRowColoring(disabled?: boolean): void;
+    public disableRowColoring(disabled?: boolean|null): void;
 
     public static getContrastColor(hexColor: string): string;