@refinitiv-ui/efx-grid 6.0.0-next.0

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

@@ -0,0 +1,120 @@
+import { arrayToObject } from "../../../tr-grid-util/es6/Util.js";
+import { DataCache } from "../Core/data/DataCache.js";
+import { DataTable } from "../Core/data/DataTable.js";
+
+declare namespace RowDefinition {
+
+    type Options = {
+        ric?: string,
+        values?: (any[]|any),
+        fields?: (string)[],
+        asChain?: boolean,
+        chainRic?: string,
+        collapsed?: boolean,
+        label?: (string|null)
+    };
+
+}
+
+declare class RowDefinition {
+
+    constructor(rowOptions?: RowDefinition.Options);
+
+    public dispose(): void;
+
+    public isDisposed(): boolean;
+
+    public initialize(rowOptions?: RowDefinition.Options): void;
+
+    public setContent(userInput: string): boolean;
+
+    public getRowId(): string;
+
+    public getDataId(): string;
+
+    public setDataSource(dataSource: DataCache): void;
+
+    public getRowData(): any;
+
+    public getData(field: string): any;
+
+    public setStaticRowData(data: { [key: string]:  any }|any[], opt_fields?: (string)[]): void;
+
+    public updateRowData(data: { [key: string]:  any }|any[], opt_fields?: (string)[]): void;
+
+    public setStaticData(field: string, value: any): void;
+
+    public setRowData(data: { [key: string]:  any }): void;
+
+    public setData(field: string, value: any): void;
+
+    public getUserInput(): string;
+
+    public getRic(): string;
+
+    public getDisplayText(): string;
+
+    public getLabel(): string|null;
+
+    public isRowHeader(): boolean;
+
+    public isChain(): boolean;
+
+    public static hasChain(rowDef: RowDefinition): boolean;
+
+    public isChainCollapsed(): boolean;
+
+    public isChainExpanded(): boolean;
+
+    public isAutoGenerated(): boolean;
+
+    public isRealTimeRow(): boolean;
+
+    public subscribeForUpdates(): void;
+
+    public unsubscribeForUpdates(): any;
+
+    public isSubscribing(): boolean;
+
+    public addUpdate(e: any): boolean;
+
+    public getUpdates(): { [key: string]:  number };
+
+    public resetUpdates(): void;
+
+    public registerToView(view: DataTable, rowId?: string): void;
+
+    public static deregisterFromView(rowIds: (string)[], rowDef: RowDefinition): (string)[];
+
+    public collapseChain(): boolean;
+
+    public expandChain(): boolean;
+
+    public toggleChain(): boolean;
+
+    public getChildren(): (RowDefinition)[];
+
+    public getDescendants(ary?: (RowDefinition)[]): (RowDefinition)[];
+
+    public getAllDescendantIds(): (string)[];
+
+    public getChildCount(): number;
+
+    public getParent(): RowDefinition;
+
+    public getDepthLevel(): number;
+
+    public getUserModel(): any;
+
+    public static toRowId(rowDef: RowDefinition): string;
+
+    public static dispose(rowDef: RowDefinition): void;
+
+}
+
+declare const ROW_DEF: string;
+
+declare function rowData(userInput: string): boolean;
+
+export {RowDefinition, ROW_DEF};
+export default RowDefinition;

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

@@ -0,0 +1,21 @@
+import {Ext} from '../../../tr-grid-util/es6/Ext.js';
+import {EventDispatcher} from '../../../tr-grid-util/es6/EventDispatcher.js';
+
+declare class SnapshotFiller extends EventDispatcher {
+
+    constructor();
+
+    public setRTK(rtk: any): void;
+
+    public addRic(ric: string): void;
+
+    public addField(str: string): void;
+
+    public addFields(fields: (string)[]): void;
+
+    public static isValidField(str: string): boolean;
+
+}
+
+export { SnapshotFiller };
+export default SnapshotFiller;

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

@@ -0,0 +1,17 @@
+import { injectCss, prettifyCss } from "../../../tr-grid-util/es6/Util.js";
+import { Core } from "../Core/grid/Core.js";
+
+declare class StyleLoader {
+
+    constructor();
+
+    public static readonly chainIcon: string;
+
+    public static readonly styles: string;
+
+    public static applyStyle(grid: Core): void;
+
+}
+
+export { StyleLoader };
+export default StyleLoader;

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

