@refinitiv-ui/efx-grid 6.0.4 → 6.0.6

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

@@ -1,6 +1,6 @@
 import Ext from "../../../tr-grid-util/es6/Ext.js";
 import ElementWrapper from "./components/ElementWrapper.js";
-import ILayoutGrid from "./ILayoutGrid.js";
+import ILayoutGrid from "./ILayoutGrid.js"; // eslint-disable-line
 import LayoutGrid from "./LayoutGrid.js";
 import DataTable from "../data/DataTable.js";
 import DataView from "../data/DataView.js";
@@ -15,7 +15,7 @@ import VirtualizedLayoutGrid from "./VirtualizedLayoutGrid.js";
 
 declare namespace Core {
 
-    type SectionReference = number|string|ILayoutGrid|SectionSettings;
+    type SectionReference = number|string|ILayoutGrid|SectionSettings|null;
 
     type MouseInfo = {
         hit: boolean,
@@ -25,38 +25,38 @@ declare namespace Core {
         sectionIndex: number,
         rowIndex: number,
         sectionType: string,
-        sectionSettings: SectionSettings,
-        section: ILayoutGrid,
-        cellElement: Element,
-        dataSource: DataView
+        sectionSettings: SectionSettings|null,
+        section: ILayoutGrid|null,
+        cellElement: Element|null,
+        dataSource: DataView|null
     };
 
-    type CellReference = Core.MouseInfo|ElementWrapper|Element;
+    type CellReference = Core.MouseInfo|ElementWrapper|Element|null;
 
     type ColumnOptions = {
-        width?: number,
-        minWidth?: number,
-        minSize?: number,
-        size?: number,
-        visible?: boolean,
-        scalable?: boolean,
-        styles?: { [key: string]:  string },
-        classes?: { [key: string]:  string },
-        dataColumnName?: string,
-        renderingHandler?: ((...params: any[]) => any),
-        dataBindingHandler?: ((...params: any[]) => any),
-        columnData?: string,
-        stationary?: boolean,
-        leftPinned?: boolean,
-        rightPinned?: boolean,
-        layout?: TrackLayout
+        width?: number|null,
+        minWidth?: number|null,
+        minSize?: number|null,
+        size?: number|null,
+        visible?: boolean|null,
+        scalable?: boolean|null,
+        styles?: { [key: string]:  string }|null,
+        classes?: { [key: string]:  string }|null,
+        dataColumnName?: string|null,
+        renderingHandler?: ((...params: any[]) => any)|null,
+        dataBindingHandler?: ((...params: any[]) => any)|null,
+        columnData?: string|null,
+        stationary?: boolean|null,
+        leftPinned?: boolean|null,
+        rightPinned?: boolean|null,
+        layout?: TrackLayout|null
     };
 
 }
 
 declare class Core extends ElementWrapper {
 
-    constructor(opt_initializer?: Element);
+    constructor(opt_initializer?: Element|null);
 
     public static getVersion(): string;
 
@@ -68,11 +68,11 @@ declare class Core extends ElementWrapper {
 
     public getSectionCount(): number;
 
-    public addSection(opt_type?: string, opt_sectionName?: string): ILayoutGrid|null|null;
+    public addSection(opt_type?: string|null, opt_sectionName?: string|null): ILayoutGrid|null|null;
 
-    public addSectionAt(at: number, opt_type?: string, opt_sectionName?: string): ILayoutGrid|null|null;
+    public addSectionAt(at: number, opt_type?: string|null, opt_sectionName?: string|null): ILayoutGrid|null|null;
 
-    public removeSection(sectionRef: Core.SectionReference): ILayoutGrid|null;
+    public removeSection(sectionRef: Core.SectionReference|null): ILayoutGrid|null;
 
     public removeSectionAt(at: number): ILayoutGrid|null;
 
@@ -80,45 +80,45 @@ declare class Core extends ElementWrapper {
 
     public removeAllSections(): void;
 
-    public setBottomPaddingSection(paddingSize: boolean|number): void;
+    public setBottomPaddingSection(paddingSize: boolean|number|null): void;
 
-    public getSection(sectionRef: Core.SectionReference): ILayoutGrid|null;
+    public getSection(sectionRef: Core.SectionReference|null): ILayoutGrid|null;
 
-    public getSectionSettings(sectionRef: Core.SectionReference): SectionSettings|null;
+    public getSectionSettings(sectionRef: Core.SectionReference|null): SectionSettings|null;
 
-    public getAllSections(opt_type?: string): (ILayoutGrid)[];
+    public getAllSections(opt_type?: string|null): (ILayoutGrid)[];
 
-    public getAllSectionSettings(opt_type?: string): (SectionSettings)[];
+    public getAllSectionSettings(opt_type?: string|null): (SectionSettings)[];
 
-    public getSectionIndex(identifier?: (MouseEvent|Core.SectionReference)): number;
+    public getSectionIndex(identifier?: (MouseEvent|Core.SectionReference)|null): number;
 
-    public getSectionTop(sectionRef: Core.SectionReference): number;
+    public getSectionTop(sectionRef: Core.SectionReference|null): number;
 
-    public getPreviousSection(identifier?: (MouseEvent|Core.SectionReference), opt_type?: string): ILayoutGrid|null;
+    public getPreviousSection(identifier?: (MouseEvent|Core.SectionReference)|null, opt_type?: string|null): ILayoutGrid|null;
 
-    public getNextSection(identifier?: (MouseEvent|Core.SectionReference), opt_type?: string): ILayoutGrid|null;
+    public getNextSection(identifier?: (MouseEvent|Core.SectionReference)|null, opt_type?: string|null): ILayoutGrid|null;
 
     public getLastSection(): ILayoutGrid|null;
 
-    public getCell(sectionRef: Core.SectionReference, colIndex: number, rowIndex: number, opt_includeSpan?: boolean): ElementWrapper|null;
+    public getCell(sectionRef: Core.SectionReference|null, colIndex: number, rowIndex: number, opt_includeSpan?: boolean|null): ElementWrapper|null;
 
-    public getCellInfo(cellRef: Core.CellReference): Core.MouseInfo|null;
+    public getCellInfo(cellRef: Core.CellReference|null): Core.MouseInfo|null;
 
-    public getNextCellInRow(cellRef: Core.CellReference, step?: number): Core.MouseInfo|null;
+    public getNextCellInRow(cellRef: Core.CellReference|null, step?: number|null): Core.MouseInfo|null;
 
-    public getPrevCellInRow(cellRef: Core.CellReference, step?: number): Core.MouseInfo|null;
+    public getPrevCellInRow(cellRef: Core.CellReference|null, step?: number|null): Core.MouseInfo|null;
 
-    public getNextCell(cellRef: Core.CellReference): Core.MouseInfo|null;
+    public getNextCell(cellRef: Core.CellReference|null): Core.MouseInfo|null;
 
-    public getPrevCell(cellRef: Core.CellReference): Core.MouseInfo|null;
+    public getPrevCell(cellRef: Core.CellReference|null): Core.MouseInfo|null;
 
     public getColumnCount(): number;
 
     public setColumnCount(num: number): void;
 
-    public insertColumn(index: number, jsonObj?: Core.ColumnOptions): void;
+    public insertColumn(index: number, jsonObj?: Core.ColumnOptions|null): void;
 
-    public insertColumns(at: number, cols?: (number|Core.ColumnOptions|(Core.ColumnOptions)[])): void;
+    public insertColumns(at: number, cols?: (number|Core.ColumnOptions|(Core.ColumnOptions)[])|null): void;
 
     public removeColumnAt(index: number): any;
 
@@ -126,17 +126,19 @@ declare class Core extends ElementWrapper {
 
     public getStationaryColumnIndex(): number;
 
-    public isColumnMoveAllowed(fromColIndex: number|(number)[], toColIndex: number): boolean;
+    public isColumnMoveAllowed(fromColIndex: number|(number)[]|null, toColIndex: number): boolean;
 
-    public moveColumn(fromCol: number, destCol: number): boolean;
+    public isColumnMovable(colIndex: number): boolean;
 
-    public addRow(opt_num?: number): void;
+    public moveColumn(fromCol: number|(number)[]|null, destCol: number): boolean;
 
-    public removeRow(opt_num?: number): void;
+    public addRow(opt_num?: number|null): void;
+
+    public removeRow(opt_num?: number|null): void;
 
     public getRowCount(): number;
 
-    public setSectionRowCount(sectionRef: Core.SectionReference, num: number): void;
+    public setSectionRowCount(sectionRef: Core.SectionReference|null, num: number): void;
 
     public getRowIndex(sectionIndex: number, rowIndex: number): number;
 
@@ -144,7 +146,7 @@ declare class Core extends ElementWrapper {
 
     public getDefaultRowHeight(): number;
 
-    public setDefaultRowHeight(val: number, opt_includeTitle?: boolean): void;
+    public setDefaultRowHeight(val: number, opt_includeTitle?: boolean|null): void;
 
     public getDataSource(): DataView|null;
 
@@ -152,19 +154,19 @@ declare class Core extends ElementWrapper {
 
     public getDataConflationRate(): number;
 
-    public setDataSource(dataSource: DataTable|DataView): DataView|null;
+    public setDataSource(dataSource: DataTable|DataView|null): DataView|null;
 
     public getColumnRenderEvent(): void;
 
     public getColumnDataBindingEvent(c: number): any;
 
-    public setColumnStyle(colIndex: number, style: string, value: string, opt_type?: string): void;
+    public setColumnStyle(colIndex: number, style: string, value: string, opt_type?: string|null): void;
 
-    public enableColumnClass(colIndex: number, clsName: string, enabled?: boolean, opt_type?: string): boolean;
+    public enableColumnClass(colIndex: number, clsName: string, enabled?: boolean|null, opt_type?: string|null): boolean;
 
-    public hasColumnClass(colIndex: number, clsName: string, opt_type?: string): boolean;
+    public hasColumnClass(colIndex: number, clsName: string, opt_type?: string|null): boolean;
 
-    public setColumnAlignment(colIndex: number, alignment?: string): void;
+    public setColumnAlignment(colIndex: number, alignment?: string|null): void;
 
     public getColumnAlignment(colIndex: number): string;
 
@@ -176,15 +178,15 @@ declare class Core extends ElementWrapper {
 
     public getColumnCustomLaneSize(colIndex: number): number;
 
-    public setColumnWidth(colIndex: number, px: number, opt_scalable?: boolean): boolean;
+    public setColumnWidth(colIndex: number, px: number, opt_scalable?: boolean|null): boolean;
 
-    public setColumnWidths(columnWidths: (number)[], opt_proportion?: (boolean|(boolean)[])): boolean;
+    public setColumnWidths(columnWidths: (number)[]|null, opt_proportion?: (boolean|(boolean)[])|null): boolean;
 
     public isColumnVisible(colIndex: number): boolean;
 
-    public hideColumn(colIndex: number, hidden?: boolean): void;
+    public hideColumn(colIndex: number, hidden?: boolean|null): void;
 
-    public hideColumns(colIndices: (number)[], hidden?: boolean): void;
+    public hideColumns(colIndices: (number)[]|null, hidden?: boolean|null): void;
 
     public showAllColumns(): void;
 
@@ -192,11 +194,11 @@ declare class Core extends ElementWrapper {
 
     public setMinimumColumnWidth(colIndex: number, width: number): void;
 
-    public setMinimumColumnWidths(minWidths: (number|null)[], proportion?: boolean): boolean;
+    public setMinimumColumnWidths(minWidths: (number|null)[]|null, proportion?: boolean|null): boolean;
 
     public getColumnScalability(colIndex: number): boolean;
 
-    public setColumnScalability(val: number|boolean, opt_scalable?: boolean): boolean;
+    public setColumnScalability(val: number|boolean|null, opt_scalable?: boolean|null): boolean;
 
     public setDefaultColumnScalable(scalable: boolean): void;
 
@@ -216,7 +218,7 @@ declare class Core extends ElementWrapper {
 
     public newColumnData(colIndex: number): any;
 
-    public setAlwaysRenderColumn(colIndex: number, alwaysRender?: boolean): void;
+    public setAlwaysRenderColumn(colIndex: number, alwaysRender?: boolean|null): void;
 
     public getFitContentWidth(): boolean;
 
@@ -232,13 +234,13 @@ declare class Core extends ElementWrapper {
 
     public getPluginList(): (string)[];
 
-    public freezeSection(opt_frozenSection?: (string|number|null)): void;
+    public freezeSection(opt_frozenSection?: (string|number|null)|null): void;
 
     public freezeFooter(frozenCount: number): void;
 
     public getFooterCount(): number;
 
-    public freezeColumn(frozenColIndex?: (number|null), numRightColumn?: number): void;
+    public freezeColumn(frozenColIndex?: (number|null)|null, numRightColumn?: number|null): void;
 
     public isPinnedColumn(colIndex: number): boolean;
 
@@ -254,35 +256,33 @@ declare class Core extends ElementWrapper {
 
     public updateScrollbars(updateHeight: boolean, updateWidth: boolean): void;
 
-    public freezeLayout(opt_bool?: boolean): boolean;
+    public freezeLayout(opt_bool?: boolean|null): boolean;
 
-    public unfreezeLayout(opt_bool?: boolean): void;
+    public unfreezeLayout(opt_bool?: boolean|null): void;
 
     public isLayoutFrozen(): boolean;
 
-    public showBorders(opt_shown?: boolean): void;
-
-    public hideBorders(opt_hidden?: boolean): void;
+    public toggleBorders(forcedVal?: boolean|null): void;
 
-    public toggleBorders(forcedVal?: boolean): void;
+    public toggleGridlines(forcedVal?: boolean|null): void;
 
-    public toggleGridlines(forcedVal?: boolean): void;
+    public toggleVerticalLines(forcedVal?: boolean|null): void;
 
-    public toggleVerticalLines(forcedVal?: boolean): void;
+    public toggleHorizontalLines(forcedVal?: boolean|null): void;
 
-    public toggleHorizontalLines(forcedVal?: boolean): void;
+    public toggleContentVerticalLines(forcedVal?: boolean|null): void;
 
     public getDataColumnMap(): (string)[]|null;
 
-    public setDataColumnMap(opt_dataMap?: (string)[]): void;
+    public setDataColumnMap(opt_dataMap?: (string)[]|null): void;
 
     public getDataColumnName(colIndex: number): string;
 
-    public setDataColumnName(colIndex: number, opt_dataColumnName?: (string|null)): void;
+    public setDataColumnName(colIndex: number, opt_dataColumnName?: (string|null)|null): void;
 
-    public setDefaultRenderingHandler(handler: ((...params: any[]) => any)): void;
+    public setDefaultRenderingHandler(handler: ((...params: any[]) => any)|null): void;
 
-    public setDefaultDataBindingHandler(handler: ((...params: any[]) => any)): void;
+    public setDefaultDataBindingHandler(handler: ((...params: any[]) => any)|null): void;
 
     public setColumnRenderingHandler(c: number, func: any): void;
 
@@ -292,7 +292,7 @@ declare class Core extends ElementWrapper {
 
     public getColumnDataBindingHandler(c: number): ((...params: any[]) => any)|null;
 
-    public enableRowHighlighting(opt_enabled?: boolean): void;
+    public enableRowHighlighting(opt_enabled?: boolean|null): void;
 
     public getRelativePosition(obj: ElementWrapper|Element|Event|MouseEvent, context?: any): Core.MouseInfo;
 
@@ -302,9 +302,9 @@ declare class Core extends ElementWrapper {
 
     public getHScrollbar(): ElementWrapper;
 
-    public autoHideScrollbars(opt_hide?: boolean): void;
+    public autoHideScrollbars(opt_hide?: boolean|null): void;
 
-    public scrollToColumn(colIndex: number, leftOfView?: boolean): boolean;
+    public scrollToColumn(colIndex: number, leftOfView?: boolean|null): boolean;
 
     public getScrollLeft(): number;
 
@@ -314,9 +314,9 @@ declare class Core extends ElementWrapper {
 
     public getScrollWidth(): number;
 
-    public getYScrollVal(sectionRef: Core.SectionReference, rowIndex: number, topOfView?: boolean): number|null|null;
+    public getYScrollVal(sectionRef: Core.SectionReference|null, rowIndex: number, topOfView?: boolean|null): number|null|null;
 
-    public scrollToRow(sectionRef: Core.SectionReference, rowIndex: number, topOfView?: boolean): void;
+    public scrollToRow(sectionRef: Core.SectionReference|null, rowIndex: number, topOfView?: boolean|null): void;
 
     public getVScrollView(): any;
 
@@ -328,21 +328,23 @@ declare class Core extends ElementWrapper {
 
     public getScrollHeight(): number;
 
+    public restoreScrollbars(): void;
+
     public getRowVirtualizer(): Virtualizer;
 
     public getColumnVirtualizer(): Virtualizer;
 
     public enableRowVirtualization(opt_enabled: boolean): void;
 
-    public enableColumnVirtualization(opt_enabled?: boolean): void;
+    public enableColumnVirtualization(opt_enabled?: boolean|null): void;
 
     public setRowScrollingStep(rowCount: number): void;
 
     public getVMouseWheelHandler(): ((...params: any[]) => any)|null;
 
-    public synchronizeVScrollbar(subGrid: Core): void;
+    public synchronizeVScrollbar(subGrid: Core|null): void;
 
-    public updateRowData(sectionRef?: Core.SectionReference, fromRowIndex?: number, lastRowIndex?: number, userParam?: any): void;
+    public updateRowData(sectionRef?: Core.SectionReference|null, fromRowIndex?: number|null, lastRowIndex?: number|null, userParam?: any): void;
 
     public rerender(): void;
 
@@ -350,7 +352,7 @@ declare class Core extends ElementWrapper {
 
     public _requestScrollbarUpdate(): void;
 
-    public deactivateRendering(disabled?: boolean): void;
+    public deactivateRendering(disabled?: boolean|null): void;
 
     public reserveRightSpace(size: number): boolean;
 
@@ -360,17 +362,17 @@ declare class Core extends ElementWrapper {
 
     public isBinding(): boolean;
 
-    public hideRow(rowId: number | string, hidden?: boolean): void;
+    public hideRow(rowId: number | string|null, hidden?: boolean|null): void;
 
-    public hideRows(rowIds: number | string | (number | string)[], hidden?: boolean): void;
+    public hideRows(rowIds: number | string | (number | string)[]|null, hidden?: boolean|null): void;
 
-    public showRows(rowIds: number | string | (number | string)[], shown?: boolean): void;
+    public showRows(rowIds: number | string | (number | string)[]|null, shown?: boolean|null): void;
 
     public unhideAllRows(): void;
 
     public hasHiddenRow(): boolean;
 
-    public selectColumn(colIndex: number, selected?: boolean): void;
+    public selectColumn(colIndex: number, selected?: boolean|null): void;
 
     public isSelectedColumn(colIndex: number): boolean;
 
@@ -382,15 +384,15 @@ declare class Core extends ElementWrapper {
 
 }
 
-declare function num(opt_type?: string): (ILayoutGrid)[];
+declare function num(opt_type?: string|null): (ILayoutGrid)[];
 
-declare function mPos(sectionRef: Core.SectionReference): number;
+declare function mPos(sectionRef: Core.SectionReference|null): number;
 
-declare function rowIndex(cellRef: Core.CellReference, step?: number): Core.MouseInfo|null;
+declare function rowIndex(cellRef: Core.CellReference|null, step?: number|null): Core.MouseInfo|null;
 
-declare function rowIndex(cellRef: Core.CellReference): Core.MouseInfo|null;
+declare function rowIndex(cellRef: Core.CellReference|null): Core.MouseInfo|null;
 
-declare function section(cellRef: Core.CellReference): Core.MouseInfo|null;
+declare function section(cellRef: Core.CellReference|null): Core.MouseInfo|null;
 
 declare function section(): number;