@refinitiv-ui/efx-grid 0.0.0-dev.12023565035.1

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

@@ -0,0 +1,107 @@
+import { Ext } from "../../tr-grid-util/es6/Ext.js";
+import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
+import { GroupDefinitions } from "../../tr-grid-util/es6/GroupDefinitions.js";
+import { cloneObject, injectCss, prettifyCss, deepEqual } from "../../tr-grid-util/es6/Util.js";
+
+declare namespace ColumnGroupingPlugin {
+
+    type Options = (ColumnGroupingPlugin.GroupDefinition)[]|null;
+
+    type GroupDefinitions = (ColumnGroupingPlugin.GroupDefinition)[]|null;
+
+    type GroupDefinition = {
+        id: string,
+        name: string,
+        tooltip?: (boolean|string)|null,
+        children: (string)[]|null,
+        alignment?: string|null,
+        render?: ((...params: any[]) => any)|null,
+        backgroundColor?: string|null
+    };
+
+}
+
+declare class ColumnGroupingPlugin extends GridPlugin {
+
+    constructor(options?: ColumnGroupingPlugin.Options|null);
+
+    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;
+
+    public getConfigObject(gridOptions?: any): any;
+
+    public renderGroups(): void;
+
+    public getMutualGroupId(colRefs: (string|number)[]|null): string;
+
+    public addColumnToGroup(column: any, groupId: string, colIndex: number): void;
+
+    public addGroup(groupDef: ColumnGroupingPlugin.GroupDefinition|null): string;
+
+    public addColumnGrouping(groupDef: ColumnGroupingPlugin.GroupDefinition|null): void;
+
+    public removeGroup(groupId: string): boolean;
+
+    public getGroupDefinition(groupId: string): ColumnGroupingPlugin.GroupDefinition|null;
+
+    public getGroupDefinitions(): ColumnGroupingPlugin.GroupDefinitions;
+
+    public setGroupDefinition(groupId: string, groupDef?: ColumnGroupingPlugin.GroupDefinition|null): string;
+
+    public setGroupDefinitions(groupDefs: ColumnGroupingPlugin.GroupDefinitions|null): void;
+
+    public setGroupChildren(groupId: string, newChildList: (string)[]|null): boolean;
+
+    public setGroupName(groupId: string, groupName: string): void;
+
+    public getGroupChildren(groupId: string): (string)[]|null;
+
+    public getChildColumnIndices(groupId: string): (number)[]|null;
+
+    public getGroupIds(colRef: string|number|null): (string)[]|null;
+
+    public getMaxGroupLevel(): number;
+
+    public getGroupLevel(groupId: string): number;
+
+    public getCellInfo(e: Element|Event|MouseEvent|null): any;
+
+    public moveColumnIntoGroup(colRef: number|string|null, to: number, groupId: string): void;
+
+    public setColumnParent(colRef: number|string|null, groupId: string): boolean;
+
+    public addGroupChild(parentId: string, childRef: number|string|null): boolean;
+
+    public removeGroupChild(parentId: string, childRef: number|string|null): boolean;
+
+    public unsetParent(childRef: number|string|null): boolean;
+
+    public getValidDestinationIndex(id: string, destCol: number|string|null): number;
+
+    public moveGroup(id: string, destCol?: (number|string)|null): void;
+
+    public reorderColumns(colList: (number|string)[]|null, destCol?: (number|string)|null): boolean;
+
+    public moveColumnById(srcCol: number|string|null, destCol?: (number|string)|null): boolean;
+
+    public pinGroup(groupId: string, side?: string|null): void;
+
+    public unpinGroup(groupId: string, dest?: (number|string)|null): void;
+
+    public selectGroupHeaders(colIndices: (number)[]|null): void;
+
+    public static getObjectIndex(column: any): number;
+
+    public static getObjectId(column: any): string;
+
+}
+
+export default ColumnGroupingPlugin;
+export { ColumnGroupingPlugin, ColumnGroupingPlugin as ColumnGrouping, ColumnGroupingPlugin as ColumnGroupingExtension };

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