@@ -0,0 +1,8 @@
+/* eslint-disable */
+import {Grid} from './Grid.js';
+/* eslint-enable */
+
+
+
+export { Grid };
+export default Grid;

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

@@ -0,0 +1,60 @@
+import {Ext} from '../../tr-grid-util/es6/Ext.js';
+import {GridPlugin} from '../../tr-grid-util/es6/GridPlugin.js';
+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,
+        predefinedColors?: any,
+        predefinedColoring?: boolean
+    };
+
+}
+
+declare class RowColoringPlugin extends GridPlugin {
+
+    constructor(options?: RowColoringPlugin.Options);
+
+    public getName(): string;
+
+    public initialize(host: any, options?: any): void;
+
+    public unload(host: any): void;
+
+    public config(options?: any): void;
+
+    public getConfigObject(gridOptions?: any): any;
+
+    public setRowColor(rowRef: string|number, bgColor?: (string|null), txtColor?: (string|null)): void;
+
+    public getRowColor(rowRef: string|number): string;
+
+    public removeRowColor(rowRef: string|number): void;
+
+    public toggleRowColor(rowRef: string|number, bgColor?: (string|null), txtColor?: (string|null), state?: boolean): boolean;
+
+    public setRowPredefinedColor(rowRef: string|number, color?: (string|null)): void;
+
+    public getPredefinedColors(): any;
+
+    public setPredefinedColors(predefinedColors: any): void;
+
+    public disableTextColoring(opt_bool?: boolean): void;
+
+    public disableBgColoring(opt_bool?: boolean): void;
+
+    public disableRowColoring(disabled?: boolean): void;
+
+    public static getContrastColor(hexColor: string): string;
+
+    public getContrastColor(hexColor: string): string;
+
+}
+
+export default RowColoringPlugin;
+export { RowColoringPlugin, RowColoringPlugin as RowColoring, RowColoringPlugin as RowColoringExtension };

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

@@ -0,0 +1,53 @@
+import { Ext } from "../../tr-grid-util/es6/Ext.js";
+import { cloneObject, injectCss, prettifyCss } from "../../tr-grid-util/es6/Util.js";
+import { ElfUtil } from "../../tr-grid-util/es6/ElfUtil.js";
+import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
+import Dom from "../../tr-grid-util/es6/Dom.js";
+
+declare namespace RowDraggingPlugin {
+
+    type Options = {
+        dragBox?: boolean,
+        disabled?: boolean,
+        mouseInput?: boolean,
+        dataTransfer?: boolean,
+        autoScroll?: boolean,
+        dragBoxRenderer?: ((...params: any[]) => any),
+        dragStart?: ((...params: any[]) => any),
+        drag?: ((...params: any[]) => any),
+        dragEnd?: ((...params: any[]) => any),
+        dataMoved?: ((...params: any[]) => any)
+    };
+
+}
+
+declare class RowDraggingPlugin extends GridPlugin {
+
+    constructor(options?: RowDraggingPlugin.Options);
+
+    public beforeProcessOption(optionName: string, optionValue: any): any;
+
+    public hasMultiTableSupport(): boolean;
+
+    public getName(): string;
+
+    public initialize(host: any, options: any): void;
+
+    public unload(host: any): void;
+
+    public config(options?: any): void;
+
+    public getConfigObject(out_obj?: any): any;
+
+    public startDrag(startRef: any, opt_suppressEvent?: boolean): void;
+
+    public stopDrag(): void;
+
+    public cancelDrag(): void;
+
+    public getGuideline(): Element;
+
+}
+
+export default RowDraggingPlugin;
+export { RowDraggingPlugin, RowDraggingPlugin as RowDragging, RowDraggingPlugin as RowDraggingExtension };

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

