@reside-ic/skadi-chart 1.0.0 → 1.1.0

package/README.md

@@ -107,6 +107,7 @@ class CustomLayer extends OptionalLayer {
 new Chart()
   .addAxes()
   .addTraces(lines)
+  .addArea()
   .addScatterPoints(points)
   .addGridLines()
   .addZoom()
@@ -165,6 +166,11 @@ fixed scale.
   ```ts
   chart.addTraces(lines);
   ```
+* `addArea` adds an [AreaLayer](./src/layers/AreaLayer.ts). This will add an area underneath
+the traces to the graph.
+  ```ts
+  chart.addArea();
+  ```
 * `addScatterPoints` add a [ScatterLayer](./src/layers/ScatterLayer.ts). This will add
 scatter points to the graph. This data will also be used for autoscaling the axes if you
 haven't provided a fixed scale.

package/dist/skadi-chart.d.ts

@@ -74,16 +74,19 @@ declare module "types" {
         end?: number;
     }>>;
     export type LineStyle = {
-        color?: string;
+        strokeColor?: string;
         opacity?: number;
         strokeWidth?: number;
         strokeDasharray?: string;
+        fillColor?: string;
+        fillOpacity?: number;
     };
     export type LineConfig<Metadata> = {
         points: Point[];
         style: LineStyle;
         metadata?: Metadata;
         bands?: Partial<XY<string>>;
+        fill?: boolean;
     };
     export type Lines<Metadata> = LineConfig<Metadata>[];
     export type ScatterPointStyle = {
@@ -103,6 +106,7 @@ declare module "layers/Layer" {
         ClipPath = "clipPath",
         BaseLayer = "baseLayer",
         Axes = "axes",
+        Area = "area",
         Zoom = "zoom",
         Trace = "trace",
         Tooltip = "skadi-chart-tooltip",
@@ -138,8 +142,11 @@ declare module "layers/AxesLayer" {
     }
 }
 declare module "helpers" {
-    import { LayerArgs, ScaleNumeric, XY } from "types";
+    import { LayerArgs, ScaleNumeric, XY, Point, ZoomExtents, Scales } from "types";
+    export const customLineGen: (lineSC: Point[], zoomExtents: ZoomExtents) => string[];
     export const numScales: (bands: Partial<XY<string>> | undefined, layerArgs: LayerArgs) => XY<ScaleNumeric>;
+    export const getXYMinMax: (points: Point[]) => Scales;
+    export const getSvgRectPath: (xStart: number, xEnd: number, yStart: number, yEnd: number) => string;
 }
 declare module "layers/TracesLayer" {
     import { LayerArgs, Lines, Point, ZoomExtents } from "types";
@@ -153,13 +160,11 @@ declare module "layers/TracesLayer" {
         options: TracesOptions;
         type: LayerType;
         private traces;
-        private lowResLinesSC;
-        private getNewPoint;
+        lowResLinesSC: Point[][];
+        getNewPoint: null | ((x: number, y: number, t: number) => Point);
+        getNewPointInverse: null | ((x: number, y: number, t: number) => Point);
         constructor(linesDC: Lines<Metadata>, options: TracesOptions);
         private customTween;
-        private round;
-        private getNewSvgPoint;
-        private customLineGen;
         private updateLowResLinesSC;
         draw: (layerArgs: LayerArgs, currentExtentsDC: ZoomExtents) => void;
     }
@@ -219,6 +224,27 @@ declare module "layers/GridLayer" {
         draw: (layerArgs: LayerArgs) => void;
     }
 }
+declare module "layers/AreaLayer" {
+    import { LayerArgs, ZoomExtents } from "types";
+    import { LayerType, OptionalLayer } from "layers/Layer";
+    type LineBoundaryInfo = {
+        xMinDC: number;
+        xMaxDC: number;
+        canvasPath: Path2D;
+        yCoordForXAxisSC: number;
+        xMinSC: number;
+        xMaxSC: number;
+    };
+    export class AreaLayer<Metadata> extends OptionalLayer {
+        type: LayerType;
+        ctx: CanvasRenderingContext2D;
+        lineBoundaryInfo: (LineBoundaryInfo | null)[][];
+        constructor();
+        draw(layerArgs: LayerArgs, currentExtentsDC: ZoomExtents): void;
+        private customTween;
+        private closeSvgPath;
+    }
+}
 declare module "Chart" {
     import { TracesOptions } from "layers/TracesLayer";
     import { ZoomOptions } from "layers/ZoomLayer";
@@ -264,6 +290,7 @@ declare module "Chart" {
         private filterLinesForLogAxis;
         private filterLines;
         addTraces: (lines: Lines<Metadata>, options?: Partial<TracesOptions>) => this;
+        addArea: () => this;
         addZoom: (options?: ZoomOptions) => this;
         addTooltips: (tooltipHtmlCallback: TooltipHtmlCallback<Metadata>) => this;
         private filterScatterPointsForLogAxis;
@@ -272,7 +299,6 @@ declare module "Chart" {
         addCustomLifecycleHooks: (lifecycleHooks: Partial<LifecycleHooks>) => this;
         addCustomLayer: (customLayer: OptionalLayer) => this;
         makeResponsive: () => this;
-        private getXYMinMax;
         private addLinearPadding;
         private addLogPadding;
         private processScales;