@uwdata/mosaic-spec 0.16.2 → 0.17.0

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

@@ -1,82 +0,0 @@
-import { ParamRef } from '../Param.js';
-import { ChannelValue, ChannelValueSpec, MarkData, MarkOptions, MarkerOptions } from './Marks.js';
-/** Options for errorbar marks. */
-interface ErrorBarOptions extends MarkOptions, MarkerOptions {
-    /**
-     * The confidence interval in (0, 1); defaults to 0.95.
-     */
-    ci?: number | ParamRef;
-    /**
-     * An optional ordinal channel for grouping data, producing an independent
-     * error bar for each group. If not specified, it defaults to **stroke** if
-     * a channel.
-     */
-    z?: ChannelValue;
-}
-/** Options for the errorbarX mark. */
-export interface ErrorBarXOptions extends ErrorBarOptions {
-    /**
-     * The dependent variable horizontal position channel, typically bound to the
-     * *x* scale.
-     */
-    x: ChannelValueSpec;
-    /**
-     * The independent variable vertical position channel, typically bound to
-     * the *y* scale; defaults to the zero-based index of the data [0, 1, 2, …].
-     */
-    y?: ChannelValueSpec;
-}
-/** The errorbarX mark. */
-export interface ErrorBarX extends MarkData, ErrorBarXOptions {
-    /**
-     * A mark that draws error bars for a calculated parametric confidence
-     * interval for a dependent variable (*x*), potentially grouped by an
-     * independent variable (*y*).
-     *
-     * This mark aggregates raw values to produce a [parametric confidence
-     * interval][1] of the mean, assuming a normal distribution. To instead
-     * visualize pre-computeted interval values or custom aggregations, use
-     * a **ruleY** mark with specified **x1** and **x2** channels.
-     *
-     * Multiple error bars can be produced by specifying a **z** or **stroke**
-     * channel. Set the **marker** option to `'tick'` to add small perpendicular
-     * lines at the start and end of the error interval.
-     *
-     * [1]: https://en.wikipedia.org/wiki/Normal_distribution#Confidence_intervals
-     */
-    mark: 'errorbarX';
-}
-/** Options for the errorbarY mark. */
-export interface ErrorBarYOptions extends ErrorBarOptions {
-    /**
-     * The independent variable horizontal position channel, typically bound to
-     * the *x* scale; defaults to the zero-based index of the data [0, 1, 2, …].
-     */
-    x?: ChannelValueSpec;
-    /**
-     * The dependent variable vertical position channel, typically bound to the
-     * *y* scale.
-     */
-    y: ChannelValueSpec;
-}
-/** The errorbarY mark. */
-export interface ErrorBarY extends MarkData, ErrorBarYOptions {
-    /**
-     * A mark that draws error bars for a calculated parametric confidence
-     * interval for a dependent variable (*y*), potentially grouped by an
-     * independent variable (*x*).
-     *
-     * This mark aggregates raw values to produce a [parametric confidence
-     * interval][1] of the mean, assuming a normal distribution. To instead
-     * visualize pre-computeted interval values or custom aggregations, use
-     * a **ruleX** mark with specified **y1** and **y2** channels.
-     *
-     * Multiple error bars can be produced by specifying a **z** or **stroke**
-     * channel. Set the **marker** option to `'tick'` to add small perpendicular
-     * lines at the start and end of the error interval.
-     *
-     * [1]: https://en.wikipedia.org/wiki/Normal_distribution#Confidence_intervals
-     */
-    mark: 'errorbarY';
-}
-export {};

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

