maybeChannel

Author: Fil

src/channel.js

@@ -38,7 +38,7 @@ export const channelRegistry = new Map([
   ["weight", {definition: maybeNumberChannel}] // density
 ]);
 
-export function definition(name, value, defaultValue) {
+export function maybeChannel(name, value, defaultValue) {
   if (!channelRegistry.has(name)) {
     warn(`The ${name} channel is not registered and might be incompatible with some transforms.`);
   }

src/legends/swatches.js

@@ -3,7 +3,7 @@ import {inferFontVariant} from "../axes.js";
 import {maybeAutoTickFormat} from "../axis.js";
 import {Context, create} from "../context.js";
 import {isNoneish} from "../options.js";
-import {definition} from "../channel.js";
+import {maybeChannel} from "../channel.js";
 import {isOrdinalScale, isThresholdScale} from "../scales.js";
 import {applyInlineStyles, impliedString, maybeClassName} from "../style.js";
 
@@ -43,14 +43,14 @@ export function legendSymbols(
   } = {},
   scale
 ) {
-  const [vf, cf] = definition("fill", fill);
-  const [vs, cs] = definition("stroke", stroke);
+  const [vf, cf] = maybeChannel("fill", fill);
+  const [vs, cs] = maybeChannel("stroke", stroke);
   const sf = maybeScale(scale, vf);
   const ss = maybeScale(scale, vs);
   const size = r * r * Math.PI;
-  fillOpacity = definition("fillOpacity", fillOpacity)[1];
-  strokeOpacity = definition("strokeOpacity", strokeOpacity)[1];
-  strokeWidth = definition("strokeWidth", strokeWidth)[1];
+  fillOpacity = maybeChannel("fillOpacity", fillOpacity)[1];
+  strokeOpacity = maybeChannel("strokeOpacity", strokeOpacity)[1];
+  strokeWidth = maybeChannel("strokeWidth", strokeWidth)[1];
   return legendItems(
     symbol,
     options,

src/marks/cell.js

@@ -1,5 +1,5 @@
 import {identity, indexOf, maybeTuple} from "../options.js";
-import {definition} from "../channel.js";
+import {maybeChannel} from "../channel.js";
 import {applyTransform} from "../style.js";
 import {AbstractBar} from "./bar.js";
 
@@ -55,7 +55,7 @@ export function cell(data, options = {}) {
  */
 export function cellX(data, options = {}) {
   let {x = indexOf, fill, stroke, ...remainingOptions} = options;
-  if (fill === undefined && definition("stroke", stroke)[0] === undefined) fill = identity;
+  if (fill === undefined && maybeChannel("stroke", stroke)[0] === undefined) fill = identity;
   return new Cell(data, {...remainingOptions, x, fill, stroke});
 }
 
@@ -73,6 +73,6 @@ export function cellX(data, options = {}) {
  */
 export function cellY(data, options = {}) {
   let {y = indexOf, fill, stroke, ...remainingOptions} = options;
-  if (fill === undefined && definition("stroke", stroke)[0] === undefined) fill = identity;
+  if (fill === undefined && maybeChannel("stroke", stroke)[0] === undefined) fill = identity;
   return new Cell(data, {...remainingOptions, y, fill, stroke});
 }

src/marks/dot.js

@@ -2,7 +2,7 @@ import {path, symbolCircle} from "d3";
 import {create} from "../context.js";
 import {positive} from "../defined.js";
 import {identity, maybeFrameAnchor, maybeTuple} from "../options.js";
-import {definition} from "../channel.js";
+import {maybeChannel} from "../channel.js";
 import {Mark} from "../plot.js";
 import {
   applyChannelStyles,
@@ -24,9 +24,9 @@ const defaults = {
 export class Dot extends Mark {
   constructor(data, options = {}) {
     const {x, y, r, rotate, symbol = symbolCircle, frameAnchor} = options;
-    const [vrotate, crotate] = definition("rotate", rotate, 0);
-    const [vsymbol, csymbol] = definition("symbol", symbol);
-    const [vr, cr] = definition("r", r, vsymbol == null ? 3 : 4.5);
+    const [vrotate, crotate] = maybeChannel("rotate", rotate, 0);
+    const [vsymbol, csymbol] = maybeChannel("symbol", symbol);
+    const [vr, cr] = maybeChannel("r", r, vsymbol == null ? 3 : 4.5);
     super(
       data,
       {

src/marks/image.js

@@ -11,7 +11,7 @@ import {
   impliedString,
   applyFrameAnchor
 } from "../style.js";
-import {definition} from "../channel.js";
+import {maybeChannel} from "../channel.js";
 
 const defaults = {
   ariaLabel: "image",
@@ -24,9 +24,9 @@ export class Image extends Mark {
     let {x, y, width, height, src, preserveAspectRatio, crossOrigin, frameAnchor} = options;
     if (width === undefined && height !== undefined) width = height;
     else if (height === undefined && width !== undefined) height = width;
-    const [vs, cs] = definition("src", src);
-    const [vw, cw] = definition("width", width, 16);
-    const [vh, ch] = definition("height", height, 16);
+    const [vs, cs] = maybeChannel("src", src);
+    const [vw, cw] = maybeChannel("width", width, 16);
+    const [vh, ch] = maybeChannel("height", height, 16);
     super(
       data,
       {

src/marks/text.js

@@ -26,7 +26,7 @@ import {
   applyFrameAnchor
 } from "../style.js";
 import {maybeIntervalMidX, maybeIntervalMidY} from "../transforms/interval.js";
-import {definition} from "../channel.js";
+import {maybeChannel} from "../channel.js";
 
 const defaults = {
   ariaLabel: "text",
@@ -54,8 +54,8 @@ export class Text extends Mark {
       fontWeight,
       rotate
     } = options;
-    const [vrotate, crotate] = definition("rotate", rotate, 0);
-    const [vfontSize, cfontSize] = definition("fontSize", fontSize);
+    const [vrotate, crotate] = maybeChannel("rotate", rotate, 0);
+    const [vfontSize, cfontSize] = maybeChannel("fontSize", fontSize);
     super(
       data,
       {

src/marks/vector.js

@@ -1,7 +1,7 @@
 import {create} from "../context.js";
 import {radians} from "../math.js";
 import {maybeFrameAnchor, maybeTuple, keyword, identity} from "../options.js";
-import {definition} from "../channel.js";
+import {maybeChannel} from "../channel.js";
 import {Mark} from "../plot.js";
 import {
   applyChannelStyles,
@@ -22,8 +22,8 @@ const defaults = {
 export class Vector extends Mark {
   constructor(data, options = {}) {
     const {x, y, length, rotate, anchor = "middle", frameAnchor} = options;
-    const [vl, cl] = definition("length", length, 12);
-    const [vr, cr] = definition("rotate", rotate, 0);
+    const [vl, cl] = maybeChannel("length", length, 12);
+    const [vr, cr] = maybeChannel("rotate", rotate, 0);
     super(
       data,
       {

src/style.js

@@ -3,7 +3,7 @@ import {defined, nonempty} from "./defined.js";
 import {formatDefault} from "./format.js";
 import {string, number, isNoneish, isNone, isRound, keyof} from "./options.js";
 import {warn} from "./warnings.js";
-import {definition} from "./channel.js";
+import {maybeChannel} from "./channel.js";
 
 export const offset = typeof window !== "undefined" && window.devicePixelRatio > 1 ? 0 : 0.5;
 
@@ -71,11 +71,11 @@ export function styles(
     if (isNoneish(defaultStroke) && !isNoneish(stroke)) defaultFill = "none";
   }
 
-  const [vfill, cfill] = definition("fill", fill, defaultFill);
-  const [vfillOpacity, cfillOpacity] = definition("fillOpacity", fillOpacity, defaultFillOpacity);
-  const [vstroke, cstroke] = definition("stroke", stroke, defaultStroke);
-  const [vstrokeOpacity, cstrokeOpacity] = definition("strokeOpacity", strokeOpacity, defaultStrokeOpacity);
-  const [vopacity, copacity] = definition("opacity", opacity);
+  const [vfill, cfill] = maybeChannel("fill", fill, defaultFill);
+  const [vfillOpacity, cfillOpacity] = maybeChannel("fillOpacity", fillOpacity, defaultFillOpacity);
+  const [vstroke, cstroke] = maybeChannel("stroke", stroke, defaultStroke);
+  const [vstrokeOpacity, cstrokeOpacity] = maybeChannel("strokeOpacity", strokeOpacity, defaultStrokeOpacity);
+  const [vopacity, copacity] = maybeChannel("opacity", opacity);
 
   // For styles that have no effect if there is no stroke, only apply the
   // defaults if the stroke is not the constant none. (If stroke is a channel,
@@ -95,7 +95,7 @@ export function styles(
     if (!isNone(cfill) && paintOrder === undefined) paintOrder = defaultPaintOrder;
   }
 
-  const [vstrokeWidth, cstrokeWidth] = definition("strokeWidth", strokeWidth);
+  const [vstrokeWidth, cstrokeWidth] = maybeChannel("strokeWidth", strokeWidth);
 
   // Some marks don’t support fill (e.g., tick and rule).
   if (defaultFill !== null) {

src/transforms/bin.js

@@ -7,7 +7,7 @@ import {
   thresholdSturges,
   utcTickInterval
 } from "d3";
-import {definition} from "../channel.js";
+import {maybeChannel} from "../channel.js";
 import {
   valueof,
   identity,
@@ -158,8 +158,8 @@ function binn(
     ...options
   } = inputs;
   const [GZ, setGZ] = maybeColumn(z);
-  const [vfill] = definition("fill", fill);
-  const [vstroke] = definition("stroke", stroke);
+  const [vfill] = maybeChannel("fill", fill);
+  const [vstroke] = maybeChannel("stroke", stroke);
   const [GF, setGF] = maybeColumn(vfill);
   const [GS, setGS] = maybeColumn(vstroke);
 

src/transforms/group.js

@@ -29,7 +29,7 @@ import {
   second,
   percentile
 } from "../options.js";
-import {definition} from "../channel.js";
+import {maybeChannel} from "../channel.js";
 import {basic} from "./basic.js";
 
 /**
@@ -135,8 +135,8 @@ function groupn(
     ...options
   } = inputs;
   const [GZ, setGZ] = maybeColumn(z);
-  const [vfill] = definition("fill", fill);
-  const [vstroke] = definition("stroke", stroke);
+  const [vfill] = maybeChannel("fill", fill);
+  const [vstroke] = maybeChannel("stroke", stroke);
   const [GF, setGF] = maybeColumn(vfill);
   const [GS, setGS] = maybeColumn(vstroke);