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

package/lib/core/es6/data/DataView.d.ts

@@ -0,0 +1,280 @@
+import Ext from "../../../tr-grid-util/es6/Ext.js";
+import DataCache from "./DataCache.js";
+import DataTable from "./DataTable.js";
+import ColumnStats from "./ColumnStats.js";
+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);
+
+    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): any[];
+
+    public getRowId(rowIndex: number): string;
+
+    public getAllRowIds(shallowCopy?: boolean, inclNonDataRow?: boolean): (string)[];
+
+    public getSortedRowIds(opt_shallowCopy?: boolean): (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)[], opt_from?: number, opt_to?: number): (any)[];
+
+    public getAllRowData(): (any)[];
+
+    public setData(rid: string, cid: string, value: any): boolean;
+
+    public setRowData(rid: string, values?: { [key: string]:  any }, opt_eventArg?: any): boolean;
+
+    public setColumnData(cid: string, valueList: any[], opt_ridList?: (string)[]): void;
+
+    public setDataAt(rowIndex: number, cid: string, value: any): boolean;
+
+    public setRowDataAt(rowIndex: number, values?: { [key: string]:  any }, opt_eventArg?: any): boolean;
+
+    public insertRow(rowRef: string|number, opt_values?: { [key: string]:  any }, opt_rid?: string|null): string;
+
+    public removeRow(rowRef: number|string): void;
+
+    public removeRows(refs: (number|string)[]): void;
+
+    public moveRow(fromIndex: (number)[]|number, toIndex: number): (string)[]|string;
+
+    public swapRow(fromIndex: number, toIndex: number): void;
+
+    public getDataTable(): DataTable;
+
+    public getDataSource(): DataTable|DataView;
+
+    public setDataSource(source?: DataTable|DataView): void;
+
+    public setConflationRate(milliSecond: number): void;
+
+    public getConflationRate(): number;
+
+    public sort(cid: string|(string)[], opt_sortOrder?: string|number|(string|number)[], sortLogics?: ((...params: any[]) => any)|(((...params: any[]) => any))[], noOptimization?: boolean): void;
+
+    public sortOnce(cid: string|(string)[], opt_sortOrder?: string|number|(string|number)[]): void;
+
+    public setSortingLogic(func: DataTable.SortLogic): void;
+
+    public setColumnSortingLogic(cid: string, func: DataTable.SortLogic): void;
+
+    public isSorting(): boolean;
+
+    public hideRow(rId: string|number, opt_show?: boolean): void;
+
+    public hideRows(rowRefs: (string|number)[], opt_show?: boolean): void;
+
+    public showRows(rowRefs: (string|number)[], opt_show?: boolean): void;
+
+    public unhideAllRows(): void;
+
+    public hasHiddenRow(): boolean;
+
+    public filterIn(cid: string|((...params: any[]) => any), value?: any, opt_filteringOut?: boolean): boolean;
+
+    public filterOut(cid: string|((...params: any[]) => any), value?: any): boolean;
+
+    public filterInOnce(cid: string|((...params: any[]) => any), value?: any, opt_filteringOut?: boolean): void;
+
+    public filterOutOnce(cid: string|((...params: any[]) => any), value?: any): void;
+
+    public clearFilter(): void;
+
+    public disablePageCorrection(opt_disable?: boolean): 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))[], opt_predefinedGroups?: any[]): void;
+
+    public addGroup(value: any|any[]): void;
+
+    public sortGroups(compare?: ((...params: any[]) => any)): void;
+
+    public moveGroup(groupRef: number|string, destIndex: number): void;
+
+    public setPredefinedGroups(predefinedGroups: any[]): void;
+
+    public addFooter(opt_num?: number): void;
+
+    public removeFooter(): void;
+
+    public getGroupByRowId(rowId: string): DataView;
+
+    public getGroup(groupRef: number|string): DataView;
+
+    public getAllGroups(out_ary?: any[]): (DataView)[];
+
+    public getGroupList(): (string)[];
+
+    public getGroupId(): string;
+
+    public getGroupValue(): any;
+
+    public getGroupRowId(): string;
+
+    public hasGroup(): boolean;
+
+    public getGroupRows(): null;
+
+    public getGroupLevel(rowRef?: (number|string)): number;
+
+    public enableColumnStats(cid: string, opt_enabled?: boolean, opt_refId?: string): ColumnStats;
+
+    public getColumnStats(cid: string): ColumnStats;
+
+    public hide(opt_hidden?: boolean): boolean;
+
+    public isHidden(): boolean;
+
+    public collapse(opt_collapsed?: boolean): void;
+
+    public collapseAllGroups(opt_collapsed?: boolean): void;
+
+    public toggleCollapsedState(): void;
+
+    public isCollapsed(): boolean;
+
+    public enableContentAsHeader(bool?: boolean): void;
+
+    public getVisibleRowIds(opt_shallowCopy?: boolean): (string)[];
+
+    public getVisibleRowCount(): number;
+
+    public isRowDataInGroup(rowData: any, groupID?: string): boolean;
+
+    public isRowIdInGroup(rowId: string, groupID?: string): boolean;
+
+    public addRowExpansion(rid: string, count?: number): void;
+
+    public removeRowExpansion(rid: string): void;
+
+    public toggleRowExpansion(rowRef: string|number, force?: boolean, count?: number): void;
+
+    public removeAllRowExpansions(): void;
+
+    public getExpansionParents(from?: number, to?: number): (string)[];
+
+    public isRowExpansion(rid: string): boolean;
+
+    public hasRowExpansion(rid: string): boolean;
+
+    public getRowExpansionId(rid: string, idx?: number): string;
+
+    public getRowExpansionIndex(rid: string): number;
+
+    public searchAll(searchLogic: ((...params: any[]) => any), opt_out?: (string)[]): (string)[];
+
+    public searchPrev(rowRef: number|string, searchLogic: ((...params: any[]) => any)): number;
+
+    public searchNext(rowRef: number|string, searchLogic: ((...params: any[]) => any)): number;
+
+    public stall(opt_bool?: boolean): boolean;
+
+    public enableAutoGroupRemoval(opt_bool?: boolean): boolean;
+
+    public enableAutoGroupHiding(opt_bool?: boolean): boolean;
+
+    public synchronizeRowOrder(): void;
+
+    public setSegmentSeparator(rowRef: string|number, enabled?: boolean): boolean;
+
+    public unsetAllSegmentSeparators(): boolean;
+
+    public hasSegmentation(): boolean;
+
+    public isSegmentSeparator(rid: string): boolean;
+
+    public getSegmentParentRowId(rid: string): string;
+
+    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 fillSegment(segmentRef: string|number): void;
+
+    public fillSegments(): void;
+
+    public addSegmentChild(segmentRef: string|number, rowRef: string|number): boolean;
+
+    public addSegmentChildren(segmentRef: string|number, rowRefs: (string|number)[]): boolean;
+
+    public removeSegmentChild(segmentRef: string|number, rowRef: string|number): boolean;
+
+    public removeSegmentChildren(segmentRef: string|number, rowRefs: (string|number)[]): boolean;
+
+    public removeAllSegmentChildren(): boolean;
+
+    public getSegmentIds(): (string)[];
+
+    public getSegmentChildIds(segmentRef: string|number): (string)[];
+
+    public sortSegments(compare: ((...params: any[]) => any)): void;
+
+    public dump(opt_options?: any): (any)[];
+
+    public log(opt_options?: any): void;
+
+    public isRowFiltered(rid: string, rowData: any): boolean;
+
+}
+
+declare function len(fromIndex: number, toIndex: number): void;
+
+declare function criteria(value: any|any[]): void;
+
+declare function len(compare?: ((...params: any[]) => any)): void;
+
+declare function complexData(opt_options?: any): void;
+
+export default DataView;
+export { DataView };