Fleshed out font settings in the chart def.

Author: ashleydavis

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "data-forge-plot",
-    "version": "0.4.5",
+    "version": "0.6.0",
     "description": "Plotting API for use with Data-Forge.",
     "main": "build/index.js",
     "types": "build/index.d.ts",
@@ -35,8 +35,8 @@
     },
     "homepage": "https://github.com/data-forge/data-forge-plot#readme",
     "dependencies": {
-        "@data-forge-plot/apex": "0.0.39",
-        "@data-forge-plot/chart-def": "^1.1.2",
+        "@data-forge-plot/apex": "0.2.0",
+        "@data-forge-plot/chart-def": "^1.4.0",
         "@data-forge/serialization": "^1.0.0",
         "inflate-template": "^1.1.6",
         "opn": "^5.5.0",

package.json

@@ -1,38 +1,26 @@
 
-import { ISerializedDataFrame } from "@data-forge/serialization";
-import { HorizontalLabelPosition, VerticalLabelPosition, AxisType, ChartType } from "@data-forge-plot/chart-def";
+import { AxisType, ChartType, IAxisLabelConfig, ILegendConfig, IDataLabels } from "@data-forge-plot/chart-def";
 
 /**
- * Defines the configuration of an axis label.
+ * Configures an axis of the chart.
  */
-export interface IAxisLabelConfig {
-
-    /**
-     * The text for the label.
-     */
-    text?: string;
+export interface IAxisConfig {
 
     /**
-     * Position of the label.
+     * Label for the axis.
      */
-    position?: HorizontalLabelPosition | VerticalLabelPosition;
+    label?: string | IAxisLabelConfig;
 }
 
 /**
  * Configures an axis of the chart.
  */
-export interface IAxisConfig {
+export interface IXAxisConfig extends IAxisConfig {
 
     /**
      * Sets the type of the axis' data.
-     * Default: AxisType.Indexed ("indexed")
      */
     axisType?: AxisType;
-
-    /**
-     * Label for the axis.
-     */
-    label?: string | IAxisLabelConfig;
 }
 
 /**
@@ -51,17 +39,6 @@ export interface IYAxisConfig extends IAxisConfig {
     max?: number;
 }
 
-/**
- * Configures the legend of the chart.
- */
-export interface ILegendConfig {
-
-    /**
-     * Set to true (default) to show the legend for the chart   .
-     */
-    show?: boolean;
-}
-
 /**
  * Defines the chart.
  */
@@ -88,7 +65,7 @@ export interface IPlotConfig {
     /**
      * Configuration for the x axis.
      */
-    x?: IAxisConfig;
+    x?: IXAxisConfig;
 
     /**
      * Configuration for the y axis.
@@ -104,6 +81,11 @@ export interface IPlotConfig {
      * Configures the chart's legend.
      */
     legend?: ILegendConfig;
+
+    /**
+     * Configure data labels for the whole chart.
+     */
+    dataLabels?: IDataLabels;
 }
 
 /**

src/chart-def.ts

@@ -1,4 +1,4 @@
-import { IChartDef, IPlotConfig as IExpandedPlotConfig, IAxisMap as IExpandedAxisMap, ChartType, IAxisConfig as IExpandedAxisConfig, IYAxisConfig as IExpandedYAxisConfig, IXAxisConfig as IExpandedXAxisConfig, IAxisSeriesConfig as IExpandedAxisSeriesConfig, IYAxisSeriesConfig as IExpandedYAxisSeriesConfig } from "@data-forge-plot/chart-def";
+import { IChartDef, IPlotConfig as IExpandedPlotConfig, IAxisMap as IExpandedAxisMap, IAxisConfig as IExpandedAxisConfig, IYAxisConfig as IExpandedYAxisConfig, IXAxisConfig as IExpandedXAxisConfig, IAxisSeriesConfig as IExpandedAxisSeriesConfig, IYAxisSeriesConfig as IExpandedYAxisSeriesConfig, ISeriesLabelConfig } from "@data-forge-plot/chart-def";
 import { IAxisMap, IPlotConfig, IAxisConfig, IYAxisConfig, IAxisSeriesConfig, IYAxisSeriesConfig } from "./chart-def";
 import { ISerializedDataFrame } from "@data-forge/serialization";
 import { isString } from "./utils";
@@ -36,14 +36,33 @@ export function expandSeriesConfig(series: string | IAxisSeriesConfig): IExpande
         };
     }
     else {
-        return Object.assign({}, series);
+        const inputSeriesConfig = series as IAxisSeriesConfig;
+        const expandedSeriesConfig: IExpandedAxisSeriesConfig = {
+            series: inputSeriesConfig.series,
+        };
+
+        if (inputSeriesConfig.label) {
+            expandedSeriesConfig.label = inputSeriesConfig.label;
+        }
+
+        if (inputSeriesConfig.format) {
+            expandedSeriesConfig.format = inputSeriesConfig.format;
+        }
+
+        if (inputSeriesConfig.color) {
+            expandedSeriesConfig.color = inputSeriesConfig.color;
+        }
+
+        return expandedSeriesConfig;
     }
 }
 
 export function expandYSeriesConfig(series: string | IYAxisSeriesConfig): IExpandedYAxisSeriesConfig {
     const expanded = expandSeriesConfig(series) as IExpandedYAxisSeriesConfig;
-    if (expanded.x) {
-        expanded.x = expandSeriesConfig(expanded.x);
+    if (!isString(series)) {
+        if (series.x) {
+            expanded.x = expandSeriesConfig(series.x);
+        }
     }
     return expanded;
 }

src/expand-chart-def.ts

@@ -14,13 +14,31 @@ describe("expand chart def", () => {
         expect(expanded.series).toBe("my series");
     });
 
-    it("can clone object series config", () => {
+    it("can expand series config", () => {
         const seriesConfig = { series: "my series" };
         const expanded = expandSeriesConfig(seriesConfig);
         expect(expanded).not.toBe(seriesConfig);
         expect(expanded).toEqual(seriesConfig);
     });    
 
+    it("can expand series config with string label", () => {
+        const seriesConfig = { series: "my series", label: "a great series" };
+        const expanded = expandSeriesConfig(seriesConfig);
+        expect(expanded.label).toBe("a great series");
+    });
+
+    it("can expand series config with format", () => {
+        const seriesConfig = { series: "my series", format: "the format!" };
+        const expanded = expandSeriesConfig(seriesConfig);
+        expect(expanded.format).toBe("the format!");
+    });
+
+    it("can expand series config with color", () => {
+        const seriesConfig = { series: "my series", format: "red" };
+        const expanded = expandSeriesConfig(seriesConfig);
+        expect(expanded.format).toBe("red");
+    });
+
     it("can expand y series config with specific x series as string", () => {
         const seriesConfig = { series: "my y series", x: "my x series" };
         const expanded = expandYSeriesConfig(seriesConfig);
@@ -163,8 +181,8 @@ describe("expand chart def", () => {
     it("can expand axis config", () => {
 
         const xConfig = { axisType: AxisType.Category };
-        const yConfig = { axisType: AxisType.Numerical };
-        const y2Config = { axisType: AxisType.Timeseries };
+        const yConfig = {};
+        const y2Config = {};
         const expanded = expandChartDef({} as any, { x: xConfig, y: yConfig, y2: y2Config }, {});
         expect(expanded.plotConfig.x).not.toBe(xConfig);
         expect(expanded.plotConfig.x).toEqual(xConfig);

src/test/expand-chart-def.test.ts

@@ -183,7 +183,7 @@ describe("plot-api", () => {
                 .addSeries("my series")
                     .label("a great series")
             .serialize();
-        expect(serialized.axisMap.y[0].label!).toBe("a great series");
+        expect(serialized.axisMap.y[0].label).toBe("a great series");
     });
 
     it("can set specific x series for y axis series", () => {
@@ -209,7 +209,7 @@ describe("plot-api", () => {
                 .addSeries("my series")
                     .label("a great series")
             .serialize();
-        expect(serialized.axisMap.y2[0].label!).toBe("a great series");
+        expect(serialized.axisMap.y2[0].label).toBe("a great series");
     });
 
     it("can set specific x series for y2 axis series", () => {