@@ -1,21 +0,0 @@
-import { ParamRef } from '../Param.js';
-import { InsetOptions, MarkOptions } from './Marks.js';
-import { RectCornerOptions } from './Rect.js';
-/** Options for the frame decoration mark. */
-export interface FrameOptions extends MarkOptions, InsetOptions, RectCornerOptions {
-    /**
-     * If null (default), the rectangular outline of the frame is drawn;
-     * otherwise the frame is drawn as a line only on the given side, and the
-     * **rx**, **ry**, **fill**, and **fillOpacity** options are ignored.
-     */
-    anchor?: 'top' | 'right' | 'bottom' | 'left' | null | ParamRef;
-}
-/** The frame mark. */
-export interface Frame extends FrameOptions {
-    /**
-     * Draws a rectangle around the plot’s frame, or if an **anchor** is given,
-     * a line on the given side. Useful for visual separation of facets, or in
-     * conjunction with axes and grids to fill the frame’s background.
-     */
-    mark: 'frame';
-}

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

@@ -1,53 +0,0 @@
-import { ParamRef } from '../Param.js';
-import { ChannelValue, ChannelValueSpec, MarkData, MarkOptions } from './Marks.js';
-/** Options for the geo mark. */
-export interface GeoOptions extends MarkOptions {
-    /**
-     * A required channel for the geometry to render; defaults to identity,
-     * assuming *data* is a GeoJSON object or an iterable of GeoJSON objects.
-     */
-    geometry?: ChannelValue;
-    /**
-     * The size of Point and MultiPoint geometries, defaulting to a constant 3
-     * pixels. If **r** is a number, it is interpreted as a constant radius in
-     * pixels; otherwise it is interpreted as a channel and the effective radius
-     * is controlled by the *r* scale, which defaults to a *sqrt* scale such that
-     * the visual area of a point is proportional to its associated value.
-     *
-     * If **r** is a channel, geometries will be sorted by descending radius by
-     * default, to limit occlusion; use the **sort** transform to control render
-     * order. Geometries with a nonpositive radius are not drawn.
-     */
-    r?: ChannelValueSpec | ParamRef;
-}
-/** The geo mark. */
-export interface Geo extends MarkData, GeoOptions {
-    /**
-     * A geo mark. The **geometry** channel, which defaults to the identity
-     * function assuming that *data* is a GeoJSON object or an iterable of
-     * GeoJSON objects, is projected to the plane using the plot’s top-level
-     * **projection**.
-     *
-     * If *data* is a GeoJSON feature collection, then the mark’s data is
-     * *data*.features; if *data* is a GeoJSON geometry collection, then the
-     * mark’s data is *data*.geometries; if *data* is some other GeoJSON
-     * object, then the mark’s data is the single-element array [*data*].
-     */
-    mark: 'geo';
-}
-/** The sphere mark. */
-export interface Sphere extends MarkOptions {
-    /**
-     * A geo mark whose *data* is the outline of the sphere on the
-     * projection’s plane. (For use with a spherical **projection** only.)
-     */
-    mark: 'sphere';
-}
-/** The graticule mark. */
-export interface Graticule extends MarkOptions {
-    /**
-     * A geo mark whose *data* is a 10° global graticule. (For use with a
-     * spherical **projection** only.)
-     */
-    mark: 'graticule';
-}

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

@@ -1,30 +0,0 @@
-import { ParamRef } from '../Param.js';
-import { DotOptions } from './Dot.js';
-import { ChannelValue, MarkData, TextStyles } from './Marks.js';
-export interface HexbinOptions extends DotOptions, TextStyles {
-    /**
-     * The basic mark type to use for hex-binned values.
-     * Defaults to a hexagon mark; dot and text marks are also supported.
-     */
-    type?: 'dot' | 'circle' | 'hexagon' | 'text' | ParamRef;
-    /**
-     * The distance between centers of neighboring hexagons, in pixels; defaults
-     * to 20. If also using a hexgrid mark, use matching **binWidth** values.
-     */
-    binWidth?: number | ParamRef;
-    /**
-     * How to subdivide bins. If not specified, defaults to the *fill* channel,
-     * if any, or the *stroke* channel, if any. If null, bins will not be
-     * subdivided.
-     */
-    z?: ChannelValue;
-}
-/** The hexbin mark. */
-export interface Hexbin extends MarkData, HexbinOptions {
-    /**
-     * A hexbin mark that bins **x** and **y** data into a hexagonal grid and
-     * visualizes aggregate functions per bin (e.g., count for binned density).
-     * Aggregate functions can be used for fill, stroke, or r (radius) options.
-     */
-    mark: 'hexbin';
-}

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

