k-vtable 1.0.0

package/README.md

@@ -0,0 +1,151 @@
+<div align="center">
+  <a href="" target="_blank">
+    <img alt="VisActor Logo" width="200" src="https://github.com/VisActor/.github/blob/main/profile/500_200.svg"/>
+  </a>
+</div>
+
+<div align="center">
+  <h1>VTable</h1>
+</div>
+
+<div align="center">
+
+VTable is not just a high-performance multidimensional data analysis table, but also a grid artist that creates art between rows and columns.
+
+<p align="center">
+  <a href="">Introduction</a> •
+  <a href="">demo</a> •
+  <a href="">Tutorial</a> •
+  <a href="">API</a>•
+</p>
+
+[![npm Version](https://img.shields.io/npm/v/@visactor/vtable.svg)](https://www.npmjs.com/package/@visactor/vtable)
+[![npm Download](https://img.shields.io/npm/dm/@visactor/vtable.svg)](https://www.npmjs.com/package/@visactor/vtable)
+[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/visactor/vtable/blob/main/LICENSE)
+
+</div>
+
+<div align="center">
+
+English| [简体中文](./README.zh-CN.md)
+
+</div>
+
+<div align="center">
+
+（video）
+
+</div>
+
+# Introduction
+
+VTable is a canvas table library based on visual rendering engine [VRender](https://github.com/VisActor/VRender). 
+
+The core capabilities are as follows:
+
+1. Extreme performance: Supports fast computation and rendering of millions of data points.
+2. Multidimensional analysis: Automatically analyzes and presents multidimensional data.
+3. Strong expressiveness: Provides flexible and powerful graphic capabilities, seamlessly integrating with charts of [VChart](https://github.com/VisActor/VChart).
+
+# Repo Intro
+
+This repository includes the following packages:
+
+1. vtable: VTable components
+2. vtable-docs: VTable documentation
+
+# Usage
+
+## Installation
+
+[npm package](https://www.npmjs.com/package/@visactor/vtable)
+
+```bash
+// npm
+npm install @visactor/vtable
+
+// yarn
+yarn add @visactor/vtable
+```
+
+## Quick Start
+
+```javascript
+import * as VTable from '@visactor/vtable';
+
+const columns =[
+    {
+        "field": "Order ID",
+        "caption": "Order ID",
+    },
+    {
+        "field": "Customer ID",
+        "caption": "Customer ID",
+    },
+    {
+        "field": "Product Name",
+        "caption": "Product Name",
+    },
+    {
+        "field": "Sales",
+        "caption": "Sales",
+    },
+    {
+        "field": "Profit",
+        "caption": "Profit",
+    }
+];
+
+const option = {
+  records:[
+      {
+      "Order ID": "CA-2018-156720",
+      "Customer ID": "JM-15580",
+      "Product Name": "Bagged Rubber Bands",
+      "Sales": "3.024",
+      "Profit": "-0.605"
+  },
+  {
+      "Order ID": "CA-2018-115427",
+      "Customer ID": "EB-13975",
+      "Product Name": "GBC Binding covers",
+      "Sales": "20.72",
+      "Profit": "6.475"
+  },
+  ...
+  ],
+  columns,
+  widthMode:'standard'
+};
+const tableInstance = new VTable.ListTable(document.getElementById(CONTAINER_ID), option);
+
+
+
+
+```
+
+##
+
+[More demos and detailed tutorials](https://visactor.io/vtable)
+
+# Related Links
+
+- [Official website](https://visactor.io/vtable)
+
+# Ecosystem
+
+| Project                                                     | Description                                                                            |
+| ----------------------------------------------------------- | -------------------------------------------------------------------------------------- |
+| [AI-generated Components](https://visactor.io/ai-vtable)    | AI-generated table component.                                                          |
+
+# Contribution
+
+If you would like to contribute, please read the [Code of Conduct ](./CODE_OF_CONDUCT.md) 和 [ Guide](./CONTRIBUTING.zh-CN.md) first。
+
+Small streams converge to make great rivers and seas!
+
+<a href="https://github.com/visactor/vtable/graphs/contributors"><img src="https://contrib.rocks/image?repo=visactor/vtable" /></a>
+
+# License
+
+[MIT License](./LICENSE)

package/cjs/ListTable-all.d.ts

@@ -0,0 +1,3 @@
+import { ListTable } from './ListTable';
+export declare class ListTableAll extends ListTable {
+}

package/cjs/ListTable-all.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+    value: !0
+}), exports.ListTableAll = void 0;
+
+const ListTable_1 = require("./ListTable"), components_1 = require("./components"), custom_cell_style_1 = require("./plugins/custom-cell-style"), list_tree_stick_cell_1 = require("./plugins/list-tree-stick-cell"), cell_type_1 = require("./scenegraph/group-creater/cell-type");
+
+(0, components_1.registerAxis)(), (0, components_1.registerEmptyTip)(), (0, components_1.registerLegend)(), 
+(0, components_1.registerMenu)(), (0, components_1.registerTitle)(), (0, components_1.registerTooltip)(), 
+(0, list_tree_stick_cell_1.registerListTreeStickCellPlugin)(), (0, custom_cell_style_1.registerCustomCellStylePlugin)(), 
+(0, cell_type_1.registerChartCell)(), (0, cell_type_1.registerCheckboxCell)(), (0, 
+cell_type_1.registerImageCell)(), (0, cell_type_1.registerProgressBarCell)(), (0, 
+cell_type_1.registerRadioCell)(), (0, cell_type_1.registerSwitchCell)(), (0, cell_type_1.registerButtonCell)(), 
+(0, cell_type_1.registerSparkLineCell)(), (0, cell_type_1.registerTextCell)(), (0, 
+cell_type_1.registerVideoCell)();
+
+class ListTableAll extends ListTable_1.ListTable {}
+
+exports.ListTableAll = ListTableAll;

package/cjs/ListTable-all.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/ListTable-all.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AACxC,6CAOsB;AACtB,mEAA4E;AAC5E,yEAAiF;AACjF,oEAW8C;AAE9C,IAAA,yBAAY,GAAE,CAAC;AACf,IAAA,6BAAgB,GAAE,CAAC;AACnB,IAAA,2BAAc,GAAE,CAAC;AACjB,IAAA,yBAAY,GAAE,CAAC;AACf,IAAA,0BAAa,GAAE,CAAC;AAChB,IAAA,4BAAe,GAAE,CAAC;AAClB,IAAA,sDAA+B,GAAE,CAAC;AAClC,IAAA,iDAA6B,GAAE,CAAC;AAEhC,IAAA,6BAAiB,GAAE,CAAC;AACpB,IAAA,gCAAoB,GAAE,CAAC;AACvB,IAAA,6BAAiB,GAAE,CAAC;AACpB,IAAA,mCAAuB,GAAE,CAAC;AAC1B,IAAA,6BAAiB,GAAE,CAAC;AACpB,IAAA,8BAAkB,GAAE,CAAC;AACrB,IAAA,8BAAkB,GAAE,CAAC;AACrB,IAAA,iCAAqB,GAAE,CAAC;AACxB,IAAA,4BAAgB,GAAE,CAAC;AACnB,IAAA,6BAAiB,GAAE,CAAC;AACpB,MAAa,YAAa,SAAQ,qBAAS;CAAG;AAA9C,oCAA8C","file":"ListTable-all.js","sourcesContent":["import { ListTable } from './ListTable';\nimport {\n  registerAxis,\n  registerEmptyTip,\n  registerLegend,\n  registerMenu,\n  registerTitle,\n  registerTooltip\n} from './components';\nimport { registerCustomCellStylePlugin } from './plugins/custom-cell-style';\nimport { registerListTreeStickCellPlugin } from './plugins/list-tree-stick-cell';\nimport {\n  registerButtonCell,\n  registerChartCell,\n  registerCheckboxCell,\n  registerImageCell,\n  registerProgressBarCell,\n  registerRadioCell,\n  registerSparkLineCell,\n  registerSwitchCell,\n  registerTextCell,\n  registerVideoCell\n} from './scenegraph/group-creater/cell-type';\n\nregisterAxis();\nregisterEmptyTip();\nregisterLegend();\nregisterMenu();\nregisterTitle();\nregisterTooltip();\nregisterListTreeStickCellPlugin();\nregisterCustomCellStylePlugin();\n\nregisterChartCell();\nregisterCheckboxCell();\nregisterImageCell();\nregisterProgressBarCell();\nregisterRadioCell();\nregisterSwitchCell();\nregisterButtonCell();\nregisterSparkLineCell();\nregisterTextCell();\nregisterVideoCell();\nexport class ListTableAll extends ListTable {}\n"]}

package/cjs/ListTable-simple.d.ts

@@ -0,0 +1,3 @@
+import { ListTable } from './ListTable';
+export declare class ListTableSimple extends ListTable {
+}

package/cjs/ListTable-simple.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+    value: !0
+}), exports.ListTableSimple = void 0;
+
+const ListTable_1 = require("./ListTable"), cell_type_1 = require("./scenegraph/group-creater/cell-type");
+
+(0, cell_type_1.registerTextCell)();
+
+class ListTableSimple extends ListTable_1.ListTable {}
+
+exports.ListTableSimple = ListTableSimple;
+//# sourceMappingURL=ListTable-simple.js.map

package/cjs/ListTable-simple.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/ListTable-simple.ts"],"names":[],"mappings":";;;AAAA,2CAAwC;AACxC,oEAAwE;AAExE,IAAA,4BAAgB,GAAE,CAAC;AACnB,MAAa,eAAgB,SAAQ,qBAAS;CAAG;AAAjD,0CAAiD","file":"ListTable-simple.js","sourcesContent":["import { ListTable } from './ListTable';\nimport { registerTextCell } from './scenegraph/group-creater/cell-type';\n\nregisterTextCell();\nexport class ListTableSimple extends ListTable {}\n"]}

package/cjs/ListTable.d.ts

@@ -0,0 +1,101 @@
+import type { AggregationType, CellAddress, CellRange, ColumnsDefine, DropDownMenuEventInfo, FieldData, FieldDef, FieldFormat, FieldKeyDef, FilterRules, IPagination, ListTableAPI, ListTableConstructorOptions, MaybePromiseOrUndefined, SortState } from './ts-types';
+import { HierarchyState } from './ts-types';
+import { BaseTable } from './core';
+import type { ListTableProtected } from './ts-types/base-table';
+import type { IEditor } from '@visactor/vtable-editors';
+import type { ListTreeStickCellPlugin } from './plugins/list-tree-stick-cell';
+export declare class ListTable extends BaseTable implements ListTableAPI {
+    internalProps: ListTableProtected;
+    options: ListTableConstructorOptions;
+    showHeader: boolean;
+    listTreeStickCellPlugin?: ListTreeStickCellPlugin;
+    constructor(options: ListTableConstructorOptions);
+    constructor(container: HTMLElement, options: ListTableConstructorOptions);
+    isListTable(): true;
+    isPivotTable(): false;
+    isPivotChart(): false;
+    get sortState(): SortState | SortState[];
+    get records(): any[];
+    get recordsCount(): number;
+    updateColumns(columns: ColumnsDefine): void;
+    get columns(): ColumnsDefine;
+    get header(): ColumnsDefine;
+    set header(header: ColumnsDefine);
+    get transpose(): boolean;
+    set transpose(transpose: boolean);
+    getCellValue(col: number, row: number, skipCustomMerge?: boolean): FieldData;
+    getCellOriginValue(col: number, row: number): FieldData;
+    getCellRawValue(col: number, row: number): FieldData;
+    getRecordShowIndexByCell(col: number, row: number): number;
+    getRecordIndexByCell(col: number, row: number): number | number[];
+    getTableIndexByRecordIndex(recordIndex: number | number[]): number;
+    getTableIndexByField(field: FieldDef): number;
+    getCellAddrByFieldRecord(field: FieldDef, recordIndex: number): CellAddress;
+    getCellOriginRecord(col: number, row: number): MaybePromiseOrUndefined;
+    getCellRawRecord(col: number, row: number): MaybePromiseOrUndefined;
+    _canResizeColumn(col: number, row: number): boolean;
+    updateOption(options: ListTableConstructorOptions): Promise<unknown>;
+    updatePagination(pagination: IPagination): void;
+    refreshHeader(): void;
+    refreshRowColCount(): void;
+    getFieldData(field: FieldDef | FieldFormat | undefined, col: number, row: number): FieldData;
+    getRawFieldData(field: FieldDef | FieldFormat | undefined, col: number, row: number): FieldData;
+    _moveHeaderPosition(source: CellAddress, target: CellAddress): {
+        sourceIndex: number;
+        targetIndex: number;
+        sourceSize: number;
+        targetSize: number;
+        moveType: "row" | "column";
+    };
+    changeRecordOrder(sourceIndex: number, targetIndex: number): void;
+    getCellAddress(findTargetRecord: any | ((record: any) => boolean), field: FieldDef): CellAddress;
+    getCellRangeByField(field: FieldDef, index: number): CellRange | null;
+    getHierarchyState(col: number, row: number): HierarchyState;
+    toggleHierarchyState(col: number, row: number, recalculateColWidths?: boolean): void;
+    setLoadingHierarchyState(col: number, row: number): void;
+    _refreshHierarchyState(col: number, row: number, recalculateColWidths?: boolean): void;
+    _hasHierarchyTreeHeader(): boolean;
+    getMenuInfo(col: number, row: number, type: string): DropDownMenuEventInfo;
+    _getSortFuncFromHeaderOption(columns: ColumnsDefine | undefined, field: FieldDef, fieldKey?: FieldKeyDef): SortState['orderFn'] | undefined;
+    updateSortState(sortState: SortState[] | SortState | null, executeSort?: boolean): void;
+    updateFilterRules(filterRules: FilterRules): void;
+    getCheckboxState(field?: string | number): any[];
+    getCellCheckboxState(col: number, row: number): boolean | "indeterminate";
+    getRadioState(field?: string | number): number | boolean | Record<string | number, number | boolean | Record<number, number>>;
+    getCellRadioState(col: number, row: number): boolean | number;
+    setCellCheckboxState(col: number, row: number, checked: boolean | 'indeterminate'): void;
+    setCellRadioState(col: number, row: number, index?: number): void;
+    getSwitchState(field?: string | number): any[];
+    getCellSwitchState(col: number, row: number): boolean | "indeterminate";
+    setCellSwitchState(col: number, row: number, checked: boolean | 'indeterminate'): void;
+    setRecords(records: Array<any>, option?: {
+        sortState?: SortState | SortState[] | null;
+    }): void;
+    setRecordChildren(records: any[], col: number, row: number, recalculateColWidths?: boolean): void;
+    startEditCell(col?: number, row?: number, value?: string | number): void;
+    completeEditCell(): void;
+    getEditor(col: number, row: number): IEditor<any, any>;
+    isHasEditorDefine(col: number, row: number): boolean;
+    changeCellValue(col: number, row: number, value: string | number | null, workOnEditableCell?: boolean, triggerEvent?: boolean): void;
+    changeCellValues(startCol: number, startRow: number, values: (string | number)[][], workOnEditableCell?: boolean, triggerEvent?: boolean): void;
+    addRecord(record: any, recordIndex?: number | number[]): void;
+    addRecords(records: any[], recordIndex?: number | number[]): void;
+    deleteRecords(recordIndexs: number[] | number[][]): void;
+    updateRecords(records: any[], recordIndexs: (number | number[])[]): void;
+    _hasCustomRenderOrLayout(): boolean;
+    getAggregateValuesByField(field: string | number): {
+        col: number;
+        aggregateValue: {
+            aggregationType: AggregationType;
+            value: number | string;
+        }[];
+    }[];
+    isAggregation(col: number, row: number): boolean;
+    getGroupTitleLevel(col: number, row: number): number | undefined;
+    getBodyRowIndexByRecordIndex(index: number | number[]): number;
+    _parseColumnWidthConfig(columnWidthConfig: {
+        key: string;
+        width: number;
+    }[]): void;
+    release(): void;
+}