tweaks

Author: mbostock

src/marks/tip.d.ts

@@ -63,10 +63,10 @@ export interface TipOptions extends MarkOptions, TextStyles {
   anchor?: FrameAnchor;
 
   /**
-   * The format option controls what the tip shows. It may be specified as a
-   * function which is passed the datum d and zero-based index i and returns a
-   * string or an iterable of already-formatted tip items, or an iterable of
-   * channels or values and how to format them.
+   * The format option controls what the tip shows; either a function which is
+   * passed the datum d and zero-based index i and returns a string or an
+   * iterable of formatted tip items, or an iterable of channel names or values
+   * and optionally how to label and format them.
    */
   format?: ((d: any, i: number) => string | Iterable<TipItem>) | Iterable<ChannelName | ChannelValue | TipFormatItem>;
 }

src/marks/tip.js

@@ -43,7 +43,6 @@ export class Tip extends Mark {
       lineWidth = 20,
       frameAnchor,
       format,
-      source, // TODO a better way to detect channels that will be derived?
       textAnchor = "start",
       textOverflow,
       textPadding = 8,
@@ -84,7 +83,7 @@ export class Tip extends Mark {
     for (const key in defaults) if (key in this.channels) this[key] = defaults[key]; // apply default even if channel
     this.splitLines = splitter(this);
     this.clipLine = clipper(this);
-    this.format = maybeTipFormat(this.channels, source?.channels, format);
+    this.format = maybeTipFormat(this.channels, format);
   }
   render(index, scales, values, dimensions, context) {
     const mark = this;
@@ -320,14 +319,14 @@ function getSources({channels}) {
 }
 
 // Note: mutates channels!
-function maybeTipFormat(channels, sourceChannels, format) {
+function maybeTipFormat(channels, format) {
   if (format === undefined) return;
   if (typeof format === "function") {
     return function (i, index, channels, scales, {data}) {
       return format.call(this, data[i], i);
     };
   }
-  format = Array.from(format, (f) => maybeTipFormatItem(f, channels, sourceChannels));
+  format = Array.from(format, (f) => maybeTipFormatItem(f, channels));
   return function* (i, index, channels, scales, values) {
     for (let {label, channel: key, format: formatValue} of format) {
       if (label === undefined) label = formatLabel(scales, channels, key);
@@ -339,22 +338,22 @@ function maybeTipFormat(channels, sourceChannels, format) {
         };
       } else {
         if (formatValue === undefined) formatValue = formatDefault;
-        const value = values[key][i];
-        const scale = channels[key].scale;
+        const channel = channels[key];
+        const scale = channel.scale;
         yield {
           label,
-          value: formatValue(value),
-          color: scale === "color" ? value : null,
-          opacity: scale === "opacity" ? value : null
+          value: formatValue(channel.value[i]),
+          color: scale === "color" ? values[key][i] : null,
+          opacity: scale === "opacity" ? values[key][i] : null
         };
       }
     }
   };
 }
 
 // Note: mutates channels!
-function maybeTipFormatItem(f, channels, sourceChannels) {
-  if (typeof f === "string") f = channels[f] || sourceChannels?.[f] ? {channel: f} : {value: f}; // shorthand string
+function maybeTipFormatItem(f, channels) {
+  if (typeof f === "string") f = {channel: f}; // shorthand channel name
   f = maybeValue(f); // shorthand function, array, etc.
   if (typeof f.format === "string") f = {...f, format: numberFormat(f.format)}; // shorthand format; TODO dates
   if (f.value !== undefined) f = {...f, channel: deriveChannel(channels, f)}; // shorthand channel

src/plot.js

@@ -532,7 +532,6 @@ function inferTips(marks) {
       p = /^x$/i.test(p) ? pointerX : /^y$/i.test(p) ? pointerY : pointer; // TODO validate
       tipOptions = p(derive(mark, tipOptions));
       tipOptions.title = null; // prevent implicit title for primitive data
-      tipOptions.source = mark; // TODO cleaner
       tips.push(tip(mark.data, tipOptions));
     }
   }