@@ -0,0 +1,118 @@
+import {Ext} from '../../tr-grid-util/es6/Ext.js';
+import {GridPlugin} from '../../tr-grid-util/es6/GridPlugin.js';
+import {FilterBuilder} from '../../tr-grid-util/es6/FilterBuilder.js';
+import {ElfUtil} from '../../tr-grid-util/es6/ElfUtil.js';
+
+declare namespace RowFilteringPlugin {
+
+    type FilterLogic = (rowData: { [key: string]:  any }, rid: string, ctx: any) => boolean;
+
+    type Expression = any;
+
+    type FilterExpression = {
+        field: string,
+        expression: RowFilteringPlugin.Expression,
+        context: any
+    };
+
+    type ColumnOptions = {
+        filter?: RowFilteringPlugin.Expression,
+        filterState?: any
+    };
+
+    type FilterDialogOptions = {
+        sortUI?: boolean,
+        filterUI?: boolean,
+        fieldDataType?: string,
+        lang?: string,
+        rawDataAccessor?: ((...params: any[]) => any),
+        formattedDataAccessor?: ((...params: any[]) => any),
+        sortLogic?: ((...params: any[]) => any)
+    };
+
+    type Options = {
+        disabledUI?: boolean,
+        click?: ((...params: any[]) => any),
+        clicked?: ((...params: any[]) => any),
+        iconCreated?: ((...params: any[]) => any),
+        filterChanged?: ((...params: any[]) => any)
+    };
+
+}
+
+declare class RowFilteringPlugin extends GridPlugin {
+
+    constructor();
+
+    public getName(): string;
+
+    public initialize(host: any, options?: any): void;
+
+    public unload(host: any): void;
+
+    public config(options?: any): void;
+
+    public getConfigObject(gridOptions?: any): any;
+
+    public disable(opt_disabled?: boolean, opt_id?: string): void;
+
+    public addFilter(exp: RowFilteringPlugin.Expression, funcName?: string, ctx?: any): string;
+
+    public addGridFilter(exp: RowFilteringPlugin.Expression, ctx?: any): string;
+
+    public addColumnFilter(colIndex: number, exp: RowFilteringPlugin.Expression, ctx?: (any|string)): boolean;
+
+    public setColumnFilter(colIndex: number, exp: RowFilteringPlugin.Expression, ctx?: (any|string)): boolean;
+
+    public removeFilter(funcRef: ((...params: any[]) => any)|string): boolean;
+
+    public removeColumnFilters(colIndex: number): boolean;
+
+    public removeColumnFilter(colIndex: number): boolean;
+
+    public removeAllColumnFilters(): boolean;
+
+    public removeAllFilters(): void;
+
+    public setOverridingFilter(func: ((...params: any[]) => any)): void;
+
+    public setPreTransform(func: ((...params: any[]) => any)): void;
+
+    public setRowTransform(func: ((...params: any[]) => any)): void;
+
+    public getFilters(): (((...params: any[]) => any))[];
+
+    public getAllColumnFilters(): (((...params: any[]) => any))[];
+
+    public getFilterExpressions(): (RowFilteringPlugin.FilterExpression)[];
+
+    public setFilterExpressions(filterExps: (RowFilteringPlugin.FilterExpression)[]): void;
+
+    public hasColumnFilter(): boolean;
+
+    public getColumnFilterIcons(colIndex: number): (Element)[];
+
+    public updateAllColumnIcons(): void;
+
+    public addDataView(dv: any): void;
+
+    public removeDataView(dv: any): void;
+
+    public refresh(): void;
+
+    public setColumnFilterState(colIndex: number, ctx: any): boolean;
+
+    public getColumnFilterState(colIndex: number): any;
+
+    public getColumnFilterStates(): any[];
+
+    public getUniqueValues(field: string, formatter?: ((...params: any[]) => any), fmtField?: string, rawDataAccessor?: ((...params: any[]) => any), formattedDataAccessor?: ((...params: any[]) => any)): any;
+
+    public openDialog(colIndex: number, options?: RowFilteringPlugin.FilterDialogOptions): void;
+
+}
+
+declare function field(colIndex: number, exp: RowFilteringPlugin.Expression, ctx?: (any|string)): boolean;
+
+export default RowFilteringPlugin;
+export { RowFilteringPlugin, RowFilteringPlugin as RowFiltering, RowFilteringPlugin as RowFilteringExtension };

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

