@uwdata/mosaic-spec 0.12.0 → 0.12.2

package/dist/types/spec/Param.d.ts

@@ -27,7 +27,7 @@ export interface ParamDate extends ParamBase {
     date: string;
 }
 /** Literal Param values. */
-export type ParamLiteral = string | number | boolean;
+export type ParamLiteral = null | string | number | boolean;
 /** Valid Param values. */
 export type ParamValue = ParamLiteral | Array<ParamLiteral | ParamRef>;
 /** A Selection definition. */

package/dist/types/spec/PlotMark.d.ts

@@ -23,5 +23,6 @@ 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 = Area | AreaX | AreaY | Arrow | AxisX | AxisY | AxisFx | AxisFy | GridX | GridY | GridFx | GridFy | BarX | BarY | Cell | CellX | CellY | Contour | DelaunayLink | DelaunayMesh | Hull | Voronoi | VoronoiMesh | DenseLine | Density | DensityX | DensityY | Dot | DotX | DotY | Circle | Hexagon | ErrorBarX | ErrorBarY | Frame | Geo | Graticule | Sphere | Hexbin | Hexgrid | Image | Line | LineX | LineY | Link | Raster | Heatmap | RasterTile | Rect | RectX | RectY | RegressionY | RuleX | RuleY | Text | TextX | TextY | TickX | TickY | Vector | VectorX | VectorY | Spike;
+export type PlotMark = Area | AreaX | AreaY | Arrow | AxisX | AxisY | AxisFx | AxisFy | GridX | GridY | GridFx | GridFy | BarX | BarY | Cell | CellX | CellY | Contour | DelaunayLink | DelaunayMesh | Hull | Voronoi | VoronoiMesh | DenseLine | Density | DensityX | DensityY | Dot | DotX | DotY | Circle | Hexagon | ErrorBarX | ErrorBarY | Frame | Geo | Graticule | Sphere | Hexbin | Hexgrid | Image | Line | LineX | LineY | Link | Raster | Heatmap | RasterTile | Rect | RectX | RectY | RegressionY | RuleX | RuleY | Text | TextX | TextY | TickX | TickY | Vector | VectorX | VectorY | Spike | WaffleX | WaffleY;

package/dist/types/spec/marks/Density.d.ts

