@barchart/chart-lib 2.384.3 → 2.385.1

chart-lib/barchart.chart.d.ts

@@ -1374,6 +1374,63 @@ declare module "@barchart/chart-lib" {
         };
     };
 
+    export type ExportOptions = {
+        /** Exclude the chart and field header rows from CSV exports. */
+        excludeHeader?: boolean;
+        /** Number of decimal places to use for numeric values in CSV exports. */
+        numDecimals?: number;
+        /** Field ids to omit from exported curve data. */
+        excludeFields?: string[];
+        /** Sort exported data sources before columns are built. */
+        sourceOrder?: (a: ExportSource, b: ExportSource) => number;
+    };
+
+    export type ExportSource = {
+        /** Unique id for this exported source. Seasonal and forward runtime sources include their offset. */
+        id: string;
+        /** Stable chart plot uid when available. Multiple runtime sources can share the same plot uid. */
+        plotUid?: string;
+        /** Public plot type name. */
+        plotType: string;
+        /** Public plot title. */
+        plotTitle: string;
+        /** Field ids exported for this source, in column order. */
+        fieldIds: string[];
+        /** Runtime seasonal offset when this source comes from a seasonal plot. */
+        seasonalOffset?: number;
+        /** Pane index in chart order. */
+        paneIndex: number;
+        /** Axis index within the pane. */
+        axisIndex: number;
+        /** Plot index within the axis. */
+        plotIndex: number;
+        /** Whether this source is the main chart plot. */
+        main: boolean;
+    };
+
+    export type ExportColumn = {
+        /** Unique key used for row values. */
+        id: string;
+        /** Human-readable field name. */
+        name: string;
+        /** Chart field id. */
+        fieldId: string;
+        /** Public source metadata for this column. */
+        source: ExportSource;
+    };
+
+    export type ExportCellValue = Date | number | string | boolean | null | undefined;
+
+    export type ExportRow = Record<string, ExportCellValue>;
+
+    export type ExportTable = {
+        columns: ExportColumn[];
+        rows: ExportRow[];
+        dateFormatHint?: string;
+    };
+
+    export function convertTableToCsv(table: ExportTable, options?: ExportOptions): string;
+
     export type ExportImageOptions = {
         /** Override the width of the exported image (pixels). By default exports the chart's width as-is currently on the screen. */
         width?: number;
@@ -2093,7 +2150,9 @@ declare module "@barchart/chart-lib" {
         /** Set the title for the chart. Not used often. Is ephemeral - does not get saved with the chart. */
         setTitle(titleOptions: TitleOptions): void;
         /** Exports all the data currently loaded in the chart as a CSV. Best viewed as a spreadsheet in, say, Microsoft Excel. */
-        exportData(): string;
+        exportData(options?: ExportOptions): string;
+        /** Exports all the data currently loaded in the chart as a structured table. */
+        exportTable(options?: ExportOptions): ExportTable;
         /** Export the currently visible portion of the chart into a PNG image. */
         exportImage(options: ExportImageOptions): ExportedImage | null;
         /** Prints the chart, optionally adding a title (for the print-out only, reverts back to no title when the printing is over).  */