@barchart/chart-lib 2.201.0 → 2.201.2

chart-lib/index.js

@@ -11,6 +11,10 @@ import {
     Topics,
     SeriesKind,
     OHLCDataPointBuilder,
+    StudySeries,
+    linReg,
+    convertSeries,
+    mapSeries,
 } from "./barchart.chart.js";
 
 const ohlcFields = [
@@ -212,15 +216,136 @@ class ExampleFeed extends BaseDataFeed {
     }
 }
 
+// using a built-in study and a small lambda function
+class ChandeForecastOscillatorSeries1 extends StudySeries {
+    constructor(options, innerSeries) {
+        super(options, innerSeries);
+        const linRegSeries = linReg(innerSeries, this.period, this.source);
+        const that = this; // chart replaces `this` inside `convertSeries` with its return value
+        const pluckField = function (pos) {
+            return {
+                [that.source.id]: this.baseVal(that.source, pos),
+            };
+        };
+        const sourceSeries = convertSeries(this.source, pluckField, innerSeries);
+        const oscFunc = (_pos, src, linReg) => (null === src ? null : (100 * (src - linReg)) / src);
+        const oscSeries = mapSeries(this.target, oscFunc, sourceSeries, linRegSeries);
+        this.addInner(oscSeries);
+    }
+    // no need for `calculateAt`, just need to expose the computed value from inner series
+    getWrappers() {
+        return [this.wrapInner(this.target, 1)];
+    }
+}
+
+function sum(arr) {
+    return arr.reduce((prev, curr) => prev + curr, 0);
+}
+
+function notEmpty(arr) {
+    return arr.every(val => val !== null);
+}
+
+// not using any built-in studies, fully implemented here
+class ChandeForecastOscillatorSeries2 extends StudySeries {
+    constructor(options, innerSeries) {
+        super(options, innerSeries);
+        const per = this.inputs.Period;
+        this.xSum = (per * (per + 1.0)) / 2.0; // = sum(1,2,..,n) = (n * (n+1)) / 2
+        this.xSum2 = this.xSum * this.xSum; // xSum squared
+        this.x2Sum = (per * (per + 1.0) * (2 * per + 1.0)) / 6.0;
+        // sum of xs squared = sum(1^2, 2^2,.., n^2) = (n * (n+1)*(2*n +1)) / 6
+    }
+    calculateAt(pos) {
+        let cfosc = null;
+        const per = this.inputs.Period;
+        if (this.atLeast(pos, per)) {
+            let lastN = this.past(pos, per, this.source);
+            if (notEmpty(lastN)) {
+                const ySum = sum(lastN);
+                const xySum = sum(lastN.map((v, i) => v * (i + 1)));
+                const slope = (per * xySum - this.xSum * ySum) / (per * this.x2Sum - this.xSum2);
+                const intercept = (ySum - slope * this.xSum) / per;
+                const mlr = intercept + slope * per;
+                // y = a + b * x; a = intercept, b = slope; y = price, x = date (of bar) index
+                const src = this.baseVal(this.source, pos);
+                cfosc = (100 * (src - mlr)) / src;
+            }
+        }
+        return {
+            [this.target.id]: cfosc,
+        };
+    }
+}
+
+class StudyProvider {
+    getFields() {
+        return [
+            {
+                id: "CFOSC",
+                category: "Study",
+                name: "ChndFcstOsc",
+                shortName: "CFOSC",
+            },
+        ];
+    }
+
+    getStudies() {
+        return [
+            {
+                id: "CFOSC",
+                meta: {
+                    title: "Chande Forecast Oscillator",
+                    overlay: false,
+                },
+                defaults: {
+                    source: "Close",
+                    inputs: [
+                        {
+                            name: "Period",
+                            value: 14,
+                        },
+                    ],
+                    curves: [
+                        {
+                            colors: ["#888"],
+                            fields: ["CFOSC"],
+                        },
+                    ],
+                },
+            },
+        ];
+    }
+
+    factory(studyId, options, innerSeries) {
+        if (studyId === "CFOSC") {
+            return Math.random() > 0.5
+                ? new ChandeForecastOscillatorSeries2(options, innerSeries)
+                : new ChandeForecastOscillatorSeries1(options, innerSeries);
+        }
+        return null;
+    }
+}
+
 const feed = initFeed(ExampleFeed, {
     throttleMillis: 250,
-    apiKey: "c3fd90ea7e38b87566c508a3f3f4bdab",
+    apiKey: "<YOUR_API_KEY>",
+    extensions: {
+        studyProvider: new StudyProvider(),
+    },
 });
 
-feed.ready().then(done => {
-    if (done) {
-        feed.addChart("root", {
-            symbol: `AMZN`,
-        });
-    }
-});
+const ready = await feed.ready();
+if (ready) {
+    const chart = feed.addChart("root", {
+        symbol: `AMZN`,
+    });
+    chart.change({
+        id: "Plot",
+        context: {
+            id: "Add",
+            type: "Study",
+            studyId: "CFOSC",
+        },
+    });
+}

chart-lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@barchart/chart-lib",
-    "version": "2.201.0",
+    "version": "2.201.2",
     "description": "Barchart HTML5 Streaming Chart",
     "main": "barchart.chart.js",
     "types": "barchart.chart.d.ts",