@@ -1,25 +0,0 @@
-import { ParamRef } from '../Param.js';
-import { MarkOptions } from './Marks.js';
-/** Options for the hexgrid mark. */
-export interface HexgridOptions extends MarkOptions {
-    /**
-     * The distance between centers of neighboring hexagons, in pixels; defaults
-     * to 20. Should match the **binWidth** of the hexbin mark.
-     */
-    binWidth?: number | ParamRef;
-}
-/** The hexgrid mark. */
-export interface Hexgrid extends HexgridOptions {
-    /**
-     * The hexgrid decoration mark complements the hexbin mark, showing the
-     * outlines of all hexagons spanning the frame with a default **stroke** of
-     * *currentColor* and a default **strokeOpacity** of 0.1, similar to the
-     * default axis grids.
-     *
-     * Note that the **binWidth** option of the hexgrid mark should match that of
-     * the hexbin transform. The grid is clipped by the frame. This is a
-     * stroke-only mark, and **fill** is not supported; to fill the frame,
-     * use the frame mark.
-     */
-    mark: 'hexgrid';
-}

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

@@ -1,89 +0,0 @@
-import { ParamRef } from '../Param.js';
-import { FrameAnchor } from '../PlotTypes.js';
-import { ChannelValue, ChannelValueSpec, MarkData, MarkOptions } from './Marks.js';
-/** Options for the image mark. */
-export interface ImageOptions extends MarkOptions {
-    /**
-     * The horizontal position channel specifying the image’s center; typically
-     * bound to the *x* scale.
-     */
-    x?: ChannelValueSpec;
-    /**
-     * The vertical position channel specifying the image’s center; typically
-     * bound to the *y* scale.
-     */
-    y?: ChannelValueSpec;
-    /**
-     * The image width in pixels. When a number, it is interpreted as a constant
-     * radius in pixels; otherwise it is interpreted as a channel. Also sets the
-     * default **height**; if neither are set, defaults to 16. Images with a
-     * nonpositive width are not drawn.
-     */
-    width?: ChannelValue | ParamRef;
-    /**
-     * The image height in pixels. When a number, it is interpreted as a constant
-     * radius in pixels; otherwise it is interpreted as a channel. Also sets the
-     * default **height**; if neither are set, defaults to 16. Images with a
-     * nonpositive height are not drawn.
-     */
-    height?: ChannelValue | ParamRef;
-    /**
-     * The image clip radius, for circular images. If null (default), images are
-     * not clipped; when a number, it is interpreted as a constant in pixels;
-     * otherwise it is interpreted as a channel, typically bound to the *r* scale.
-     * Also defaults **height** and **width** to twice its value.
-     */
-    r?: ChannelValue | ParamRef;
-    /**
-     * The rotation angle, in degrees clockwise. When a number, it is interpreted
-     * as a constant; otherwise it is interpreted as a channel.
-     */
-    rotate?: ChannelValue | ParamRef;
-    /**
-     * The required image URL (or relative path). If a string that starts with a
-     * dot, slash, or URL protocol (*e.g.*, “https:”) it is assumed to be a
-     * constant; otherwise it is interpreted as a channel.
-     */
-    src?: ChannelValue | ParamRef;
-    /**
-     * The image [aspect ratio][1]; defaults to *xMidYMid meet*. To crop the image
-     * instead of scaling it to fit, use *xMidYMid slice*.
-     *
-     * [1]: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/preserveAspectRatio
-     */
-    preserveAspectRatio?: string | ParamRef;
-    /**
-     * The [cross-origin][1] behavior. See the [Plot.image notebook][2] for details.
-     *
-     * [1]: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/crossorigin
-     * [2]: https://observablehq.com/@observablehq/plot-image
-     */
-    crossOrigin?: string | ParamRef;
-    /**
-     * The frame anchor specifies defaults for **x** and **y** based on the plot’s
-     * frame; it may be one of the four sides (*top*, *right*, *bottom*, *left*),
-     * one of the four corners (*top-left*, *top-right*, *bottom-right*,
-     * *bottom-left*), or the *middle* of the frame.
-     */
-    frameAnchor?: FrameAnchor | ParamRef;
-    /**
-     * The [image-rendering attribute][1]; defaults to *auto* (bilinear). The
-     * option may be set to *pixelated* to disable bilinear interpolation for a
-     * sharper image; however, note that this is not supported in WebKit.
-     *
-     * [1]: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/image-rendering
-     */
-    imageRendering?: string | ParamRef;
-}
-export interface Image extends MarkData, ImageOptions {
-    /**
-     * An image mark that draws images as in a scatterplot.
-     *
-     * If either **x** or **y** is not specified, the default is determined by
-     * the **frameAnchor** option. If none of **x**, **y**, and **frameAnchor**
-     * are specified, *data* is assumed to be an array of pairs [[*x₀*, *y₀*],
-     * [*x₁*, *y₁*], [*x₂*, *y₂*], …] such that **x** = [*x₀*, *x₁*, *x₂*, …]
-     * and **y** = [*y₀*, *y₁*, *y₂*, …].
-     */
-    mark: 'image';
-}

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

