@uwdata/mosaic-spec 0.17.0 → 0.18.0

package/dist/src/spec/marks/Tick.d.ts

@@ -0,0 +1,62 @@
+import { ChannelValueSpec, InsetOptions, MarkData, MarkOptions, MarkerOptions } from './Marks.js';
+/** Options for the tickX mark. */
+export interface TickXOptions extends MarkOptions, MarkerOptions, Omit<InsetOptions, 'insetLeft' | 'insetRight'> {
+    /**
+     * The required horizontal position of the tick; a channel typically bound to
+     * the *x* scale.
+     */
+    x?: ChannelValueSpec;
+    /**
+     * The optional vertical position of the tick; an ordinal channel typically
+     * bound to the *y* scale. If not specified, the tick spans the vertical
+     * extent of the frame; otherwise the *y* scale must be a *band* scale.
+     *
+     * If *y* represents quantitative or temporal values, use a ruleX mark
+     * instead.
+     */
+    y?: ChannelValueSpec;
+}
+/** Options for the tickY mark. */
+export interface TickYOptions extends MarkOptions, MarkerOptions, Omit<InsetOptions, 'insetTop' | 'insetBottom'> {
+    /**
+     * The required vertical position of the tick; a channel typically bound to
+     * the *y* scale.
+     */
+    y?: ChannelValueSpec;
+    /**
+     * The optional horizontal position of the tick; an ordinal channel typically
+     * bound to the *x* scale. If not specified, the tick spans the horizontal
+     * extent of the frame; otherwise the *x* scale must be a *band* scale.
+     *
+     * If *x* represents quantitative or temporal values, use a ruleY mark
+     * instead.
+     */
+    x?: ChannelValueSpec;
+}
+/** The tickX mark. */
+export interface TickX extends MarkData, TickXOptions {
+    /**
+     * A horizontally-positioned tickX mark (a vertical line, |). The **x**
+     * channel specifies the tick’s horizontal position and defaults to identity,
+     * assuming that *data* = [*x₀*, *x₁*, *x₂*, …]; the optional **y** ordinal
+     * channel specifies its vertical position.
+     *
+     * If *y* represents quantitative or temporal values, use a ruleX mark
+     * instead.
+     */
+    mark: 'tickX';
+}
+/** The tickY mark. */
+export interface TickY extends MarkData, TickYOptions {
+    /**
+     * A vertically-positioned tickY mark (a horizontal line, —). The **y**
+     * channel specifies the tick's vertical position and defaults to identity,
+     * assuming that *data* = [*y₀*, *y₁*, *y₂*, …]; the optional **x** ordinal
+     * channel specifies its horizontal position.
+     *
+     * If *x* represents quantitative or temporal values, use a ruleY mark
+     * instead.
+     */
+    mark: 'tickY';
+}
+//# sourceMappingURL=Tick.d.ts.map

package/dist/src/spec/marks/Tick.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Tick.d.ts","sourceRoot":"","sources":["../../../../src/spec/marks/Tick.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAAE,YAAY,EAAE,QAAQ,EAAE,WAAW,EAAE,aAAa,EACrE,MAAM,YAAY,CAAC;AAEpB,kCAAkC;AAClC,MAAM,WAAW,YAAa,SAAQ,WAAW,EAAE,aAAa,EAAE,IAAI,CAAC,YAAY,EAAE,WAAW,GAAG,YAAY,CAAC;IAC9G;;;OAGG;IACH,CAAC,CAAC,EAAE,gBAAgB,CAAC;IAErB;;;;;;;OAOG;IACH,CAAC,CAAC,EAAE,gBAAgB,CAAC;CACtB;AAED,kCAAkC;AAClC,MAAM,WAAW,YAAa,SAAQ,WAAW,EAAE,aAAa,EAAE,IAAI,CAAC,YAAY,EAAE,UAAU,GAAG,aAAa,CAAC;IAC9G;;;OAGG;IACH,CAAC,CAAC,EAAE,gBAAgB,CAAC;IAErB;;;;;;;OAOG;IACH,CAAC,CAAC,EAAE,gBAAgB,CAAC;CACtB;AAED,sBAAsB;AACtB,MAAM,WAAW,KAAM,SAAQ,QAAQ,EAAE,YAAY;IACnD;;;;;;;;OAQG;IACH,IAAI,EAAE,OAAO,CAAC;CACf;AAED,sBAAsB;AACtB,MAAM,WAAW,KAAM,SAAQ,QAAQ,EAAE,YAAY;IACnD;;;;;;;;OAQG;IACH,IAAI,EAAE,OAAO,CAAC;CACf"}

package/dist/src/spec/marks/Vector.d.ts

