@kanunilabs/pivotgrid-core 1.11.7 → 1.11.9
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/dist/index.cjs +13 -13
- package/dist/index.d.cts +140 -4
- package/dist/index.d.ts +140 -4
- package/dist/index.js +13 -13
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -78,6 +78,11 @@ interface PivotDictionary {
|
|
|
78
78
|
loading: string;
|
|
79
79
|
emptyData: string;
|
|
80
80
|
noItems: string;
|
|
81
|
+
/**
|
|
82
|
+
* How an empty (null/undefined) row or column value reads: in the headers, the
|
|
83
|
+
* filter list, the exported headers and chart categories. '' leaves the cell
|
|
84
|
+
* empty (a list row is then named by the language's own text for screen readers).
|
|
85
|
+
*/
|
|
81
86
|
blanks: string;
|
|
82
87
|
loadingData: string;
|
|
83
88
|
fieldSettings: string;
|
|
@@ -1200,6 +1205,12 @@ interface PivotEngineResult {
|
|
|
1200
1205
|
shown: number;
|
|
1201
1206
|
total: number;
|
|
1202
1207
|
};
|
|
1208
|
+
/**
|
|
1209
|
+
* For a field grouped by its format (B.89): each member's smallest raw
|
|
1210
|
+
* value, by member text, per field id - the order the sort uses, so "9,5"
|
|
1211
|
+
* comes before "18,2". Main thread only; absent when no field groups so.
|
|
1212
|
+
*/
|
|
1213
|
+
memberOrder?: ReadonlyMap<string, ReadonlyMap<string, number>>;
|
|
1203
1214
|
}
|
|
1204
1215
|
interface FieldDistinctEntry {
|
|
1205
1216
|
rawStr: string;
|
|
@@ -1553,6 +1564,7 @@ interface ColHeaderCell {
|
|
|
1553
1564
|
declare function buildColumnHeaders(colTree: PivotNode[], dataFields: PivotField[], layout: PivotLayoutState, expandedColPaths: Set<string>, allExpanded?: boolean, labels?: {
|
|
1554
1565
|
grandTotal?: string;
|
|
1555
1566
|
subTotal?: string;
|
|
1567
|
+
blanks?: string;
|
|
1556
1568
|
}, colFieldCount?: number): ColHeaderCell[][];
|
|
1557
1569
|
/**
|
|
1558
1570
|
* Whether the pivot has the "Grand Total" row over its measure headers
|
|
@@ -1726,7 +1738,7 @@ declare function buildColPathsList(engineResult: PivotEngineResult, dataFields:
|
|
|
1726
1738
|
* does (`DateFormatter.format(value, 'grid', …)`), honoring the field's
|
|
1727
1739
|
* groupInterval. Non-date fields and total/blank cells pass through unchanged.
|
|
1728
1740
|
*/
|
|
1729
|
-
declare function formatHeaderValue(value: any, field: PivotField | undefined, locale: string): any;
|
|
1741
|
+
declare function formatHeaderValue(value: any, field: PivotField | undefined, locale: string, blanksText?: string): any;
|
|
1730
1742
|
/**
|
|
1731
1743
|
* Flatten row nodes for export, honoring `rowHeaderLayout`. In `tree` mode all
|
|
1732
1744
|
* row fields collapse into a single indented column (matching the grid's tree
|
|
@@ -1745,6 +1757,7 @@ declare function flattenExportRows(engineResult: PivotEngineResult, rowFields: P
|
|
|
1745
1757
|
*/
|
|
1746
1758
|
declare function buildRowLabelCells(flatRow: FlatRow, rowFields: PivotField[], treeMode: boolean, rowLabelCols: number, locale: string, labels?: {
|
|
1747
1759
|
subTotal?: string;
|
|
1760
|
+
blanks?: string;
|
|
1748
1761
|
}): any[];
|
|
1749
1762
|
/** Find the data field for a given column path entry. */
|
|
1750
1763
|
declare function resolveColPath(cPathInfo: string[], dataFields: PivotField[]): {
|
|
@@ -1761,6 +1774,7 @@ declare function resolveColPath(cPathInfo: string[], dataFields: PivotField[]):
|
|
|
1761
1774
|
declare function buildPivotAOA(engineResult: PivotEngineResult, rowFields: PivotField[], dataFields: PivotField[], layout: PivotLayoutState, expandedPaths: Set<string>, expandedColPaths: Set<string>, allExpanded?: boolean, locale?: string, applyFormatting?: boolean, colFields?: PivotField[], signal?: AbortSignal, onProgress?: (percent: number) => void, labels?: {
|
|
1762
1775
|
grandTotal?: string;
|
|
1763
1776
|
subTotal?: string;
|
|
1777
|
+
blanks?: string;
|
|
1764
1778
|
}): Promise<{
|
|
1765
1779
|
aoa: any[][];
|
|
1766
1780
|
styles: (ExportCellStyle | null)[][] | null;
|
|
@@ -1967,6 +1981,29 @@ interface PivotField<TRow = any, TCellTemplate = PivotCellTemplate, TStyle = any
|
|
|
1967
1981
|
calculateSummaryExpression?: string | ((cellValues: Record<string, number>) => number);
|
|
1968
1982
|
/** Intl format options or custom formatter for cell display values. */
|
|
1969
1983
|
format?: Intl.NumberFormatOptions | Intl.DateTimeFormatOptions | ((value: number) => string);
|
|
1984
|
+
/**
|
|
1985
|
+
* Group a row or column field by the text its `format` writes (Tekax B.89).
|
|
1986
|
+
* Default `false`: members are the raw values and their headers show them
|
|
1987
|
+
* raw ("18.23").
|
|
1988
|
+
*
|
|
1989
|
+
* With `true`, a number is grouped by its formatted text in the grid's
|
|
1990
|
+
* `locale` — the same text the header filter list shows — so 18.21 and 18.24
|
|
1991
|
+
* under a one-decimal format are ONE member, "18,2" in `tr-TR`, with every
|
|
1992
|
+
* measure summed over both. The header, exports, charts, `cellClick` /
|
|
1993
|
+
* `getCellRecords` (and so the drill-down), the path keys (`expandedPaths`,
|
|
1994
|
+
* `sortBySummaryPath`) and a member's `value` all carry that text. Members
|
|
1995
|
+
* sort by their smallest raw value, not alphabetically. The field's filter
|
|
1996
|
+
* stays a set of raw values (a list row ticks every raw value under it); to
|
|
1997
|
+
* filter to one member in code use `controller.memberFilterValues`.
|
|
1998
|
+
*
|
|
1999
|
+
* No effect without a `format`, with a `groupInterval` (which groups
|
|
2000
|
+
* already), on a date field, in the Values area, or with a `serverSource`:
|
|
2001
|
+
* the browser ignores it there and the server groups. Your own
|
|
2002
|
+
* `serverSource.compute` sees the flag on the field objects; the request
|
|
2003
|
+
* `pivotServerSource` sends does not carry it. Text and blank
|
|
2004
|
+
* values keep their raw key.
|
|
2005
|
+
*/
|
|
2006
|
+
groupByFormat?: boolean;
|
|
1970
2007
|
/** Conditional formatting rules evaluated per cell. */
|
|
1971
2008
|
conditionalFormatting?: PivotConditionRule<TStyle>[];
|
|
1972
2009
|
/** Custom cell render function. */
|
|
@@ -2179,6 +2216,28 @@ interface PivotLayoutState {
|
|
|
2179
2216
|
* even at the floor does the line scroll sideways. A view setting.
|
|
2180
2217
|
*/
|
|
2181
2218
|
areaChipOverflow?: 'wrap' | 'scroll' | 'shrink';
|
|
2219
|
+
/**
|
|
2220
|
+
* The search box at the top of the header filter popup (a field's value list, B.90). Default `true`. `false` leaves
|
|
2221
|
+
* the plain list: no box, no type-ahead; Select All / Clear All, the arrow keys, Space, Enter and Escape work as
|
|
2222
|
+
* before, and the rows are still grouped by their label (B.88). A view setting. The app's setting: not saved with
|
|
2223
|
+
* the state, and a restored state keeps the grid's current value.
|
|
2224
|
+
*/
|
|
2225
|
+
filterPopupSearch?: boolean;
|
|
2226
|
+
/**
|
|
2227
|
+
* Which items the View options menu (right-click on a data cell) lists (Tekax B.93). Both default
|
|
2228
|
+
* to `true`. `footer: false` leaves out "Footer bar" and `filterArea: false` leaves out "Filter area":
|
|
2229
|
+
* use it when the app decides that bar itself (`showFooter: false`) and the user must not bring it
|
|
2230
|
+
* back. With both `false` the menu does not open. It changes what the menu offers, not what the
|
|
2231
|
+
* layout is: `showFooter` and `showFilterArea` still apply, and `setLayout` can still change them.
|
|
2232
|
+
* A view setting. The app's setting: not saved with the state (`getPersistedState`, `stateStoring`,
|
|
2233
|
+
* reports), and a restored state keeps the grid's current value. While an item is left out, the
|
|
2234
|
+
* reader cannot switch that bar, so a restored state keeps the grid's current `showFooter` /
|
|
2235
|
+
* `showFilterArea` too; a listed item's saved value is restored as before.
|
|
2236
|
+
*/
|
|
2237
|
+
viewOptionsMenu?: {
|
|
2238
|
+
filterArea?: boolean;
|
|
2239
|
+
footer?: boolean;
|
|
2240
|
+
};
|
|
2182
2241
|
/** Chart integration type when rendering in chart mode. */
|
|
2183
2242
|
chartType?: string;
|
|
2184
2243
|
}
|
|
@@ -3089,6 +3148,14 @@ declare class PivotController<TRow> {
|
|
|
3089
3148
|
* An empty path is that axis's grand total. No event is fired.
|
|
3090
3149
|
*/
|
|
3091
3150
|
getCellRecords(rowPath: string[], colPath: string[]): TRow[];
|
|
3151
|
+
/**
|
|
3152
|
+
* The filter values that keep exactly one member of a row or column field:
|
|
3153
|
+
* `new Set([member])`, or, for a field grouped by its format (B.89), every
|
|
3154
|
+
* raw value whose text is `member` — a filter names raw values. For
|
|
3155
|
+
* `applyFilter(fieldId, controller.memberFilterValues(fieldId, member), 'include')`
|
|
3156
|
+
* from a chart category or a header.
|
|
3157
|
+
*/
|
|
3158
|
+
memberFilterValues(fieldId: string, member: unknown): Set<unknown>;
|
|
3092
3159
|
/**
|
|
3093
3160
|
* The fields in `area`, in order. For `'data'` this is what the ENGINE
|
|
3094
3161
|
* computes: helper fields (`helper: true`, B.21) come last, after every shown
|
|
@@ -3312,6 +3379,12 @@ declare class PivotEngineService<TRow> {
|
|
|
3312
3379
|
* filter needs a column of its own (`filterColumnId`), encoded by reconfigure.
|
|
3313
3380
|
*/
|
|
3314
3381
|
private unplacedFilteredFieldIds;
|
|
3382
|
+
/**
|
|
3383
|
+
* The row or column fields as the encoder takes them: a field grouped by its
|
|
3384
|
+
* format (B.89) is marked with the grid's locale, so its members are the
|
|
3385
|
+
* formatted texts. Every other field is passed as it is.
|
|
3386
|
+
*/
|
|
3387
|
+
private axisFields;
|
|
3315
3388
|
private createStructuralFieldsHash;
|
|
3316
3389
|
private createFieldsHash;
|
|
3317
3390
|
private createFilterHash;
|
|
@@ -3565,12 +3638,26 @@ declare function toggleHeaderFilterGroup(ticked: ReadonlySet<string>, group: {
|
|
|
3565
3638
|
}): Set<string>;
|
|
3566
3639
|
declare function formatHeaderFilterLabel(val: unknown, field: {
|
|
3567
3640
|
format?: unknown;
|
|
3568
|
-
|
|
3641
|
+
dataType?: string;
|
|
3642
|
+
groupInterval?: unknown;
|
|
3643
|
+
}, locale: string,
|
|
3644
|
+
/** What a blank reads as. Given, the engine's '(Blank)' member reads as it too (B.94); omitted, only null/undefined do. */
|
|
3645
|
+
blanksText?: string): string;
|
|
3569
3646
|
|
|
3570
3647
|
declare function executePostAggregationPhase<TRow>(engineResult: PivotEngineResult, dataFields: PivotField<TRow>[], registry?: PivotEngineRegistry): void;
|
|
3571
3648
|
declare function executeSummaryDisplayModesPhase<TRow>(engineResult: PivotEngineResult, dataFields: PivotField<TRow>[]): void;
|
|
3572
3649
|
|
|
3573
3650
|
declare function extractGroupValue<TRow>(row: TRow, field: PivotField<TRow>): PivotValue;
|
|
3651
|
+
/** True when `field` groups its members by their formatted text. */
|
|
3652
|
+
declare function groupsByFormat(field: Pick<PivotField, 'groupByFormat' | 'format' | 'groupInterval' | 'dataType'>): boolean;
|
|
3653
|
+
/** The group key of a value already read by `extractGroupValue`: the formatted text of a number, else the raw key. */
|
|
3654
|
+
declare function formattedGroupKey(value: PivotValue, field: Pick<PivotField, 'format'>, locale: string): string;
|
|
3655
|
+
/**
|
|
3656
|
+
* The key a source row sits under for a row or column field — what a path
|
|
3657
|
+
* member names. `String(extractGroupValue(row))`, or its formatted text when
|
|
3658
|
+
* the field groups by format (`locale`: the grid's).
|
|
3659
|
+
*/
|
|
3660
|
+
declare function groupKeyOf<TRow>(row: TRow, field: PivotField<TRow>, locale: string): string;
|
|
3574
3661
|
|
|
3575
3662
|
/** The key of the member path `parts` (`[]` is the root, ""). Assumes no member value starts with or contains `|`. */
|
|
3576
3663
|
declare function pathKey(parts: readonly unknown[]): string;
|
|
@@ -3604,8 +3691,20 @@ declare function withoutCollapsed(set: ReadonlySet<string>): Set<string>;
|
|
|
3604
3691
|
interface DimensionFieldInfo {
|
|
3605
3692
|
dataType?: string;
|
|
3606
3693
|
groupInterval?: DateGranularity | null;
|
|
3694
|
+
/** A date field with `Intl.DateTimeFormatOptions` here is written with them (B.95); anything else is ignored. */
|
|
3695
|
+
format?: unknown;
|
|
3607
3696
|
}
|
|
3608
|
-
|
|
3697
|
+
/** The engine's member for a missing (null/undefined) value. An internal marker: never shown to a person. */
|
|
3698
|
+
declare const BLANK_MEMBER = "(Blank)";
|
|
3699
|
+
/** Whether a member value is the blank member (or a missing value). */
|
|
3700
|
+
declare function isBlankMember(value: unknown): boolean;
|
|
3701
|
+
/** The text a blank member is shown as: the dictionary's `blanks` ('' allowed), otherwise '(Blank)'. */
|
|
3702
|
+
declare function blanksTextOf(dictionary?: {
|
|
3703
|
+
blanks?: unknown;
|
|
3704
|
+
} | null): string;
|
|
3705
|
+
declare function formatDimensionValue(value: unknown, field: DimensionFieldInfo | undefined, context: DateFormatContext, locale: string,
|
|
3706
|
+
/** B.94: what a blank member reads as on screen. Omitted, '(Blank)' is returned as before. */
|
|
3707
|
+
blanksText?: string): string;
|
|
3609
3708
|
|
|
3610
3709
|
type AnnounceKey = 'sortAsc' | 'sortDesc' | 'clearSort' | 'columnFilter';
|
|
3611
3710
|
/** The announcement for the first field whose sort or filter changed; null when none did. */
|
|
@@ -3758,6 +3857,43 @@ declare function placePopup(anchor: {
|
|
|
3758
3857
|
viewport?: PopupViewport;
|
|
3759
3858
|
}): PopupPlacement;
|
|
3760
3859
|
|
|
3860
|
+
interface ViewOptionsMenuItems {
|
|
3861
|
+
filterArea: boolean;
|
|
3862
|
+
footer: boolean;
|
|
3863
|
+
/** At least one item is listed. */
|
|
3864
|
+
any: boolean;
|
|
3865
|
+
}
|
|
3866
|
+
declare function viewOptionsMenuItems(layout: Pick<PivotLayoutState, 'viewOptionsMenu'> | undefined): ViewOptionsMenuItems;
|
|
3867
|
+
|
|
3868
|
+
/** Keep the size a user dragged this field's popup to; the next open starts there. */
|
|
3869
|
+
declare function rememberFilterPopupSize(gridId: string | undefined, fieldId: string, width: number, height: number): void;
|
|
3870
|
+
/** The kept size, or undefined. */
|
|
3871
|
+
declare function recalledFilterPopupSize(gridId: string | undefined, fieldId: string): {
|
|
3872
|
+
width: number;
|
|
3873
|
+
height: number;
|
|
3874
|
+
} | undefined;
|
|
3875
|
+
/** Forget every kept size (tests). */
|
|
3876
|
+
declare function clearFilterPopupSizes(): void;
|
|
3877
|
+
interface FilterPopupBox {
|
|
3878
|
+
left: number;
|
|
3879
|
+
top: number;
|
|
3880
|
+
width: number;
|
|
3881
|
+
height: number;
|
|
3882
|
+
minHeight: number;
|
|
3883
|
+
/** The room the popup may grow into: its edge to the visible area's edge, in px. */
|
|
3884
|
+
maxWidth: number;
|
|
3885
|
+
maxHeight: number;
|
|
3886
|
+
}
|
|
3887
|
+
declare function filterPopupBox(anchor: {
|
|
3888
|
+
x: number;
|
|
3889
|
+
y: number;
|
|
3890
|
+
}, gridId: string | undefined, fieldId: string, viewport: PopupViewport): FilterPopupBox;
|
|
3891
|
+
/** The CSS `max-height` / `max-width`: the room, lowered by the app's variables when it sets them. */
|
|
3892
|
+
declare function filterPopupLimits(box: FilterPopupBox): {
|
|
3893
|
+
maxWidth: string;
|
|
3894
|
+
maxHeight: string;
|
|
3895
|
+
};
|
|
3896
|
+
|
|
3761
3897
|
/**
|
|
3762
3898
|
* B.75 / B.76: where the resize guide line goes, in the coordinates of the positioned `host` it is a child of.
|
|
3763
3899
|
*
|
|
@@ -4189,4 +4325,4 @@ declare function rollupInMemory<TRow>(rows: readonly TRow[], request: PivotServe
|
|
|
4189
4325
|
/** Every value of a field in rows held in memory — the reference `loadFieldValues`. */
|
|
4190
4326
|
declare function fieldValuesInMemory<TRow>(rows: readonly TRow[], field: PivotServerField): unknown[];
|
|
4191
4327
|
|
|
4192
|
-
export { type AdvancedExportRequest, type AdvancedExporter, CHART_LEGEND_POSITIONS, CHART_PALETTE_NAMES, CHIP_AUTO_MAX_WIDTH, COLLAPSED_PREFIX, type CalculatedFieldTextKey, type CellClickEvent, type CellPath, type CellPreparedEvent, type ChartCategoryKeyAction, type ChartFont, type ChartFormat, type ChartGridLines, type ChartImageRequest, type ChartKeyTextKey, type ChartLabelAngle, type ChartLegendPosition, type ChartMark, type ChartPaletteName, type ChartStacking, type ChartStyle, type ChartStyleDefaults, type ColHeaderCell, type ColumnSlot, type ColumnSlotOptions, type ConditionalVisual, type CustomSummaryOptions, DEFAULT_DATA_COLUMN_WIDTH, DEFAULT_ROW_HEADER_WIDTH, type DateFormatContext, DateFormatter, type DateGranularity, type DimensionFieldInfo, type DrillDownTextKey, type DropIntent, EXCEL_MAX_COLUMN_WIDTH, EXCEL_MIN_COLUMN_WIDTH, EXCEL_WIDTH_SAMPLE_ROWS, ExcelWidthTracker, type ExportFormat, type ExportOptions, ExportStreamController, type ExportingEvent, FILTER_AREA_PADDING, FILTER_AREA_ROW_GAP, FastTrie, type FieldDistinctEntry, type FieldMoveEvent, type FilterCondition, type FilterGroup, type FilterOperator, type FlatCellMatrix, FlatPivotEngine, type FlatRow, type FloatingFrame, type FrameRect, type FrameSize, type FunnelStage, type HeaderFilterGroup, type HeaderFilterOption, type HeaderFilterState, type HeaderFilterWrite, type HistogramBin, type LargeExportInfo, MAX_C, type MarkTone, PIVOT_AI_FEATURES, PIVOT_LICENSE_TEXT, PIVOT_STATE_VERSION, type PersistedPivotFilters, type PersistedPivotState, type PivotAiApplyResult, type PivotAiCondition, type PivotAiFeature, type PivotAiFieldOptions, type PivotAiFilter, type PivotAiOptions, type PivotAiSort, type PivotAiState, type PivotAiTotals, type PivotAiValue, type PivotArea, type PivotCell, PivotCellAggregator, type PivotCellTemplate, type PivotCellTextAccessor, type PivotCellValueAccessor, type PivotChartChange, type PivotChartChangedEvent, type PivotChartClosedEvent, type PivotChartOpenedEvent, type PivotChartReportPart, type PivotChartState, type PivotChartWindowState, type PivotChipView, type PivotColumnWidthDefaults, type PivotConditionRule, PivotController, type PivotControllerCallbacks, type PivotControllerEvents, type PivotControllerOptions, type PivotControllerState, type PivotDataSource, type PivotDensity, type PivotDictionary, type PivotDragIntentState, PivotEngineRegistry, type PivotEngineResult, PivotEngineService, type PivotEngineServiceConfig, PivotEventEmitter, type PivotEventHandler, type PivotEventMap, PivotExportService, type PivotField, PivotFieldService, type PivotGridRef, type PivotGroupInterval, type PivotLabelFilter, type PivotLayoutProfile, type PivotLayoutState, type PivotLocale, type PivotNode, type PivotPlugin, type PivotPrefilter, type PivotReport, PivotReportManager, PivotReportService, type PivotReportState, type PivotRowKey, type PivotRowKeyResolver, type PivotRowSparkline, type PivotRowTransaction, type PivotSelectionMode, PivotSelectionModel, type PivotSelectionRange, type PivotSelectionState, type PivotSelectionStats, type PivotServerCell, type PivotServerField, type PivotServerInput, type PivotServerRequest, type PivotServerResponse, type PivotServerSource, type PivotServerSourceOptions, type PivotServerValue, type PivotStateListener, type PivotStateSession, PivotStateStore, type PivotStateStoringConfig, type PivotSummaryColumn, type PivotSummaryDisplayMode, type PivotSummaryTable, type PivotSummaryTableOptions, type PivotSummaryType, type PivotTheme, type PivotToolbarConfig, type PivotTransactionResult, type PivotValue, type PivotValueFilter, type PopupPlacement, type PopupViewport, type PrefilterConditionSpec, type PrefilterGroupSpec, ROW_HEADER_MAX_PINNED_FRACTION, ROW_HEADER_MIN_COL_WIDTH, ROW_HEADER_MIN_DATA_STRIP, type ReportStatePart, type RowHeaderLayout, SHAPE_CHART_TYPES, SHORT_PIVOT_HEIGHT, type ShapeChartInput, type ShapeChartType, type StackedSegment, type TreemapCell, type TrendShape, type ValueRange, type WaterfallStep, type WorkerComputeRequest, type WorkerFilterRequest, type WorkerFilterSpec, type WorkerInitRequest, type WorkerResponse, type WorkerTransactionRequest, type XYPair, type XYPairInput, applyPivotAiState, ar, attachFloatingFrame, bindPivotScrollMemory, buildCellLookup, buildColPathsList, buildColumnHeaders, buildEngineResult, buildPivotAOA, buildRowLabelCells, calculatedFieldText, cellHash, cellHashCol, cellHashRow, centredFrame, chartCategoryKey, chartKeyText, chartPalette, chartWindowFrame, clearFormatCache, collapsedKey, collapsedKeyPath, collatorFor, columnSlotOptions, compileSafeFormula, computeFieldRanges, computePivotMatrixAsync, computeRowHeaderWidths, computedFields, conditionRuleToExcelStyle, countFilteredFields, cssColorToRgb, cssZoomOf, de, defaultPivotLayout, destroyEngineWorker, diffPivotChartState, drillDownText, en, es, escapeXmlText, excelTextLength, excelValueLength, executePostAggregationPhase, executeSummaryDisplayModesPhase, exportPivotData, extractGroupValue, fieldNeedsRange, fieldValuesInMemory, filterAreaMaxHeight, filterAreaRows, filterEmptySummaryTree, filterPivotEngineAsync, filterRecords, filterRecordsAsync, flattenExportRows, flattenRowTree, flattenRowTreeTabular, flattenRowTreeTree, formatCellValue, formatCellValueCached, formatDimensionValue, formatHeaderFilterLabel, formatHeaderValue, fr, funnelMarks, funnelStages, getAdvancedExporter, getCellVal, getFieldDistinctValues, getPivotAiSchema, getPivotAiState, getRecordsForCells, getSummaryTable, getVisibleColLeaves, getVisibleColSlots, getVisibleLeafCount, getVisibleMaxDepth, grandTotalHeaderShown, grandTotalShown, groupHeaderFilterOptions, headerFilterGroupTick, headerFilterShown, headerFilterWrite, heatColor, heatTextColor, heatmapMarks, histogramBins, histogramMarks, initPivotEngineAsync, intlFormatToExcelNumFmt, invertRowHeaderWidth, isCollapsedKey, isKeyExpanded, it, ja, keepFieldGroups, keepFocusAcross, ko, logAxisTicks, measureFitWidth, mergePersistedState, nextChartWindowId, nextLiveText, paintedFontWeight, pairSeriesForXY, parseColor, pathKey, pathParts, percentAxisTicks, percentModeExcelNumFmt, percentModeText, pivotChangeAnnouncement, pivotChipView, pivotDensityClass, pivotLicenseText, pivotRowHeight, pivotRowTrend, pivotSchemeTheme, pivotServerSource, placePopup, popupViewport, pt, rangeBarMarks, rangeRatio, readChartFormat, readFrameRect, readPivotChartState, reconfigurePivotEngineAsync, registerAdvancedExporter, resizeLineX, resolveChartPalette, resolveChartStyle, resolveColPath, resolveColumnWidthDefaults, resolveConditionalVisual, rollupInMemory, rowHeaderGroupEnd, rowHeadersUnpinned, ru, scaleColor, serverRequestFor, setActiveEngineGrid, setHeaderFilterGroups, setKeysIn, shownFields, sortPivotTree, splitPersistedState, squarify, stackSeries, subtotalFor, summaryTypeLabel, sunburstMarks, testSafeFormula, toCssPixels, toggleHeaderFilterGroup, toggleKeyIn, tr, treemapMarks, trendColumnPaths, trendShape, watchShortPivot, waterfallDomain, waterfallMarks, waterfallSteps, windowStartFor, withoutCollapsed, zhCN };
|
|
4328
|
+
export { type AdvancedExportRequest, type AdvancedExporter, BLANK_MEMBER, CHART_LEGEND_POSITIONS, CHART_PALETTE_NAMES, CHIP_AUTO_MAX_WIDTH, COLLAPSED_PREFIX, type CalculatedFieldTextKey, type CellClickEvent, type CellPath, type CellPreparedEvent, type ChartCategoryKeyAction, type ChartFont, type ChartFormat, type ChartGridLines, type ChartImageRequest, type ChartKeyTextKey, type ChartLabelAngle, type ChartLegendPosition, type ChartMark, type ChartPaletteName, type ChartStacking, type ChartStyle, type ChartStyleDefaults, type ColHeaderCell, type ColumnSlot, type ColumnSlotOptions, type ConditionalVisual, type CustomSummaryOptions, DEFAULT_DATA_COLUMN_WIDTH, DEFAULT_ROW_HEADER_WIDTH, type DateFormatContext, DateFormatter, type DateGranularity, type DimensionFieldInfo, type DrillDownTextKey, type DropIntent, EXCEL_MAX_COLUMN_WIDTH, EXCEL_MIN_COLUMN_WIDTH, EXCEL_WIDTH_SAMPLE_ROWS, ExcelWidthTracker, type ExportFormat, type ExportOptions, ExportStreamController, type ExportingEvent, FILTER_AREA_PADDING, FILTER_AREA_ROW_GAP, FastTrie, type FieldDistinctEntry, type FieldMoveEvent, type FilterCondition, type FilterGroup, type FilterOperator, type FilterPopupBox, type FlatCellMatrix, FlatPivotEngine, type FlatRow, type FloatingFrame, type FrameRect, type FrameSize, type FunnelStage, type HeaderFilterGroup, type HeaderFilterOption, type HeaderFilterState, type HeaderFilterWrite, type HistogramBin, type LargeExportInfo, MAX_C, type MarkTone, PIVOT_AI_FEATURES, PIVOT_LICENSE_TEXT, PIVOT_STATE_VERSION, type PersistedPivotFilters, type PersistedPivotState, type PivotAiApplyResult, type PivotAiCondition, type PivotAiFeature, type PivotAiFieldOptions, type PivotAiFilter, type PivotAiOptions, type PivotAiSort, type PivotAiState, type PivotAiTotals, type PivotAiValue, type PivotArea, type PivotCell, PivotCellAggregator, type PivotCellTemplate, type PivotCellTextAccessor, type PivotCellValueAccessor, type PivotChartChange, type PivotChartChangedEvent, type PivotChartClosedEvent, type PivotChartOpenedEvent, type PivotChartReportPart, type PivotChartState, type PivotChartWindowState, type PivotChipView, type PivotColumnWidthDefaults, type PivotConditionRule, PivotController, type PivotControllerCallbacks, type PivotControllerEvents, type PivotControllerOptions, type PivotControllerState, type PivotDataSource, type PivotDensity, type PivotDictionary, type PivotDragIntentState, PivotEngineRegistry, type PivotEngineResult, PivotEngineService, type PivotEngineServiceConfig, PivotEventEmitter, type PivotEventHandler, type PivotEventMap, PivotExportService, type PivotField, PivotFieldService, type PivotGridRef, type PivotGroupInterval, type PivotLabelFilter, type PivotLayoutProfile, type PivotLayoutState, type PivotLocale, type PivotNode, type PivotPlugin, type PivotPrefilter, type PivotReport, PivotReportManager, PivotReportService, type PivotReportState, type PivotRowKey, type PivotRowKeyResolver, type PivotRowSparkline, type PivotRowTransaction, type PivotSelectionMode, PivotSelectionModel, type PivotSelectionRange, type PivotSelectionState, type PivotSelectionStats, type PivotServerCell, type PivotServerField, type PivotServerInput, type PivotServerRequest, type PivotServerResponse, type PivotServerSource, type PivotServerSourceOptions, type PivotServerValue, type PivotStateListener, type PivotStateSession, PivotStateStore, type PivotStateStoringConfig, type PivotSummaryColumn, type PivotSummaryDisplayMode, type PivotSummaryTable, type PivotSummaryTableOptions, type PivotSummaryType, type PivotTheme, type PivotToolbarConfig, type PivotTransactionResult, type PivotValue, type PivotValueFilter, type PopupPlacement, type PopupViewport, type PrefilterConditionSpec, type PrefilterGroupSpec, ROW_HEADER_MAX_PINNED_FRACTION, ROW_HEADER_MIN_COL_WIDTH, ROW_HEADER_MIN_DATA_STRIP, type ReportStatePart, type RowHeaderLayout, SHAPE_CHART_TYPES, SHORT_PIVOT_HEIGHT, type ShapeChartInput, type ShapeChartType, type StackedSegment, type TreemapCell, type TrendShape, type ValueRange, type ViewOptionsMenuItems, type WaterfallStep, type WorkerComputeRequest, type WorkerFilterRequest, type WorkerFilterSpec, type WorkerInitRequest, type WorkerResponse, type WorkerTransactionRequest, type XYPair, type XYPairInput, applyPivotAiState, ar, attachFloatingFrame, bindPivotScrollMemory, blanksTextOf, buildCellLookup, buildColPathsList, buildColumnHeaders, buildEngineResult, buildPivotAOA, buildRowLabelCells, calculatedFieldText, cellHash, cellHashCol, cellHashRow, centredFrame, chartCategoryKey, chartKeyText, chartPalette, chartWindowFrame, clearFilterPopupSizes, clearFormatCache, collapsedKey, collapsedKeyPath, collatorFor, columnSlotOptions, compileSafeFormula, computeFieldRanges, computePivotMatrixAsync, computeRowHeaderWidths, computedFields, conditionRuleToExcelStyle, countFilteredFields, cssColorToRgb, cssZoomOf, de, defaultPivotLayout, destroyEngineWorker, diffPivotChartState, drillDownText, en, es, escapeXmlText, excelTextLength, excelValueLength, executePostAggregationPhase, executeSummaryDisplayModesPhase, exportPivotData, extractGroupValue, fieldNeedsRange, fieldValuesInMemory, filterAreaMaxHeight, filterAreaRows, filterEmptySummaryTree, filterPivotEngineAsync, filterPopupBox, filterPopupLimits, filterRecords, filterRecordsAsync, flattenExportRows, flattenRowTree, flattenRowTreeTabular, flattenRowTreeTree, formatCellValue, formatCellValueCached, formatDimensionValue, formatHeaderFilterLabel, formatHeaderValue, formattedGroupKey, fr, funnelMarks, funnelStages, getAdvancedExporter, getCellVal, getFieldDistinctValues, getPivotAiSchema, getPivotAiState, getRecordsForCells, getSummaryTable, getVisibleColLeaves, getVisibleColSlots, getVisibleLeafCount, getVisibleMaxDepth, grandTotalHeaderShown, grandTotalShown, groupHeaderFilterOptions, groupKeyOf, groupsByFormat, headerFilterGroupTick, headerFilterShown, headerFilterWrite, heatColor, heatTextColor, heatmapMarks, histogramBins, histogramMarks, initPivotEngineAsync, intlFormatToExcelNumFmt, invertRowHeaderWidth, isBlankMember, isCollapsedKey, isKeyExpanded, it, ja, keepFieldGroups, keepFocusAcross, ko, logAxisTicks, measureFitWidth, mergePersistedState, nextChartWindowId, nextLiveText, paintedFontWeight, pairSeriesForXY, parseColor, pathKey, pathParts, percentAxisTicks, percentModeExcelNumFmt, percentModeText, pivotChangeAnnouncement, pivotChipView, pivotDensityClass, pivotLicenseText, pivotRowHeight, pivotRowTrend, pivotSchemeTheme, pivotServerSource, placePopup, popupViewport, pt, rangeBarMarks, rangeRatio, readChartFormat, readFrameRect, readPivotChartState, recalledFilterPopupSize, reconfigurePivotEngineAsync, registerAdvancedExporter, rememberFilterPopupSize, resizeLineX, resolveChartPalette, resolveChartStyle, resolveColPath, resolveColumnWidthDefaults, resolveConditionalVisual, rollupInMemory, rowHeaderGroupEnd, rowHeadersUnpinned, ru, scaleColor, serverRequestFor, setActiveEngineGrid, setHeaderFilterGroups, setKeysIn, shownFields, sortPivotTree, splitPersistedState, squarify, stackSeries, subtotalFor, summaryTypeLabel, sunburstMarks, testSafeFormula, toCssPixels, toggleHeaderFilterGroup, toggleKeyIn, tr, treemapMarks, trendColumnPaths, trendShape, viewOptionsMenuItems, watchShortPivot, waterfallDomain, waterfallMarks, waterfallSteps, windowStartFor, withoutCollapsed, zhCN };
|
package/dist/index.d.ts
CHANGED
|
@@ -78,6 +78,11 @@ interface PivotDictionary {
|
|
|
78
78
|
loading: string;
|
|
79
79
|
emptyData: string;
|
|
80
80
|
noItems: string;
|
|
81
|
+
/**
|
|
82
|
+
* How an empty (null/undefined) row or column value reads: in the headers, the
|
|
83
|
+
* filter list, the exported headers and chart categories. '' leaves the cell
|
|
84
|
+
* empty (a list row is then named by the language's own text for screen readers).
|
|
85
|
+
*/
|
|
81
86
|
blanks: string;
|
|
82
87
|
loadingData: string;
|
|
83
88
|
fieldSettings: string;
|
|
@@ -1200,6 +1205,12 @@ interface PivotEngineResult {
|
|
|
1200
1205
|
shown: number;
|
|
1201
1206
|
total: number;
|
|
1202
1207
|
};
|
|
1208
|
+
/**
|
|
1209
|
+
* For a field grouped by its format (B.89): each member's smallest raw
|
|
1210
|
+
* value, by member text, per field id - the order the sort uses, so "9,5"
|
|
1211
|
+
* comes before "18,2". Main thread only; absent when no field groups so.
|
|
1212
|
+
*/
|
|
1213
|
+
memberOrder?: ReadonlyMap<string, ReadonlyMap<string, number>>;
|
|
1203
1214
|
}
|
|
1204
1215
|
interface FieldDistinctEntry {
|
|
1205
1216
|
rawStr: string;
|
|
@@ -1553,6 +1564,7 @@ interface ColHeaderCell {
|
|
|
1553
1564
|
declare function buildColumnHeaders(colTree: PivotNode[], dataFields: PivotField[], layout: PivotLayoutState, expandedColPaths: Set<string>, allExpanded?: boolean, labels?: {
|
|
1554
1565
|
grandTotal?: string;
|
|
1555
1566
|
subTotal?: string;
|
|
1567
|
+
blanks?: string;
|
|
1556
1568
|
}, colFieldCount?: number): ColHeaderCell[][];
|
|
1557
1569
|
/**
|
|
1558
1570
|
* Whether the pivot has the "Grand Total" row over its measure headers
|
|
@@ -1726,7 +1738,7 @@ declare function buildColPathsList(engineResult: PivotEngineResult, dataFields:
|
|
|
1726
1738
|
* does (`DateFormatter.format(value, 'grid', …)`), honoring the field's
|
|
1727
1739
|
* groupInterval. Non-date fields and total/blank cells pass through unchanged.
|
|
1728
1740
|
*/
|
|
1729
|
-
declare function formatHeaderValue(value: any, field: PivotField | undefined, locale: string): any;
|
|
1741
|
+
declare function formatHeaderValue(value: any, field: PivotField | undefined, locale: string, blanksText?: string): any;
|
|
1730
1742
|
/**
|
|
1731
1743
|
* Flatten row nodes for export, honoring `rowHeaderLayout`. In `tree` mode all
|
|
1732
1744
|
* row fields collapse into a single indented column (matching the grid's tree
|
|
@@ -1745,6 +1757,7 @@ declare function flattenExportRows(engineResult: PivotEngineResult, rowFields: P
|
|
|
1745
1757
|
*/
|
|
1746
1758
|
declare function buildRowLabelCells(flatRow: FlatRow, rowFields: PivotField[], treeMode: boolean, rowLabelCols: number, locale: string, labels?: {
|
|
1747
1759
|
subTotal?: string;
|
|
1760
|
+
blanks?: string;
|
|
1748
1761
|
}): any[];
|
|
1749
1762
|
/** Find the data field for a given column path entry. */
|
|
1750
1763
|
declare function resolveColPath(cPathInfo: string[], dataFields: PivotField[]): {
|
|
@@ -1761,6 +1774,7 @@ declare function resolveColPath(cPathInfo: string[], dataFields: PivotField[]):
|
|
|
1761
1774
|
declare function buildPivotAOA(engineResult: PivotEngineResult, rowFields: PivotField[], dataFields: PivotField[], layout: PivotLayoutState, expandedPaths: Set<string>, expandedColPaths: Set<string>, allExpanded?: boolean, locale?: string, applyFormatting?: boolean, colFields?: PivotField[], signal?: AbortSignal, onProgress?: (percent: number) => void, labels?: {
|
|
1762
1775
|
grandTotal?: string;
|
|
1763
1776
|
subTotal?: string;
|
|
1777
|
+
blanks?: string;
|
|
1764
1778
|
}): Promise<{
|
|
1765
1779
|
aoa: any[][];
|
|
1766
1780
|
styles: (ExportCellStyle | null)[][] | null;
|
|
@@ -1967,6 +1981,29 @@ interface PivotField<TRow = any, TCellTemplate = PivotCellTemplate, TStyle = any
|
|
|
1967
1981
|
calculateSummaryExpression?: string | ((cellValues: Record<string, number>) => number);
|
|
1968
1982
|
/** Intl format options or custom formatter for cell display values. */
|
|
1969
1983
|
format?: Intl.NumberFormatOptions | Intl.DateTimeFormatOptions | ((value: number) => string);
|
|
1984
|
+
/**
|
|
1985
|
+
* Group a row or column field by the text its `format` writes (Tekax B.89).
|
|
1986
|
+
* Default `false`: members are the raw values and their headers show them
|
|
1987
|
+
* raw ("18.23").
|
|
1988
|
+
*
|
|
1989
|
+
* With `true`, a number is grouped by its formatted text in the grid's
|
|
1990
|
+
* `locale` — the same text the header filter list shows — so 18.21 and 18.24
|
|
1991
|
+
* under a one-decimal format are ONE member, "18,2" in `tr-TR`, with every
|
|
1992
|
+
* measure summed over both. The header, exports, charts, `cellClick` /
|
|
1993
|
+
* `getCellRecords` (and so the drill-down), the path keys (`expandedPaths`,
|
|
1994
|
+
* `sortBySummaryPath`) and a member's `value` all carry that text. Members
|
|
1995
|
+
* sort by their smallest raw value, not alphabetically. The field's filter
|
|
1996
|
+
* stays a set of raw values (a list row ticks every raw value under it); to
|
|
1997
|
+
* filter to one member in code use `controller.memberFilterValues`.
|
|
1998
|
+
*
|
|
1999
|
+
* No effect without a `format`, with a `groupInterval` (which groups
|
|
2000
|
+
* already), on a date field, in the Values area, or with a `serverSource`:
|
|
2001
|
+
* the browser ignores it there and the server groups. Your own
|
|
2002
|
+
* `serverSource.compute` sees the flag on the field objects; the request
|
|
2003
|
+
* `pivotServerSource` sends does not carry it. Text and blank
|
|
2004
|
+
* values keep their raw key.
|
|
2005
|
+
*/
|
|
2006
|
+
groupByFormat?: boolean;
|
|
1970
2007
|
/** Conditional formatting rules evaluated per cell. */
|
|
1971
2008
|
conditionalFormatting?: PivotConditionRule<TStyle>[];
|
|
1972
2009
|
/** Custom cell render function. */
|
|
@@ -2179,6 +2216,28 @@ interface PivotLayoutState {
|
|
|
2179
2216
|
* even at the floor does the line scroll sideways. A view setting.
|
|
2180
2217
|
*/
|
|
2181
2218
|
areaChipOverflow?: 'wrap' | 'scroll' | 'shrink';
|
|
2219
|
+
/**
|
|
2220
|
+
* The search box at the top of the header filter popup (a field's value list, B.90). Default `true`. `false` leaves
|
|
2221
|
+
* the plain list: no box, no type-ahead; Select All / Clear All, the arrow keys, Space, Enter and Escape work as
|
|
2222
|
+
* before, and the rows are still grouped by their label (B.88). A view setting. The app's setting: not saved with
|
|
2223
|
+
* the state, and a restored state keeps the grid's current value.
|
|
2224
|
+
*/
|
|
2225
|
+
filterPopupSearch?: boolean;
|
|
2226
|
+
/**
|
|
2227
|
+
* Which items the View options menu (right-click on a data cell) lists (Tekax B.93). Both default
|
|
2228
|
+
* to `true`. `footer: false` leaves out "Footer bar" and `filterArea: false` leaves out "Filter area":
|
|
2229
|
+
* use it when the app decides that bar itself (`showFooter: false`) and the user must not bring it
|
|
2230
|
+
* back. With both `false` the menu does not open. It changes what the menu offers, not what the
|
|
2231
|
+
* layout is: `showFooter` and `showFilterArea` still apply, and `setLayout` can still change them.
|
|
2232
|
+
* A view setting. The app's setting: not saved with the state (`getPersistedState`, `stateStoring`,
|
|
2233
|
+
* reports), and a restored state keeps the grid's current value. While an item is left out, the
|
|
2234
|
+
* reader cannot switch that bar, so a restored state keeps the grid's current `showFooter` /
|
|
2235
|
+
* `showFilterArea` too; a listed item's saved value is restored as before.
|
|
2236
|
+
*/
|
|
2237
|
+
viewOptionsMenu?: {
|
|
2238
|
+
filterArea?: boolean;
|
|
2239
|
+
footer?: boolean;
|
|
2240
|
+
};
|
|
2182
2241
|
/** Chart integration type when rendering in chart mode. */
|
|
2183
2242
|
chartType?: string;
|
|
2184
2243
|
}
|
|
@@ -3089,6 +3148,14 @@ declare class PivotController<TRow> {
|
|
|
3089
3148
|
* An empty path is that axis's grand total. No event is fired.
|
|
3090
3149
|
*/
|
|
3091
3150
|
getCellRecords(rowPath: string[], colPath: string[]): TRow[];
|
|
3151
|
+
/**
|
|
3152
|
+
* The filter values that keep exactly one member of a row or column field:
|
|
3153
|
+
* `new Set([member])`, or, for a field grouped by its format (B.89), every
|
|
3154
|
+
* raw value whose text is `member` — a filter names raw values. For
|
|
3155
|
+
* `applyFilter(fieldId, controller.memberFilterValues(fieldId, member), 'include')`
|
|
3156
|
+
* from a chart category or a header.
|
|
3157
|
+
*/
|
|
3158
|
+
memberFilterValues(fieldId: string, member: unknown): Set<unknown>;
|
|
3092
3159
|
/**
|
|
3093
3160
|
* The fields in `area`, in order. For `'data'` this is what the ENGINE
|
|
3094
3161
|
* computes: helper fields (`helper: true`, B.21) come last, after every shown
|
|
@@ -3312,6 +3379,12 @@ declare class PivotEngineService<TRow> {
|
|
|
3312
3379
|
* filter needs a column of its own (`filterColumnId`), encoded by reconfigure.
|
|
3313
3380
|
*/
|
|
3314
3381
|
private unplacedFilteredFieldIds;
|
|
3382
|
+
/**
|
|
3383
|
+
* The row or column fields as the encoder takes them: a field grouped by its
|
|
3384
|
+
* format (B.89) is marked with the grid's locale, so its members are the
|
|
3385
|
+
* formatted texts. Every other field is passed as it is.
|
|
3386
|
+
*/
|
|
3387
|
+
private axisFields;
|
|
3315
3388
|
private createStructuralFieldsHash;
|
|
3316
3389
|
private createFieldsHash;
|
|
3317
3390
|
private createFilterHash;
|
|
@@ -3565,12 +3638,26 @@ declare function toggleHeaderFilterGroup(ticked: ReadonlySet<string>, group: {
|
|
|
3565
3638
|
}): Set<string>;
|
|
3566
3639
|
declare function formatHeaderFilterLabel(val: unknown, field: {
|
|
3567
3640
|
format?: unknown;
|
|
3568
|
-
|
|
3641
|
+
dataType?: string;
|
|
3642
|
+
groupInterval?: unknown;
|
|
3643
|
+
}, locale: string,
|
|
3644
|
+
/** What a blank reads as. Given, the engine's '(Blank)' member reads as it too (B.94); omitted, only null/undefined do. */
|
|
3645
|
+
blanksText?: string): string;
|
|
3569
3646
|
|
|
3570
3647
|
declare function executePostAggregationPhase<TRow>(engineResult: PivotEngineResult, dataFields: PivotField<TRow>[], registry?: PivotEngineRegistry): void;
|
|
3571
3648
|
declare function executeSummaryDisplayModesPhase<TRow>(engineResult: PivotEngineResult, dataFields: PivotField<TRow>[]): void;
|
|
3572
3649
|
|
|
3573
3650
|
declare function extractGroupValue<TRow>(row: TRow, field: PivotField<TRow>): PivotValue;
|
|
3651
|
+
/** True when `field` groups its members by their formatted text. */
|
|
3652
|
+
declare function groupsByFormat(field: Pick<PivotField, 'groupByFormat' | 'format' | 'groupInterval' | 'dataType'>): boolean;
|
|
3653
|
+
/** The group key of a value already read by `extractGroupValue`: the formatted text of a number, else the raw key. */
|
|
3654
|
+
declare function formattedGroupKey(value: PivotValue, field: Pick<PivotField, 'format'>, locale: string): string;
|
|
3655
|
+
/**
|
|
3656
|
+
* The key a source row sits under for a row or column field — what a path
|
|
3657
|
+
* member names. `String(extractGroupValue(row))`, or its formatted text when
|
|
3658
|
+
* the field groups by format (`locale`: the grid's).
|
|
3659
|
+
*/
|
|
3660
|
+
declare function groupKeyOf<TRow>(row: TRow, field: PivotField<TRow>, locale: string): string;
|
|
3574
3661
|
|
|
3575
3662
|
/** The key of the member path `parts` (`[]` is the root, ""). Assumes no member value starts with or contains `|`. */
|
|
3576
3663
|
declare function pathKey(parts: readonly unknown[]): string;
|
|
@@ -3604,8 +3691,20 @@ declare function withoutCollapsed(set: ReadonlySet<string>): Set<string>;
|
|
|
3604
3691
|
interface DimensionFieldInfo {
|
|
3605
3692
|
dataType?: string;
|
|
3606
3693
|
groupInterval?: DateGranularity | null;
|
|
3694
|
+
/** A date field with `Intl.DateTimeFormatOptions` here is written with them (B.95); anything else is ignored. */
|
|
3695
|
+
format?: unknown;
|
|
3607
3696
|
}
|
|
3608
|
-
|
|
3697
|
+
/** The engine's member for a missing (null/undefined) value. An internal marker: never shown to a person. */
|
|
3698
|
+
declare const BLANK_MEMBER = "(Blank)";
|
|
3699
|
+
/** Whether a member value is the blank member (or a missing value). */
|
|
3700
|
+
declare function isBlankMember(value: unknown): boolean;
|
|
3701
|
+
/** The text a blank member is shown as: the dictionary's `blanks` ('' allowed), otherwise '(Blank)'. */
|
|
3702
|
+
declare function blanksTextOf(dictionary?: {
|
|
3703
|
+
blanks?: unknown;
|
|
3704
|
+
} | null): string;
|
|
3705
|
+
declare function formatDimensionValue(value: unknown, field: DimensionFieldInfo | undefined, context: DateFormatContext, locale: string,
|
|
3706
|
+
/** B.94: what a blank member reads as on screen. Omitted, '(Blank)' is returned as before. */
|
|
3707
|
+
blanksText?: string): string;
|
|
3609
3708
|
|
|
3610
3709
|
type AnnounceKey = 'sortAsc' | 'sortDesc' | 'clearSort' | 'columnFilter';
|
|
3611
3710
|
/** The announcement for the first field whose sort or filter changed; null when none did. */
|
|
@@ -3758,6 +3857,43 @@ declare function placePopup(anchor: {
|
|
|
3758
3857
|
viewport?: PopupViewport;
|
|
3759
3858
|
}): PopupPlacement;
|
|
3760
3859
|
|
|
3860
|
+
interface ViewOptionsMenuItems {
|
|
3861
|
+
filterArea: boolean;
|
|
3862
|
+
footer: boolean;
|
|
3863
|
+
/** At least one item is listed. */
|
|
3864
|
+
any: boolean;
|
|
3865
|
+
}
|
|
3866
|
+
declare function viewOptionsMenuItems(layout: Pick<PivotLayoutState, 'viewOptionsMenu'> | undefined): ViewOptionsMenuItems;
|
|
3867
|
+
|
|
3868
|
+
/** Keep the size a user dragged this field's popup to; the next open starts there. */
|
|
3869
|
+
declare function rememberFilterPopupSize(gridId: string | undefined, fieldId: string, width: number, height: number): void;
|
|
3870
|
+
/** The kept size, or undefined. */
|
|
3871
|
+
declare function recalledFilterPopupSize(gridId: string | undefined, fieldId: string): {
|
|
3872
|
+
width: number;
|
|
3873
|
+
height: number;
|
|
3874
|
+
} | undefined;
|
|
3875
|
+
/** Forget every kept size (tests). */
|
|
3876
|
+
declare function clearFilterPopupSizes(): void;
|
|
3877
|
+
interface FilterPopupBox {
|
|
3878
|
+
left: number;
|
|
3879
|
+
top: number;
|
|
3880
|
+
width: number;
|
|
3881
|
+
height: number;
|
|
3882
|
+
minHeight: number;
|
|
3883
|
+
/** The room the popup may grow into: its edge to the visible area's edge, in px. */
|
|
3884
|
+
maxWidth: number;
|
|
3885
|
+
maxHeight: number;
|
|
3886
|
+
}
|
|
3887
|
+
declare function filterPopupBox(anchor: {
|
|
3888
|
+
x: number;
|
|
3889
|
+
y: number;
|
|
3890
|
+
}, gridId: string | undefined, fieldId: string, viewport: PopupViewport): FilterPopupBox;
|
|
3891
|
+
/** The CSS `max-height` / `max-width`: the room, lowered by the app's variables when it sets them. */
|
|
3892
|
+
declare function filterPopupLimits(box: FilterPopupBox): {
|
|
3893
|
+
maxWidth: string;
|
|
3894
|
+
maxHeight: string;
|
|
3895
|
+
};
|
|
3896
|
+
|
|
3761
3897
|
/**
|
|
3762
3898
|
* B.75 / B.76: where the resize guide line goes, in the coordinates of the positioned `host` it is a child of.
|
|
3763
3899
|
*
|
|
@@ -4189,4 +4325,4 @@ declare function rollupInMemory<TRow>(rows: readonly TRow[], request: PivotServe
|
|
|
4189
4325
|
/** Every value of a field in rows held in memory — the reference `loadFieldValues`. */
|
|
4190
4326
|
declare function fieldValuesInMemory<TRow>(rows: readonly TRow[], field: PivotServerField): unknown[];
|
|
4191
4327
|
|
|
4192
|
-
export { type AdvancedExportRequest, type AdvancedExporter, CHART_LEGEND_POSITIONS, CHART_PALETTE_NAMES, CHIP_AUTO_MAX_WIDTH, COLLAPSED_PREFIX, type CalculatedFieldTextKey, type CellClickEvent, type CellPath, type CellPreparedEvent, type ChartCategoryKeyAction, type ChartFont, type ChartFormat, type ChartGridLines, type ChartImageRequest, type ChartKeyTextKey, type ChartLabelAngle, type ChartLegendPosition, type ChartMark, type ChartPaletteName, type ChartStacking, type ChartStyle, type ChartStyleDefaults, type ColHeaderCell, type ColumnSlot, type ColumnSlotOptions, type ConditionalVisual, type CustomSummaryOptions, DEFAULT_DATA_COLUMN_WIDTH, DEFAULT_ROW_HEADER_WIDTH, type DateFormatContext, DateFormatter, type DateGranularity, type DimensionFieldInfo, type DrillDownTextKey, type DropIntent, EXCEL_MAX_COLUMN_WIDTH, EXCEL_MIN_COLUMN_WIDTH, EXCEL_WIDTH_SAMPLE_ROWS, ExcelWidthTracker, type ExportFormat, type ExportOptions, ExportStreamController, type ExportingEvent, FILTER_AREA_PADDING, FILTER_AREA_ROW_GAP, FastTrie, type FieldDistinctEntry, type FieldMoveEvent, type FilterCondition, type FilterGroup, type FilterOperator, type FlatCellMatrix, FlatPivotEngine, type FlatRow, type FloatingFrame, type FrameRect, type FrameSize, type FunnelStage, type HeaderFilterGroup, type HeaderFilterOption, type HeaderFilterState, type HeaderFilterWrite, type HistogramBin, type LargeExportInfo, MAX_C, type MarkTone, PIVOT_AI_FEATURES, PIVOT_LICENSE_TEXT, PIVOT_STATE_VERSION, type PersistedPivotFilters, type PersistedPivotState, type PivotAiApplyResult, type PivotAiCondition, type PivotAiFeature, type PivotAiFieldOptions, type PivotAiFilter, type PivotAiOptions, type PivotAiSort, type PivotAiState, type PivotAiTotals, type PivotAiValue, type PivotArea, type PivotCell, PivotCellAggregator, type PivotCellTemplate, type PivotCellTextAccessor, type PivotCellValueAccessor, type PivotChartChange, type PivotChartChangedEvent, type PivotChartClosedEvent, type PivotChartOpenedEvent, type PivotChartReportPart, type PivotChartState, type PivotChartWindowState, type PivotChipView, type PivotColumnWidthDefaults, type PivotConditionRule, PivotController, type PivotControllerCallbacks, type PivotControllerEvents, type PivotControllerOptions, type PivotControllerState, type PivotDataSource, type PivotDensity, type PivotDictionary, type PivotDragIntentState, PivotEngineRegistry, type PivotEngineResult, PivotEngineService, type PivotEngineServiceConfig, PivotEventEmitter, type PivotEventHandler, type PivotEventMap, PivotExportService, type PivotField, PivotFieldService, type PivotGridRef, type PivotGroupInterval, type PivotLabelFilter, type PivotLayoutProfile, type PivotLayoutState, type PivotLocale, type PivotNode, type PivotPlugin, type PivotPrefilter, type PivotReport, PivotReportManager, PivotReportService, type PivotReportState, type PivotRowKey, type PivotRowKeyResolver, type PivotRowSparkline, type PivotRowTransaction, type PivotSelectionMode, PivotSelectionModel, type PivotSelectionRange, type PivotSelectionState, type PivotSelectionStats, type PivotServerCell, type PivotServerField, type PivotServerInput, type PivotServerRequest, type PivotServerResponse, type PivotServerSource, type PivotServerSourceOptions, type PivotServerValue, type PivotStateListener, type PivotStateSession, PivotStateStore, type PivotStateStoringConfig, type PivotSummaryColumn, type PivotSummaryDisplayMode, type PivotSummaryTable, type PivotSummaryTableOptions, type PivotSummaryType, type PivotTheme, type PivotToolbarConfig, type PivotTransactionResult, type PivotValue, type PivotValueFilter, type PopupPlacement, type PopupViewport, type PrefilterConditionSpec, type PrefilterGroupSpec, ROW_HEADER_MAX_PINNED_FRACTION, ROW_HEADER_MIN_COL_WIDTH, ROW_HEADER_MIN_DATA_STRIP, type ReportStatePart, type RowHeaderLayout, SHAPE_CHART_TYPES, SHORT_PIVOT_HEIGHT, type ShapeChartInput, type ShapeChartType, type StackedSegment, type TreemapCell, type TrendShape, type ValueRange, type WaterfallStep, type WorkerComputeRequest, type WorkerFilterRequest, type WorkerFilterSpec, type WorkerInitRequest, type WorkerResponse, type WorkerTransactionRequest, type XYPair, type XYPairInput, applyPivotAiState, ar, attachFloatingFrame, bindPivotScrollMemory, buildCellLookup, buildColPathsList, buildColumnHeaders, buildEngineResult, buildPivotAOA, buildRowLabelCells, calculatedFieldText, cellHash, cellHashCol, cellHashRow, centredFrame, chartCategoryKey, chartKeyText, chartPalette, chartWindowFrame, clearFormatCache, collapsedKey, collapsedKeyPath, collatorFor, columnSlotOptions, compileSafeFormula, computeFieldRanges, computePivotMatrixAsync, computeRowHeaderWidths, computedFields, conditionRuleToExcelStyle, countFilteredFields, cssColorToRgb, cssZoomOf, de, defaultPivotLayout, destroyEngineWorker, diffPivotChartState, drillDownText, en, es, escapeXmlText, excelTextLength, excelValueLength, executePostAggregationPhase, executeSummaryDisplayModesPhase, exportPivotData, extractGroupValue, fieldNeedsRange, fieldValuesInMemory, filterAreaMaxHeight, filterAreaRows, filterEmptySummaryTree, filterPivotEngineAsync, filterRecords, filterRecordsAsync, flattenExportRows, flattenRowTree, flattenRowTreeTabular, flattenRowTreeTree, formatCellValue, formatCellValueCached, formatDimensionValue, formatHeaderFilterLabel, formatHeaderValue, fr, funnelMarks, funnelStages, getAdvancedExporter, getCellVal, getFieldDistinctValues, getPivotAiSchema, getPivotAiState, getRecordsForCells, getSummaryTable, getVisibleColLeaves, getVisibleColSlots, getVisibleLeafCount, getVisibleMaxDepth, grandTotalHeaderShown, grandTotalShown, groupHeaderFilterOptions, headerFilterGroupTick, headerFilterShown, headerFilterWrite, heatColor, heatTextColor, heatmapMarks, histogramBins, histogramMarks, initPivotEngineAsync, intlFormatToExcelNumFmt, invertRowHeaderWidth, isCollapsedKey, isKeyExpanded, it, ja, keepFieldGroups, keepFocusAcross, ko, logAxisTicks, measureFitWidth, mergePersistedState, nextChartWindowId, nextLiveText, paintedFontWeight, pairSeriesForXY, parseColor, pathKey, pathParts, percentAxisTicks, percentModeExcelNumFmt, percentModeText, pivotChangeAnnouncement, pivotChipView, pivotDensityClass, pivotLicenseText, pivotRowHeight, pivotRowTrend, pivotSchemeTheme, pivotServerSource, placePopup, popupViewport, pt, rangeBarMarks, rangeRatio, readChartFormat, readFrameRect, readPivotChartState, reconfigurePivotEngineAsync, registerAdvancedExporter, resizeLineX, resolveChartPalette, resolveChartStyle, resolveColPath, resolveColumnWidthDefaults, resolveConditionalVisual, rollupInMemory, rowHeaderGroupEnd, rowHeadersUnpinned, ru, scaleColor, serverRequestFor, setActiveEngineGrid, setHeaderFilterGroups, setKeysIn, shownFields, sortPivotTree, splitPersistedState, squarify, stackSeries, subtotalFor, summaryTypeLabel, sunburstMarks, testSafeFormula, toCssPixels, toggleHeaderFilterGroup, toggleKeyIn, tr, treemapMarks, trendColumnPaths, trendShape, watchShortPivot, waterfallDomain, waterfallMarks, waterfallSteps, windowStartFor, withoutCollapsed, zhCN };
|
|
4328
|
+
export { type AdvancedExportRequest, type AdvancedExporter, BLANK_MEMBER, CHART_LEGEND_POSITIONS, CHART_PALETTE_NAMES, CHIP_AUTO_MAX_WIDTH, COLLAPSED_PREFIX, type CalculatedFieldTextKey, type CellClickEvent, type CellPath, type CellPreparedEvent, type ChartCategoryKeyAction, type ChartFont, type ChartFormat, type ChartGridLines, type ChartImageRequest, type ChartKeyTextKey, type ChartLabelAngle, type ChartLegendPosition, type ChartMark, type ChartPaletteName, type ChartStacking, type ChartStyle, type ChartStyleDefaults, type ColHeaderCell, type ColumnSlot, type ColumnSlotOptions, type ConditionalVisual, type CustomSummaryOptions, DEFAULT_DATA_COLUMN_WIDTH, DEFAULT_ROW_HEADER_WIDTH, type DateFormatContext, DateFormatter, type DateGranularity, type DimensionFieldInfo, type DrillDownTextKey, type DropIntent, EXCEL_MAX_COLUMN_WIDTH, EXCEL_MIN_COLUMN_WIDTH, EXCEL_WIDTH_SAMPLE_ROWS, ExcelWidthTracker, type ExportFormat, type ExportOptions, ExportStreamController, type ExportingEvent, FILTER_AREA_PADDING, FILTER_AREA_ROW_GAP, FastTrie, type FieldDistinctEntry, type FieldMoveEvent, type FilterCondition, type FilterGroup, type FilterOperator, type FilterPopupBox, type FlatCellMatrix, FlatPivotEngine, type FlatRow, type FloatingFrame, type FrameRect, type FrameSize, type FunnelStage, type HeaderFilterGroup, type HeaderFilterOption, type HeaderFilterState, type HeaderFilterWrite, type HistogramBin, type LargeExportInfo, MAX_C, type MarkTone, PIVOT_AI_FEATURES, PIVOT_LICENSE_TEXT, PIVOT_STATE_VERSION, type PersistedPivotFilters, type PersistedPivotState, type PivotAiApplyResult, type PivotAiCondition, type PivotAiFeature, type PivotAiFieldOptions, type PivotAiFilter, type PivotAiOptions, type PivotAiSort, type PivotAiState, type PivotAiTotals, type PivotAiValue, type PivotArea, type PivotCell, PivotCellAggregator, type PivotCellTemplate, type PivotCellTextAccessor, type PivotCellValueAccessor, type PivotChartChange, type PivotChartChangedEvent, type PivotChartClosedEvent, type PivotChartOpenedEvent, type PivotChartReportPart, type PivotChartState, type PivotChartWindowState, type PivotChipView, type PivotColumnWidthDefaults, type PivotConditionRule, PivotController, type PivotControllerCallbacks, type PivotControllerEvents, type PivotControllerOptions, type PivotControllerState, type PivotDataSource, type PivotDensity, type PivotDictionary, type PivotDragIntentState, PivotEngineRegistry, type PivotEngineResult, PivotEngineService, type PivotEngineServiceConfig, PivotEventEmitter, type PivotEventHandler, type PivotEventMap, PivotExportService, type PivotField, PivotFieldService, type PivotGridRef, type PivotGroupInterval, type PivotLabelFilter, type PivotLayoutProfile, type PivotLayoutState, type PivotLocale, type PivotNode, type PivotPlugin, type PivotPrefilter, type PivotReport, PivotReportManager, PivotReportService, type PivotReportState, type PivotRowKey, type PivotRowKeyResolver, type PivotRowSparkline, type PivotRowTransaction, type PivotSelectionMode, PivotSelectionModel, type PivotSelectionRange, type PivotSelectionState, type PivotSelectionStats, type PivotServerCell, type PivotServerField, type PivotServerInput, type PivotServerRequest, type PivotServerResponse, type PivotServerSource, type PivotServerSourceOptions, type PivotServerValue, type PivotStateListener, type PivotStateSession, PivotStateStore, type PivotStateStoringConfig, type PivotSummaryColumn, type PivotSummaryDisplayMode, type PivotSummaryTable, type PivotSummaryTableOptions, type PivotSummaryType, type PivotTheme, type PivotToolbarConfig, type PivotTransactionResult, type PivotValue, type PivotValueFilter, type PopupPlacement, type PopupViewport, type PrefilterConditionSpec, type PrefilterGroupSpec, ROW_HEADER_MAX_PINNED_FRACTION, ROW_HEADER_MIN_COL_WIDTH, ROW_HEADER_MIN_DATA_STRIP, type ReportStatePart, type RowHeaderLayout, SHAPE_CHART_TYPES, SHORT_PIVOT_HEIGHT, type ShapeChartInput, type ShapeChartType, type StackedSegment, type TreemapCell, type TrendShape, type ValueRange, type ViewOptionsMenuItems, type WaterfallStep, type WorkerComputeRequest, type WorkerFilterRequest, type WorkerFilterSpec, type WorkerInitRequest, type WorkerResponse, type WorkerTransactionRequest, type XYPair, type XYPairInput, applyPivotAiState, ar, attachFloatingFrame, bindPivotScrollMemory, blanksTextOf, buildCellLookup, buildColPathsList, buildColumnHeaders, buildEngineResult, buildPivotAOA, buildRowLabelCells, calculatedFieldText, cellHash, cellHashCol, cellHashRow, centredFrame, chartCategoryKey, chartKeyText, chartPalette, chartWindowFrame, clearFilterPopupSizes, clearFormatCache, collapsedKey, collapsedKeyPath, collatorFor, columnSlotOptions, compileSafeFormula, computeFieldRanges, computePivotMatrixAsync, computeRowHeaderWidths, computedFields, conditionRuleToExcelStyle, countFilteredFields, cssColorToRgb, cssZoomOf, de, defaultPivotLayout, destroyEngineWorker, diffPivotChartState, drillDownText, en, es, escapeXmlText, excelTextLength, excelValueLength, executePostAggregationPhase, executeSummaryDisplayModesPhase, exportPivotData, extractGroupValue, fieldNeedsRange, fieldValuesInMemory, filterAreaMaxHeight, filterAreaRows, filterEmptySummaryTree, filterPivotEngineAsync, filterPopupBox, filterPopupLimits, filterRecords, filterRecordsAsync, flattenExportRows, flattenRowTree, flattenRowTreeTabular, flattenRowTreeTree, formatCellValue, formatCellValueCached, formatDimensionValue, formatHeaderFilterLabel, formatHeaderValue, formattedGroupKey, fr, funnelMarks, funnelStages, getAdvancedExporter, getCellVal, getFieldDistinctValues, getPivotAiSchema, getPivotAiState, getRecordsForCells, getSummaryTable, getVisibleColLeaves, getVisibleColSlots, getVisibleLeafCount, getVisibleMaxDepth, grandTotalHeaderShown, grandTotalShown, groupHeaderFilterOptions, groupKeyOf, groupsByFormat, headerFilterGroupTick, headerFilterShown, headerFilterWrite, heatColor, heatTextColor, heatmapMarks, histogramBins, histogramMarks, initPivotEngineAsync, intlFormatToExcelNumFmt, invertRowHeaderWidth, isBlankMember, isCollapsedKey, isKeyExpanded, it, ja, keepFieldGroups, keepFocusAcross, ko, logAxisTicks, measureFitWidth, mergePersistedState, nextChartWindowId, nextLiveText, paintedFontWeight, pairSeriesForXY, parseColor, pathKey, pathParts, percentAxisTicks, percentModeExcelNumFmt, percentModeText, pivotChangeAnnouncement, pivotChipView, pivotDensityClass, pivotLicenseText, pivotRowHeight, pivotRowTrend, pivotSchemeTheme, pivotServerSource, placePopup, popupViewport, pt, rangeBarMarks, rangeRatio, readChartFormat, readFrameRect, readPivotChartState, recalledFilterPopupSize, reconfigurePivotEngineAsync, registerAdvancedExporter, rememberFilterPopupSize, resizeLineX, resolveChartPalette, resolveChartStyle, resolveColPath, resolveColumnWidthDefaults, resolveConditionalVisual, rollupInMemory, rowHeaderGroupEnd, rowHeadersUnpinned, ru, scaleColor, serverRequestFor, setActiveEngineGrid, setHeaderFilterGroups, setKeysIn, shownFields, sortPivotTree, splitPersistedState, squarify, stackSeries, subtotalFor, summaryTypeLabel, sunburstMarks, testSafeFormula, toCssPixels, toggleHeaderFilterGroup, toggleKeyIn, tr, treemapMarks, trendColumnPaths, trendShape, viewOptionsMenuItems, watchShortPivot, waterfallDomain, waterfallMarks, waterfallSteps, windowStartFor, withoutCollapsed, zhCN };
|