@cj-tech-master/excelts 9.4.2 → 9.5.0

package/dist/esm/modules/excel/chart/install.js

@@ -0,0 +1,91 @@
+/**
+ * Opt-in chart-support installer.
+ *
+ * This file carries the static imports that wire the concrete chart
+ * implementation (cache populator, chart builder, ChartEx builder,
+ * preset engine, sidecar serialisers, `Chart` class and chart-api
+ * helpers) into the excel host. Keep these imports isolated in a
+ * separate module so callers who import only the types, the SVG/PNG
+ * renderers, or the parser from `./index` do not trigger the entire
+ * builder pipeline at bundle time.
+ *
+ * A single process-wide slot is populated:
+ *
+ * - The chart-support slot (`@excel/chart-host-registry`) — enables
+ *   `worksheet.addChart()`, `worksheet.addLineChart()`, chart cache
+ *   population during `workbook.xlsx.writeFile()`, and `Chart`
+ *   reconstruction during XLSX load.
+ *
+ * The slot accepts `null` to uninstall. See
+ * {@link uninstallChartSupport} for tests that need to exercise the
+ * "no chart support" error path.
+ */
+import { registerChartSupport } from "../chart-host-registry.js";
+import { ChartSpaceXform } from "../xlsx/xform/chart/chart-space-xform.js";
+import { fillChartCaches, fillChartExCaches } from "./cache-populator.js";
+import { Chart } from "./chart.js";
+import { chartExOptionsFromRows, chartExOptionsFromTable, chartOptionsFromRows, chartOptionsFromTable, seriesFromColumns } from "./chart-api.js";
+import { buildChartModel, buildComboChartModel } from "./chart-builder.js";
+import { buildChartExModel } from "./chart-ex-builder.js";
+import { parseChartEx } from "./chart-ex-parser.js";
+import { canRenderChartExAsVectorPdf, drawChartExPdf, renderChartEx, renderChartExLegendXml, renderChartExPng, rewriteChartExDataRefsToDefinedNames } from "./chart-ex-renderer.js";
+import { resolvePendingChartImages } from "./chart-images.js";
+import { applyChartExPreset, applyChartPreset } from "./chart-presets.js";
+import { drawChartPdf, renderChartPng } from "./chart-renderer.js";
+import { buildChartColors, buildChartStyle } from "./chart-sidecar.js";
+import { themeIndexToName } from "./chart-utils.js";
+/**
+ * Install the chart runtime into the excel host.
+ *
+ * After calling this once, chart-manipulating APIs on `Worksheet`,
+ * `Workbook` and `Chartsheet` run the full chart builder and renderer
+ * pipeline instead of throwing. Subsequently-loaded workbooks also
+ * reconstruct `Chart` instances for their existing charts so consumer
+ * code can inspect / mutate them.
+ *
+ * Safe to call more than once — the registry accepts the last
+ * registration. Calling is idempotent and cheap; no shared state is
+ * mutated beyond the host-registry slot.
+ */
+export function installChartSupport() {
+    const support = {
+        buildChartModel,
+        buildComboChartModel,
+        buildChartExModel,
+        applyChartPreset,
+        applyChartExPreset,
+        fillChartCaches: fillChartCaches,
+        fillChartExCaches: fillChartExCaches,
+        resolvePendingChartImages: resolvePendingChartImages,
+        buildChartStyle,
+        buildChartColors,
+        createChart: (worksheet, ids, range) => new Chart(worksheet, ids, range),
+        chartOptionsFromTable: chartOptionsFromTable,
+        chartOptionsFromRows: chartOptionsFromRows,
+        chartExOptionsFromTable: chartExOptionsFromTable,
+        chartExOptionsFromRows: chartExOptionsFromRows,
+        seriesFromColumns: seriesFromColumns,
+        parseChartEx,
+        renderChartEx,
+        renderChartExLegendXml,
+        rewriteChartExDataRefsToDefinedNames,
+        themeIndexToName,
+        createChartSpaceXform: () => new ChartSpaceXform(),
+        drawChartPdf,
+        drawChartExPdf,
+        renderChartPng,
+        renderChartExPng,
+        canRenderChartExAsVectorPdf
+    };
+    registerChartSupport(support);
+}
+/**
+ * Uninstall the chart runtime, restoring the cold-start state where
+ * chart-manipulating APIs throw. Mainly useful for tests that exercise
+ * the "no chart support" error path. In production, calling this is
+ * rarely necessary — subsequent `installChartSupport()` calls simply
+ * overwrite the previous registration.
+ */
+export function uninstallChartSupport() {
+    registerChartSupport(null);
+}