@@ -0,0 +1,109 @@
+import { Ext } from "../../tr-grid-util/es6/Ext.js";
+import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
+import { ExpanderIcon } from "../../tr-grid-util/es6/ExpanderIcon.js";
+import { ElfUtil } from "../../tr-grid-util/es6/ElfUtil.js";
+import { RowPainter } from "../../tr-grid-util/es6/RowPainter.js";
+
+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,
+        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)
+    };
+
+    type GroupCriteria = string|(string|((...params: any[]) => any))[];
+
+    type GroupingState = {
+        collapsed: boolean,
+        groupId?: (number|string)
+    };
+
+}
+
+declare class RowGroupingPlugin extends GridPlugin {
+
+    constructor(options?: RowGroupingPlugin.Options);
+
+    public beforeProcessOption(optionName: string, optionVal: any): any;
+
+    public getName(): string;
+
+    public initialize(host: any, options?: any): void;
+
+    public unload(host?: any): void;
+
+    public config(options?: any): void;
+
+    public getConfigObject(gridOptions?: any): any;
+
+    public getColumnMenu(colIndex: number, config: any): any;
+
+    public getGroupingCriteria(): (string)[];
+
+    public hasGroupingCriteria(): boolean;
+
+    public setGroupingCriteria(criteria: RowGroupingPlugin.GroupCriteria): void;
+
+    public groupBy(criteria: RowGroupingPlugin.GroupCriteria): void;
+
+    public getDataView(): any;
+
+    public setGroupSortingLogic(sortFunction: RowGroupingPlugin.GroupSortLogic): void;
+
+    public getGroupSortingLogic(): ((...params: any[]) => any);
+
+    public setPredefinedGroups(predefinedGroups: any[]|(any[])[]): void;
+
+    public sortGroups(): void;
+
+    public updateHeaders(): void;
+
+    public expandAll(opt_expanded?: boolean): void;
+
+    public collapseAll(opt_collapsed?: boolean): void;
+
+    public expand(groupRowId: string, opt_expanded?: boolean): void;
+
+    public collapse(groupRowId: string, opt_collapsed?: boolean): void;
+
+    public disableClicking(opt_disabled?: boolean): void;
+
+    public getGroupingStates(): (RowGroupingPlugin.GroupingState)[];
+
+    public setGroupingStates(states: (RowGroupingPlugin.GroupingState)[]|string): void;
+
+    public enableFixedDisplayColumn(opt_enabled?: boolean): void;
+
+    public enableFooterRow(opt_num?: (boolean|number)): void;
+
+}
+
+declare function isNonFunction(obj: any): boolean;
+
+export default RowGroupingPlugin;
+export { RowGroupingPlugin, RowGroupingPlugin as RowGrouping, RowGroupingPlugin as RowGroupingExtension };

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

@@ -0,0 +1,83 @@
+import { Ext } from "../../tr-grid-util/es6/Ext.js";
+import { GridPlugin, rowDefRowGetter } from "../../tr-grid-util/es6/GridPlugin.js";
+import { ExpanderIcon } from "../../tr-grid-util/es6/ExpanderIcon.js";
+import { ElfUtil } from "../../tr-grid-util/es6/ElfUtil.js";
+import { RowPainter } from "../../tr-grid-util/es6/RowPainter.js";
+
+declare namespace RowSegmentingPlugin {
+
+    type SortingLogic = (rowDataA: any, rowDataB: any) => number;
+
+    type Options = {
+        spanning?: boolean,
+        colorTag?: boolean,
+        clicked?: ((...params: any[]) => any),
+        segmentSeparatorBinding?: ((...params: any[]) => any),
+        nonSegmentSeparatorBinding?: ((...params: any[]) => any),
+        sortingLogic?: ((...params: any[]) => any)
+    };
+
+}
+
+declare class RowSegmentingPlugin extends GridPlugin {
+
+    constructor(options?: RowSegmentingPlugin.Options);
+
+    public getName(): string;
+
+    public initialize(host: any, options?: any): void;
+
+    public unload(host?: any): void;
+
+    public config(options?: any): void;
+
+    public getConfigObject(gridOptions?: any): any;
+
+    public updateHeaders(): void;
+
+    public getSegmentParentRowId(rowRef: string|number): string;
+
+    public setSegmentSeparator(rowRef: string|number, enabled?: boolean): boolean;
+
+    public unsetAllSegmentSeparators(): boolean;
+
+    public hasSegmentation(): boolean;
+
+    public isSegmentSeparator(rowRef: string|number): boolean;
+
+    public collapseSegment(rowRef: string|number, collapsed?: boolean): boolean;
+
+    public expandSegment(rowRef: string|number, expanded?: boolean): boolean;
+
+    public expandAllSegments(): boolean;
+
+    public isSegmentCollapsed(rowRef: string|number): boolean;
+
+    public setSegmentCollapsingLogic(func: ((...params: any[]) => any)): void;
+
+    public fillSegment(segmentRef: string|number): void;
+
+    public fillSegments(): void;
+
+    public addSegmentChild(segmentRef: string|number, rowRef: string|number): void;
+
+    public addSegmentChildren(segmentRef: string|number, rowRefs: (string|number)[]): void;
+
+    public removeSegmentChild(segmentRef: string|number, rowRef: string|number): void;
+
+    public removeSegmentChildren(segmentRef: string|number, rowRefs: (string|number)[]): void;
+
+    public removeAllSegmentChildren(): void;
+
+    public getSegmentIds(): (string)[];
+
+    public getSegmentChildIds(segmentRef: string|number): (string)[];
+
+    public setSortingLogic(sortFunction: RowSegmentingPlugin.SortingLogic): void;
+
+    public sortSegments(sortFunction?: RowSegmentingPlugin.SortingLogic): void;
+
+}
+
+export default RowSegmentingPlugin;
+export { RowSegmentingPlugin, RowSegmentingPlugin as RowSegmenting, RowSegmentingPlugin as RowSegmentingExtension };

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