@@ -1,10 +1,10 @@
-import { ParamRef } from "../Param.js";
-import { AreaXOptions, AreaYOptions } from "./Area.js";
-import { DotOptions } from "./Dot.js";
-import { LineXOptions, LineYOptions } from "./Line.js";
-import { MarkData, MarkOptions, TextStyles } from "./Marks.js";
-import { Grid2DOptions } from "./Raster.js";
-import { TextOptions } from "./Text.js";
+import { ParamRef } from '../Param.js';
+import { AreaXOptions, AreaYOptions } from './Area.js';
+import { DotOptions } from './Dot.js';
+import { LineXOptions, LineYOptions } from './Line.js';
+import { MarkData, MarkOptions, TextStyles } from './Marks.js';
+import { Grid2DOptions } from './Raster.js';
+import { TextOptions } from './Text.js';
 export interface Density2DOptions extends MarkOptions, Omit<DotOptions, 'x' | 'y'>, TextStyles, Grid2DOptions {
     /**
      * The basic mark type to use to render 2D density values.
@@ -36,6 +36,13 @@ export interface Density1DOptions {
      * Defaults to 1024.
      */
     bins?: number | ParamRef;
+    /**
+     * Normalization method for density estimates. If `false` or `'none'` (the
+     * default), the density estimates are smoothed weighted counts. If `true`
+     * or `'sum'`, density estimates are divided by the sum of the total point
+     * mass. If `'max'`, estimates are divided by the maximum smoothed value.
+     */
+    normalize?: boolean | 'max' | 'sum' | 'none' | ParamRef;
 }
 export interface DensityAreaXOptions extends Omit<AreaXOptions, 'x' | 'x1' | 'x2'> {
     /**
@@ -43,6 +50,10 @@ export interface DensityAreaXOptions extends Omit<AreaXOptions, 'x' | 'x1' | 'x2
      * areaX mark; lineX, dotX, and textX marks are also supported.
      */
     type: 'areaX';
+    /**
+     * Flag indicating if densities should be stacked. Defaults to false.
+     */
+    stack?: boolean | ParamRef;
 }
 export interface DensityAreaYOptions extends Omit<AreaYOptions, 'y' | 'y1' | 'y2'> {
     /**
@@ -50,6 +61,10 @@ export interface DensityAreaYOptions extends Omit<AreaYOptions, 'y' | 'y1' | 'y2
      * areaY mark; lineY, dot, and text marks are also supported.
      */
     type?: 'areaY';
+    /**
+     * Flag indicating if densities should be stacked. Defaults to false.
+     */
+    stack?: boolean | ParamRef;
 }
 export interface DensityLineXOptions extends Omit<LineXOptions, 'x' | 'x1' | 'x2'> {
     /**

package/dist/types/spec/marks/Waffle.d.ts

@@ -0,0 +1,58 @@
+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';
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uwdata/mosaic-spec",
-  "version": "0.12.0",
+  "version": "0.12.2",
   "description": "Declarative specification of Mosaic-powered applications.",
   "keywords": [
     "mosaic",
@@ -33,10 +33,10 @@
     "prepublishOnly": "npm run test && npm run lint && npm run build"
   },
   "dependencies": {
-    "@uwdata/mosaic-core": "^0.12.0",
-    "@uwdata/mosaic-sql": "^0.12.0",
-    "@uwdata/vgplot": "^0.12.0",
+    "@uwdata/mosaic-core": "^0.12.2",
+    "@uwdata/mosaic-sql": "^0.12.2",
+    "@uwdata/vgplot": "^0.12.2",
     "ts-json-schema-generator": "^2.3.0"
   },
-  "gitHead": "523b1afe2a0880291c92f81e4a7b91829362d285"
+  "gitHead": "0ca741d840b98039255f26a5ceedf10be66f790e"
 }

package/src/spec/Param.ts

@@ -32,6 +32,7 @@ export interface ParamDate extends ParamBase {
 
 /** Literal Param values. */
 export type ParamLiteral =
+  | null
   | string
   | number
   | boolean;

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/marks/Density.ts

@@ -1,10 +1,10 @@
-import { ParamRef } from "../Param.js";
-import { AreaXOptions, AreaYOptions } from "./Area.js";
-import { DotOptions } from "./Dot.js";
-import { LineXOptions, LineYOptions } from "./Line.js";
-import { MarkData, MarkOptions, TextStyles } from "./Marks.js";
-import { Grid2DOptions } from "./Raster.js";
-import { TextOptions } from "./Text.js";
+import { ParamRef } from '../Param.js';
+import { AreaXOptions, AreaYOptions } from './Area.js';
+import { DotOptions } from './Dot.js';
+import { LineXOptions, LineYOptions } from './Line.js';
+import { MarkData, MarkOptions, TextStyles } from './Marks.js';
+import { Grid2DOptions } from './Raster.js';
+import { TextOptions } from './Text.js';
 
 // Density2D
 
@@ -44,6 +44,14 @@ export interface Density1DOptions {
    * Defaults to 1024.
    */
   bins?: number | ParamRef;
+
+  /**
+   * Normalization method for density estimates. If `false` or `'none'` (the
+   * default), the density estimates are smoothed weighted counts. If `true`
+   * or `'sum'`, density estimates are divided by the sum of the total point
+   * mass. If `'max'`, estimates are divided by the maximum smoothed value.
+   */
+  normalize?: boolean | 'max' | 'sum' | 'none' | ParamRef;
 }
 
 export interface DensityAreaXOptions extends Omit<AreaXOptions, 'x' | 'x1' | 'x2'> {
@@ -52,6 +60,11 @@ export interface DensityAreaXOptions extends Omit<AreaXOptions, 'x' | 'x1' | 'x2
    * areaX mark; lineX, dotX, and textX marks are also supported.
    */
   type: 'areaX';
+
+  /**
+   * Flag indicating if densities should be stacked. Defaults to false.
+   */
+  stack?: boolean | ParamRef;
 }
 
 export interface DensityAreaYOptions extends Omit<AreaYOptions, 'y' | 'y1' | 'y2'> {
@@ -60,6 +73,11 @@ export interface DensityAreaYOptions extends Omit<AreaYOptions, 'y' | 'y1' | 'y2
    * areaY mark; lineY, dot, and text marks are also supported.
    */
   type?: 'areaY';
+
+  /**
+   * Flag indicating if densities should be stacked. Defaults to false.
+   */
+  stack?: boolean | ParamRef;
 }
 
 export interface DensityLineXOptions extends Omit<LineXOptions, 'x' | 'x1' | 'x2'> {

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';
+}