@uwdata/mosaic-spec 0.11.0 → 0.12.1

package/src/config/transforms.js

@@ -10,6 +10,7 @@ export function transformNames(overrides = []) {
     'centroid',
     'centroidX',
     'centroidY',
+    'column',
     'count',
     'covariance',
     'covarPop',

package/src/constants.js

@@ -13,6 +13,7 @@ export const OPTIONS = 'options';
 // params and selections
 export const SELECTION = 'selection';
 export const PARAMREF = 'paramref';
+export const COLUMPARAMREF = 'columnparamref';
 export const PARAM = 'param';
 export const INCLUDE = 'include';
 
@@ -30,7 +31,6 @@ export const DATA = 'data';
 // sql expressions
 export const EXPRESSION = 'expression';
 export const SQL = 'sql';
-export const AGG = 'agg';
 
 // inputs
 export const INPUT = 'input';

package/src/spec/Input.ts

@@ -171,7 +171,7 @@ export interface Table {
   /**
    * The name of a database table to use as a data source for this widget.
    */
-  from: string;
+  from: string | ParamRef;
   /**
    * A list of column names to include in the table grid.
    * If unspecified, all table columns are included.

package/src/spec/PlotAttribute.ts

@@ -178,13 +178,21 @@ export interface PlotAttributes {
   grid?: boolean | string | ParamRef;
 
   /**
-   * A textual label to show on the axis or legend; if null, show no label. By
-   * default the scale label is inferred from channel definitions, possibly with
-   * an arrow (↑, →, ↓, or ←) to indicate the direction of increasing value.
+   * The [aria-label attribute][1] on the SVG root.
    *
-   * For axes and legends only.
+   * [1]: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label
    */
-  label?: string | null | ParamRef;
+  ariaLabel?: string | null;
+
+  /**
+   * The [aria-description attribute][1] on the SVG root.
+   *
+   * [1]: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-description
+   */
+  ariaDescription?: string | null;
+
+  /** The default clip for all marks. */
+  clip?: 'frame' | 'sphere' | boolean | null | ParamRef;
 
 
   // x scale attributes

package/src/spec/PlotFrom.ts

@@ -9,7 +9,7 @@ export type PlotDataInline = any[];
 /** Input data specification for a plot mark. */
 export interface PlotFrom {
   /** The name of the backing data table. */
-  from: string;
+  from: string | ParamRef;
   /** A selection that filters the mark data. */
   filterBy?: ParamRef;
   /**

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/PlotMark.ts

@@ -23,6 +23,7 @@ import { RuleX, RuleY } from './marks/Rule.js';
 import { Text,TextX, TextY } from './marks/Text.js';
 import { TickX, TickY } from './marks/Tick.js';
 import { Spike, Vector, VectorX, VectorY } from './marks/Vector.js';
+import { WaffleX, WaffleY } from './marks/Waffle.js';
 
 /** A plot mark entry. */
 export type PlotMark =
@@ -50,4 +51,5 @@ export type PlotMark =
   | RuleX | RuleY
   | Text | TextX | TextY
   | TickX | TickY
-  | Vector | VectorX | VectorY | Spike;
+  | Vector | VectorX | VectorY | Spike
+  | WaffleX | WaffleY;

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:
    *

package/src/spec/marks/Waffle.ts

@@ -0,0 +1,61 @@
+import { ParamRef } from '../Param.js';
+import { BarXOptions, BarYOptions } from './Bar.js';
+import { MarkData } from './Marks.js';
+
+/** Options for the waffleX and waffleY mark. */
+export interface WaffleOptions {
+  /** The number of cells per row or column; defaults to undefined for automatic. */
+  multiple?: number | ParamRef;
+  /** The quantity each cell represents; defaults to 1. */
+  unit?: number | ParamRef;
+  /** The gap in pixels between cells; defaults to 1. */
+  gap?: number | ParamRef;
+  /** If true, round to integers to avoid partial cells. */
+  round?: boolean | ParamRef;
+}
+
+/** The waffleX mark. */
+export interface WaffleX extends MarkData, BarXOptions, WaffleOptions {
+  /**
+   * A horizontal waffle mark. The required *x* values should be quantitative,
+   * and the optional *y* values should be ordinal.
+   *
+   * If neither **x1** nor **x2** nor **interval** is specified, an implicit
+   * stackX transform is applied and **x** defaults to the identity function,
+   * assuming that *data* = [*x₀*, *x₁*, *x₂*, …]. Otherwise if an **interval**
+   * is specified, then **x1** and **x2** are derived from **x**, representing
+   * the lower and upper bound of the containing interval, respectively.
+   * Otherwise, if only one of **x1** or **x2** is specified, the other
+   * defaults to **x**, which defaults to zero.
+   *
+   * The optional **y** ordinal channel specifies the vertical position; it is
+   * typically bound to the *y* scale, which must be a *band* scale. If the
+   * **y** channel is not specified, the bar will span the vertical extent of
+   * the plot’s frame. Because a waffle represents a discrete number of square
+   * cells, it may not use all of the available bandwidth.
+   */
+  mark: 'waffleX';
+}
+
+/** The waffleY mark. */
+export interface WaffleY extends MarkData, BarYOptions, WaffleOptions {
+  /**
+   * A vertical waffle mark. The required *y* values should be quantitative,
+   * and the optional *x* values should be ordinal.
+   *
+   * If neither **y1** nor **y2** nor **interval** is specified, an implicit
+   * stackY transform is applied and **y** defaults to the identity function,
+   * assuming that *data* = [*y₀*, *y₁*, *y₂*, …]. Otherwise if an **interval**
+   * is specified, then **y1** and **y2** are derived from **y**, representing
+   * the lower and upper bound of the containing interval, respectively.
+   * Otherwise, if only one of **y1** or **y2** is specified, the other
+   * defaults to **y**, which defaults to zero.
+   *
+   * The optional **x** ordinal channel specifies the horizontal position; it
+   * is typically bound to the *x* scale, which must be a *band* scale. If the
+   * **x** channel is not specified, the bar will span the horizontal extent of
+   * the plot’s frame. Because a waffle represents a discrete number of square
+   * cells, it may not use all of the available bandwidth.
+   */
+  mark: 'waffleY';
+}