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

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

@@ -0,0 +1,332 @@
+import Ext from "../../../../tr-grid-util/es6/Ext.js";
+import DataCache from "./DataCache.js";
+import DataTable from "./DataTable.js";
+import WrappedView from "./WrappedView.js"; // eslint-disable-line
+import ColumnStats from "./ColumnStats.js";
+import Segment from "./Segment.js"; // eslint-disable-line
+import EventDispatcher from "../grid/event/EventDispatcher.js";
+import Util from "../grid/util/util.js";
+import { Conflator } from "../../../../tr-grid-util/es6/Conflator.js";
+
+declare class DataView extends EventDispatcher {
+
+    constructor(source?: DataTable|DataView|null);
+
+    public dispose(): void;
+
+    public getData(rid: string, cid: string): { [key: string]:  any };
+
+    public getRowData(rid: string): { [key: string]:  any };
+
+    public getColumnData(cid: string, inclNonDataRow?: boolean|null): any[];
+
+    public getRowId(rowIndex: number): string;
+
+    public getAllRowIds(shallowCopy?: boolean|null, inclNonDataRow?: boolean|null): (string)[];
+
+    public getVisibleRowIds(shallowCopy?: boolean|null): (string)[];
+
+    public getSortedRowIds(shallowCopy?: boolean|null): (string)[];
+
+    public getRowIndex(rid: string): number;
+
+    public getRowCount(): number;
+
+    public getDataAt(rowIndex: number, cid: string): { [key: string]:  any };
+
+    public getRowDataAt(rowIndex: number): { [key: string]:  any };
+
+    public getPreviousData(rid: string, cid: string): { [key: string]:  any };
+
+    public getMultipleRowData(rids: (string)[]|null, opt_from?: number|null, opt_to?: number|null): (any)[];
+
+    public getAllRowData(): (any)[];
+
+    public setData(rid: string, cid: string, value: any): boolean;
+
+    public setRowData(rid: string, values?: { [key: string]:  any }|null, opt_eventArg?: any): boolean;
+
+    public setColumnData(cid: string, valueList: any[]|null, opt_ridList?: (string)[]|null): void;
+
+    public setDataAt(rowIndex: number, cid: string, value: any): boolean;
+
+    public setRowDataAt(rowIndex: number, values?: { [key: string]:  any }|null, opt_eventArg?: any): boolean;
+
+    public insertRow(rowRef: string|number|null, opt_values?: { [key: string]:  any }|null, opt_rid?: string|null|null): string;
+
+    public removeRow(rowRef: number|string|null): void;
+
+    public removeRows(rowRefs: (number|string)[]|null): void;
+
+    public moveRow(fromRef: (number|string)[]|number|string|null, toRef: number|string|null): (string)[]|string|null;
+
+    public swapRow(fromIndex: number, toIndex: number): void;
+
+    public getDataTable(): DataTable|null;
+
+    public getDataSource(): DataTable|DataView|null;
+
+    public setDataSource(source?: (DataTable|DataView)|null): void;
+
+    public setConflationRate(milliSecond: number): void;
+
+    public getConflationRate(): number;
+
+    public sort(cid: string|(string)[]|null, opt_sortOrder?: string|number|(string|number)[]|null, sortLogics?: ((...params: any[]) => any)|(((...params: any[]) => any))[]|null, noOptimization?: boolean|null): void;
+
+    public sortOnce(cid: string|(string)[]|null, opt_sortOrder?: string|number|(string|number)[]|null): void;
+
+    public setSortingLogic(func: DataTable.SortLogic|null): void;
+
+    public setColumnSortingLogic(cid: string, func: DataTable.SortLogic|null): void;
+
+    public getColumnSortingLogic(cid?: string|null): DataTable.SortLogic|null;
+
+    public isSorting(): boolean;
+
+    public hideRow(rId: string|number|null, hidden?: boolean|null): void;
+
+    public hideRows(rowRefs: (string|number)[]|null, hidden?: boolean|null): void;
+
+    public showRows(rowRefs: (string|number)[]|null, shown?: boolean|null): void;
+
+    public unhideAllRows(): void;
+
+    public hasHiddenRow(): boolean;
+
+    public filterIn(cid: string|((...params: any[]) => any), value?: any, opt_filteringOut?: boolean|null): boolean;
+
+    public filterOut(cid: string|((...params: any[]) => any), value?: any): boolean;
+
+    public filterInOnce(cid: string|((...params: any[]) => any)|null, value?: any, opt_filteringOut?: boolean|null): void;
+
+    public filterOutOnce(cid: string|((...params: any[]) => any), value?: any): void;
+
+    public clearFilter(): void;
+
+    public disablePageCorrection(opt_disable?: boolean|null): void;
+
+    public setPage(pageIndex: number): boolean;
+
+    public gotoPage(): void;
+
+    public nextPage(): boolean;
+
+    public previousPage(): boolean;
+
+    public prevPage(): void;
+
+    public lastPage(): boolean;
+
+    public firstPage(): boolean;
+
+    public getCurrentPage(): number;
+
+    public getPageIndex(): void;
+
+    public isOnLastPage(): boolean;
+
+    public isOnFirstPage(): boolean;
+
+    public getPageSize(): number;
+
+    public getPageCount(): number;
+
+    public getTotalPages(): void;
+
+    public setPageSize(pageSize: number): void;
+
+    public groupBy(cid: string|((...params: any[]) => any)|(string|((...params: any[]) => any))[]|null, opt_predefinedGroups?: any[]|null): void;
+
+    public addGroup(value: any|any[]): void;
+
+    public sortGroups(compare?: ((...params: any[]) => any)|null): void;
+
+    public moveGroup(groupRef: number|string|null, destIndex: number): void;
+
+    public setPredefinedGroups(predefinedGroups: any[]|null): void;
+
+    public addFooter(opt_num?: number|null): void;
+
+    public removeFooter(): void;
+
+    public getGroupByRowId(rowId: string): DataView|null;
+
+    public getGroup(groupRef: number|string|null): DataView|null;
+
+    public getAllGroups(out_ary?: any[]|null): (DataView)[];
+
+    public getGroupList(): (string)[]|null;
+
+    public getGroupId(): string;
+
+    public getGroupValue(): any;
+
+    public getGroupRowId(): string;
+
+    public hasGroup(): boolean;
+
+    public getGroupRows(): null;
+
+    public getGroupLevel(rowRef?: (number|string)|null): number;
+
+    public enableColumnStats(cid: string, opt_enabled?: boolean|null, opt_refId?: string|null): ColumnStats|null;
+
+    public getColumnStats(cid: string): ColumnStats|null;
+
+    public hide(opt_hidden?: boolean|null): boolean;
+
+    public isHidden(): boolean;
+
+    public isHiddenRow(rowId: string): boolean;
+
+    public collapse(opt_collapsed?: boolean|null): void;
+
+    public collapseAllGroups(opt_collapsed?: boolean|null): void;
+
+    public toggleCollapsedState(): void;
+
+    public isCollapsed(): boolean;
+
+    public enableContentAsHeader(bool?: boolean|null): void;
+
+    public setDefaultCollapse(collapse?: boolean|null): void;
+
+    public getDefaultCollapse(): boolean;
+
+    public isCollapsible(): boolean;
+
+    public disableCollapsing(bool?: boolean|null): void;
+
+    public setGroupColor(groupColor: string): void;
+
+    public getGroupColor(): string;
+
+    public getVisibleRowCount(): number;
+
+    public isRowDataInGroup(rowData: any, groupID?: string|null): boolean;
+
+    public isRowIdInGroup(rowId: string, groupID?: string|null): boolean;
+
+    public addRowExpansion(rid: string, count?: number|null): void;
+
+    public removeRowExpansion(rid: string): void;
+
+    public toggleRowExpansion(rowRef: string|number|null, force?: boolean|null, count?: number|null): void;
+
+    public removeAllRowExpansions(): void;
+
+    public getExpansionParents(from?: number|null, to?: number|null): (string)[]|null;
+
+    public getExpansionParentByRowId(rid: string): string;
+
+    public isRowExpansion(rid: string): boolean;
+
+    public hasRowExpansion(rid: string): boolean;
+
+    public getRowExpansionCount(rowId: string): number;
+
+    public getRowExpansionId(rid: string, idx?: number|null): string;
+
+    public getRowExpansionIndex(rid: string): number;
+
+    public searchAll(searchLogic: ((...params: any[]) => any)|null, opt_out?: (string)[]|null): (string)[];
+
+    public searchPrev(rowRef: number|string|null, searchLogic: ((...params: any[]) => any)|null): number;
+
+    public searchNext(rowRef: number|string|null, searchLogic: ((...params: any[]) => any)|null): number;
+
+    public stall(bool?: boolean|null): boolean;
+
+    public stallSorting(bool?: boolean|null): boolean;
+
+    public enableAutoGroupRemoval(opt_bool?: boolean|null): boolean;
+
+    public enableAutoGroupHiding(opt_bool?: boolean|null): boolean;
+
+    public synchronizeRowOrder(): void;
+
+    public setSegmentSeparators(rowIds: (string)[]|null, enabled?: boolean|null): boolean;
+
+    public setSegmentSeparator(rowRef: string|number|null, options?: any): boolean;
+
+    public unsetAllSegmentSeparators(): boolean;
+
+    public hasSegmentation(): boolean;
+
+    public isSegmentSeparator(rid: string): boolean;
+
+    public getSegment(rid: string): Segment|null;
+
+    public getSegmentParent(rid: string): Segment|null;
+
+    public getSegmentLevel(rid: string): number;
+
+    public getSegmentParentRowId(rid: string): string;
+
+    public collapseSegment(rowRef: string|number|null, collapsed?: boolean|null): boolean;
+
+    public collapseSegments(rowIds: (string|number)[]|null, collapsed?: boolean|null): boolean;
+
+    public expandSegment(rowRef: string|number|null, expanded?: boolean|null): boolean;
+
+    public expandAllSegments(): boolean;
+
+    public isSegmentCollapsed(rowRef: string|number|null): boolean;
+
+    public fillSegment(segmentRef: string|number|null): void;
+
+    public fillSegments(): void;
+
+    public addSegmentChild(segmentRef: string|number|null, rowRef: string|number|null, dataId?: string|null): boolean;
+
+    public addSegmentChildren(segmentRef: string|number|null, rowRefs: (string|number)[]|null, dataIds?: (string)[]|null): boolean;
+
+    public setSegmentChildren(segmentArr: (any)[]|null): boolean;
+
+    public removeSegmentChild(segmentRef: string|number|null, rowRef: string|number|null): boolean;
+
+    public removeSegmentChildren(segmentRef: string|number|null, rowRefs: (string|number)[]|null): boolean;
+
+    public removeAllSegmentChildren(): boolean;
+
+    public getSegmentIds(): (string)[]|null;
+
+    public getSegmentChildIds(segmentRef: string|number|null): (string)[]|null;
+
+    public sortSeparators(sortLogics: ((...params: any[]) => any)|(((...params: any[]) => any))[]|any|null, sortOrders?: (number|(number)[])|null, cids?: (string|(string)[])|null): void;
+
+    public sortSegments(compare: ((...params: any[]) => any)|null): void;
+
+    public enableEmptySegmentFiltering(enabled?: boolean|null): void;
+
+    public enableSeparatorFiltering(enabled?: boolean|null): void;
+
+    public setSegmentClassification(segmentRef: string|number|null, fields: string|(string)[]|null): boolean;
+
+    public setSegmentDefaultCollapsing(bool: boolean): boolean;
+
+    public getWrapSize(): number;
+
+    public getWrappedViews(): (WrappedView)[]|null;
+
+    public wrapView(wrapSize?: number|null): void;
+
+    public dump(opt_options?: any): (any)[];
+
+    public log(opt_options?: any): void;
+
+    public isRowFiltered(rid: string, rowData: any): boolean;
+
+}
+
+declare function fromRids(fromIndex: number, toIndex: number): void;
+
+declare function criteria(value: any|any[]): void;
+
+declare function len(compare?: ((...params: any[]) => any)|null): void;
+
+declare function complexData(opt_options?: any): void;
+
+export default DataView;
+export { DataView };

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

