@uwdata/mosaic-spec 0.16.2 → 0.17.0

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

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

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

@@ -1,58 +0,0 @@
-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/dist/types/util.d.ts

@@ -1,12 +0,0 @@
-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;

package/jsconfig.json

@@ -1,10 +0,0 @@
-{
-  "include": ["src/**/*", "../../specs/ts/*.ts"],
-  "compilerOptions": {
-    "checkJs": true,
-    "noEmit": true,
-    "noImplicitAny": false,
-    "module": "node16",
-    "skipLibCheck": true
-  }
-}