@@ -0,0 +1,68 @@
+import {Ext} from '../../tr-grid-util/es6/Ext.js';
+import {GridPlugin} from '../../tr-grid-util/es6/GridPlugin.js';
+import {Dom} from '../../tr-grid-util/es6/Dom.js';
+import { injectCss, prettifyCss } from "../../tr-grid-util/es6/Util.js";
+
+declare namespace ColumnResizingPlugin {
+
+    type Options = {
+        preserveProportion?: boolean|null,
+        preserveGridSize?: boolean|null,
+        noResizing?: boolean|null,
+        columnResized?: ((...params: any[]) => any)|null,
+        dblClicked?: ((...params: any[]) => any)|null,
+        dragStart?: ((...params: any[]) => any)|null,
+        dragEnd?: ((...params: any[]) => any)|null
+    };
+
+    type ColumnOptions = {
+        noResizing?: boolean|null,
+        defaultWidth?: number|null
+    };
+
+}
+
+declare class ColumnResizingPlugin extends GridPlugin {
+
+    constructor(options?: ColumnResizingPlugin.Options|null);
+
+    public getName(): string;
+
+    public beforeProcessOption(optionName: string, optionVal: any): any;
+
+    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 disableResizing(colIndex: number, opt_disabled?: boolean|null): void;
+
+    public getDraggedColumnIndex(): number;
+
+    public getDraggedAnchorX(): number;
+
+    public setColumnWidths(cols: (number)[]|null, width: (number)[]|number|null, opt_scalable?: boolean|null): void;
+
+    public setAllColumnWidths(colWidth: number, scalability?: boolean|null): boolean;
+
+    public getColumnWidths(): (number)[]|null;
+
+    public resetAllColumnsToDefaultWidth(): boolean;
+
+    public getColumnSizeStates(): (any)[]|null;
+
+    public setColumnSizeStates(columns: (any)[]|string|null): void;
+
+    public enablePipeHandleMode(bool?: boolean|null): void;
+
+    public enableHandlebarMode(bool?: boolean|null): void;
+
+}
+
+export default ColumnResizingPlugin;
+export { ColumnResizingPlugin, ColumnResizingPlugin as ColumnResizing, ColumnResizingPlugin as ColumnResizingExtension };

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

@@ -0,0 +1,77 @@
+import { Ext } from "../../tr-grid-util/es6/Ext.js";
+import { Dom } from "../../tr-grid-util/es6/Dom.js";
+import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
+import { prettifyCss } from "../../tr-grid-util/es6/Util.js";
+
+declare namespace ColumnSelectionPlugin {
+
+    type Options = {
+        singleSelection?: boolean|null,
+        clickToggle?: boolean|null,
+        selectionChanged?: ((...params: any[]) => any)|null,
+        menuClicked?: ((...params: any[]) => any)|null,
+        menuPosition?: string|null
+    };
+
+    type ColumnOptions = {
+        unselectable?: boolean|null
+    };
+
+}
+
+declare class ColumnSelectionPlugin extends GridPlugin {
+
+    constructor(options?: ColumnSelectionPlugin.Options|null);
+
+    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_bool?: boolean|null): void;
+
+    public isEnabled(): boolean;
+
+    public hasSelectedColumn(): boolean;
+
+    public getSelectedColumns(): (number)[];
+
+    public getFirstSelectedColumn(): number;
+
+    public getLastSelectedColumn(): number;
+
+    public setSelectedColumn(colIndex: number, opt_select?: boolean|null, opt_grid?: any): boolean;
+
+    public selectSingleColumn(opt_colIndex?: (number|null)|null, opt_grid?: any): void;
+
+    public selectSingleGroup(groupId: string, opt_grid?: any): void;
+
+    public selectRange(anchorIndex: number, len: number, opt_grid?: any): void;
+
+    public selectAllColumns(): void;
+
+    public clearAllSelections(): void;
+
+    public clearSelectedColumns(): void;
+
+    public clearSelection(cols?: (number|(number)[])|null): void;
+
+    public selectAll(): void;
+
+    public deselectAll(): void;
+
+    public isSelectedColumn(colIndex: number): boolean;
+
+    public getActiveGrid(): any;
+
+    public dispatchSelectionChanged(): void;
+
+}
+
+export default ColumnSelectionPlugin;
+export { ColumnSelectionPlugin, ColumnSelectionPlugin as ColumnSelection, ColumnSelectionPlugin as ColumnSelectionExtension };

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