@@ -0,0 +1,91 @@
+import Ext from "../../../../tr-grid-util/es6/Ext.js";
+import EventDispatcher from "../../../../tr-grid-util/es6/EventDispatcher.js";
+
+declare class Segment extends EventDispatcher {
+
+    constructor(rid: string, sharedObj: any);
+
+    public dispose(): void;
+
+    public getId(): string;
+
+    public getParentId(): string;
+
+    public getParent(): Segment|null;
+
+    public getSubSegmentIds(out_ary?: (string)[]|null): (string)[]|null;
+
+    public addChild(rid: string, dataId?: string|null): boolean;
+
+    public addChildren(rids: (string)[]|null, dataIds?: (string)[]|null): boolean;
+
+    public containsChild(rid: string): boolean;
+
+    public getChildIndex(rid: string): number;
+
+    public removeChild(rid: string): boolean;
+
+    public removeChildren(rids: (string)[]|null): boolean;
+
+    public removeAllChildren(): boolean;
+
+    public getChildIds(): (string)[];
+
+    public getChildren(): any;
+
+    public getChildCount(): number;
+
+    public markCollapsingStateDirty(): void;
+
+    public getClassification(): (string)[]|null;
+
+    public setClassification(fields: string|(string)[]|null): boolean;
+
+    public classify(rows?: { [key: string]:  any }|null): boolean;
+
+    public hasSubSegments(): boolean;
+
+    public isSubSegment(): boolean;
+
+    public isRootSegment(): boolean;
+
+    public getFirstAncestor(): Segment|null;
+
+    public getAllSubSegments(out_ary?: (Segment)[]|null): (Segment)[]|null;
+
+    public updateTreeStructure(counter: number, rootOrder: number, ridMap: any): number;
+
+    public getSegmentLevel(): number;
+
+    public setRowData(rows?: any, clsSource?: any): void;
+
+    public getSubSegmentName(row?: any): string;
+
+    public sortSegments(comparer: ((...params: any[]) => any)): boolean;
+
+    public getFlattenTreeIds(ary: (string)[]|null): (string)[];
+
+    public collapse(bool?: boolean|null): boolean;
+
+    public expand(bool?: boolean|null): boolean;
+
+    public isCollapsed(): boolean;
+
+    public getCollapsingStates(objMap?: any, parentState?: boolean|null): boolean;
+
+    public getOrder(): number;
+
+    public getLastOrder(): number;
+
+    public setOrder(val: number): void;
+
+    public setLastOrder(val: number): number;
+
+    public log(lines?: (string)[]|null, tabLevel?: number|null): (string)[];
+
+}
+
+declare const UNCATEGORY: string;
+
+export default Segment;
+export { Segment, UNCATEGORY };

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