@@ -1,82 +0,0 @@
-import { ChannelValue, ChannelValueSpec, CurveAutoOptions, MarkData, MarkOptions, MarkerOptions } from './Marks.js';
-/** Options for the line mark. */
-export interface LineOptions extends MarkOptions, MarkerOptions, CurveAutoOptions {
-    /**
-     * The required horizontal position channel, typically bound to the *x*
-     * scale.
-     */
-    x?: ChannelValueSpec;
-    /**
-     * The required vertical position channel, typically bound to the *y* scale.
-     */
-    y?: ChannelValueSpec;
-    /**
-     * An optional ordinal channel for grouping data into (possibly stacked)
-     * series to be drawn as separate lines. If not specified, it defaults to
-     * **fill** if a channel, or **stroke** if a channel.
-     */
-    z?: ChannelValue;
-}
-/** Options for the lineX mark. */
-export interface LineXOptions extends LineOptions {
-    /**
-     * The vertical position channel, typically bound to the *y* scale;
-     * defaults to the zero-based index of the data [0, 1, 2, …].
-     */
-    y?: ChannelValueSpec;
-}
-/** Options for the lineY mark. */
-export interface LineYOptions extends LineOptions {
-    /**
-     * The horizontal position channel, typically bound to the *x* scale;
-     * defaults to the zero-based index of the data [0, 1, 2, …].
-     */
-    x?: ChannelValueSpec;
-}
-/** The line mark. */
-export interface Line extends MarkData, LineOptions {
-    /**
-     * A line mark that connects control points.
-     *
-     * Points along the line are connected in input order. If there are multiple
-     * series via the **z**, **fill**, or **stroke** channel, series are drawn in
-     * input order such that the last series is drawn on top. Typically *data* is
-     * already in sorted order, such as chronological for time series; if needed,
-     * consider a **sort** transform.
-     *
-     * If any **x** or **y** values are invalid (undefined, null, or NaN), the
-     * line will be interrupted, resulting in a break that divides the line shape
-     * into multiple segments. If a line segment consists of only a single point,
-     * it may appear invisible unless rendered with rounded or square line caps.
-     * In addition, some curves such as *cardinal-open* only render a visible
-     * segment if it contains multiple points.
-     *
-     * Variable aesthetic channels are supported: if the **stroke** is defined as
-     * a channel, the line will be broken into contiguous overlapping segments
-     * when the stroke color changes; the stroke color will apply to the interval
-     * spanning the current data point and the following data point. This
-     * behavior also applies to the **fill**, **fillOpacity**, **strokeOpacity**,
-     * **strokeWidth**, **opacity**, **href**, **title**, and **ariaLabel**
-     * channels. When any of these channels are used, setting an explicit **z**
-     * channel (possibly to null) is strongly recommended.
-     */
-    mark: 'line';
-}
-/** The lineX mark. */
-export interface LineX extends MarkData, LineXOptions {
-    /**
-     * Like line, except that **x** defaults to the identity function assuming
-     * that *data* = [*x₀*, *x₁*, *x₂*, …] and **y** defaults to the zero-based
-     * index [0, 1, 2, …].
-     */
-    mark: 'lineX';
-}
-/** The lineY mark. */
-export interface LineY extends MarkData, LineYOptions {
-    /**
-     * Like line, except **y** defaults to the identity function and assumes
-     * that *data* = [*y₀*, *y₁*, *y₂*, …] and **x** defaults to the zero-based
-     * index [0, 1, 2, …].
-     */
-    mark: 'lineY';
-}

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

