@uwdata/mosaic-spec 0.11.0 → 0.12.0

package/src/spec/PlotInteractor.ts

@@ -3,6 +3,7 @@ import { IntervalX, IntervalY } from './interactors/Interval1D.js';
 import { IntervalXY } from './interactors/Interval2D.js';
 import { NearestX, NearestY } from './interactors/Nearest.js';
 import { Pan, PanX, PanY, PanZoom, PanZoomX, PanZoomY } from './interactors/PanZoom.js';
+import { Region } from './interactors/Region.js';
 import { Toggle, ToggleColor, ToggleX, ToggleY } from './interactors/Toggle.js';
 
 /** A plot interactor entry. */
@@ -13,13 +14,14 @@ export type PlotInteractor =
   | IntervalXY
   | NearestX
   | NearestY
-  | Toggle
-  | ToggleX
-  | ToggleY
-  | ToggleColor
   | Pan
   | PanX
   | PanY
   | PanZoom
   | PanZoomX
-  | PanZoomY;
+  | PanZoomY
+  | Region
+  | Toggle
+  | ToggleX
+  | ToggleY
+  | ToggleColor;

package/src/spec/Transform.ts

@@ -17,7 +17,7 @@ export interface AggregateOptions {
 }
 
 /** A transform argument. */
-type Arg = string | number | boolean;
+type Arg = string | number | boolean | ParamRef;
 
 /** A zero argument transform signature. */
 type Arg0 = null | [];
@@ -102,6 +102,14 @@ export interface Bin {
   offset?: number;
 }
 
+/* A column transform. */
+export interface Column {
+  /**
+   * Intpret a string or param-value as a column reference.
+   */
+  column: Arg1;
+}
+
 /* A dateMonth transform. */
 export interface DateMonth {
   /**
@@ -423,6 +431,7 @@ export interface NthValue extends WindowOptions {
 /** A data transform that maps one column value to another. */
 export type ColumnTransform =
   | Bin
+  | Column
   | DateMonth
   | DateMonthDay
   | DateDay

package/src/spec/interactors/BrushStyles.ts

@@ -0,0 +1,27 @@
+/** Styles for rectangular selection brushes. */
+export interface BrushStyles {
+  /**
+   * The overall opacity of the brush rectangle.
+   */
+  opacity?: number;
+  /**
+   * The fill opacity of the brush rectangle.
+   */
+  fillOpacity?: number;
+  /**
+   * The stroke opacity of the brush rectangle.
+   */
+  strokeOpacity?: number;
+  /**
+   * The fill color of the brush rectangle.
+   */
+  fill?: string;
+  /**
+   * The stroke color of the brush rectangle.
+   */
+  stroke?: string;
+  /**
+   * The stroke dash array of the brush rectangle.
+   */
+  strokeDasharray?: string;
+}

package/src/spec/interactors/Interval1D.ts

@@ -1,28 +1,5 @@
 import { ParamRef } from '../Param.js';
-
-/** Styles for rectangular selection brushes. */
-export interface BrushStyles {
-  /**
-   * The overall opacity of the brush rectangle.
-   */
-  opacity?: number;
-  /**
-   * The fill opacity of the brush rectangle.
-   */
-  fillOpacity?: number;
-  /**
-   * The stroke opacity of the brush rectangle.
-   */
-  strokeOpacity?: number;
-  /**
-   * The fill color of the brush rectangle.
-   */
-  fill?: string;
-  /**
-   * The stroke color of the brush rectangle.
-   */
-  stroke?: string;
-}
+import { BrushStyles } from './BrushStyles.js';
 
 /** Options for 1D interval interactors. */
 export interface Interval1DOptions {
@@ -39,13 +16,14 @@ export interface Interval1DOptions {
   field?: string;
   /**
    * The size of an interative pixel (default `1`). Larger pixel sizes reduce
-   * the brush resolution, which can reduce the size of data cube indexes.
+   * the brush resolution, which can reduce the size of pre-aggregated
+   * materialized views.
    */
   pixelSize?: number;
   /**
-   * A flag indicating if peer (sibling) marks are when cross-filtering
-   * (default `true`). If set, peer marks will not be filtered by this
-   * interactor's selection in cross-filtering setups.
+   * A flag indicating if peer (sibling) marks are excluded when
+   * cross-filtering (default `true`). If set, peer marks will not be
+   * filtered by this interactor's selection in cross-filtering setups.
    */
   peers?: boolean;
   /**

package/src/spec/interactors/Interval2D.ts

@@ -1,5 +1,5 @@
 import { ParamRef } from '../Param.js';
-import { BrushStyles } from './Interval1D.js';
+import { BrushStyles } from './BrushStyles.js';
 
 /** Options for 2D interval interactors. */
 export interface Interval2DOptions {
@@ -23,13 +23,14 @@ export interface Interval2DOptions {
   yfield?: string;
   /**
    * The size of an interative pixel (default `1`). Larger pixel sizes reduce
-   * the brush resolution, which can reduce the size of data cube indexes.
+   * the brush resolution, which can reduce the size of pre-aggregated
+   * materialized views.
    */
   pixelSize?: number;
   /**
-   * A flag indicating if peer (sibling) marks are when cross-filtering
-   * (default `true`). If set, peer marks will not be filtered by this
-   * interactor's selection in cross-filtering setups.
+   * A flag indicating if peer (sibling) marks are excluded when
+   * cross-filtering (default `true`). If set, peer marks will not be
+   * filtered by this interactor's selection in cross-filtering setups.
    */
   peers?: boolean;
   /**

package/src/spec/interactors/Region.ts

@@ -0,0 +1,34 @@
+import { ParamRef } from '../Param.js';
+import { BrushStyles } from './BrushStyles.js';
+
+/** Options for region interactors. */
+export interface RegionOptions {
+  /**
+   * The output selection. A clause of the form
+   * `(field = value1) OR (field = value2) ...`
+   * is added for the currently selected values.
+   */
+  as: ParamRef;
+  /**
+   * The encoding channels over which to select values.
+   * For a selected mark, selection clauses will cover
+   * the backing data fields for each channel.
+   */
+  channels: string[];
+  /**
+   * A flag indicating if peer (sibling) marks are excluded when
+   * cross-filtering (default `true`). If set, peer marks will not be
+   * filtered by this interactor's selection in cross-filtering setups.
+   */
+  peers?: boolean;
+  /**
+   * CSS styles for the brush (SVG `rect`) element.
+   */
+  brush?: BrushStyles;
+}
+
+/** A rectangular region interactor. */
+export interface Region extends RegionOptions {
+  /** Select aspects of individual marks within a 2D range. */
+  select: 'region';
+}

package/src/spec/interactors/Toggle.ts

@@ -9,9 +9,9 @@ export interface ToggleOptions {
    */
   as: ParamRef;
   /**
-   * A flag indicating if peer (sibling) marks are when cross-filtering
-   * (default `true`). If set, peer marks will not be filtered by this
-   * interactor's selection in cross-filtering setups.
+   * A flag indicating if peer (sibling) marks are excluded when
+   * cross-filtering (default `true`). If set, peer marks will not be
+   * filtered by this interactor's selection in cross-filtering setups.
    */
   peers?: boolean;
 }

package/src/spec/marks/Marks.ts

@@ -432,6 +432,12 @@ export interface MarkOptions {
     | (TipOptions & { pointer?: TipPointer })
     | ParamRef;
 
+  /**
+   * Additional named channels, for example to include in a tooltip.
+   * Consists of (channel name, data field name) key-value pairs.
+   */
+  channels?: Record<string, string>;
+
   /**
    * How to clip the mark; one of:
    *