@canvas-components/react-pivot-table 0.2.17 → 0.2.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/README.md +6 -0
  2. package/dist/index.cjs +555 -139
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +6 -1
  5. package/dist/index.d.ts +6 -1
  6. package/dist/index.js +557 -141
  7. package/dist/index.js.map +1 -1
  8. package/package.json +10 -8
  9. package/LICENSE +0 -21
package/dist/index.d.cts CHANGED
@@ -1,6 +1,6 @@
1
1
  import * as react from 'react';
2
2
  import { CSSProperties, ReactNode, ForwardedRef, PropsWithChildren } from 'react';
3
- import { PivotTableOptions, PivotField, PivotFieldLayout, PivotModel, PivotTable, PivotSelectionState, PivotFilterState, PivotSortRule, PivotCellAddress, PivotAxis, PivotFilterAxis, PivotDimensionFilter, PivotFilterOptionItem, PivotExportOptions, PivotTableStateSnapshot } from '@canvas-components/pivot-table';
3
+ import { PivotTableOptions, PivotFieldLayout, PivotField, PivotTable, PivotModel, PivotSelectionState, PivotFilterState, PivotSortRule, PivotCellAddress, PivotAxis, PivotFilterAxis, PivotDimensionFilter, PivotFilterOptionItem, PivotExportOptions, PivotTableStateSnapshot } from '@canvas-components/pivot-table';
4
4
 
5
5
  /** PivotTable 自定义字段面板配置。 */
6
6
  interface ReactPivotTableCustomizationOptions<RecordType = Record<string, unknown>> {
@@ -28,11 +28,14 @@ interface ReactPivotTableProps<RecordType = Record<string, unknown>> extends Omi
28
28
  style?: CSSProperties;
29
29
  /** 标题栏左侧内容。 */
30
30
  title?: ReactNode;
31
+ /** 初始透视字段区域；字段 key 从行、列、指标及 customization.fields 中查找，已缓存布局优先。 */
32
+ pivotAreas?: PivotFieldLayout;
31
33
  /** 开启字段自定义模式及右侧字段面板。 */
32
34
  customization?: boolean | ReactPivotTableCustomizationOptions<RecordType>;
33
35
  }
34
36
  /** ReactPivotTable 实例方法。 */
35
37
  interface ReactPivotTableRef<RecordType = Record<string, unknown>> {
38
+ autoFitColumnWidths: PivotTable<RecordType>["autoFitColumnWidths"];
36
39
  getPivotModel: () => PivotModel<RecordType> | null;
37
40
  getVisibleRowNodes: () => ReturnType<PivotTable<RecordType>["getVisibleRowNodes"]>;
38
41
  getVisibleColumnNodes: () => ReturnType<PivotTable<RecordType>["getVisibleColumnNodes"]>;
@@ -58,6 +61,8 @@ interface ReactPivotTableRef<RecordType = Record<string, unknown>> {
58
61
  expandAll: (axis?: PivotAxis | "both") => number;
59
62
  collapseAll: (axis?: PivotAxis | "both") => number;
60
63
  setDimensionFilter: (axis: PivotFilterAxis, dimensionKey: string, filter: PivotDimensionFilter | null) => PivotFilterState | null;
64
+ setIndicatorFilter: (indicatorKey: string, columnPathKey: string, filter: PivotDimensionFilter | null) => PivotFilterState | null;
65
+ getIndicatorFilterOptions: (indicatorKey: string, columnPathKey: string) => PivotFilterOptionItem[];
61
66
  getDimensionFilterOptions: (axis: PivotFilterAxis, dimensionKey: string) => PivotFilterOptionItem[];
62
67
  resetFilters: () => PivotFilterState | null;
63
68
  setDimensionSort: (axis: PivotAxis, dimensionKey: string, direction: "asc" | "desc" | null) => PivotSortRule[];
package/dist/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import * as react from 'react';
2
2
  import { CSSProperties, ReactNode, ForwardedRef, PropsWithChildren } from 'react';
3
- import { PivotTableOptions, PivotField, PivotFieldLayout, PivotModel, PivotTable, PivotSelectionState, PivotFilterState, PivotSortRule, PivotCellAddress, PivotAxis, PivotFilterAxis, PivotDimensionFilter, PivotFilterOptionItem, PivotExportOptions, PivotTableStateSnapshot } from '@canvas-components/pivot-table';
3
+ import { PivotTableOptions, PivotFieldLayout, PivotField, PivotTable, PivotModel, PivotSelectionState, PivotFilterState, PivotSortRule, PivotCellAddress, PivotAxis, PivotFilterAxis, PivotDimensionFilter, PivotFilterOptionItem, PivotExportOptions, PivotTableStateSnapshot } from '@canvas-components/pivot-table';
4
4
 
5
5
  /** PivotTable 自定义字段面板配置。 */
6
6
  interface ReactPivotTableCustomizationOptions<RecordType = Record<string, unknown>> {
@@ -28,11 +28,14 @@ interface ReactPivotTableProps<RecordType = Record<string, unknown>> extends Omi
28
28
  style?: CSSProperties;
29
29
  /** 标题栏左侧内容。 */
30
30
  title?: ReactNode;
31
+ /** 初始透视字段区域；字段 key 从行、列、指标及 customization.fields 中查找，已缓存布局优先。 */
32
+ pivotAreas?: PivotFieldLayout;
31
33
  /** 开启字段自定义模式及右侧字段面板。 */
32
34
  customization?: boolean | ReactPivotTableCustomizationOptions<RecordType>;
33
35
  }
34
36
  /** ReactPivotTable 实例方法。 */
35
37
  interface ReactPivotTableRef<RecordType = Record<string, unknown>> {
38
+ autoFitColumnWidths: PivotTable<RecordType>["autoFitColumnWidths"];
36
39
  getPivotModel: () => PivotModel<RecordType> | null;
37
40
  getVisibleRowNodes: () => ReturnType<PivotTable<RecordType>["getVisibleRowNodes"]>;
38
41
  getVisibleColumnNodes: () => ReturnType<PivotTable<RecordType>["getVisibleColumnNodes"]>;
@@ -58,6 +61,8 @@ interface ReactPivotTableRef<RecordType = Record<string, unknown>> {
58
61
  expandAll: (axis?: PivotAxis | "both") => number;
59
62
  collapseAll: (axis?: PivotAxis | "both") => number;
60
63
  setDimensionFilter: (axis: PivotFilterAxis, dimensionKey: string, filter: PivotDimensionFilter | null) => PivotFilterState | null;
64
+ setIndicatorFilter: (indicatorKey: string, columnPathKey: string, filter: PivotDimensionFilter | null) => PivotFilterState | null;
65
+ getIndicatorFilterOptions: (indicatorKey: string, columnPathKey: string) => PivotFilterOptionItem[];
61
66
  getDimensionFilterOptions: (axis: PivotFilterAxis, dimensionKey: string) => PivotFilterOptionItem[];
62
67
  resetFilters: () => PivotFilterState | null;
63
68
  setDimensionSort: (axis: PivotAxis, dimensionKey: string, direction: "asc" | "desc" | null) => PivotSortRule[];