@@ -0,0 +1,100 @@
+import { ParamRef } from '../Param.js';
+import { FrameAnchor } from '../PlotTypes.js';
+import { ChannelValue, ChannelValueSpec, MarkData, MarkOptions } from './Marks.js';
+/**
+ * The built-in vector shape implementations; one of:
+ *
+ * - *arrow* - a straight line with an open arrowhead at the end (↑)
+ * - *spike* - an isosceles triangle with a flat base (▲)
+ */
+export type VectorShapeName = 'arrow' | 'spike';
+/** How to draw a vector: either a named shape or a custom implementation. */
+export type VectorShape = VectorShapeName;
+/** Options for the vector mark. */
+export interface VectorOptions extends MarkOptions {
+    /**
+     * The horizontal position of the vector’s anchor point; an optional channel
+     * bound to the *x* scale. Default depends on the **frameAnchor**.
+     */
+    x?: ChannelValueSpec;
+    /**
+     * The vertical position of the vector’s anchor point; an optional channel
+     * bound to the *y* scale. Default depends on the **frameAnchor**.
+     */
+    y?: ChannelValueSpec;
+    /**
+     * The vector shape’s radius, such as half the width of the *arrow*’s head or
+     * the *spike*’s base; a constant number in pixels. Defaults to 3.5 pixels.
+     */
+    r?: number | ParamRef;
+    /**
+     * The vector’s length; either an optional channel bound to the *length* scale
+     * or a constant number in pixels. Defaults to 12 pixels.
+     */
+    length?: ChannelValueSpec;
+    /**
+     * The vector’s orientation (rotation angle); either a constant number in
+     * degrees clockwise, or an optional channel (with no associated scale).
+     * Defaults to 0 degrees with the vector pointing up.
+     */
+    rotate?: ChannelValue;
+    /** The shape of the vector; a constant. Defaults to *arrow*. */
+    shape?: VectorShape | ParamRef;
+    /**
+     * The vector’s position along its orientation relative to its anchor point; a
+     * constant. Assuming a default **rotate** angle of 0°, one of:
+     *
+     * - *start* - from [*x*, *y*] to [*x*, *y* - *l*]
+     * - *middle* (default) - from [*x*, *y* + *l* / 2] to [*x*, *y* - *l* / 2]
+     * - *end* - from [*x*, *y* + *l*] to [*x*, *y*]
+     *
+     * where [*x*, *y*] is the vector’s anchor point and *l* is the vector’s
+     * (possibly scaled) length in pixels.
+     */
+    anchor?: 'start' | 'middle' | 'end' | ParamRef;
+    /**
+     * The vector’s frame anchor, to default **x** and **y** relative to the
+     * frame; a constant representing one of the frame corners (*top-left*,
+     * *top-right*, *bottom-right*, *bottom-left*), sides (*top*, *right*,
+     * *bottom*, *left*), or *middle* (default). Has no effect if both **x**
+     * and **y** are specified.
+     */
+    frameAnchor?: FrameAnchor | ParamRef;
+}
+/** The vector mark. */
+export interface Vector extends MarkData, VectorOptions {
+    /**
+     * A vector mark.
+     *
+     * If none of **frameAnchor**, **x**, and **y** are specified, then **x** and
+     * **y** default to accessors assuming that *data* contains tuples [[*x₀*,
+     * *y₀*], [*x₁*, *y₁*], [*x₂*, *y₂*], …]
+     */
+    mark: 'vector';
+}
+/** The vectorX mark. */
+export interface VectorX extends MarkData, VectorOptions {
+    /**
+     * Like vector, but **x** instead defaults to the identity function and **y**
+     * defaults to null, assuming that *data* is an array of numbers [*x₀*, *x₁*,
+     * *x₂*, …].
+     */
+    mark: 'vectorX';
+}
+/** The vectorY mark. */
+export interface VectorY extends MarkData, VectorOptions {
+    /**
+     * Like vector, but **y** instead defaults to the identity function and **x**
+     * defaults to null, assuming that *data* is an array of numbers [*y₀*, *y₁*,
+     * *y₂*, …].
+     */
+    mark: 'vectorY';
+}
+/** The spike mark. */
+export interface Spike extends MarkData, VectorOptions {
+    /**
+     * Like vector, but with default *options* suitable for drawing a spike map.
+     */
+    mark: 'spike';
+}
+//# sourceMappingURL=Vector.d.ts.map

package/dist/src/spec/marks/Vector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Vector.d.ts","sourceRoot":"","sources":["../../../../src/spec/marks/Vector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEnF;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,OAAO,CAAC;AAEhD,6EAA6E;AAC7E,MAAM,MAAM,WAAW,GAAG,eAAe,CAAC;AAE1C,mCAAmC;AACnC,MAAM,WAAW,aAAc,SAAQ,WAAW;IAChD;;;OAGG;IACH,CAAC,CAAC,EAAE,gBAAgB,CAAC;IAErB;;;OAGG;IACH,CAAC,CAAC,EAAE,gBAAgB,CAAC;IAErB;;;OAGG;IACH,CAAC,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAE1B;;;;OAIG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;IAEtB,gEAAgE;IAChE,KAAK,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC;IAE/B;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IAE/C;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC;CACtC;AAED,uBAAuB;AACvB,MAAM,WAAW,MAAO,SAAQ,QAAQ,EAAE,aAAa;IACrD;;;;;;OAMG;IACH,IAAI,EAAE,QAAQ,CAAC;CAChB;AAED,wBAAwB;AACxB,MAAM,WAAW,OAAQ,SAAQ,QAAQ,EAAE,aAAa;IACtD;;;;OAIG;IACH,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,wBAAwB;AACxB,MAAM,WAAW,OAAQ,SAAQ,QAAQ,EAAE,aAAa;IACtD;;;;OAIG;IACH,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,sBAAsB;AACtB,MAAM,WAAW,KAAM,SAAQ,QAAQ,EAAE,aAAa;IACpD;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;CACf"}

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

