@visactor/vtable 0.9.0-alpha.0-alpha.0

package/es/core/BaseTable.d.ts

@@ -0,0 +1,287 @@
+import '../tools/style.css';
+import type { CellAddress, CellRange, TableEventHandlersEventArgumentMap, TableEventHandlersReturnMap, TableKeyboardOptions, DropDownMenuHighlightInfo, MenuListItem, WidthModeDef, ICustomRender, ICellHeaderPaths, HeaderData, FullExtendStyle, FieldDef, ColumnTypeOption, SortState, IPagerConf, ICustomLayout, CellInfo, CellStyle, DropDownMenuOptions, FieldFormat, FieldData, MaybePromiseOrUndefined, MousePointerCellEvent, DropDownMenuEventInfo, HierarchyState, FieldKeyDef, CellType, LayoutObjectId } from '../ts-types';
+import type { ColumnIconOption } from '../ts-types';
+import { TABLE_EVENT_TYPE } from './TABLE_EVENT_TYPE';
+import { EventTarget } from '../event/EventTarget';
+import { NumberMap } from '../tools/NumberMap';
+import { Rect } from '../tools/Rect';
+import type { TableTheme } from '../themes/theme';
+import { Scenegraph } from '../scenegraph/scenegraph';
+import { StateManeger } from '../state/state';
+import { EventManeger } from '../event/event';
+import type { CachedDataSource, DataSource } from '../data';
+import type { IWrapTextGraphicAttribute } from '@visactor/vrender';
+import type { ITextSize } from '@visactor/vutils';
+import type { ColumnData, ColumnDefine, ColumnsDefine, IndicatorData } from '../ts-types/list-table/layout-map/api';
+import type { TooltipOptions } from '../ts-types/tooltip';
+import type { BaseTableAPI, BaseTableConstructorOptions, IBaseTableProtected } from '../ts-types/base-table';
+export declare abstract class BaseTable extends EventTarget implements BaseTableAPI {
+    internalProps: IBaseTableProtected;
+    showPin: boolean;
+    showSort: boolean;
+    padding: {
+        top: number;
+        left: number;
+        right: number;
+        bottom: number;
+    };
+    globalDropDownMenu?: MenuListItem[];
+    tableNoFrameWidth: number;
+    tableNoFrameHeight: number;
+    tableX: number;
+    tableY: number;
+    _widthMode: WidthModeDef;
+    customRender?: ICustomRender;
+    canvasWidth?: number;
+    canvasHeight?: number;
+    scenegraph: Scenegraph;
+    stateManeger?: StateManeger;
+    eventManeger?: EventManeger;
+    _pixelRatio: number;
+    _cellToBeInvalidatedNextFrame: Set<string>;
+    _willNextFrameInvalidate: boolean;
+    static get EVENT_TYPE(): typeof TABLE_EVENT_TYPE;
+    readonly options: BaseTableConstructorOptions;
+    pagerConf?: IPagerConf | undefined;
+    id: string;
+    headerStyleCache: any;
+    bodyStyleCache: any;
+    constructor(options?: BaseTableConstructorOptions);
+    throttleInvalidate: (this: any, ...args: any[]) => void;
+    getParentElement(): HTMLElement;
+    getElement(): HTMLElement;
+    get canvas(): HTMLCanvasElement;
+    get rowCount(): number;
+    set rowCount(rowCount: number);
+    get colCount(): number;
+    set colCount(colCount: number);
+    get frozenColCount(): number;
+    set frozenColCount(frozenColCount: number);
+    setFrozenColCount(frozenColCount: number): void;
+    _setFrozenColCount(frozenColCount: number): void;
+    _resetFrozenColCount(): void;
+    get frozenRowCount(): number;
+    set frozenRowCount(frozenRowCount: number);
+    get defaultRowHeight(): number;
+    set defaultRowHeight(defaultRowHeight: number);
+    get defaultHeaderRowHeight(): number | number[];
+    set defaultHeaderRowHeight(defaultHeaderRowHeight: number | number[]);
+    get defaultColWidth(): number;
+    set defaultColWidth(defaultColWidth: number);
+    get defaultHeaderColWidth(): number | number[];
+    set defaultHeaderColWidth(defaultHeaderColWidth: number | number[]);
+    get colWidthsMap(): NumberMap<string | number>;
+    set colWidthsMap(colWidthsMap: NumberMap<string | number>);
+    get colContentWidthsMap(): NumberMap<string | number>;
+    set colContentWidthsMap(colContentWidthsMap: NumberMap<string | number>);
+    get _colRangeWidthsMap(): Map<string, number>;
+    set _colRangeWidthsMap(_colRangeWidthsMap: Map<string, number>);
+    get _rowRangeHeightsMap(): Map<string, number>;
+    set _rowRangeHeightsMap(_rowRangeHeightsMap: Map<string, number>);
+    get rowHeightsMap(): NumberMap<number>;
+    set rowHeightsMap(rowHeightsMap: NumberMap<number>);
+    get colWidthsLimit(): {
+        [col: number]: {
+            max?: string | number;
+            min?: string | number;
+        };
+    };
+    set colWidthsLimit(colWidthsLimit: {
+        [col: number]: {
+            max?: string | number;
+            min?: string | number;
+        };
+    });
+    get keyboardOptions(): TableKeyboardOptions | null;
+    set keyboardOptions(keyboardOptions: TableKeyboardOptions | null);
+    get widthMode(): WidthModeDef;
+    set widthMode(widthMode: WidthModeDef);
+    private _colWidthDefineToPxWidth;
+    private _calculateAutoColWidthExpr;
+    private _getColWidthLimits;
+    private _adjustColWidth;
+    setPixelRatio(pixelRatio: number): void;
+    _updateSize(): void;
+    get rowHierarchyType(): 'grid' | 'tree';
+    setColWidths(widths: number[]): void;
+    getColsWidth(startCol: number, endCol: number): number;
+    getRowHeight(row: number): number;
+    setRowHeight(row: number, height: number, clearCache?: boolean): void;
+    fillRowsHeight(rowStart: number, rowEnd: number, rowHeight: number): void;
+    getRowsHeight(startRow: number, endRow: number): number;
+    getColWidthDefine(col: number): string | number;
+    getColWidth(col: number): number;
+    setColWidth(col: number, width: string | number, clearCache?: boolean, skipCheckFrozen?: boolean): void;
+    _clearColRangeWidthsMap(col?: number): void;
+    _clearRowRangeHeightsMap(row: number): void;
+    _getColContentWidth(col: number): number;
+    _setColContentWidth(col: number, width: string | number): void;
+    getAllRowsHeight(): number;
+    getAllColsWidth(): number;
+    getMaxColWidth(col: number): number;
+    setMaxColWidth(col: number, maxwidth: string | number): void;
+    getMinColWidth(col: number): number;
+    setMinColWidth(col: number, minwidth: string | number): void;
+    getCellRect(col: number, row: number): Rect;
+    getMergeCellRect(col: number, row: number): Rect;
+    getCellRelativeRect(col: number, row: number): Rect;
+    getCellRangeRelativeRect(range: CellRange | CellAddress): Rect;
+    getVisibleCellRangeRelativeRect(range: CellRange | CellAddress): Rect;
+    _getVisiableRect(relativeRectObj: Rect, cellRange: CellRange): Rect;
+    getCellsRect(startCol: number, startRow: number, endCol: number, endRow: number): Rect;
+    getCellsRectWidth(startCol: number, startRow: number, endCol: number, endRow: number): number;
+    getCellRangeRect(range: CellRange | CellAddress): Rect;
+    getCellRangeRectWidth(range: CellRange | CellAddress): number;
+    isFrozenCell(col: number, row: number): {
+        row: boolean;
+        col: boolean;
+    } | null;
+    getRowAt(absoluteY: number): {
+        top: number;
+        row: number;
+        bottom: number;
+        height: number;
+    };
+    getColAt(absoluteX: number): {
+        left: number;
+        col: number;
+        right: number;
+        width: number;
+    };
+    getCellAt(absoluteX: number, absoluteY: number): CellAddress;
+    _checkRowCol(col: number, row: number): boolean;
+    _makeVisibleCell(col: number, row: number): void;
+    invalidate(): void;
+    _toRelativeRect(absoluteRect: Rect): Rect;
+    getVisibleRect(): Rect;
+    get visibleRowCount(): number;
+    get visibleColCount(): number;
+    get scrollTop(): number;
+    set scrollTop(scrollTop: number);
+    get scrollLeft(): number;
+    set scrollLeft(scrollLeft: number);
+    getScrollLeft(): number;
+    getScrollTop(): number;
+    setScrollLeft(num: number): void;
+    setScrollTop(num: number): void;
+    getCellOverflowText(col: number, row: number): string | null;
+    addDisposable(disposable: {
+        dispose: () => void;
+    }): void;
+    dispose(): void;
+    fireListeners<TYPE extends keyof TableEventHandlersEventArgumentMap>(type: TYPE, ...event: TableEventHandlersEventArgumentMap[TYPE]): TableEventHandlersReturnMap[TYPE][];
+    updateOption(options: BaseTableConstructorOptions): void;
+    getFrozenRowsHeight(): number;
+    getFrozenColsWidth(): number;
+    getDrawRange(): Rect;
+    _getMouseAbstractPoint(evt: TouchEvent | MouseEvent | undefined, isAddScroll?: boolean): {
+        x: number;
+        y: number;
+    } | null;
+    _getCellEventArgsSet<EVT extends TouchEvent | MouseEvent>(e: EVT): {
+        abstractPos?: {
+            x: number;
+            y: number;
+        };
+        cell?: CellAddress;
+        eventArgs?: CellAddress & {
+            event: EVT;
+            related?: CellAddress;
+        };
+    };
+    getTheme(): TableTheme;
+    getTargetColAt(absoluteX: number): {
+        col: number;
+        left: number;
+        right: number;
+        width: number;
+    } | null;
+    getTargetRowAt(absoluteY: number): {
+        row: number;
+        top: number;
+        bottom: number;
+        height: number;
+    } | null;
+    private computeTargetRowByY;
+    private computeTargetColByX;
+    clearSelected(): void;
+    selectCell(col: number, row: number): void;
+    abstract isListTable(): boolean;
+    abstract isPivotTable(): boolean;
+    protected abstract getSortFuncFromHeaderOption(columns: ColumnsDefine | undefined, field: FieldDef, fieldKey?: FieldKeyDef): ((v1: any, v2: any, order: string) => 0 | 1 | -1) | undefined;
+    abstract refreshHeader(): void;
+    abstract refreshRowColCount(): void;
+    abstract getHierarchyState(col: number, row: number): HierarchyState | null;
+    abstract toggleHierarchyState(col: number, row: number): void;
+    abstract hasHierarchyTreeHeader(): boolean;
+    abstract getMenuInfo(col: number, row: number, type: string): DropDownMenuEventInfo;
+    abstract moveHeaderPosition(source: CellAddress, target: CellAddress): boolean;
+    abstract getFieldData(field: FieldDef | FieldFormat | undefined, col: number, row: number): FieldData;
+    abstract getRecordIndexByRow(col: number, row: number): number;
+    abstract getCellOriginRecord(col: number, row: number): MaybePromiseOrUndefined;
+    abstract getCellValue(col: number, row: number): FieldData;
+    abstract getCellOriginValue(col: number, row: number): FieldData;
+    updatePager(cof: IPagerConf): void;
+    get allowFrozenColCount(): number;
+    get rowHeaderLevelCount(): number;
+    get columnHeaderLevelCount(): number;
+    get records(): any[] | null;
+    get dataSource(): DataSource | CachedDataSource;
+    set dataSource(dataSource: DataSource | CachedDataSource);
+    get autoWrapText(): boolean;
+    set autoWrapText(autoWrapText: boolean);
+    get theme(): TableTheme;
+    set theme(theme: TableTheme);
+    getBodyField(col: number, row: number): FieldDef | undefined;
+    getBodyColumnDefine(col: number, row: number): ColumnDefine;
+    getBodyColumnType(col: number, row: number): ColumnTypeOption;
+    getHeaderField(col: number, row: number): FieldDef;
+    getHeaderFieldKey(col: number, row: number): FieldDef;
+    getHeaderDefine(col: number, row: number): ColumnDefine;
+    getCellType(col: number, row: number): CellType;
+    getCellHeaderPaths(col: number, row: number): ICellHeaderPaths;
+    getHeadersDefine(col: number, row: number): ColumnDefine[];
+    _getHeaderLayoutMap(col: number, row: number): HeaderData;
+    _getBodyLayoutMap(col: number, row: number): ColumnData | IndicatorData;
+    getContext(): CanvasRenderingContext2D;
+    getRecordByRowCol(col: number, row: number): MaybePromiseOrUndefined;
+    getRecordStartRowByRecordIndex(index: number): number;
+    _getHeaderCellBySortState(sortState: SortState): CellAddress | undefined;
+    getCellRange(col: number, row: number): CellRange;
+    isCellRangeEqual(col: number, row: number, targetCol: number, targetRow: number): boolean;
+    _getLayoutCellId(col: number, row: number): LayoutObjectId;
+    getHeaderDescription(col: number, row: number): string | undefined;
+    setRecords(records: Array<any>, sort?: SortState | SortState[]): void;
+    setDropDownMenuHighlight(cells: DropDownMenuHighlightInfo[]): void;
+    _dropDownMenuIsHighlight(colNow: number, rowNow: number, index: number): boolean;
+    isHeader(col: number, row: number): boolean;
+    isColumnHeader(col: number, row: number): boolean;
+    isRowHeader(col: number, row: number): boolean;
+    isCornerHeader(col: number, row: number): boolean;
+    getCellInfo(col: number, row: number): MousePointerCellEvent;
+    _hasField(field: FieldDef, col: number, row: number): boolean;
+    _getCellStyle(col: number, row: number): FullExtendStyle;
+    _canResizeColumn(col: number, row: number): boolean;
+    _canDragHeaderPosition(col: number, row: number): boolean;
+    getCellIcons(col: number, row: number): ColumnIconOption[];
+    showDropDownMenu(col: number, row: number, dropDownMenuOptions?: DropDownMenuOptions): void;
+    showTooltip(col: number, row: number, tooltipOptions?: TooltipOptions): void;
+    getCellStyle(col: number, row: number): CellStyle;
+    getAllBodyCells(colMaxCount?: number, rowMaxCount?: number): CellInfo[][];
+    getAllCells(colMaxCount?: number, rowMaxCount?: number): CellInfo[][];
+    getAllColumnHeaderCells(): CellInfo[][];
+    getAllRowHeaderCells(): CellInfo[][];
+    scrollToCell(cellAddr: {
+        col?: number;
+        row?: number;
+    }): void;
+    getCopyValue(): string;
+    getSelectedCellInfos(): CellInfo[][];
+    measureText(text: string, font: {
+        fontSize: number;
+        fontFamily: string;
+    }): ITextSize;
+    measureTextBounds(attributes: IWrapTextGraphicAttribute): ITextSize;
+    getCustomRender(col: number, row: number): ICustomRender;
+    getCustomLayout(col: number, row: number): ICustomLayout;
+}