Fixed various examples.

ashleydavis · ashleydavis · commit 7e851cd9a189 · 2019-04-24T17:55:07.000+10:00
Exposed chart def decls from the package.
Chart options are now passed to the chart via JSON. The makeStatic flag and a new flag showChartDef that displays the expanded/formatted chart def.
diff --git a/examples/example-10.ts b/examples/example-10.ts
@@ -13,7 +13,7 @@ import { DataFrame } from 'data-forge';
 import '../src/index';
 import * as fs from 'fs-extra';
 import * as path from 'path';
-import { ChartType, IAxisMap } from '../src/chart-def';
+import { ChartType } from '../src/index';
 
 const outputName = path.basename(__filename, ".ts");
 const outputPath = path.join("./output", outputName);
@@ -34,14 +34,16 @@ async function main(): Promise<void> {
     
     const plot = df.plot()
         .chartType(ChartType.Scatter)
-        .y("versicolor_y")
-            .seriesLabel("Versicolor")
-            //todo: .color("blue")
-            .x("versicolor_x")
-        .y("setosa_y")
-            .seriesLabel("Setosa")
-            //todo: .color("green")
-            .x("setosa_x");
+        .y()
+            .addSeries("versicolor_y")
+                .label("Versicolor")
+                //todo: .color("blue")
+                .setX("versicolor_x")
+        .y()
+            .addSeries("setosa_y")
+                .label("Setosa")
+                //todo: .color("green")
+                .setX("setosa_x");
 
     await plot.renderImage(path.join(outputPath, "image.png"), { openImage: false });
     await plot.exportWeb(path.join(outputPath, "web"), { overwrite: true, openBrowser: false });
diff --git a/examples/example-4.ts b/examples/example-4.ts
@@ -31,9 +31,12 @@ async function main(): Promise<void> {
     //console.log(df.toString());
     
     const plot = df.plot()
-        .x("date")
-        .y("data1")
-        .y("data2");
+        .x()
+            .setSeries("date")
+        .y()
+            .addSeries("data1")
+        .y()
+            .addSeries("data2");
     await plot.renderImage(path.join(outputPath, "image.png"), { openImage: false });
     await plot.exportWeb(path.join(outputPath, "web"), { overwrite: true, openBrowser: false });
 }
diff --git a/examples/example-5.ts b/examples/example-5.ts
@@ -12,7 +12,7 @@ import { DataFrame } from 'data-forge';
 import '../src/index';
 import * as fs from 'fs-extra';
 import * as path from 'path';
-import { ChartType } from '../src/chart-def';
+import { ChartType } from '../src/index';
 
 const outputName = path.basename(__filename, ".ts");
 const outputPath = path.join("./output", outputName);
diff --git a/examples/example-6.ts b/examples/example-6.ts
@@ -12,7 +12,7 @@ import { DataFrame } from 'data-forge';
 import '../src/index';
 import * as fs from 'fs-extra';
 import * as path from 'path';
-import { ChartType } from '../src/chart-def';
+import { ChartType } from '../src/index';
 
 const outputName = path.basename(__filename, ".ts");
 const outputPath = path.join("./output", outputName);
diff --git a/examples/example-7.ts b/examples/example-7.ts
@@ -11,7 +11,7 @@ import { DataFrame } from 'data-forge';
 import '../src/index';
 import * as fs from 'fs-extra';
 import * as path from 'path';
-import { ChartType } from '../src/chart-def';
+import { ChartType } from '../src/index';
 
 const outputName = path.basename(__filename, ".ts");
 const outputPath = path.join("./output", outputName);
diff --git a/examples/example-8.ts b/examples/example-8.ts
@@ -11,7 +11,7 @@ import { DataFrame } from 'data-forge';
 import '../src/index';
 import * as fs from 'fs-extra';
 import * as path from 'path';
-import { ChartType } from '../src/chart-def';
+import { ChartType } from '../src/index';
 
 const outputName = path.basename(__filename, ".ts");
 const outputPath = path.join("./output", outputName);
@@ -30,8 +30,10 @@ async function main(): Promise<void> {
     
     const plot = df.plot()
         .chartType(ChartType.Scatter)
-        .x("versicolor_x")
-        .y("versicolor_y");
+        .x()
+            .setSeries("versicolor_x")
+        .y()
+            .addSeries("versicolor_y");
     await plot.renderImage(path.join(outputPath, "image.png"), { openImage: false });
     await plot.exportWeb(path.join(outputPath, "web"), { overwrite: true, openBrowser: false });
 }
diff --git a/examples/example-9.ts b/examples/example-9.ts
@@ -13,7 +13,7 @@ import { DataFrame } from 'data-forge';
 import '../src/index';
 import * as fs from 'fs-extra';
 import * as path from 'path';
-import { ChartType, IAxisMap } from '../src/chart-def';
+import { ChartType } from '../src/index';
 
 const outputName = path.basename(__filename, ".ts");
 const outputPath = path.join("./output", outputName);
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -34,7 +34,7 @@
     },
     "homepage": "https://github.com/data-forge/data-forge-plot#readme",
     "dependencies": {
-        "@data-forge-plot/apex": "0.0.26",
+        "@data-forge-plot/apex": "0.0.30",
         "@data-forge-plot/chart-def": "^1.0.9",
         "@data-forge/serialization": "^1.0.0",
         "capture-template": "^1.1.10",
diff --git a/src/apply-defaults.ts b/src/apply-defaults.ts
@@ -117,4 +117,4 @@ export function applyDefaults(inputChartDef: IChartDef, plotDefaults?: IPlotConf
     }
 
     return chartDef;
-}
+}
diff --git a/src/index.ts b/src/index.ts
@@ -2,6 +2,8 @@ import { ISeries, Series } from "data-forge";
 import { IDataFrame, DataFrame } from "data-forge";
 import { IPlotAPI, PlotAPI, /*todo: globalChartRenderer,*/ startPlot, endPlot } from "./plot-api";
 import { IPlotConfig, IAxisMap } from "./chart-def";
