ChannelValueDenseBinSpec

Author: mbostock

src/channel.d.ts

@@ -1,6 +1,7 @@
 import type {Interval} from "./interval.js";
 import type {Reducer} from "./reducer.js";
 import type {ScaleName, ScaleType} from "./scales.js";
+import type {BinOptions} from "./transforms/bin.js";
 
 /** Lazily-constructed channel values derived from data. */
 export interface ChannelTransform {
@@ -148,6 +149,18 @@ export type ChannelValueSpec = ChannelValue | {value: ChannelValue; scale?: Chan
  */
 export type ChannelValueIntervalSpec = ChannelValueSpec | {value: ChannelValue; interval?: Interval}; // TODO scale override?
 
+/**
+ * When binning on **x** or **y**, you can specify the channel values as a
+ * {value} object to provide separate bin options for each.
+ */
+export type ChannelValueBinSpec = ChannelValue | ({value: ChannelValue} & BinOptions);
+
+/**
+ * For marks that use a one-dimensional dense interval transform, such as lineX
+ * and areaY; here interval must be a mark-level option.
+ */
+export type ChannelValueDenseBinSpec = ChannelValue | ({value: ChannelValue; scale?: Channel["scale"]} & Omit<BinOptions, "interval">); // prettier-ignore
+
 /**
  * The available inputs for imputing scale domains. In addition to a named
  * channel, an input may be specified as:

src/marks/area.d.ts

@@ -1,4 +1,4 @@
-import type {ChannelValue, ChannelValueSpec} from "../channel.js";
+import type {ChannelValue, ChannelValueDenseBinSpec, ChannelValueSpec} from "../channel.js";
 import type {CurveOptions} from "../curve.js";
 import type {Data, MarkOptions, RenderableMark} from "../mark.js";
 import type {BinOptions, BinReducer} from "../transforms/bin.js";
@@ -14,12 +14,12 @@ export interface AreaOptions extends MarkOptions, StackOptions, CurveOptions {
 
 export interface AreaXOptions extends Omit<AreaOptions, "y1" | "y2">, BinOptions {
   x?: ChannelValueSpec;
-  y?: ChannelValueSpec & Omit<BinOptions, "interval">; // interval must be a mark-level option
+  y?: ChannelValueDenseBinSpec;
   reduce?: BinReducer;
 }
 
 export interface AreaYOptions extends Omit<AreaOptions, "x1" | "x2">, BinOptions {
-  x?: ChannelValueSpec & Omit<BinOptions, "interval">; // interval must be a mark-level option
+  x?: ChannelValueDenseBinSpec;
   y?: ChannelValueSpec;
   reduce?: BinReducer;
 }

src/marks/line.d.ts

@@ -1,4 +1,4 @@
-import type {ChannelValue, ChannelValueSpec} from "../channel.js";
+import type {ChannelValue, ChannelValueDenseBinSpec, ChannelValueSpec} from "../channel.js";
 import type {CurveAutoOptions} from "../curve.js";
 import type {Data, MarkOptions, RenderableMark} from "../mark.js";
 import type {MarkerOptions} from "../marker.js";
@@ -11,12 +11,12 @@ export interface LineOptions extends MarkOptions, MarkerOptions, CurveAutoOption
 }
 
 export interface LineXOptions extends LineOptions, BinOptions {
-  y?: ChannelValueSpec & Omit<BinOptions, "interval">; // interval must be mark-level option
+  y?: ChannelValueDenseBinSpec;
   reduce?: BinReducer;
 }
 
 export interface LineYOptions extends LineOptions, BinOptions {
-  x?: ChannelValueSpec & Omit<BinOptions, "interval">; // interval must be mark-level option
+  x?: ChannelValueDenseBinSpec;
   reduce?: BinReducer;
 }
 

src/marks/linearRegression.d.ts

@@ -1,4 +1,4 @@
-import type {ChannelValue, ChannelValueSpec} from "../channel.js";
+import type {ChannelValue, ChannelValueDenseBinSpec, ChannelValueSpec} from "../channel.js";
 import type {Data, MarkOptions, RenderableMark} from "../mark.js";
 import type {BinOptions, BinReducer} from "../transforms/bin.js";
 
@@ -12,11 +12,11 @@ interface LinearRegressionOptions extends MarkOptions, BinOptions {
 }
 
 export interface LinearRegressionXOptions extends LinearRegressionOptions {
-  y?: ChannelValueSpec & Omit<BinOptions, "interval">; // interval must be mark-level option
+  y?: ChannelValueDenseBinSpec;
 }
 
 export interface LinearRegressionYOptions extends LinearRegressionOptions {
-  x?: ChannelValueSpec & Omit<BinOptions, "interval">; // interval must be mark-level option
+  x?: ChannelValueDenseBinSpec;
 }
 
 export function linearRegressionX(data?: Data, options?: LinearRegressionXOptions): RenderableMark;

src/transforms/bin.d.ts

@@ -1,4 +1,4 @@
-import type {ChannelReducers, ChannelValue} from "../channel.js";
+import type {ChannelReducers, ChannelValueBinSpec} from "../channel.js";
 import type {RangeInterval} from "../interval.js";
 import type {Reducer} from "../reducer.js";
 import type {Transformed} from "./basic.js";
@@ -149,12 +149,6 @@ export interface BinReducerImplementation<S = any, T = S> {
   // TODO label
 }
 
-/**
- * When binning on **x** or **y**, you can specify the channel values as a
- * {value} object to provide separate bin options for each.
- */
-export type ChannelValueBinSpec = ChannelValue | ({value: ChannelValue} & BinOptions);
-
 /** Inputs to the binX transform. */
 export type BinXInputs<T> = Omit<T, "x"> & {x?: ChannelValueBinSpec} & BinOptions;