Updated chart def and apex.

Author: ashleydavis

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "data-forge-plot",
-    "version": "0.3.2",
+    "version": "0.3.3",
     "description": "Plotting API for use with Data-Forge.",
     "main": "build/index.js",
     "types": "build/index.d.ts",
@@ -34,8 +34,8 @@
     },
     "homepage": "https://github.com/data-forge/data-forge-plot#readme",
     "dependencies": {
-        "@data-forge-plot/apex": "0.0.31",
-        "@data-forge-plot/chart-def": "^1.0.9",
+        "@data-forge-plot/apex": "0.0.33",
+        "@data-forge-plot/chart-def": "^1.1.1",
         "@data-forge/serialization": "^1.0.0",
         "capture-template": "^1.1.10",
         "inflate-template": "^1.1.6",

package.json

@@ -1,4 +1,4 @@
-import { IChartDef, IPlotConfig as IExpandedPlotConfig, IAxisMap as IExpandedAxisMap, ChartType, IAxisConfig as IExpandedAxisConfig, IYAxisConfig as IExpandedYAxisConfig, IAxisSeriesConfig as IExpandedAxisSeriesConfig, IYAxisSeriesConfig as IExpandedYAxisSeriesConfig } from "@data-forge-plot/chart-def";
+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 { IAxisMap, IPlotConfig, IAxisConfig, IYAxisConfig, IAxisSeriesConfig, IYAxisSeriesConfig } from "./chart-def";
 import { ISerializedDataFrame } from "@data-forge/serialization";
 import { isString } from "./utils";
@@ -19,6 +19,11 @@ export function expandAxisConfig(axisConfig: IAxisConfig): IExpandedAxisConfig {
     return expandedAxisConfig;
 }
 
+export function expandXAxisConfig(axisConfig: IYAxisConfig): IExpandedXAxisConfig {
+    const expandedAxisConfig = expandAxisConfig(axisConfig);
+    return expandedAxisConfig;
+}
+
 export function expandYAxisConfig(axisConfig: IYAxisConfig): IExpandedYAxisConfig {
     const expandedAxisConfig = expandAxisConfig(axisConfig);
     return expandedAxisConfig;

src/expand-chart-def.ts

@@ -5,7 +5,7 @@ import { exportTemplate, IExportOptions } from "inflate-template";
 import { captureImage, ICaptureOptions } from "capture-template";
 import { IPlotConfig, IAxisMap } from "./chart-def";
 import { isObject } from "./utils";
-import { ChartType, IChartDef, AxisType, HorizontalLabelPosition, VerticalLabelPosition, IAxisConfig, IYAxisSeriesConfig, IAxisSeriesConfig } from "@data-forge-plot/chart-def";
+import { ChartType, IChartDef, AxisType, HorizontalLabelPosition, VerticalLabelPosition, IAxisConfig, IYAxisSeriesConfig, IAxisSeriesConfig, IXAxisConfig, IYAxisConfig } from "@data-forge-plot/chart-def";
 import { expandChartDef } from "./expand-chart-def";
 import { applyDefaults } from "./apply-defaults";
 
@@ -169,11 +169,6 @@ export interface IAxisConfigAPI<FluentT> extends IPlotAPI {
      * Set the label for the axis.
      */
     label(label: string): FluentT;
-
-    /**
-     * Set the type of the axis.
-     */
-    type(axisType: AxisType): FluentT;
 }
 
 /**
@@ -220,6 +215,11 @@ export interface IXAxisConfigAPI extends IAxisConfigAPI<IXAxisConfigAPI> {
      */
     setSeries(seriesName: string): IXAxisSeriesConfigAPI;
 
+    /**
+     * Set the type of the axis.
+     */
+    type(axisType: AxisType): IXAxisSeriesConfigAPI;
+
     /**
      * Set the position for the label.
      */
@@ -577,7 +577,7 @@ class YAxisSeriesConfigAPI extends AxisSeriesConfigAPI<YAxisSeriesConfigAPI, IYA
 /**
  * Fluent API for configuring an axis of the chart.
  */
-abstract class AxisConfigAPI<FluentT, AxisMapT> extends AbstractPlotAPI implements IAxisConfigAPI<FluentT> {
+abstract class AxisConfigAPI<FluentT, AxisConfigT extends IAxisConfig> extends AbstractPlotAPI implements IAxisConfigAPI<FluentT> {
 
     /**
      * The name of the axis being configured.
@@ -587,11 +587,11 @@ abstract class AxisConfigAPI<FluentT, AxisMapT> extends AbstractPlotAPI implemen
     /**
      * Configuration for the axis.
      */
-    protected axisConfig: IAxisConfig;
+    protected axisConfig: AxisConfigT;
 
     constructor(
         axisName: string,
-        axisConfig: IAxisConfig,
+        axisConfig: AxisConfigT,
         chartDef: IChartDef
     ) {
         super(chartDef);
@@ -613,25 +613,18 @@ abstract class AxisConfigAPI<FluentT, AxisMapT> extends AbstractPlotAPI implemen
         return this as any as FluentT;
     }
 
-    /**
-     * Set the type of the axis.
-     */
-    type(axisType: AxisType): FluentT {
-        this.axisConfig.axisType = axisType;
-        return this as any as FluentT;
-    }
 }
 
 /**
  * Fluent API for configuring an axis of the chart.
  */
-class XAxisConfigAPI extends AxisConfigAPI<IXAxisConfigAPI, IAxisConfig> implements IXAxisConfigAPI {
+class XAxisConfigAPI extends AxisConfigAPI<IXAxisConfigAPI, IXAxisConfig> implements IXAxisConfigAPI {
 
     createSeriesConfig: (seriesName: string) => IAxisSeriesConfig;
 
     constructor(
         axisName: string,
-        axisConfig: IAxisConfig,
+        axisConfig: IXAxisConfig,
         createSeriesConfig: (seriesName: string) => IAxisSeriesConfig,
         chartDef: IChartDef
     ) {
@@ -651,6 +644,14 @@ class XAxisConfigAPI extends AxisConfigAPI<IXAxisConfigAPI, IAxisConfig> impleme
         );
     }
 
+    /**
+     * Set the type of the axis.
+     */
+    type(axisType: AxisType): IXAxisSeriesConfigAPI {
+        this.axisConfig.axisType = axisType;
+        return this as any as IXAxisSeriesConfigAPI;
+    }
+
     /**
      * Set the position for the label.
      */
@@ -668,13 +669,13 @@ class XAxisConfigAPI extends AxisConfigAPI<IXAxisConfigAPI, IAxisConfig> impleme
 /**
  * Fluent API for configuring an axis of the chart.
  */
-class YAxisConfigAPI extends AxisConfigAPI<IYAxisConfigAPI, IYAxisSeriesConfig> implements IYAxisConfigAPI {
+class YAxisConfigAPI extends AxisConfigAPI<IYAxisConfigAPI, IYAxisConfig> implements IYAxisConfigAPI {
 
     createSeriesConfig: (seriesName: string) => IYAxisSeriesConfig;
 
     constructor(
         axisName: string,
-        axisConfig: IAxisConfig,
+        axisConfig: IYAxisConfig,
         createSeriesConfig: (seriesName: string) => IYAxisSeriesConfig,
         chartDef: IChartDef
     ) {

src/plot-api.ts

@@ -163,7 +163,7 @@ describe("expand chart def", () => {
     it("can expand axis config", () => {
 
         const xConfig = { axisType: AxisType.Category };
-        const yConfig = { axisType: AxisType.Indexed };
+        const yConfig = { axisType: AxisType.Numerical };
         const y2Config = { axisType: AxisType.Timeseries };
         const expanded = expandChartDef({} as any, { x: xConfig, y: yConfig, y2: y2Config }, {});
         expect(expanded.plotConfig.x).not.toBe(xConfig);

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

@@ -375,17 +375,6 @@ describe("plot-api", () => {
         expect(serialized.plotConfig.y!.label!.position).toBe(VerticalLabelPosition.OuterMiddle);
     });
 
-    it("can set y axis type", () => {
-        const data: any = {};
-        const plotConfig: IPlotConfig = {};
-        const axisMap: IAxisMap = {};
-        const plot = new PlotAPI(data, plotConfig, axisMap)
-            .y()
-                .type(AxisType.Timeseries);
-        const serialized = plot.serialize();
-        expect(serialized.plotConfig.y!.axisType).toBe(AxisType.Timeseries);
-    });
-
     it("can set y2 axis label", () => {
         const data: any = {};
         const plotConfig: IPlotConfig = { y2: { label: { text: "A label!" }}};
@@ -429,17 +418,6 @@ describe("plot-api", () => {
         expect(serialized.plotConfig.y2!.label!.position).toBe(VerticalLabelPosition.OuterMiddle);
     });
 
-    it("can set y2 axis type", () => {
-        const data: any = {};
-        const plotConfig: IPlotConfig = {};
-        const axisMap: IAxisMap = {};
-        const plot = new PlotAPI(data, plotConfig, axisMap)
-            .y2()
-                .type(AxisType.Timeseries);
-        const serialized = plot.serialize();
-        expect(serialized.plotConfig.y2!.axisType).toBe(AxisType.Timeseries);
-    });
-
     it("can render image", async () => {
         const data: any = {};
         const plotConfig: IPlotConfig = { x: { label: { position: HorizontalLabelPosition.OuterRight }}};