@@ -0,0 +1,84 @@
+import Ext from "../../../../tr-grid-util/es6/Ext.js";
+import EventDispatcher from "../../../../tr-grid-util/es6/EventDispatcher.js";
+import { Segment, UNCATEGORY } from "./Segment.js";
+
+declare class SegmentCollection extends EventDispatcher {
+
+    constructor();
+
+    public dispose(): void;
+
+    public addSegment(rid: string, childRids?: (string)[]|null): boolean;
+
+    public addSegments(rids: (string)[]|null): boolean;
+
+    public containsSegment(rid: string): boolean;
+
+    public getParentRowId(rid: string): string;
+
+    public removeSegment(rid: string): boolean;
+
+    public removeAllSegments(): boolean;
+
+    public getSegmentCount(): number;
+
+    public getSegment(rid: string): Segment|null;
+
+    public getSegmentParent(rid: string): Segment|null;
+
+    public getSegments(): { [key: string]:  Segment }|null;
+
+    public getSegmentIds(): (string)[];
+
+    public sortSegments(comparer: ((...params: any[]) => any)): (Segment)[];
+
+    public collapseSegments(segmentIds: (string)[]|null, bool?: boolean|null): boolean;
+
+    public collapseSegment(segmentId: string, bool?: boolean|null): boolean;
+
+    public expandSegment(segmentId: string, bool?: boolean|null): boolean;
+
+    public expandAllSegments(): boolean;
+
+    public isCollapsedSegment(segmentId: string): boolean;
+
+    public getCollapsedRows(): any;
+
+    public invalidateSegmentOrder(): boolean;
+
+    public addSegmentChild(segmentId: string, rid: string, dataId?: string|null): boolean;
+
+    public addSegmentChildren(segmentId: string, rids: (string)[]|null, dataIds?: (string)[]|null): boolean;
+
+    public containsSegmentChild(segmentId: string, rid: string): boolean;
+
+    public removeSegmentChild(segmentId: string, rid: string): boolean;
+
+    public removeSegmentChildren(segmentId: string, rids: (string)[]|null): boolean;
+
+    public removeAllSegmentChildren(): boolean;
+
+    public fillSegment(segmentId: string, rids: (string)[]|null): void;
+
+    public fillSegments(rids: (string)[]|null): boolean;
+
+    public calcSegmentOrder(rids: (string)[]|null, useCache?: boolean|null): void;
+
+    public getSegmentValues(rids: (string)[], partial?: boolean|null): (number)[]|null;
+
+    public logStructure(): string;
+
+    public logRowIdMap(): string;
+
+    public setSegmentClassification(segmentId: string, fields: string|(string)[]|null): boolean;
+
+    public hasClassification(): boolean;
+
+    public classify(rows: { [key: string]:  any }|null): boolean;
+
+    public setDefaultCollapsing(bool: boolean): boolean;
+
+}
+
+export default SegmentCollection;
+export { SegmentCollection };