@@ -1,60 +0,0 @@
-import { ParamRef } from '../Param.js';
-import { ChannelValueSpec, CurveAutoOptions, MarkData, MarkOptions, MarkerOptions } from './Marks.js';
-/** Options for the link mark. */
-export interface LinkOptions extends MarkOptions, MarkerOptions, CurveAutoOptions {
-    /**
-     * The horizontal position, for vertical links; typically bound to the *x*
-     * scale; shorthand for setting defaults for both **x1** and **x2**.
-     */
-    x?: ChannelValueSpec;
-    /**
-     * The vertical position, for horizontal links; typically bound to the *y*
-     * scale; shorthand for setting defaults for both **y1** and **y2**.
-     */
-    y?: ChannelValueSpec;
-    /**
-     * The starting horizontal position; typically bound to the *x* scale; also
-     * sets a default for **x2**.
-     */
-    x1?: ChannelValueSpec;
-    /**
-     * The starting vertical position; typically bound to the *y* scale; also sets
-     * a default for **y2**.
-     */
-    y1?: ChannelValueSpec;
-    /**
-     * The ending horizontal position; typically bound to the *x* scale; also sets
-     * a default for **x1**.
-     */
-    x2?: ChannelValueSpec;
-    /**
-     * The ending vertical position; typically bound to the *y* scale; also sets a
-     * default for **y1**.
-     */
-    y2?: ChannelValueSpec;
-    /**
-     * The curve (interpolation) method for connecting adjacent points.
-     *
-     * Since a link has exactly two points, only the following curves (or a custom
-     * curve) are recommended: *linear*, *step*, *step-after*, *step-before*,
-     * *bump-x*, or *bump-y*. Note that the *linear* curve is incapable of showing
-     * a fill since a straight line has zero area. For a curved link, use an arrow
-     * mark with the **bend** option.
-     *
-     * If the plot uses a spherical **projection**, the default *auto* **curve**
-     * will render links as geodesics; to draw a straight line instead, use the
-     * *linear* **curve**.
-     */
-    curve?: CurveAutoOptions['curve'] | ParamRef;
-}
-/** The link mark. */
-export interface Link extends MarkData, LinkOptions {
-    /**
-     * A link mark, drawing line segments (curves) connecting pairs of points.
-     *
-     * If the plot uses a spherical **projection**, the default *auto* **curve**
-     * will render links as geodesics; to draw a straight line instead, use the
-     * *linear* **curve**.
-     */
-    mark: 'link';
-}