@@ -0,0 +1,160 @@
+import { Ext } from "../../tr-grid-util/es6/Ext.js";
+import { GridPlugin } from "../../tr-grid-util/es6/GridPlugin.js";
+import { Conflator } from "../../tr-grid-util/es6/Conflator.js";
+import { Icon } from "../../tr-grid-util/es6/Icon.js";
+import { ElfUtil } from "../../tr-grid-util/es6/ElfUtil.js";
+import { GroupDefinitions } from "../../tr-grid-util/es6/GroupDefinitions.js";
+import { Dom } from "../../tr-grid-util/es6/Dom.js";
+import { injectCss, prettifyCss } from "../../tr-grid-util/es6/Util.js";
+import { preventDefault } from "../../tr-grid-util/es6/EventDispatcher.js";
+
+declare namespace ColumnStackPlugin {
+
+    type Options = {
+        fields: (string)[]|null,
+        stacks: (ColumnStackPlugin.StackDefinition)[]|null,
+        autoStacking?: boolean|null,
+        clicked?: ((...params: any[]) => any)|null,
+        menuElement?: Element|null,
+        menuItemClicked?: ((...params: any[]) => any)|null
+    };
+
+    type ColumnOptions = {
+        stackId?: string|null,
+        stack?: (string|ColumnStackPlugin.StackOptions)|null
+    };
+
+    type StackOptions = {
+        id: string,
+        spreading?: boolean|null,
+        collapsed?: boolean|null
+    };
+
+    type StackDefinition = {
+        id: string,
+        spreading?: boolean|null,
+        collapsed?: boolean|null,
+        children?: (string)[]|null,
+        fields?: (string)[]|null,
+        name?: string|null,
+        activeColumn?: string|null
+    };
+
+    type StackConfiguration = {
+        spreading?: boolean|null,
+        collapsed?: boolean|null,
+        activeColumn?: string|null
+    };
+
+}
+
+declare class ColumnStackPlugin extends GridPlugin {
+
+    constructor();
+
+    public initialize(host: any, options?: any): void;
+
+    public unload(host: any): void;
+
+    public config(options?: any): void;
+
+    public getConfigObject(gridOptions?: any): any;
+
+    public getMemberIndices(colIndex: number): (number)[]|null;
+
+    public collapseGroup(colIndex: number, collapsed?: boolean|null): (number)[]|null;
+
+    public expandGroup(colIndex: number): (number)[]|null;
+
+    public isColumnStackable(colIndices: (number)[]|null): boolean;
+
+    public isColumnStacked(colIndices?: (number)[]|null): boolean;
+
+    public isInactiveStackedColumn(colIndex: number): boolean;
+
+    public isActiveStackedColumn(colIndex: number): boolean;
+
+    public isStackingMode(colIndex: number): boolean;
+
+    public isCollapsingMode(colIndex: number): boolean;
+
+    public isColumnInCollection(colIndex: number): boolean;
+
+    public isInCollection(colIndex: number): boolean;
+
+    public isColumnCollapsed(colIndex: number): boolean;
+
+    public isColumnActive(colIndex: number): boolean;
+
+    public getStackId(colRef: number|string|null): string;
+
+    public stackColumns(colRefs?: (number|string)[]|null, stackId?: string|null, options?: ColumnStackPlugin.StackConfiguration|null): boolean;
+
+    public setStack(colRefs?: (number|string)[]|null, activeColRef?: (number|string)|null): boolean;
+
+    public setStacks(stacks: (ColumnStackPlugin.StackDefinition)[]|null): void;
+
+    public getStacks(): (ColumnStackPlugin.StackDefinition)[];
+
+    public unstackColumns(colIndices?: (number)[]|null): boolean;
+
+    public removeStack(stackId: string): boolean;
+
+    public removeAllStacks(enableUpdateUI?: boolean|null): boolean;
+
+    public setActiveColumn(activeColumn: number|string|null): boolean;
+
+    public swapColumn(colRef: number|Event|null, swappingIndex: number): boolean;
+
+    public getStackMemberIndices(stackId: string): (number)[];
+
+    public getStackMemberIds(stackId: string): (string)[];
+
+    public getColumnIdsByIndex(colIndices: number|(number)[]|null): (string)[];
+
+    public getColumnIndicesByColumnIds(colIds: string|(string)[]|null): (string)[];
+
+    public getColumnIdsByFields(fields: string|(string)[]|null): (string)[];
+
+    public addColumnToStack(colRef: number|string|null, stackId: string): void;
+
+    public removeColumnFromStack(colRef: number|string|null): void;
+
+    public reorderStackColumns(colRefs: (number|string)[]|null, stackId: string): void;
+
+    public setStackName(stackId: string, name: string): void;
+
+    public getStackName(stackId: string): string;
+
+    public getActiveColumnId(stackId: string): string;
+
+    public getActiveColumnField(stackId: string): string;
+
+    public getActiveColumnIndex(stackId: string): number;
+
+    public addStackChild(stackId: string, colRef: number|string|null): void;
+
+    public removeStackChild(stackId: string, colRef: number|string|null): void;
+
+    public unsetParent(colRef: number|string|null): void;
+
+    public reorderColumns(colList: (number|string)[]|null, destCol?: (number|string)|null): boolean;
+
+    public moveColumnById(srcCol: number|string|null, destCol?: (number|string)|null): boolean;
+
+    public hideStack(stackId: string, hidden?: boolean|null): void;
+
+    public showStack(stackId: string): void;
+
+    public isStackHidden(stackId: string): boolean|null|null;
+
+    public moveStack(stackId: string, destCol?: (number|string)|null): boolean;
+
+    public pinStack(stackId: string, side?: string|null): void;
+
+    public unpinStack(stackId: string, dest?: (number|string)|null): void;
+
+}
+
+export default ColumnStackPlugin;
+export { ColumnStackPlugin, ColumnStackPlugin as ColumnStack, ColumnStackPlugin as ColumnStackExtension };

