@canvas-components/pivot-table 0.2.2 → 0.2.3

package/dist/index.d.cts

@@ -261,6 +261,18 @@ type PivotAggregatorRegistry<RecordType = Record<string, unknown>> = Record<stri
 /** 第一阶段内置聚合器名称。 */
 type BuiltInPivotAggregatorName = "sum" | "avg" | "count" | "distinctCount" | "min" | "max";
 
+/** 透视表指标的快捷数据显示格式。 */
+type PivotIndicatorDataFormatType = "default" | "text" | "number" | "thousands" | "decimal" | "percent" | "percentDecimal" | "scientific" | "numberToChineseUpper" | "chineseUpperToNumber" | "cny" | "cnyDecimal" | "usd" | "usdDecimal" | "dateSlash" | "dateDash" | "dateFullCN" | "time" | "timeShort" | "datetime" | "datetime12" | "custom";
+/** 透视表指标的精确数据显示格式配置。 */
+interface PivotIndicatorDataFormatOptions {
+    type: PivotIndicatorDataFormatType;
+    decimalPlaces?: number;
+    useGrouping?: boolean;
+    symbol?: string;
+    pattern?: string;
+}
+/** 透视表指标数据显示格式。 */
+type PivotIndicatorDataFormat = PivotIndicatorDataFormatType | PivotIndicatorDataFormatOptions;
 /** 指标格式化上下文。 */
 interface PivotIndicatorFormatContext<RecordType> {
     indicator: PivotIndicator<RecordType>;
@@ -284,6 +296,8 @@ interface PivotIndicator<RecordType = Record<string, unknown>> {
     formatter?: (value: unknown, context: PivotIndicatorFormatContext<RecordType>) => string;
     /** 数字精度。 */
     precision?: number;
+    /** 指标数据显示格式。 */
+    dataFormat?: PivotIndicatorDataFormat;
     /** 指标列宽。 */
     width?: number;
     /** 指标对齐方式。 */
@@ -383,11 +397,18 @@ interface PivotTooltipRequest {
 interface PivotLoadingRequest {
     text?: string;
 }
-/** PivotTable 值区右键菜单请求。 */
+/** 透视表密度，与 ListTable 右键菜单语义保持一致。 */
+type PivotTableDensity = "comfortable" | "middle" | "compact" | "ultra-compact" | "auto";
+/** PivotTable 右键菜单请求。 */
 interface PivotContextMenuRequest {
     x: number;
     y: number;
-    recordCount: number;
+    target?: "header" | "body" | "summary";
+    title?: string;
+    axis?: PivotFilterAxis;
+    nodeKind?: PivotNodeKind | "empty";
+    indicatorKey?: string;
+    recordCount?: number;
     onCopy: () => void;
     onCopySelection?: () => void;
     customSelection?: {
@@ -406,6 +427,24 @@ interface PivotContextMenuRequest {
     }) => void;
     onExportCsv: () => void;
     onExportXlsx: () => void;
+    sortDirection?: "asc" | "desc" | null;
+    onSortAsc?: () => void;
+    onSortDesc?: () => void;
+    onClearSort?: () => void;
+    onOpenFilter?: () => void;
+    expanded?: boolean;
+    onExpand?: () => void;
+    onCollapse?: () => void;
+    onExpandAll?: () => void;
+    onCollapseAll?: () => void;
+    summaryAggregator?: BuiltInPivotAggregatorName;
+    summaryPrecision?: number;
+    onChangeSummaryAggregator?: (aggregator: BuiltInPivotAggregatorName) => void;
+    onChangeSummaryPrecision?: (precision: number | undefined) => void;
+    density?: PivotTableDensity;
+    onChangeDensity?: (density: PivotTableDensity) => void;
+    dataFormat?: PivotIndicatorDataFormat;
+    onChangeDataFormat?: (dataFormat: PivotIndicatorDataFormat) => void;
     onClose: () => void;
 }
 /** PivotTable UI 适配协议。 */
@@ -866,6 +905,9 @@ declare class PivotTable<RecordType = Record<string, unknown>> {
     restoreState(snapshot: PivotTableStateSnapshot): boolean;
     /** 选中指定值单元格。 */
     selectCell(address: PivotCellAddress, extend?: boolean): PivotSelectionState | null;
+    /** 鼠标命中的单元格已在视口内，选中时不再校正滚动位置。 */
+    private selectPointerCell;
+    private commitCellSelection;
     /** 选中行轴或列轴维度节点。 */
     selectNode(axis: PivotAxis, nodeId: string): PivotSelectionState | null;
     /** 将指定稳定地址滚动到可视区域。 */
@@ -905,6 +947,7 @@ declare class PivotTable<RecordType = Record<string, unknown>> {
     private stopWheelScrollSmoothing;
     private advanceWheelScrollSmoothing;
     private readonly handleContextMenu;
+    private createContextMenuSettings;
     private updateTooltip;
     private readonly handlePointerDown;
     private readonly handlePointerUp;
@@ -1229,4 +1272,4 @@ declare function flattenVisiblePivotLeaves(params: {
     defaultExpandDepth?: number;
 }): PivotNode[];
 
-export { type BuiltInPivotAggregatorName, type PivotAggregateCell, type PivotAggregator, type PivotAggregatorContext, type PivotAggregatorRegistry, type PivotAxis, type PivotAxisScrollbarLayout, type PivotAxisSlot, type PivotBodyCellLayout, type PivotCellAddress, type PivotCellStyle, type PivotContextMenuRequest, type PivotDataIndex, type PivotDimension, type PivotDimensionFilter, type PivotDimensionFilterOption, type PivotDimensionFilterPanelRequest, type PivotDimensionHeaderContent, type PivotDimensionHeaderImageContent, type PivotDimensionHeaderTextContent, type PivotDimensionTitle, type PivotDimensionValue, type PivotExpansionChangeEvent, type PivotExportMatrix, type PivotExportOptions, type PivotField, type PivotFieldArea, type PivotFieldLayout, type PivotFilterAxis, type PivotFilterChangeEvent, type PivotFilterCondition, type PivotFilterConditionOperator, type PivotFilterOptionItem, type PivotFilterState, type PivotGrandTotalPosition, type PivotHeaderCellLayout, type PivotHighlightMode, type PivotHitRegion, type PivotHitTestResult, type PivotIndicator, type PivotIndicatorFormatContext, type PivotLayoutSnapshot, type PivotLoadingRequest, type PivotModel, type PivotNode, type PivotNodeKind, type PivotRect, type PivotRenderStats, type PivotReportFilterCellLayout, type PivotResizeHit, type PivotResolvedPath, type PivotScrollState, type PivotScrollbarAxis, type PivotScrollbarLayout, type PivotScrollbarRect, type PivotScrollbarRole, type PivotSelectionChangeEvent, type PivotSelectionRange, type PivotSelectionState, type PivotSortChangeEvent, type PivotSortRule, type PivotSubtotalPosition, PivotTable, type PivotTableOptions, type PivotTableStateSnapshot, type PivotTableTheme, type PivotTableUiOptions, type PivotTextAlign, type PivotTooltipRequest, type PivotTotalsOptions, type ResolvedPivotDimensionValue, aggregatePivotRecords, buildPivotDimensionTree, buildPivotLayoutSnapshot, clearPivotFieldLayout, computePivotScrollbarLayout, createBuiltInPivotAggregators, createEmptyPivotFieldLayout, createEmptyPivotFilterState, createPivotAggregatorRegistry, createPivotAxisSlots, createPivotCellKey, createPivotExportMatrix, createPivotFieldCatalog, createPivotFieldLayout, createPivotSelectionText, defaultPivotTableTheme, encodePivotDimensionValue, encodePivotPath, exportPivotMatrixToCsv, exportPivotMatrixToXlsx, filterPivotRecords, findPivotFieldArea, flattenVisiblePivotLeaves, getPivotDimensionFilterOptions, hitTestPivotLayout, hitTestPivotResize, hitTestPivotScrollbar, loadPivotFieldLayout, movePivotField, removePivotField, renderPivotTable, resolvePivotDefaultSorts, resolvePivotDimensionKey, resolvePivotDimensionTitle, resolvePivotDimensionValue, resolvePivotDimensionWidth, resolvePivotFieldLayoutOptions, resolvePivotIndicatorAggregator, resolvePivotValueFieldTitle, savePivotFieldLayout };
+export { type BuiltInPivotAggregatorName, type PivotAggregateCell, type PivotAggregator, type PivotAggregatorContext, type PivotAggregatorRegistry, type PivotAxis, type PivotAxisScrollbarLayout, type PivotAxisSlot, type PivotBodyCellLayout, type PivotCellAddress, type PivotCellStyle, type PivotContextMenuRequest, type PivotDataIndex, type PivotDimension, type PivotDimensionFilter, type PivotDimensionFilterOption, type PivotDimensionFilterPanelRequest, type PivotDimensionHeaderContent, type PivotDimensionHeaderImageContent, type PivotDimensionHeaderTextContent, type PivotDimensionTitle, type PivotDimensionValue, type PivotExpansionChangeEvent, type PivotExportMatrix, type PivotExportOptions, type PivotField, type PivotFieldArea, type PivotFieldLayout, type PivotFilterAxis, type PivotFilterChangeEvent, type PivotFilterCondition, type PivotFilterConditionOperator, type PivotFilterOptionItem, type PivotFilterState, type PivotGrandTotalPosition, type PivotHeaderCellLayout, type PivotHighlightMode, type PivotHitRegion, type PivotHitTestResult, type PivotIndicator, type PivotIndicatorDataFormat, type PivotIndicatorDataFormatOptions, type PivotIndicatorDataFormatType, type PivotIndicatorFormatContext, type PivotLayoutSnapshot, type PivotLoadingRequest, type PivotModel, type PivotNode, type PivotNodeKind, type PivotRect, type PivotRenderStats, type PivotReportFilterCellLayout, type PivotResizeHit, type PivotResolvedPath, type PivotScrollState, type PivotScrollbarAxis, type PivotScrollbarLayout, type PivotScrollbarRect, type PivotScrollbarRole, type PivotSelectionChangeEvent, type PivotSelectionRange, type PivotSelectionState, type PivotSortChangeEvent, type PivotSortRule, type PivotSubtotalPosition, PivotTable, type PivotTableDensity, type PivotTableOptions, type PivotTableStateSnapshot, type PivotTableTheme, type PivotTableUiOptions, type PivotTextAlign, type PivotTooltipRequest, type PivotTotalsOptions, type ResolvedPivotDimensionValue, aggregatePivotRecords, buildPivotDimensionTree, buildPivotLayoutSnapshot, clearPivotFieldLayout, computePivotScrollbarLayout, createBuiltInPivotAggregators, createEmptyPivotFieldLayout, createEmptyPivotFilterState, createPivotAggregatorRegistry, createPivotAxisSlots, createPivotCellKey, createPivotExportMatrix, createPivotFieldCatalog, createPivotFieldLayout, createPivotSelectionText, defaultPivotTableTheme, encodePivotDimensionValue, encodePivotPath, exportPivotMatrixToCsv, exportPivotMatrixToXlsx, filterPivotRecords, findPivotFieldArea, flattenVisiblePivotLeaves, getPivotDimensionFilterOptions, hitTestPivotLayout, hitTestPivotResize, hitTestPivotScrollbar, loadPivotFieldLayout, movePivotField, removePivotField, renderPivotTable, resolvePivotDefaultSorts, resolvePivotDimensionKey, resolvePivotDimensionTitle, resolvePivotDimensionValue, resolvePivotDimensionWidth, resolvePivotFieldLayoutOptions, resolvePivotIndicatorAggregator, resolvePivotValueFieldTitle, savePivotFieldLayout };

package/dist/index.d.ts

@@ -261,6 +261,18 @@ type PivotAggregatorRegistry<RecordType = Record<string, unknown>> = Record<stri
 /** 第一阶段内置聚合器名称。 */
 type BuiltInPivotAggregatorName = "sum" | "avg" | "count" | "distinctCount" | "min" | "max";
 
+/** 透视表指标的快捷数据显示格式。 */
+type PivotIndicatorDataFormatType = "default" | "text" | "number" | "thousands" | "decimal" | "percent" | "percentDecimal" | "scientific" | "numberToChineseUpper" | "chineseUpperToNumber" | "cny" | "cnyDecimal" | "usd" | "usdDecimal" | "dateSlash" | "dateDash" | "dateFullCN" | "time" | "timeShort" | "datetime" | "datetime12" | "custom";
+/** 透视表指标的精确数据显示格式配置。 */
+interface PivotIndicatorDataFormatOptions {
+    type: PivotIndicatorDataFormatType;
+    decimalPlaces?: number;
+    useGrouping?: boolean;
+    symbol?: string;
+    pattern?: string;
+}
+/** 透视表指标数据显示格式。 */
+type PivotIndicatorDataFormat = PivotIndicatorDataFormatType | PivotIndicatorDataFormatOptions;
 /** 指标格式化上下文。 */
 interface PivotIndicatorFormatContext<RecordType> {
     indicator: PivotIndicator<RecordType>;
@@ -284,6 +296,8 @@ interface PivotIndicator<RecordType = Record<string, unknown>> {
     formatter?: (value: unknown, context: PivotIndicatorFormatContext<RecordType>) => string;
     /** 数字精度。 */
     precision?: number;
+    /** 指标数据显示格式。 */
+    dataFormat?: PivotIndicatorDataFormat;
     /** 指标列宽。 */
     width?: number;
     /** 指标对齐方式。 */
@@ -383,11 +397,18 @@ interface PivotTooltipRequest {
 interface PivotLoadingRequest {
     text?: string;
 }
-/** PivotTable 值区右键菜单请求。 */
+/** 透视表密度，与 ListTable 右键菜单语义保持一致。 */
+type PivotTableDensity = "comfortable" | "middle" | "compact" | "ultra-compact" | "auto";
+/** PivotTable 右键菜单请求。 */
 interface PivotContextMenuRequest {
     x: number;
     y: number;
-    recordCount: number;
+    target?: "header" | "body" | "summary";
+    title?: string;
+    axis?: PivotFilterAxis;
+    nodeKind?: PivotNodeKind | "empty";
+    indicatorKey?: string;
+    recordCount?: number;
     onCopy: () => void;
     onCopySelection?: () => void;
     customSelection?: {
@@ -406,6 +427,24 @@ interface PivotContextMenuRequest {
     }) => void;
     onExportCsv: () => void;
     onExportXlsx: () => void;
+    sortDirection?: "asc" | "desc" | null;
+    onSortAsc?: () => void;
+    onSortDesc?: () => void;
+    onClearSort?: () => void;
+    onOpenFilter?: () => void;
+    expanded?: boolean;
+    onExpand?: () => void;
+    onCollapse?: () => void;
+    onExpandAll?: () => void;
+    onCollapseAll?: () => void;
+    summaryAggregator?: BuiltInPivotAggregatorName;
+    summaryPrecision?: number;
+    onChangeSummaryAggregator?: (aggregator: BuiltInPivotAggregatorName) => void;
+    onChangeSummaryPrecision?: (precision: number | undefined) => void;
+    density?: PivotTableDensity;
+    onChangeDensity?: (density: PivotTableDensity) => void;
+    dataFormat?: PivotIndicatorDataFormat;
+    onChangeDataFormat?: (dataFormat: PivotIndicatorDataFormat) => void;
     onClose: () => void;
 }
 /** PivotTable UI 适配协议。 */
@@ -866,6 +905,9 @@ declare class PivotTable<RecordType = Record<string, unknown>> {
     restoreState(snapshot: PivotTableStateSnapshot): boolean;
     /** 选中指定值单元格。 */
     selectCell(address: PivotCellAddress, extend?: boolean): PivotSelectionState | null;
+    /** 鼠标命中的单元格已在视口内，选中时不再校正滚动位置。 */
+    private selectPointerCell;
+    private commitCellSelection;
     /** 选中行轴或列轴维度节点。 */
     selectNode(axis: PivotAxis, nodeId: string): PivotSelectionState | null;
     /** 将指定稳定地址滚动到可视区域。 */
@@ -905,6 +947,7 @@ declare class PivotTable<RecordType = Record<string, unknown>> {
     private stopWheelScrollSmoothing;
     private advanceWheelScrollSmoothing;
     private readonly handleContextMenu;
+    private createContextMenuSettings;
     private updateTooltip;
     private readonly handlePointerDown;
     private readonly handlePointerUp;
@@ -1229,4 +1272,4 @@ declare function flattenVisiblePivotLeaves(params: {
     defaultExpandDepth?: number;
 }): PivotNode[];
 
-export { type BuiltInPivotAggregatorName, type PivotAggregateCell, type PivotAggregator, type PivotAggregatorContext, type PivotAggregatorRegistry, type PivotAxis, type PivotAxisScrollbarLayout, type PivotAxisSlot, type PivotBodyCellLayout, type PivotCellAddress, type PivotCellStyle, type PivotContextMenuRequest, type PivotDataIndex, type PivotDimension, type PivotDimensionFilter, type PivotDimensionFilterOption, type PivotDimensionFilterPanelRequest, type PivotDimensionHeaderContent, type PivotDimensionHeaderImageContent, type PivotDimensionHeaderTextContent, type PivotDimensionTitle, type PivotDimensionValue, type PivotExpansionChangeEvent, type PivotExportMatrix, type PivotExportOptions, type PivotField, type PivotFieldArea, type PivotFieldLayout, type PivotFilterAxis, type PivotFilterChangeEvent, type PivotFilterCondition, type PivotFilterConditionOperator, type PivotFilterOptionItem, type PivotFilterState, type PivotGrandTotalPosition, type PivotHeaderCellLayout, type PivotHighlightMode, type PivotHitRegion, type PivotHitTestResult, type PivotIndicator, type PivotIndicatorFormatContext, type PivotLayoutSnapshot, type PivotLoadingRequest, type PivotModel, type PivotNode, type PivotNodeKind, type PivotRect, type PivotRenderStats, type PivotReportFilterCellLayout, type PivotResizeHit, type PivotResolvedPath, type PivotScrollState, type PivotScrollbarAxis, type PivotScrollbarLayout, type PivotScrollbarRect, type PivotScrollbarRole, type PivotSelectionChangeEvent, type PivotSelectionRange, type PivotSelectionState, type PivotSortChangeEvent, type PivotSortRule, type PivotSubtotalPosition, PivotTable, type PivotTableOptions, type PivotTableStateSnapshot, type PivotTableTheme, type PivotTableUiOptions, type PivotTextAlign, type PivotTooltipRequest, type PivotTotalsOptions, type ResolvedPivotDimensionValue, aggregatePivotRecords, buildPivotDimensionTree, buildPivotLayoutSnapshot, clearPivotFieldLayout, computePivotScrollbarLayout, createBuiltInPivotAggregators, createEmptyPivotFieldLayout, createEmptyPivotFilterState, createPivotAggregatorRegistry, createPivotAxisSlots, createPivotCellKey, createPivotExportMatrix, createPivotFieldCatalog, createPivotFieldLayout, createPivotSelectionText, defaultPivotTableTheme, encodePivotDimensionValue, encodePivotPath, exportPivotMatrixToCsv, exportPivotMatrixToXlsx, filterPivotRecords, findPivotFieldArea, flattenVisiblePivotLeaves, getPivotDimensionFilterOptions, hitTestPivotLayout, hitTestPivotResize, hitTestPivotScrollbar, loadPivotFieldLayout, movePivotField, removePivotField, renderPivotTable, resolvePivotDefaultSorts, resolvePivotDimensionKey, resolvePivotDimensionTitle, resolvePivotDimensionValue, resolvePivotDimensionWidth, resolvePivotFieldLayoutOptions, resolvePivotIndicatorAggregator, resolvePivotValueFieldTitle, savePivotFieldLayout };
+export { type BuiltInPivotAggregatorName, type PivotAggregateCell, type PivotAggregator, type PivotAggregatorContext, type PivotAggregatorRegistry, type PivotAxis, type PivotAxisScrollbarLayout, type PivotAxisSlot, type PivotBodyCellLayout, type PivotCellAddress, type PivotCellStyle, type PivotContextMenuRequest, type PivotDataIndex, type PivotDimension, type PivotDimensionFilter, type PivotDimensionFilterOption, type PivotDimensionFilterPanelRequest, type PivotDimensionHeaderContent, type PivotDimensionHeaderImageContent, type PivotDimensionHeaderTextContent, type PivotDimensionTitle, type PivotDimensionValue, type PivotExpansionChangeEvent, type PivotExportMatrix, type PivotExportOptions, type PivotField, type PivotFieldArea, type PivotFieldLayout, type PivotFilterAxis, type PivotFilterChangeEvent, type PivotFilterCondition, type PivotFilterConditionOperator, type PivotFilterOptionItem, type PivotFilterState, type PivotGrandTotalPosition, type PivotHeaderCellLayout, type PivotHighlightMode, type PivotHitRegion, type PivotHitTestResult, type PivotIndicator, type PivotIndicatorDataFormat, type PivotIndicatorDataFormatOptions, type PivotIndicatorDataFormatType, type PivotIndicatorFormatContext, type PivotLayoutSnapshot, type PivotLoadingRequest, type PivotModel, type PivotNode, type PivotNodeKind, type PivotRect, type PivotRenderStats, type PivotReportFilterCellLayout, type PivotResizeHit, type PivotResolvedPath, type PivotScrollState, type PivotScrollbarAxis, type PivotScrollbarLayout, type PivotScrollbarRect, type PivotScrollbarRole, type PivotSelectionChangeEvent, type PivotSelectionRange, type PivotSelectionState, type PivotSortChangeEvent, type PivotSortRule, type PivotSubtotalPosition, PivotTable, type PivotTableDensity, type PivotTableOptions, type PivotTableStateSnapshot, type PivotTableTheme, type PivotTableUiOptions, type PivotTextAlign, type PivotTooltipRequest, type PivotTotalsOptions, type ResolvedPivotDimensionValue, aggregatePivotRecords, buildPivotDimensionTree, buildPivotLayoutSnapshot, clearPivotFieldLayout, computePivotScrollbarLayout, createBuiltInPivotAggregators, createEmptyPivotFieldLayout, createEmptyPivotFilterState, createPivotAggregatorRegistry, createPivotAxisSlots, createPivotCellKey, createPivotExportMatrix, createPivotFieldCatalog, createPivotFieldLayout, createPivotSelectionText, defaultPivotTableTheme, encodePivotDimensionValue, encodePivotPath, exportPivotMatrixToCsv, exportPivotMatrixToXlsx, filterPivotRecords, findPivotFieldArea, flattenVisiblePivotLeaves, getPivotDimensionFilterOptions, hitTestPivotLayout, hitTestPivotResize, hitTestPivotScrollbar, loadPivotFieldLayout, movePivotField, removePivotField, renderPivotTable, resolvePivotDefaultSorts, resolvePivotDimensionKey, resolvePivotDimensionTitle, resolvePivotDimensionValue, resolvePivotDimensionWidth, resolvePivotFieldLayoutOptions, resolvePivotIndicatorAggregator, resolvePivotValueFieldTitle, savePivotFieldLayout };