@@ -0,0 +1,74 @@
+import { Ext } from '../../tr-grid-util/es6/Ext.js';
+import { EventDispatcher } from '../../tr-grid-util/es6/EventDispatcher.js';
+import { GridPlugin } from '../../tr-grid-util/es6/GridPlugin.js';
+import { isMac as isMacFn } from '../../tr-grid-util/es6/Util.js';
+import { isIE, prepareTSVContent } from "../../tr-grid-util/es6/Util.js";
+
+declare namespace RowSelectionPlugin {
+
+    type Options = {
+        singleSelection?: boolean,
+        selectionChanged?: ((...params: any[]) => any),
+        beforeSelection?: ((...params: any[]) => any),
+        basedOnContent?: boolean,
+        selectionField?: string
+    };
+
+}
+
+declare class RowSelectionPlugin extends GridPlugin {
+
+    constructor(options?: RowSelectionPlugin.Options);
+
+    public getName(): string;
+
+    public hasMultiTableSupport(): boolean;
+
+    public initialize(host: any, options?: any): void;
+
+    public unload(host?: any): void;
+
+    public config(options?: any): void;
+
+    public getConfigObject(gridOptions?: any): any;
+
+    public clearAllSelections(preserveAnchor?: boolean, activeGrid?: any): void;
+
+    public clearSelectedRows(preserveAnchor?: boolean, activeGrid?: any): void;
+
+    public clearSelection(preserveAnchor?: boolean, activeGrid?: any): void;
+
+    public getActiveGrid(): any;
+
+    public getRowAnchor(sectRef?: any): number;
+
+    public getFirstSelectedIndex(sectRef?: any): number|null;
+
+    public getLastSelectedIndex(sectRef?: any): number|null;
+
+    public getSelectedRows(sectRef?: any): (number)[];
+
+    public getSelectedRowIds(sectRef?: any): (string)[];
+
+    public getSelectedRowCount(sectRef?: any): number;
+
+    public setSelectedRow(rowIndex: number, opt_select?: boolean, sectRef?: any): void;
+
+    public selectSingleRow(rowIndex: number, sectRef?: any, activeGrid?: any): boolean;
+
+    public selectAllRows(activeGrid?: any): void;
+
+    public selectRowRange(rowIndex: number, length: number, sectRef?: any, opt_scrollToRow?: boolean): void;
+
+    public disable(disabled?: boolean): void;
+
+    public isEnabled(): boolean;
+
+    public disableMultiSelection(disabled?: boolean): void;
+
+    public getSelectedText(): string;
+
+}
+
+export default RowSelectionPlugin;
+export { RowSelectionPlugin, RowSelectionPlugin as RowSelection, RowSelectionPlugin as RowSelectionExtension };

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

@@ -0,0 +1,21 @@
+import FormatterBuilder from "./FormatterBuilder.js";
+
+declare namespace SimpleImageFormatter {
+
+    type Options = {
+        height?: (string|number),
+        width?: (string|number)
+    };
+
+}
+
+declare class SimpleImageFormatter {
+
+    constructor(options?: any);
+
+    public static create(options?: (FormatterBuilder.Options|SimpleImageFormatter.Options|any)): any;
+
+}
+
+export default SimpleImageFormatter;
+export { SimpleImageFormatter };