expose window, normalize (observablehq#551)

mbostock · Fil · web-flow · commit ce19abb0f520 · 2021-09-24T08:08:58.000-07:00
* expose window, normalize

* Update test/plots/aapl-bollinger.js

Co-authored-by: Philippe Rivi&egrave;re &lt;fil@rezo.net&gt;

* update test snapshot

Co-authored-by: Philippe Rivi&egrave;re &lt;fil@rezo.net&gt;
diff --git a/README.md b/README.md
@@ -1340,6 +1340,14 @@ Plot.mapY("cumsum", {y: d3.randomNormal()})
 
 Equivalent to Plot.map({y: *map*, y1: *map*, y2: *map*}, *options*), but ignores any of **y**, **y1**, and **y2** not present in *options*.
 
+#### Plot.normalize(*basis*)
+
+```js
+Plot.map({y: Plot.normalize("first")}, {x: "Date", y: "Close", stroke: "Symbol"})
+```
+
+Returns a normalize map method for the given *basis*, suitable for use with Plot.map.
+
 #### Plot.normalizeX(*basis*, *options*)
 
 ```js
@@ -1356,6 +1364,14 @@ Plot.normalizeY("first", {x: "Date", y: "Close", stroke: "Symbol"})
 
 Like [Plot.mapY](#plotmapymap-options), but applies the normalize map method with the given *basis*.
 
+#### Plot.window(*k*)
+
+```js
+Plot.map({y: Plot.window(24)}, {x: "Date", y: "Close", stroke: "Symbol"})
+```
+
+Returns a window map method for the given window size *k*, suitable for use with Plot.map. For additional options to the window transform, replace the number *k* with an object with properties *k*, *anchor*, or *reduce*.
+
 #### Plot.windowX(*k*, *options*)
 
 ```js
diff --git a/src/index.js b/src/index.js
@@ -16,9 +16,9 @@ export {reverse} from "./transforms/reverse.js";
 export {sort} from "./transforms/sort.js";
 export {bin, binX, binY} from "./transforms/bin.js";
 export {group, groupX, groupY, groupZ} from "./transforms/group.js";
-export {normalizeX, normalizeY} from "./transforms/normalize.js";
+export {normalize, normalizeX, normalizeY} from "./transforms/normalize.js";
 export {map, mapX, mapY} from "./transforms/map.js";
-export {windowX, windowY} from "./transforms/window.js";
+export {window, windowX, windowY} from "./transforms/window.js";
 export {selectFirst, selectLast, selectMaxX, selectMaxY, selectMinX, selectMinY} from "./transforms/select.js";
 export {stackX, stackX1, stackX2, stackY, stackY1, stackY2} from "./transforms/stack.js";
 export {formatIsoDate, formatWeekday, formatMonth} from "./format.js";
diff --git a/src/transforms/normalize.js b/src/transforms/normalize.js
@@ -13,7 +13,7 @@ export function normalizeY(basis, options) {
   return mapY(normalize(basis), options);
 }
 
-function normalize(basis) {
+export function normalize(basis) {
   if (basis === undefined) return normalizeFirst;
   if (typeof basis === "function") return normalizeBasis((I, S) => basis(take(S, I)));
   switch ((basis + "").toLowerCase()) {
diff --git a/src/transforms/window.js b/src/transforms/window.js
@@ -11,7 +11,7 @@ export function windowY(windowOptions = {}, options) {
   return mapY(window(windowOptions), options);
 }
 
-function window(options = {}) {
+export function window(options = {}) {
   if (typeof options === "number") options = {k: options};
   let {k, reduce, shift, anchor = maybeShift(shift)} = options;
   if (!((k = Math.floor(k)) > 0)) throw new Error("invalid k");
diff --git a/test/output/aaplBollinger.svg b/test/output/aaplBollinger.svg
diff --git a/test/plots/aapl-bollinger.js b/test/plots/aapl-bollinger.js
@@ -0,0 +1,20 @@
+import * as Plot from "@observablehq/plot";
+import * as d3 from "d3";
+
+export default async function() {
+  const AAPL = await d3.csv("data/aapl.csv", d3.autoType);
+  return Plot.plot({
+    y: {
+      grid: true
+    },
+    marks: [
+      Plot.areaY(AAPL, Plot.map({y1: bollinger(20, -2), y2: bollinger(20, 2)}, {x: "Date", y: "Close", fillOpacity: 0.2})),
+      Plot.line(AAPL, Plot.map({y: bollinger(20, 0)}, {x: "Date", y: "Close", stroke: "blue"})),
+      Plot.line(AAPL, {x: "Date", y: "Close", strokeWidth: 1})
+    ]
+  });
+}
+
+function bollinger(N, K) {
+  return Plot.window({k: N, reduce: Y => d3.mean(Y) + K * d3.deviation(Y), anchor: "end"});
+}
diff --git a/test/plots/index.js b/test/plots/index.js
@@ -1,3 +1,4 @@
+export {default as aaplBollinger} from "./aapl-bollinger.js";
 export {default as aaplCandlestick} from "./aapl-candlestick.js";
 export {default as aaplChangeVolume} from "./aapl-change-volume.js";
 export {default as aaplClose} from "./aapl-close.js";

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ export function normalizeY(basis, options) {`
`13`	`13`	`return mapY(normalize(basis), options);`
`14`	`14`	`}`
`15`	`15`
`16`		`-function normalize(basis) {`
	`16`	`+export function normalize(basis) {`
`17`	`17`	`if (basis === undefined) return normalizeFirst;`
`18`	`18`	`if (typeof basis === "function") return normalizeBasis((I, S) => basis(take(S, I)));`
`19`	`19`	`switch ((basis + "").toLowerCase()) {`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ export function windowY(windowOptions = {}, options) {`
`11`	`11`	`return mapY(window(windowOptions), options);`
`12`	`12`	`}`
`13`	`13`
`14`		`-function window(options = {}) {`
	`14`	`+export function window(options = {}) {`
`15`	`15`	`if (typeof options === "number") options = {k: options};`
`16`	`16`	`let {k, reduce, shift, anchor = maybeShift(shift)} = options;`
`17`	`17`	`if (!((k = Math.floor(k)) > 0)) throw new Error("invalid k");`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+export {default as aaplBollinger} from "./aapl-bollinger.js";`
`1`	`2`	`export {default as aaplCandlestick} from "./aapl-candlestick.js";`
`2`	`3`	`export {default as aaplChangeVolume} from "./aapl-change-volume.js";`
`3`	`4`	`export {default as aaplClose} from "./aapl-close.js";`