+export * from "./chart-def";
+export { ChartType, AxisType, HorizontalLabelPosition, VerticalLabelPosition } from "@data-forge-plot/chart-def";
 
 //
 // Augment ISeries and Series with plot function.
diff --git a/src/plot-api.ts b/src/plot-api.ts
@@ -60,6 +60,11 @@ export interface IRenderOptions {
      * Name of the template used to render the image.
      */
     template?: string;
+
+    /**
+     * Set to true to show the chart definition after expansion and also after formatting.
+     */
+    showChartDef?: boolean;
 }
 
 /**
@@ -82,6 +87,11 @@ export interface IWebExportOptions {
      * Name of the template used to render the image.
      */
     template?: string;
+
+    /**
+     * Set to true to show the chart definition after expansion and also after formatting.
+     */
+    showChartDef?: boolean;
 }
 
 /**
@@ -368,14 +378,29 @@ export abstract class AbstractPlotAPI implements IPlotAPI {
     async renderImage(imageFilePath: string, renderOptions?: IRenderOptions): Promise<void> {
 
         const chartDef = this.serialize();
+        if (renderOptions && renderOptions.showChartDef) {
+            console.log("Expanded chart definition:");
+            console.log(JSON.stringify(chartDef, null, 4));
+        }
+
         const templatePath = renderOptions && renderOptions.template || await findChartTemplatePath();
         const captureOptions: ICaptureOptions = {
             electronPath: renderOptions && renderOptions.electronPath,
             inflateOptions: {
                 inMemoryFiles: [
                     {
                         file: "chart-def.json",
-                        content: JSON.stringify(chartDef, null, 4),
+                        content: JSON.stringify(
+                            { 
+                                chartDef, 
+                                options: {
+                                    makeStatic: true,
+                                    showChartDef: renderOptions && renderOptions.showChartDef || false,
+                                },
+                            }, 
+                            null, 
+                            4
+                        ),
                     },
                 ],
             },
@@ -393,6 +418,11 @@ export abstract class AbstractPlotAPI implements IPlotAPI {
     async exportWeb(outputFolderPath: string, exportOptions?: IWebExportOptions): Promise<void> {
 
         const chartDef = this.serialize();
+        if (exportOptions && exportOptions.showChartDef) {
+            console.log("Expanded chart definition:");
+            console.log(JSON.stringify(chartDef, null, 4));
+        }
+
         const templatePath = exportOptions && exportOptions.template || await findChartTemplatePath();
         const overwrite = exportOptions && !!exportOptions.overwrite || false;
 
@@ -401,8 +431,18 @@ export abstract class AbstractPlotAPI implements IPlotAPI {
             inMemoryFiles: [
                 {
                     file: "chart-def.json",
-                    content: JSON.stringify(chartDef, null, 4),
-                },
+                    content: JSON.stringify(
+                        { 
+                            chartDef, 
+                            options: {
+                                makeStatic: false,
+                                showChartDef: exportOptions && exportOptions.showChartDef || false,
+                            },
+                        }, 
+                        null, 
+                        4
+                    ),
+            },
             ],
         };
 
diff --git a/src/test/plot-api.test.ts b/src/test/plot-api.test.ts
@@ -459,6 +459,4 @@ describe("plot-api", () => {
         await plot.exportWeb(outputPath);
         expect(exportTemplate).toHaveBeenCalled();
     });
-
-
 });
diff --git a/tslint.json b/tslint.json
@@ -28,7 +28,8 @@
         "no-trailing-whitespace": false,
         "ban-types": false,
         "array-type": false,
-        "no-empty-interface": false
+        "no-empty-interface": false,
+        "no-console": false
     },
     "defaultSeverity": "warning"
 }

Original file line number	Diff line number	Diff line change
`@@ -117,4 +117,4 @@ export function applyDefaults(inputChartDef: IChartDef, plotDefaults?: IPlotConf`
`117`	`117`	`}`
`118`	`118`
`119`	`119`	`return chartDef;`
`120`		`-}`
	`120`	`+}`