@@ -0,0 +1,59 @@
+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';
+}
+//# sourceMappingURL=Waffle.d.ts.map

package/dist/src/spec/marks/Waffle.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Waffle.d.ts","sourceRoot":"","sources":["../../../../src/spec/marks/Waffle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,gDAAgD;AAChD,MAAM,WAAW,aAAa;IAC5B,kFAAkF;IAClF,QAAQ,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC7B,wDAAwD;IACxD,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IACzB,sDAAsD;IACtD,GAAG,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IACxB,yDAAyD;IACzD,KAAK,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC;CAC5B;AAED,wBAAwB;AACxB,MAAM,WAAW,OAAQ,SAAQ,QAAQ,EAAE,WAAW,EAAE,aAAa;IACnE;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,EAAE,SAAS,CAAC;CACjB;AAED,wBAAwB;AACxB,MAAM,WAAW,OAAQ,SAAQ,QAAQ,EAAE,WAAW,EAAE,aAAa;IACnE;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,EAAE,SAAS,CAAC;CACjB"}

package/dist/src/util.d.ts

@@ -0,0 +1,13 @@
+export function paramRef(value: any): any;
+export function paramStr(value: any): any;
+export function toParamRef(name: any): string;
+export function toArray(value: any): any[];
+export function isArray(value: any): value is any[];
+export function isObject(value: any): boolean;
+export function isNumber(value: any): value is number;
+export function isNumberOrString(value: any): boolean;
+export function isString(value: any): value is string;
+export function isFunction(value: any): boolean;
+export function error(message: any, data: any): void;
+export function isoparse(string: any, fallback: any): any;
+//# sourceMappingURL=util.d.ts.map

package/dist/src/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../src/util.js"],"names":[],"mappings":"AAAA,0CAKC;AAED,0CAEC;AAED,8CAEC;AAED,2CAEC;AAED,oDAEC;AAED,8CAEC;AAED,sDAEC;AAED,sDAGC;AAED,sDAEC;AAED,gDAEC;AAED,qDAEC;AAKD,0DAGC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uwdata/mosaic-spec",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "description": "Declarative specification of Mosaic-powered applications.",
   "keywords": [
     "mosaic",
@@ -16,23 +16,31 @@
     "types": "./dist/src/index.d.ts",
     "default": "./src/index.js"
   },
+  "files": [
+    "dist",
+    "!dist/tsconfig.tsbuildinfo",
+    "src"
+  ],
   "repository": {
     "type": "git",
     "url": "https://github.com/uwdata/mosaic.git"
   },
   "scripts": {
-    "prebuild": "rimraf dist && mkdir dist",
-    "build": "tsc && npm run schema",
+    "clean": "rimraf dist && mkdir dist",
+    "prebuild": "npm run clean",
+    "build": "npm run schema",
     "lint": "eslint src test",
+    "preschema": "tsc --build",
     "schema": "ts-json-schema-generator -f tsconfig.json -p src/spec/Spec.ts -t Spec --no-type-check --no-ref-encode --functions hide > dist/mosaic-schema.json",
-    "test": "vitest run && tsc",
-    "version": "cd ../.. && npm run docs:schema",
+    "test": "npm run schema && vitest run",
+    "version": "cd ../../.. && npm run docs:schema",
     "prepublishOnly": "npm run test && npm run lint && npm run build"
   },
   "dependencies": {
-    "@uwdata/mosaic-core": "^0.17.0",
-    "@uwdata/mosaic-sql": "^0.17.0",
-    "@uwdata/vgplot": "^0.17.0",
-    "ts-json-schema-generator": "^2.3.0"
-  }
+    "@uwdata/mosaic-core": "^0.18.0",
+    "@uwdata/mosaic-sql": "^0.18.0",
+    "@uwdata/vgplot": "^0.18.0",
+    "ts-json-schema-generator": "^2.4.0"
+  },
+  "gitHead": "dfb9ded0b0307754e3185ca34cc49a1384fe8455"
 }

package/tsconfig.json

@@ -1,13 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "include": ["src/**/*"],
-  "compilerOptions": {
-    "emitDeclarationOnly": true,
-    "outDir": "dist"
-  },
-  "references": [
-    { "path": "../core" },
-    { "path": "../sql" },
-    { "path": "../vgplot" }
-  ]
-}

package/vitest.config.ts

@@ -1,3 +0,0 @@
-import { defineConfig } from 'vite';
-
-export default defineConfig({});