@kanunilabs/pivotgrid-react 1.2.2 → 1.4.0
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.
- package/README.md +3 -3
- package/dist/index.cjs +2 -2
- package/dist/index.d.cts +79 -5
- package/dist/index.d.ts +79 -5
- package/dist/index.js +2 -2
- package/dist/styles.css +3 -0
- package/package.json +5 -4
package/dist/index.d.cts
CHANGED
|
@@ -1,11 +1,36 @@
|
|
|
1
1
|
import * as React$1 from 'react';
|
|
2
2
|
import React__default, { Component, ErrorInfo } from 'react';
|
|
3
3
|
import * as _kanunilabs_pivotgrid_core from '@kanunilabs/pivotgrid-core';
|
|
4
|
-
import { PivotField as PivotField$1, PivotCellTemplate as PivotCellTemplate$1, CellClickEvent as CellClickEvent$1, CellPreparedEvent as CellPreparedEvent$1, PivotConditionRule as PivotConditionRule$1, PivotCell, PivotEngineResult, PivotLayoutState, PivotTheme, PivotStateStoringConfig, PivotToolbarConfig, PivotEngineRegistry, PivotLocale, PivotDictionary, FieldMoveEvent, ExportingEvent,
|
|
5
|
-
export { CustomSummaryOptions, DropIntent, ExportingEvent, FieldMoveEvent, FilterCondition, FilterGroup, FilterOperator, PivotArea, PivotCell, PivotCellTextAccessor, PivotCellValueAccessor, PivotControllerCallbacks, PivotControllerOptions, PivotControllerState, PivotDataSource, PivotDictionary, PivotDragIntentState,
|
|
4
|
+
import { PivotField as PivotField$1, PivotCellTemplate as PivotCellTemplate$1, CellClickEvent as CellClickEvent$1, CellPreparedEvent as CellPreparedEvent$1, PivotGridRef as PivotGridRef$1, PivotRowTransaction, PivotTransactionResult, PivotController, PivotConditionRule as PivotConditionRule$1, PivotCell, PivotEngineResult, PivotControllerOptions, PivotLayoutState, PivotTheme, PivotStateStoringConfig, PivotToolbarConfig, PivotEngineRegistry, PivotLocale, PivotDictionary, PivotColumnWidthDefaults, FieldMoveEvent, ExportingEvent, ExportFormat, PivotReport, PivotArea, PivotNode, PivotControllerState } from '@kanunilabs/pivotgrid-core';
|
|
5
|
+
export { CustomSummaryOptions, DropIntent, ExportingEvent, FieldMoveEvent, FilterCondition, FilterGroup, FilterOperator, PivotArea, PivotCell, PivotCellTextAccessor, PivotCellValueAccessor, PivotColumnWidthDefaults, PivotControllerCallbacks, PivotControllerOptions, PivotControllerState, PivotDataSource, PivotDictionary, PivotDragIntentState, PivotGroupInterval, PivotImportStatus, PivotLayoutProfile, PivotLayoutState, PivotLocale, PivotNode, PivotPrefilter, PivotRowKey, PivotRowKeyResolver, PivotRowTransaction, PivotSelectionMode, PivotSelectionRange, PivotSelectionState, PivotSelectionStats, PivotStateStoringConfig, PivotSummaryDisplayMode, PivotSummaryType, PivotTheme, PivotToolbarConfig, PivotTransactionResult, defaultPivotLayout } from '@kanunilabs/pivotgrid-core';
|
|
6
6
|
import * as _dnd_kit_core from '@dnd-kit/core';
|
|
7
7
|
import { DragMoveEvent, DragEndEvent } from '@dnd-kit/core';
|
|
8
8
|
|
|
9
|
+
/** The imperative handle a `ref` on the grid receives. */
|
|
10
|
+
interface PivotGridRef extends PivotGridRef$1 {
|
|
11
|
+
/**
|
|
12
|
+
* Replaces the stored column widths — the same map a resize drag writes,
|
|
13
|
+
* persisted with the layout. Keys are `row-<i>` and `leaf-<i>`; see
|
|
14
|
+
* `PivotControllerState.columnWidths`. Columns left out go back to
|
|
15
|
+
* `defaultColumnWidths`, so merge with `getState().columnWidths` to change
|
|
16
|
+
* one column and keep the rest.
|
|
17
|
+
*/
|
|
18
|
+
setColumnWidths: (widths: Record<string, number>) => void;
|
|
19
|
+
/**
|
|
20
|
+
* Add, update and remove rows without rebuilding the pivot (live updates).
|
|
21
|
+
* Rows are matched by the `rowKey` prop (by object identity without it); an
|
|
22
|
+
* update for an unknown key is ignored, a remove wins over an update of the
|
|
23
|
+
* same row, adds go to the end. Returns what was applied; the recomputed
|
|
24
|
+
* pivot follows asynchronously.
|
|
25
|
+
*/
|
|
26
|
+
applyTransaction: (transaction: PivotRowTransaction<any>) => PivotTransactionResult;
|
|
27
|
+
/**
|
|
28
|
+
* The controller behind the grid — for the calls that take one, such as the
|
|
29
|
+
* Enterprise AI layout functions (`getPivotAiSchema(ref.current.getController())`).
|
|
30
|
+
* The vanilla grid hands out the same object as `api.controller`.
|
|
31
|
+
*/
|
|
32
|
+
getController: () => PivotController<any>;
|
|
33
|
+
}
|
|
9
34
|
type PivotCellTemplate = (props: Parameters<PivotCellTemplate$1>[0]) => React$1.ReactNode;
|
|
10
35
|
type PivotConditionRule = PivotConditionRule$1<React$1.CSSProperties>;
|
|
11
36
|
type PivotField<TRow = any> = PivotField$1<TRow, PivotCellTemplate, React$1.CSSProperties>;
|
|
@@ -16,6 +41,12 @@ interface PivotChartIntegrationOptions {
|
|
|
16
41
|
inverted?: boolean;
|
|
17
42
|
hideTotals?: boolean;
|
|
18
43
|
maxPoints?: number;
|
|
44
|
+
/**
|
|
45
|
+
* Most series (column paths × measures) handed to the chart; the rest are
|
|
46
|
+
* dropped and `isSeriesSampled` says so. The built-in transformer's default
|
|
47
|
+
* is 20 — one chart element per visible column leaf is otherwise unbounded.
|
|
48
|
+
*/
|
|
49
|
+
maxSeries?: number;
|
|
19
50
|
dataFieldsDisplayMode?: 'singleAxis' | 'splitAxes';
|
|
20
51
|
processCell?: (cell: PivotCell) => boolean;
|
|
21
52
|
transformer?: (engineResult: PivotEngineResult, fields: PivotField[], expandedPaths: Set<string>, locale: string, options: any) => ChartSyncResult;
|
|
@@ -25,10 +56,32 @@ interface ChartSeriesDef {
|
|
|
25
56
|
name: string;
|
|
26
57
|
color: string;
|
|
27
58
|
yAxisId?: string;
|
|
59
|
+
/**
|
|
60
|
+
* The data field this series measures — so a chart can print its values
|
|
61
|
+
* with that field's own `format`. Set by the built-in transformer.
|
|
62
|
+
*/
|
|
63
|
+
fieldId?: string;
|
|
64
|
+
/**
|
|
65
|
+
* The column path this series belongs to ('' for a pivot without column
|
|
66
|
+
* fields) and its label. Series of the same group are the same column cut
|
|
67
|
+
* of different measures — what an X-Y chart pairs as x, y and size.
|
|
68
|
+
*/
|
|
69
|
+
seriesKey?: string;
|
|
70
|
+
seriesLabel?: string;
|
|
28
71
|
}
|
|
29
72
|
interface ChartSyncResult {
|
|
30
73
|
chartData: any[];
|
|
31
74
|
chartSeries: ChartSeriesDef[];
|
|
75
|
+
/**
|
|
76
|
+
* The built-in transformer's sampling report, passed through: `maxPoints`
|
|
77
|
+
* dropped categories (`isSampled`, of `totalArgs`), `maxSeries` dropped
|
|
78
|
+
* series (`isSeriesSampled`, of `totalSeries`). Tell the reader they are
|
|
79
|
+
* looking at part of the pivot.
|
|
80
|
+
*/
|
|
81
|
+
isSampled?: boolean;
|
|
82
|
+
totalArgs?: number;
|
|
83
|
+
isSeriesSampled?: boolean;
|
|
84
|
+
totalSeries?: number;
|
|
32
85
|
}
|
|
33
86
|
declare function usePivotChartSync(engineResult: PivotEngineResult | null, fields: PivotField[], expandedPaths: Set<string>, options?: PivotChartIntegrationOptions): ChartSyncResult;
|
|
34
87
|
|
|
@@ -47,8 +100,18 @@ interface BasePivotGridProps<TRow> {
|
|
|
47
100
|
* point this at it, e.g. `/kanunilabs/pivot.worker.js`.
|
|
48
101
|
*/
|
|
49
102
|
workerUrl?: string | URL;
|
|
50
|
-
/**
|
|
103
|
+
/**
|
|
104
|
+
* The raw tabular data array. A NEW array replaces every row; passing the
|
|
105
|
+
* same array again (any re-render) does not, so rows changed through
|
|
106
|
+
* `ref.applyTransaction` stay changed.
|
|
107
|
+
*/
|
|
51
108
|
data: TRow[];
|
|
109
|
+
/**
|
|
110
|
+
* What identifies a row for `ref.applyTransaction`: a field name, or a
|
|
111
|
+
* function returning a string or number. Without it rows are matched by
|
|
112
|
+
* object identity.
|
|
113
|
+
*/
|
|
114
|
+
rowKey?: PivotControllerOptions<TRow>['rowKey'];
|
|
52
115
|
/** Initial field configuration (Uncontrolled mode). */
|
|
53
116
|
initialFields?: PivotField<TRow>[];
|
|
54
117
|
/** Controlled field configuration. If provided, component acts as controlled. */
|
|
@@ -71,6 +134,8 @@ interface BasePivotGridProps<TRow> {
|
|
|
71
134
|
};
|
|
72
135
|
/** Configuration for the toolbar visibility and features. */
|
|
73
136
|
toolbar?: PivotToolbarConfig;
|
|
137
|
+
/** Server-side pivot (Enterprise): the server aggregates; `data` is not read. */
|
|
138
|
+
serverSource?: PivotControllerOptions<TRow>['serverSource'];
|
|
74
139
|
/** The plugin registry containing custom functions and formatters. */
|
|
75
140
|
registry?: PivotEngineRegistry;
|
|
76
141
|
/** Locale for the grid (tr, en, ar). Defaults to tr. */
|
|
@@ -81,6 +146,13 @@ interface BasePivotGridProps<TRow> {
|
|
|
81
146
|
dictionary?: Partial<PivotDictionary>;
|
|
82
147
|
/** Apply zebra striping to the data rows. */
|
|
83
148
|
striped?: boolean;
|
|
149
|
+
/**
|
|
150
|
+
* Starting widths in pixels: `{ rowHeader, data }` for every row-header
|
|
151
|
+
* column and every data column. Defaults 150 and 95. A width the user drags
|
|
152
|
+
* (or `ref.setColumnWidths` writes) still wins; see
|
|
153
|
+
* `PivotControllerState.columnWidths` for its keys.
|
|
154
|
+
*/
|
|
155
|
+
defaultColumnWidths?: PivotColumnWidthDefaults;
|
|
84
156
|
/**
|
|
85
157
|
* Fired when any cell is clicked (data cells, row headers, grand totals).
|
|
86
158
|
* Replaces the deprecated onDrillDown handler.
|
|
@@ -184,6 +256,8 @@ interface PivotGridBodyProps {
|
|
|
184
256
|
onMoveField?: (id: string, direction: 'start' | 'end' | 'left' | 'right') => void;
|
|
185
257
|
onGlobalContextMenu?: (x: number, y: number) => void;
|
|
186
258
|
columnWidths?: Record<string, number>;
|
|
259
|
+
/** What a column with no `columnWidths` entry is painted at. Defaults 150 / 95. */
|
|
260
|
+
defaultColumnWidths?: PivotColumnWidthDefaults;
|
|
187
261
|
onColumnWidthsChange?: (widths: Record<string, number>) => void;
|
|
188
262
|
onSelectionStatsChange?: (stats: {
|
|
189
263
|
count: number;
|
|
@@ -200,7 +274,7 @@ interface PivotGridBodyProps {
|
|
|
200
274
|
disabled?: boolean;
|
|
201
275
|
renderNodeContextMenu?: (props: any) => React.ReactNode;
|
|
202
276
|
}
|
|
203
|
-
declare function PivotGridBody({ engineResult, isBuilding, buildProgress, rowFields, colFields: _colFields, dataFields, layout, expandedPaths, allExpanded, onToggleExpand, onExpandPaths, onCollapsePaths, expandedColPaths, allColExpanded, onToggleColExpand, onExpandColPaths, onCollapseColPaths, onCellClick, onContextMenu, onFilterClick, onRemoveField, onSort, onMoveField, onGlobalContextMenu, columnWidths, onColumnWidthsChange, onSelectionStatsChange, registry, keyboardNavigation, onCellPrepared, renderNodeContextMenu }: PivotGridBodyProps): React$1.JSX.Element;
|
|
277
|
+
declare function PivotGridBody({ engineResult, isBuilding, buildProgress, rowFields, colFields: _colFields, dataFields, layout, expandedPaths, allExpanded, onToggleExpand, onExpandPaths, onCollapsePaths, expandedColPaths, allColExpanded, onToggleColExpand, onExpandColPaths, onCollapseColPaths, onCellClick, onContextMenu, onFilterClick, onRemoveField, onSort, onMoveField, onGlobalContextMenu, columnWidths, defaultColumnWidths, onColumnWidthsChange, onSelectionStatsChange, registry, keyboardNavigation, onCellPrepared, renderNodeContextMenu }: PivotGridBodyProps): React$1.JSX.Element;
|
|
204
278
|
|
|
205
279
|
interface PivotFooterProps {
|
|
206
280
|
onToggleFieldChooser: () => void;
|
|
@@ -503,4 +577,4 @@ interface PivotThemeProviderProps {
|
|
|
503
577
|
}
|
|
504
578
|
declare function PivotThemeProvider({ theme, className, style, children }: PivotThemeProviderProps): React__default.JSX.Element;
|
|
505
579
|
|
|
506
|
-
export { BasePivotGrid, type BasePivotGridProps, type CellClickEvent, type CellPreparedEvent, type ChartSeriesDef, type ChartSyncResult, type NodeContextMenuState, PivotAreaStrips, type PivotCellTemplate, type PivotChartIntegrationOptions, type PivotConditionRule, PivotConfigProvider, PivotContextMenu, PivotErrorBoundary, type PivotField, PivotFieldList, PivotFieldSettingsDialog, PivotFooter, PivotGridBody, PivotHeaderFilterPopup, PivotImportStatusModal, PivotNodeContextMenu, type PivotNodeContextMenuProps, PivotPortal, PivotPortalContext, PivotReportMenu, PivotReportSaveModal, PivotThemeProvider, usePivotChartSync, usePivotConfig, usePivotContextMenu, usePivotController, usePivotControllerStore, usePivotDnD, usePivotFullscreen };
|
|
580
|
+
export { BasePivotGrid, type BasePivotGridProps, type CellClickEvent, type CellPreparedEvent, type ChartSeriesDef, type ChartSyncResult, type NodeContextMenuState, PivotAreaStrips, type PivotCellTemplate, type PivotChartIntegrationOptions, type PivotConditionRule, PivotConfigProvider, PivotContextMenu, PivotErrorBoundary, type PivotField, PivotFieldList, PivotFieldSettingsDialog, PivotFooter, PivotGridBody, type PivotGridRef, PivotHeaderFilterPopup, PivotImportStatusModal, PivotNodeContextMenu, type PivotNodeContextMenuProps, PivotPortal, PivotPortalContext, PivotReportMenu, PivotReportSaveModal, PivotThemeProvider, usePivotChartSync, usePivotConfig, usePivotContextMenu, usePivotController, usePivotControllerStore, usePivotDnD, usePivotFullscreen };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,11 +1,36 @@
|
|
|
1
1
|
import * as React$1 from 'react';
|
|
2
2
|
import React__default, { Component, ErrorInfo } from 'react';
|
|
3
3
|
import * as _kanunilabs_pivotgrid_core from '@kanunilabs/pivotgrid-core';
|
|
4
|
-
import { PivotField as PivotField$1, PivotCellTemplate as PivotCellTemplate$1, CellClickEvent as CellClickEvent$1, CellPreparedEvent as CellPreparedEvent$1, PivotConditionRule as PivotConditionRule$1, PivotCell, PivotEngineResult, PivotLayoutState, PivotTheme, PivotStateStoringConfig, PivotToolbarConfig, PivotEngineRegistry, PivotLocale, PivotDictionary, FieldMoveEvent, ExportingEvent,
|
|
5
|
-
export { CustomSummaryOptions, DropIntent, ExportingEvent, FieldMoveEvent, FilterCondition, FilterGroup, FilterOperator, PivotArea, PivotCell, PivotCellTextAccessor, PivotCellValueAccessor, PivotControllerCallbacks, PivotControllerOptions, PivotControllerState, PivotDataSource, PivotDictionary, PivotDragIntentState,
|
|
4
|
+
import { PivotField as PivotField$1, PivotCellTemplate as PivotCellTemplate$1, CellClickEvent as CellClickEvent$1, CellPreparedEvent as CellPreparedEvent$1, PivotGridRef as PivotGridRef$1, PivotRowTransaction, PivotTransactionResult, PivotController, PivotConditionRule as PivotConditionRule$1, PivotCell, PivotEngineResult, PivotControllerOptions, PivotLayoutState, PivotTheme, PivotStateStoringConfig, PivotToolbarConfig, PivotEngineRegistry, PivotLocale, PivotDictionary, PivotColumnWidthDefaults, FieldMoveEvent, ExportingEvent, ExportFormat, PivotReport, PivotArea, PivotNode, PivotControllerState } from '@kanunilabs/pivotgrid-core';
|
|
5
|
+
export { CustomSummaryOptions, DropIntent, ExportingEvent, FieldMoveEvent, FilterCondition, FilterGroup, FilterOperator, PivotArea, PivotCell, PivotCellTextAccessor, PivotCellValueAccessor, PivotColumnWidthDefaults, PivotControllerCallbacks, PivotControllerOptions, PivotControllerState, PivotDataSource, PivotDictionary, PivotDragIntentState, PivotGroupInterval, PivotImportStatus, PivotLayoutProfile, PivotLayoutState, PivotLocale, PivotNode, PivotPrefilter, PivotRowKey, PivotRowKeyResolver, PivotRowTransaction, PivotSelectionMode, PivotSelectionRange, PivotSelectionState, PivotSelectionStats, PivotStateStoringConfig, PivotSummaryDisplayMode, PivotSummaryType, PivotTheme, PivotToolbarConfig, PivotTransactionResult, defaultPivotLayout } from '@kanunilabs/pivotgrid-core';
|
|
6
6
|
import * as _dnd_kit_core from '@dnd-kit/core';
|
|
7
7
|
import { DragMoveEvent, DragEndEvent } from '@dnd-kit/core';
|
|
8
8
|
|
|
9
|
+
/** The imperative handle a `ref` on the grid receives. */
|
|
10
|
+
interface PivotGridRef extends PivotGridRef$1 {
|
|
11
|
+
/**
|
|
12
|
+
* Replaces the stored column widths — the same map a resize drag writes,
|
|
13
|
+
* persisted with the layout. Keys are `row-<i>` and `leaf-<i>`; see
|
|
14
|
+
* `PivotControllerState.columnWidths`. Columns left out go back to
|
|
15
|
+
* `defaultColumnWidths`, so merge with `getState().columnWidths` to change
|
|
16
|
+
* one column and keep the rest.
|
|
17
|
+
*/
|
|
18
|
+
setColumnWidths: (widths: Record<string, number>) => void;
|
|
19
|
+
/**
|
|
20
|
+
* Add, update and remove rows without rebuilding the pivot (live updates).
|
|
21
|
+
* Rows are matched by the `rowKey` prop (by object identity without it); an
|
|
22
|
+
* update for an unknown key is ignored, a remove wins over an update of the
|
|
23
|
+
* same row, adds go to the end. Returns what was applied; the recomputed
|
|
24
|
+
* pivot follows asynchronously.
|
|
25
|
+
*/
|
|
26
|
+
applyTransaction: (transaction: PivotRowTransaction<any>) => PivotTransactionResult;
|
|
27
|
+
/**
|
|
28
|
+
* The controller behind the grid — for the calls that take one, such as the
|
|
29
|
+
* Enterprise AI layout functions (`getPivotAiSchema(ref.current.getController())`).
|
|
30
|
+
* The vanilla grid hands out the same object as `api.controller`.
|
|
31
|
+
*/
|
|
32
|
+
getController: () => PivotController<any>;
|
|
33
|
+
}
|
|
9
34
|
type PivotCellTemplate = (props: Parameters<PivotCellTemplate$1>[0]) => React$1.ReactNode;
|
|
10
35
|
type PivotConditionRule = PivotConditionRule$1<React$1.CSSProperties>;
|
|
11
36
|
type PivotField<TRow = any> = PivotField$1<TRow, PivotCellTemplate, React$1.CSSProperties>;
|
|
@@ -16,6 +41,12 @@ interface PivotChartIntegrationOptions {
|
|
|
16
41
|
inverted?: boolean;
|
|
17
42
|
hideTotals?: boolean;
|
|
18
43
|
maxPoints?: number;
|
|
44
|
+
/**
|
|
45
|
+
* Most series (column paths × measures) handed to the chart; the rest are
|
|
46
|
+
* dropped and `isSeriesSampled` says so. The built-in transformer's default
|
|
47
|
+
* is 20 — one chart element per visible column leaf is otherwise unbounded.
|
|
48
|
+
*/
|
|
49
|
+
maxSeries?: number;
|
|
19
50
|
dataFieldsDisplayMode?: 'singleAxis' | 'splitAxes';
|
|
20
51
|
processCell?: (cell: PivotCell) => boolean;
|
|
21
52
|
transformer?: (engineResult: PivotEngineResult, fields: PivotField[], expandedPaths: Set<string>, locale: string, options: any) => ChartSyncResult;
|
|
@@ -25,10 +56,32 @@ interface ChartSeriesDef {
|
|
|
25
56
|
name: string;
|
|
26
57
|
color: string;
|
|
27
58
|
yAxisId?: string;
|
|
59
|
+
/**
|
|
60
|
+
* The data field this series measures — so a chart can print its values
|
|
61
|
+
* with that field's own `format`. Set by the built-in transformer.
|
|
62
|
+
*/
|
|
63
|
+
fieldId?: string;
|
|
64
|
+
/**
|
|
65
|
+
* The column path this series belongs to ('' for a pivot without column
|
|
66
|
+
* fields) and its label. Series of the same group are the same column cut
|
|
67
|
+
* of different measures — what an X-Y chart pairs as x, y and size.
|
|
68
|
+
*/
|
|
69
|
+
seriesKey?: string;
|
|
70
|
+
seriesLabel?: string;
|
|
28
71
|
}
|
|
29
72
|
interface ChartSyncResult {
|
|
30
73
|
chartData: any[];
|
|
31
74
|
chartSeries: ChartSeriesDef[];
|
|
75
|
+
/**
|
|
76
|
+
* The built-in transformer's sampling report, passed through: `maxPoints`
|
|
77
|
+
* dropped categories (`isSampled`, of `totalArgs`), `maxSeries` dropped
|
|
78
|
+
* series (`isSeriesSampled`, of `totalSeries`). Tell the reader they are
|
|
79
|
+
* looking at part of the pivot.
|
|
80
|
+
*/
|
|
81
|
+
isSampled?: boolean;
|
|
82
|
+
totalArgs?: number;
|
|
83
|
+
isSeriesSampled?: boolean;
|
|
84
|
+
totalSeries?: number;
|
|
32
85
|
}
|
|
33
86
|
declare function usePivotChartSync(engineResult: PivotEngineResult | null, fields: PivotField[], expandedPaths: Set<string>, options?: PivotChartIntegrationOptions): ChartSyncResult;
|
|
34
87
|
|
|
@@ -47,8 +100,18 @@ interface BasePivotGridProps<TRow> {
|
|
|
47
100
|
* point this at it, e.g. `/kanunilabs/pivot.worker.js`.
|
|
48
101
|
*/
|
|
49
102
|
workerUrl?: string | URL;
|
|
50
|
-
/**
|
|
103
|
+
/**
|
|
104
|
+
* The raw tabular data array. A NEW array replaces every row; passing the
|
|
105
|
+
* same array again (any re-render) does not, so rows changed through
|
|
106
|
+
* `ref.applyTransaction` stay changed.
|
|
107
|
+
*/
|
|
51
108
|
data: TRow[];
|
|
109
|
+
/**
|
|
110
|
+
* What identifies a row for `ref.applyTransaction`: a field name, or a
|
|
111
|
+
* function returning a string or number. Without it rows are matched by
|
|
112
|
+
* object identity.
|
|
113
|
+
*/
|
|
114
|
+
rowKey?: PivotControllerOptions<TRow>['rowKey'];
|
|
52
115
|
/** Initial field configuration (Uncontrolled mode). */
|
|
53
116
|
initialFields?: PivotField<TRow>[];
|
|
54
117
|
/** Controlled field configuration. If provided, component acts as controlled. */
|
|
@@ -71,6 +134,8 @@ interface BasePivotGridProps<TRow> {
|
|
|
71
134
|
};
|
|
72
135
|
/** Configuration for the toolbar visibility and features. */
|
|
73
136
|
toolbar?: PivotToolbarConfig;
|
|
137
|
+
/** Server-side pivot (Enterprise): the server aggregates; `data` is not read. */
|
|
138
|
+
serverSource?: PivotControllerOptions<TRow>['serverSource'];
|
|
74
139
|
/** The plugin registry containing custom functions and formatters. */
|
|
75
140
|
registry?: PivotEngineRegistry;
|
|
76
141
|
/** Locale for the grid (tr, en, ar). Defaults to tr. */
|
|
@@ -81,6 +146,13 @@ interface BasePivotGridProps<TRow> {
|
|
|
81
146
|
dictionary?: Partial<PivotDictionary>;
|
|
82
147
|
/** Apply zebra striping to the data rows. */
|
|
83
148
|
striped?: boolean;
|
|
149
|
+
/**
|
|
150
|
+
* Starting widths in pixels: `{ rowHeader, data }` for every row-header
|
|
151
|
+
* column and every data column. Defaults 150 and 95. A width the user drags
|
|
152
|
+
* (or `ref.setColumnWidths` writes) still wins; see
|
|
153
|
+
* `PivotControllerState.columnWidths` for its keys.
|
|
154
|
+
*/
|
|
155
|
+
defaultColumnWidths?: PivotColumnWidthDefaults;
|
|
84
156
|
/**
|
|
85
157
|
* Fired when any cell is clicked (data cells, row headers, grand totals).
|
|
86
158
|
* Replaces the deprecated onDrillDown handler.
|
|
@@ -184,6 +256,8 @@ interface PivotGridBodyProps {
|
|
|
184
256
|
onMoveField?: (id: string, direction: 'start' | 'end' | 'left' | 'right') => void;
|
|
185
257
|
onGlobalContextMenu?: (x: number, y: number) => void;
|
|
186
258
|
columnWidths?: Record<string, number>;
|
|
259
|
+
/** What a column with no `columnWidths` entry is painted at. Defaults 150 / 95. */
|
|
260
|
+
defaultColumnWidths?: PivotColumnWidthDefaults;
|
|
187
261
|
onColumnWidthsChange?: (widths: Record<string, number>) => void;
|
|
188
262
|
onSelectionStatsChange?: (stats: {
|
|
189
263
|
count: number;
|
|
@@ -200,7 +274,7 @@ interface PivotGridBodyProps {
|
|
|
200
274
|
disabled?: boolean;
|
|
201
275
|
renderNodeContextMenu?: (props: any) => React.ReactNode;
|
|
202
276
|
}
|
|
203
|
-
declare function PivotGridBody({ engineResult, isBuilding, buildProgress, rowFields, colFields: _colFields, dataFields, layout, expandedPaths, allExpanded, onToggleExpand, onExpandPaths, onCollapsePaths, expandedColPaths, allColExpanded, onToggleColExpand, onExpandColPaths, onCollapseColPaths, onCellClick, onContextMenu, onFilterClick, onRemoveField, onSort, onMoveField, onGlobalContextMenu, columnWidths, onColumnWidthsChange, onSelectionStatsChange, registry, keyboardNavigation, onCellPrepared, renderNodeContextMenu }: PivotGridBodyProps): React$1.JSX.Element;
|
|
277
|
+
declare function PivotGridBody({ engineResult, isBuilding, buildProgress, rowFields, colFields: _colFields, dataFields, layout, expandedPaths, allExpanded, onToggleExpand, onExpandPaths, onCollapsePaths, expandedColPaths, allColExpanded, onToggleColExpand, onExpandColPaths, onCollapseColPaths, onCellClick, onContextMenu, onFilterClick, onRemoveField, onSort, onMoveField, onGlobalContextMenu, columnWidths, defaultColumnWidths, onColumnWidthsChange, onSelectionStatsChange, registry, keyboardNavigation, onCellPrepared, renderNodeContextMenu }: PivotGridBodyProps): React$1.JSX.Element;
|
|
204
278
|
|
|
205
279
|
interface PivotFooterProps {
|
|
206
280
|
onToggleFieldChooser: () => void;
|
|
@@ -503,4 +577,4 @@ interface PivotThemeProviderProps {
|
|
|
503
577
|
}
|
|
504
578
|
declare function PivotThemeProvider({ theme, className, style, children }: PivotThemeProviderProps): React__default.JSX.Element;
|
|
505
579
|
|
|
506
|
-
export { BasePivotGrid, type BasePivotGridProps, type CellClickEvent, type CellPreparedEvent, type ChartSeriesDef, type ChartSyncResult, type NodeContextMenuState, PivotAreaStrips, type PivotCellTemplate, type PivotChartIntegrationOptions, type PivotConditionRule, PivotConfigProvider, PivotContextMenu, PivotErrorBoundary, type PivotField, PivotFieldList, PivotFieldSettingsDialog, PivotFooter, PivotGridBody, PivotHeaderFilterPopup, PivotImportStatusModal, PivotNodeContextMenu, type PivotNodeContextMenuProps, PivotPortal, PivotPortalContext, PivotReportMenu, PivotReportSaveModal, PivotThemeProvider, usePivotChartSync, usePivotConfig, usePivotContextMenu, usePivotController, usePivotControllerStore, usePivotDnD, usePivotFullscreen };
|
|
580
|
+
export { BasePivotGrid, type BasePivotGridProps, type CellClickEvent, type CellPreparedEvent, type ChartSeriesDef, type ChartSyncResult, type NodeContextMenuState, PivotAreaStrips, type PivotCellTemplate, type PivotChartIntegrationOptions, type PivotConditionRule, PivotConfigProvider, PivotContextMenu, PivotErrorBoundary, type PivotField, PivotFieldList, PivotFieldSettingsDialog, PivotFooter, PivotGridBody, type PivotGridRef, PivotHeaderFilterPopup, PivotImportStatusModal, PivotNodeContextMenu, type PivotNodeContextMenuProps, PivotPortal, PivotPortalContext, PivotReportMenu, PivotReportSaveModal, PivotThemeProvider, usePivotChartSync, usePivotConfig, usePivotContextMenu, usePivotController, usePivotControllerStore, usePivotDnD, usePivotFullscreen };
|