@cj-tech-master/excelts 9.4.2 → 9.5.0

package/dist/types/modules/excel/chart/chart-presets.d.ts

@@ -0,0 +1,392 @@
+import type { AddChartExOptions } from "./chart-ex-types.js";
+import type { AddChartOptions, AddChartSeriesOptions } from "./types.js";
+type PresetSeriesDefaults = Partial<Pick<AddChartSeriesOptions, "bubble3D" | "explosion">>;
+interface PresetConfig {
+    /**
+     * Partial options merged on top of the caller-supplied options. `type` is
+     * mandatory so callers get a runtime-usable `AddChartOptions` even when
+     * they omit `type` from their own input; this is enforced by the type
+     * rather than by a non-null assertion in {@link applyChartPreset}.
+     */
+    options: Partial<AddChartOptions> & {
+        type: AddChartOptions["type"];
+    };
+    seriesDefaults?: PresetSeriesDefaults;
+}
+export declare const CHART_PRESETS: {
+    columnClustered: PresetConfig;
+    columnStacked: PresetConfig;
+    columnStacked100: PresetConfig;
+    columnPercentStacked: PresetConfig;
+    colClustered: PresetConfig;
+    colStacked: PresetConfig;
+    colPercentStacked: PresetConfig;
+    colStacked100: PresetConfig;
+    barClustered: PresetConfig;
+    barStacked: PresetConfig;
+    barPercentStacked: PresetConfig;
+    barStacked100: PresetConfig;
+    pieOfPie: {
+        options: {
+            type: "ofPie";
+            ofPieType: "pie";
+        };
+    };
+    barOfPie: {
+        options: {
+            type: "ofPie";
+            ofPieType: "bar";
+        };
+    };
+    column3DClustered: PresetConfig;
+    column3DStacked: PresetConfig;
+    column3DStacked100: PresetConfig;
+    col3DClustered: PresetConfig;
+    col3DStacked: PresetConfig;
+    col3DStacked100: PresetConfig;
+    bar3DClustered: PresetConfig;
+    bar3DStacked: PresetConfig;
+    bar3DStacked100: PresetConfig;
+    col3DConeClustered: PresetConfig;
+    col3DConeStacked: PresetConfig;
+    col3DConeStacked100: PresetConfig;
+    coneColClustered: PresetConfig;
+    coneColStacked: PresetConfig;
+    coneColStacked100: PresetConfig;
+    bar3DConeClustered: PresetConfig;
+    bar3DConeStacked: PresetConfig;
+    bar3DConeStacked100: PresetConfig;
+    coneBarClustered: PresetConfig;
+    coneBarStacked: PresetConfig;
+    coneBarStacked100: PresetConfig;
+    col3DCylinderClustered: PresetConfig;
+    col3DCylinderStacked: PresetConfig;
+    col3DCylinderStacked100: PresetConfig;
+    cylinderColClustered: PresetConfig;
+    cylinderColStacked: PresetConfig;
+    cylinderColStacked100: PresetConfig;
+    bar3DCylinderClustered: PresetConfig;
+    bar3DCylinderStacked: PresetConfig;
+    bar3DCylinderStacked100: PresetConfig;
+    cylinderBarClustered: PresetConfig;
+    cylinderBarStacked: PresetConfig;
+    cylinderBarStacked100: PresetConfig;
+    col3DPyramidClustered: PresetConfig;
+    col3DPyramidStacked: PresetConfig;
+    col3DPyramidStacked100: PresetConfig;
+    pyramidColClustered: PresetConfig;
+    pyramidColStacked: PresetConfig;
+    pyramidColStacked100: PresetConfig;
+    bar3DPyramidClustered: PresetConfig;
+    bar3DPyramidStacked: PresetConfig;
+    bar3DPyramidStacked100: PresetConfig;
+    pyramidBarClustered: PresetConfig;
+    pyramidBarStacked: PresetConfig;
+    pyramidBarStacked100: PresetConfig;
+    line: {
+        options: {
+            type: "line";
+        };
+    };
+    lineMarkers: {
+        options: {
+            type: "line";
+            showMarker: true;
+        };
+    };
+    lineStacked: {
+        options: {
+            type: "line";
+            grouping: "stacked";
+        };
+    };
+    lineStacked100: {
+        options: {
+            type: "line";
+            grouping: "percentStacked";
+        };
+    };
+    pie: {
+        options: {
+            type: "pie";
+        };
+    };
+    pieExploded: {
+        options: {
+            type: "pie";
+        };
+        seriesDefaults: {
+            explosion: number;
+        };
+    };
+    pie3D: {
+        options: {
+            type: "pie3D";
+        };
+    };
+    pieExploded3D: {
+        options: {
+            type: "pie3D";
+        };
+        seriesDefaults: {
+            explosion: number;
+        };
+    };
+    doughnut: {
+        options: {
+            type: "doughnut";
+        };
+    };
+    doughnutExploded: {
+        options: {
+            type: "doughnut";
+            holeSize: number;
+        };
+        seriesDefaults: {
+            explosion: number;
+        };
+    };
+    area: {
+        options: {
+            type: "area";
+        };
+    };
+    areaStacked: {
+        options: {
+            type: "area";
+            grouping: "stacked";
+        };
+    };
+    areaStacked100: {
+        options: {
+            type: "area";
+            grouping: "percentStacked";
+        };
+    };
+    area3D: {
+        options: {
+            type: "area3D";
+        };
+    };
+    area3DStacked: {
+        options: {
+            type: "area3D";
+            grouping: "stacked";
+        };
+    };
+    area3DStacked100: {
+        options: {
+            type: "area3D";
+            grouping: "percentStacked";
+        };
+    };
+    scatter: {
+        options: {
+            type: "scatter";
+            scatterStyle: "marker";
+        };
+    };
+    scatterMarker: {
+        options: {
+            type: "scatter";
+            scatterStyle: "marker";
+        };
+    };
+    scatterStraight: {
+        options: {
+            type: "scatter";
+            scatterStyle: "lineMarker";
+        };
+    };
+    scatterLines: {
+        options: {
+            type: "scatter";
+            scatterStyle: "lineMarker";
+        };
+    };
+    scatterLinesNoMarkers: {
+        options: {
+            type: "scatter";
+            scatterStyle: "line";
+        };
+    };
+    scatterSmooth: {
+        options: {
+            type: "scatter";
+            scatterStyle: "smoothMarker";
+        };
+    };
+    scatterSmoothMarker: {
+        options: {
+            type: "scatter";
+            scatterStyle: "smoothMarker";
+        };
+    };
+    scatterSmoothNoMarkers: {
+        options: {
+            type: "scatter";
+            scatterStyle: "smooth";
+        };
+    };
+    bubble: {
+        options: {
+            type: "bubble";
+        };
+    };
+    bubble3D: {
+        options: {
+            type: "bubble";
+        };
+        seriesDefaults: {
+            bubble3D: true;
+        };
+    };
+    radar: {
+        options: {
+            type: "radar";
+            radarStyle: "standard";
+        };
+    };
+    radarMarkers: {
+        options: {
+            type: "radar";
+            radarStyle: "marker";
+        };
+    };
+    radarFilled: {
+        options: {
+            type: "radar";
+            radarStyle: "filled";
+        };
+    };
+    stockHLC: {
+        options: {
+            type: "stock";
+            hiLowLines: true;
+        };
+    };
+    stockOHLC: {
+        options: {
+            type: "stock";
+            upDownBars: true;
+            hiLowLines: true;
+        };
+    };
+    surface: {
+        options: {
+            type: "surface";
+        };
+    };
+    surface3D: {
+        options: {
+            type: "surface3D";
+        };
+    };
+    surfaceTopView: {
+        options: {
+            type: "surface3D";
+            view3D: {
+                rotX: number;
+                rotY: number;
+            };
+        };
+    };
+    contour: {
+        options: {
+            type: "surface";
+        };
+    };
+    wireframeSurface: {
+        options: {
+            type: "surface3D";
+            wireframe: true;
+        };
+    };
+    surface3DWireframe: {
+        options: {
+            type: "surface3D";
+            wireframe: true;
+        };
+    };
+    surfaceWireframe: {
+        options: {
+            type: "surface3D";
+            wireframe: true;
+        };
+    };
+    wireframeContour: {
+        options: {
+            type: "surface";
+            wireframe: true;
+        };
+    };
+    topViewWireframe: {
+        options: {
+            type: "surface3D";
+            wireframe: true;
+            view3D: {
+                rotX: number;
+                rotY: number;
+            };
+        };
+    };
+};
+export type ExcelChartPreset = keyof typeof CHART_PRESETS;
+export declare const EXCEL_CHART_PRESETS: ExcelChartPreset[];
+export declare const CHART_EX_PRESETS: {
+    histogram: {
+        options: {
+            type: "histogram";
+        };
+    };
+    pareto: {
+        options: {
+            type: "pareto";
+        };
+    };
+    waterfall: {
+        options: {
+            type: "waterfall";
+        };
+    };
+    funnel: {
+        options: {
+            type: "funnel";
+        };
+    };
+    treemap: {
+        options: {
+            type: "treemap";
+        };
+    };
+    sunburst: {
+        options: {
+            type: "sunburst";
+        };
+    };
+    boxWhisker: {
+        options: {
+            type: "boxWhisker";
+        };
+    };
+    boxAndWhisker: {
+        options: {
+            type: "boxWhisker";
+        };
+    };
+    regionMap: {
+        options: {
+            type: "regionMap";
+        };
+    };
+    map: {
+        options: {
+            type: "regionMap";
+        };
+    };
+};
+export type ExcelChartExPreset = keyof typeof CHART_EX_PRESETS;
+export declare const EXCEL_CHART_EX_PRESETS: ExcelChartExPreset[];
+export declare function applyChartPreset(preset: ExcelChartPreset, options: Omit<AddChartOptions, "type"> & Partial<Pick<AddChartOptions, "type">>): AddChartOptions;
+export declare function applyChartExPreset(preset: ExcelChartExPreset, options: Omit<AddChartExOptions, "type"> & Partial<Pick<AddChartExOptions, "type">>): AddChartExOptions;
+export {};