document normalize #1354
document normalize #1354
Conversation
src/transforms/normalize.d.ts
Outdated
| @@ -22,12 +22,73 @@ export interface NormalizeOptions { | |||
| basis?: NormalizeBasis; | |||
| } | |||
|
|
|||
| /** | |||
| * Normalize series values relative to the given basis. For example, if the | |||
There was a problem hiding this comment.
This is another instance where we want the first sentence to emphasize what is unique about normalizeX as opposed to shared across all variations of the normalize transform: it should mention specifically which channels are going to be transformed. (Fixing as I edit.)
There was a problem hiding this comment.
Also, since the normalize transform is built on top of the map transform, we should also mention that data are first grouped into series. From Plot.map in the README:
Groups on the first channel of z, fill, or stroke, if any, and then for each channel declared in the specified outputs object, applies the corresponding map method.
Something like:
Groups data into series using the first channel of z, fill, or stroke, if any, and then derives new x, x1, and x2 channels for each corresponding input channel by applying the given normalize basis.
* document normalize * avoid duplication * edits --------- Co-authored-by: Mike Bostock <mbostock@gmail.com>
for #1343
lots of repetitions, but looks ok?