package/lib/types/es6/CompositeGrid/CollapsibleHeaderPlugin.d.ts

@@ -0,0 +1,11 @@
+import Ext from "../../../tr-grid-util/es6/Ext.js";
+import TreeIndentingPlugin from "./TreeIndentingPlugin.js";
+
+declare class CollapsibleHeaderPlugin extends TreeIndentingPlugin {
+
+    constructor(opt_collapsibleColumn?: number);
+
+}
+
+export default CollapsibleHeaderPlugin;
+export { CollapsibleHeaderPlugin };

package/lib/types/es6/CompositeGrid/ColumnSelectionPlugin.d.ts

@@ -0,0 +1,41 @@
+import Ext from "../../../tr-grid-util/es6/Ext.js";
+import { isMac } from "../../../tr-grid-util/es6/Util.js";
+import { preventDefault } from "../../../tr-grid-util/es6/EventDispatcher.js";
+
+import Plugin from "./Plugin.js";
+import { ILayoutGrid, Core } from "../Core/index.js";
+
+declare class ColumnSelectionPlugin extends Plugin {
+
+    constructor(opt_restrictions?: (number|boolean)[]|null, opt_exclusions?: (number|boolean)[]|null);
+
+    public disable(opt_bool?: boolean): void;
+
+    public isEnabled(): boolean;
+
+    public clearSelection(opt_cols?: (number)[]): void;
+
+    public getSelectedColumns(): (number)[];
+
+    public getFirstSelectedColumn(): number;
+
+    public getLastSelectedColumn(): number;
+
+    public setSelectedColumn(colIndex: number, opt_select: boolean, opt_grid?: Core): boolean;
+
+    public selectSingleColumn(opt_colIndex?: number|null, opt_grid?: Core): void;
+
+    public selectRange(anchorIndex: number, len: number, opt_grid?: Core): void;
+
+    public selectAllColumns(): void;
+
+    public isSelectedColumn(colIndex: number): boolean;
+
+    public getActiveGrid(): Core|null;
+
+    public enableSingleSelectionMode(bool?: boolean): void;
+
+}
+
+export default ColumnSelectionPlugin;
+export { ColumnSelectionPlugin };

package/lib/types/es6/CompositeGrid/ColumnWidthAdjustingPlugin.d.ts

@@ -0,0 +1,45 @@
+import Ext from "../../../tr-grid-util/es6/Ext.js";
+import Plugin from "./Plugin.js";
+import { Conflator } from "../Core/index.js";
+import TextWidthCalculator from "./TextWidthCalculator.js"
+
+declare class ColumnWidthAdjustingPlugin extends Plugin {
+
+    constructor(opt_restrictions?: (number|boolean)[]|null, opt_exclusions?: (number|boolean)[]|null, opt_autoAdjust?: boolean);
+
+    public getMarker(): null;
+
+    public setMaxWidth(maxWidth: number): void;
+
+    public getMaxWidth(): number;
+
+    public setMaxCharacters(maxCharacters: number): void;
+
+    public getMaxCharacters(): number;
+
+    public setOffsetWidth(offsetWidth: number): void;
+
+    public getOffsetWidth(): number;
+
+    public getAdjustedColumnWidth(colIndex: number): number;
+
+    public setCharacterThreshold(value: number): void;
+
+    public update(opt_e?: any): boolean;
+
+    public setProportionalScaling(bool: boolean): void;
+
+    public getProportionalScaling(): boolean;
+
+    public setMinimumColumnWidth(colIndex: number, px: number): void;
+
+    public excludeNonContentSections(opt_excluded?: boolean): void;
+
+    public disableAutoAdjusting(opt_disabled?: boolean): void;
+
+}
+
+declare function to(): void;
+
+export default ColumnWidthAdjustingPlugin;
+export { ColumnWidthAdjustingPlugin };