@uwdata/mosaic-spec 0.7.0 → 0.8.0

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

@@ -0,0 +1,139 @@
+import { ChannelValue, ChannelValueSpec, CurveOptions, MarkData, MarkOptions, StackOptions } from './Marks.js';
+/** Options for the area, areaX, and areaY marks. */
+export interface AreaOptions extends MarkOptions, StackOptions, CurveOptions {
+    /**
+     * The required primary (starting, often left) horizontal position channel,
+     * representing the area’s baseline, typically bound to the *x* scale. For
+     * areaX, setting this option disables the implicit stackX transform.
+     */
+    x1?: ChannelValueSpec;
+    /**
+     * The optional secondary (ending, often right) horizontal position channel,
+     * representing the area’s topline, typically bound to the *x* scale; if not
+     * specified, **x1** is used. For areaX, setting this option disables the
+     * implicit stackX transform.
+     */
+    x2?: ChannelValueSpec;
+    /**
+     * The required primary (starting, often bottom) vertical position channel,
+     * representing the area’s baseline, typically bound to the *y* scale. For
+     * areaY, setting this option disables the implicit stackY transform.
+     */
+    y1?: ChannelValueSpec;
+    /**
+     * The optional secondary (ending, often top) vertical position channel,
+     * representing the area’s topline, typically bound to the *y* scale; if not
+     * specified, **y1** is used. For areaY, setting this option disables the
+     * implicit stackY transform.
+     */
+    y2?: ChannelValueSpec;
+    /**
+     * An optional ordinal channel for grouping data into (possibly stacked)
+     * series to be drawn as separate areas; defaults to **fill** if a channel, or
+     * **stroke** if a channel.
+     */
+    z?: ChannelValue;
+}
+/** Options for the areaX mark. */
+export interface AreaXOptions extends Omit<AreaOptions, 'y1' | 'y2'> {
+    /**
+     * The horizontal position (or length) channel, typically bound to the *x*
+     * scale.
+     *
+     * If neither **x1** nor **x2** is specified, an implicit stackX transform is
+     * applied and **x** defaults to the identity function, assuming that *data* =
+     * [*x₀*, *x₁*, *x₂*, …]. Otherwise, if only one of **x1** or **x2** is
+     * specified, the other defaults to **x**, which defaults to zero.
+     */
+    x?: ChannelValueSpec;
+    /**
+     * 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 areaY mark. */
+export interface AreaYOptions extends Omit<AreaOptions, 'x1' | 'x2'> {
+    /**
+     * 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 vertical position (or length) channel, typically bound to the *y*
+     * scale.
+     *
+     * If neither **y1** nor **y2** is specified, an implicit stackY transform is
+     * applied and **y** defaults to the identity function, assuming that *data* =
+     * [*y₀*, *y₁*, *y₂*, …]. Otherwise, if only one of **y1** or **y2** is
+     * specified, the other defaults to **y**, which defaults to zero.
+     */
+    y?: ChannelValueSpec;
+}
+/** The area mark. */
+export interface Area extends MarkData, AreaOptions {
+    /**
+     * An area mark. The area mark is rarely used directly; it is only needed
+     * when the baseline and topline have neither *x* nor *y* values in common.
+     * Use areaY for a horizontal orientation where the baseline and topline
+     * share *x* values, or areaX for a vertical orientation where the baseline
+     * and topline share *y* values.
+     */
+    mark: 'area';
+}
+/** The areaX mark. */
+export interface AreaX extends MarkData, AreaXOptions {
+    /**
+     * A vertically-oriented area mark, where the baseline and topline share
+     * **y** values, as in a time-series area chart where time goes up↑.
+     *
+     * If neither **x1** nor **x2** is specified, an implicit stackX transform is
+     * applied and **x** defaults to the identity function, assuming that *data* =
+     * [*x₀*, *x₁*, *x₂*, …]. Otherwise, if only one of **x1** or **x2** is
+     * specified, the other defaults to **x**, which defaults to zero.
+     *
+     * If an **interval** is specified, **y** values are binned accordingly,
+     * allowing zeroes for empty bins instead of interpolating across gaps. This is
+     * recommended to “regularize” sampled data; for example, if your data
+     * represents timestamped observations and you expect one observation per day,
+     * use *day* as the **interval**.
+     *
+     * Variable aesthetic channels are supported: if the **fill** is defined as a
+     * channel, the area will be broken into contiguous overlapping sections when
+     * the fill color changes; the fill color will apply to the interval spanning
+     * the current data point and the following data point. This behavior also
+     * applies to the **fillOpacity**, **stroke**, **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: 'areaX';
+}
+/** The areaY mark. */
+export interface AreaY extends MarkData, AreaYOptions {
+    /**
+     * A horizontally-oriented area mark, where the baseline and topline share
+     * **x** values, as in a time-series area chart where time goes right→.
+     *
+     * If neither **y1** nor **y2** is specified, an implicit stackY transform is
+     * applied and **y** defaults to the identity function, assuming that *data* =
+     * [*y₀*, *y₁*, *y₂*, …]. Otherwise, if only one of **y1** or **y2** is
+     * specified, the other defaults to **y**, which defaults to zero.
+     *
+     * If an **interval** is specified, **x** values are binned accordingly,
+     * allowing zeroes for empty bins instead of interpolating across gaps. This is
+     * recommended to “regularize” sampled data; for example, if your data
+     * represents timestamped observations and you expect one observation per day,
+     * use *day* as the **interval**.
+     *
+     * Variable aesthetic channels are supported: if the **fill** is defined as a
+     * channel, the area will be broken into contiguous overlapping sections when
+     * the fill color changes; the fill color will apply to the interval spanning
+     * the current data point and the following data point. This behavior also
+     * applies to the **fillOpacity**, **stroke**, **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: 'areaY';
+}

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

@@ -0,0 +1,94 @@
+import { ParamRef } from '../Param.js';
+import { ChannelValueSpec, MarkData, MarkOptions } from './Marks.js';
+/** Options for the arrow mark. */
+export interface ArrowOptions extends MarkOptions {
+    /**
+     * The horizontal position, for vertical arrows; typically bound to the *x*
+     * scale; shorthand for setting defaults for both **x1** and **x2**.
+     */
+    x?: ChannelValueSpec;
+    /**
+     * The vertical position, for horizontal arrows; 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 angle, a constant in degrees, between the straight line intersecting
+     * the arrow’s two control points and the outgoing tangent direction of the
+     * arrow from the start point. The angle must be within ±90°; a positive
+     * angle will produce a clockwise curve, while a negative angle will produce
+     * a counterclockwise curve; zero (the default) will produce a straight line.
+     * Use true for 22.5°.
+     */
+    bend?: number | boolean | ParamRef;
+    /**
+     * How pointy the arrowhead is, in degrees; a constant typically between 0°
+     * and 180°, and defaults to 60°.
+     */
+    headAngle?: number | ParamRef;
+    /**
+     * The size of the arrowhead relative to the **strokeWidth**; a constant.
+     * Assuming the default of stroke width 1.5px, this is the length of the
+     * arrowhead’s side in pixels.
+     */
+    headLength?: number | ParamRef;
+    /**
+     * Shorthand to set the same default for **insetStart** and **insetEnd**.
+     */
+    inset?: number | ParamRef;
+    /**
+     * The starting inset, a constant in pixels; defaults to 0. A positive inset
+     * shortens the arrow by moving the starting point towards the endpoint
+     * point, while a negative inset extends it by moving the starting point in
+     * the opposite direction. A positive starting inset may be useful if the
+     * arrow emerges from a dot.
+     */
+    insetStart?: number | ParamRef;
+    /**
+     * The ending inset, a constant in pixels; defaults to 0. A positive inset
+     * shortens the arrow by moving the ending point towards the starting point,
+     * while a negative inset extends it by moving the ending point in the
+     * opposite direction. A positive ending inset may be useful if the arrow
+     * points to a dot.
+     */
+    insetEnd?: number | ParamRef;
+    /**
+     * The sweep order; defaults to 1 indicating a positive (clockwise) bend
+     * angle; -1 indicates a negative (anticlockwise) bend angle; 0 effectively
+     * clears the bend angle. If set to *-x*, the bend angle is flipped when the
+     * ending point is to the left of the starting point — ensuring all arrows
+     * bulge up (down if bend is negative); if set to *-y*, the bend angle is
+     * flipped when the ending point is above the starting point — ensuring all
+     * arrows bulge right (left if bend is negative); the sign is negated for
+     * *+x* and *+y*.
+     */
+    sweep?: number | '+x' | '-x' | '+y' | '-y' | ParamRef;
+}
+/** The arrow mark. */
+export interface Arrow extends MarkData, ArrowOptions {
+    /**
+     * An arrow mark, drawing (possibly swoopy) arrows connecting pairs of
+     * points.
+     */
+    mark: 'arrow';
+}

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

@@ -0,0 +1,281 @@
+import { ParamRef } from '../Param.js';
+import { Interval } from '../PlotTypes.js';
+import { MarkOptions } from './Marks.js';
+import { RuleXOptions, RuleYOptions } from './Rule.js';
+import { TextOptions } from './Text.js';
+import { TickXOptions, TickYOptions } from './Tick.js';
+/** The scale options used by axis and grid marks. */
+interface ScaleOptions {
+    /**
+     * Enforces uniformity for data at regular intervals, such as integer values
+     * or daily samples. The interval may be one of:
+     *
+     * - a named time interval such as *day* (for date intervals)
+     * - a number (for number intervals), defining intervals at integer multiples of *n*
+     *
+     * This option sets the internal transform to the given interval’s
+     * *interval*.floor function. In addition, the default **domain** will align
+     * with interval boundaries.
+     */
+    interval?: Interval | ParamRef;
+    /**
+     * The desired approximate number of axis ticks, or an explicit array of tick
+     * values, or an interval such as *day* or *month*.
+     */
+    ticks?: number | Interval | any[] | ParamRef;
+    /**
+     * The length of axis tick marks in pixels; negative values extend in the
+     * opposite direction. Defaults to 6 for *x* and *y* axes and *color* and
+     * *opacity* *ramp* legends, and 0 for *fx* and *fy* axes.
+     */
+    tickSize?: number | ParamRef;
+    /**
+     * The desired approximate spacing between adjacent axis ticks, affecting the
+     * default **ticks**; defaults to 80 pixels for *x* and *fx*, and 35 pixels
+     * for *y* and *fy*.
+     */
+    tickSpacing?: number | ParamRef;
+    /**
+     * The distance between an axis tick mark and its associated text label (in
+     * pixels); often defaults to 3, but may be affected by **xTickSize** and
+     * **xTickRotate**.
+     */
+    tickPadding?: number | ParamRef;
+    /**
+     * How to format inputs (abstract values) for axis tick labels; one of:
+     *
+     * - a [d3-format][1] string for numeric scales
+     * - a [d3-time-format][2] string for temporal scales
+     *
+     * [1]: https://d3js.org/d3-time
+     * [2]: https://d3js.org/d3-time-format
+     */
+    tickFormat?: string | null | ParamRef;
+    /**
+     * The rotation angle of axis tick labels in degrees clocksize; defaults to 0.
+     */
+    tickRotate?: number | 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.
+     *
+     * For axes and legends only.
+     */
+    label?: string | null | ParamRef;
+    /**
+     * Where to place the axis **label** relative to the plot’s frame. For
+     * vertical position scales (*y* and *fy*), may be *top*, *bottom*, or
+     * *center*; for horizontal position scales (*x* and *fx*), may be *left*,
+     * *right*, or *center*. Defaults to *center* for ordinal scales (including
+     * *fx* and *fy*), and otherwise *top* for *y*, and *right* for *x*.
+     */
+    labelAnchor?: 'top' | 'right' | 'bottom' | 'left' | 'center' | ParamRef;
+    /**
+     * The axis **label** position offset (in pixels); default depends on margins
+     * and orientation.
+     */
+    labelOffset?: number | ParamRef;
+    /**
+     * Whether to apply a directional arrow such as → or ↑ to the scale label. If
+     * *auto* (the default), the presence of the arrow depends on whether the
+     * scale is ordinal.
+     */
+    labelArrow?: 'auto' | 'up' | 'right' | 'down' | 'left' | 'none' | true | false | null | ParamRef;
+}
+/** The subset of scale options for grids. */
+type GridScaleOptions = Pick<ScaleOptions, 'interval' | 'ticks' | 'tickSpacing'>;
+/** The subset of scale options for axes. */
+type AxisScaleOptions = Pick<ScaleOptions, 'tickSize' | 'tickPadding' | 'tickFormat' | 'tickRotate' | 'label' | 'labelOffset' | 'labelAnchor' | 'labelArrow'>;
+/** Options for the grid marks. */
+export interface GridOptions extends GridScaleOptions {
+    /**
+     * The side of the frame on which to place the axis: *top* or *bottom* for
+     * horizontal axes (axisX and axisFx) and their associated vertical grids
+     * (gridX and gridFx), or *left* or *right* for vertical axes (axisY and
+     * axisFY) and their associated horizontal grids (gridY and gridFy).
+     *
+     * The default **anchor** depends on the associated scale:
+     *
+     * - *x* - *bottom*
+     * - *y* - *left*
+     * - *fx* - *top* if there is a *bottom* *x* axis, and otherwise *bottom*
+     * - *fy* - *right* if there is a *left* *y* axis, and otherwise *right*
+     *
+     * For grids, the **anchor** also affects the extent of grid lines when the
+     * opposite dimension is specified (**x** for gridY and **y** for gridX).
+     */
+    anchor?: 'top' | 'right' | 'bottom' | 'left' | ParamRef;
+    /**
+     * A shorthand for setting both **fill** and **stroke**; affects the stroke of
+     * tick vectors and grid rules, and the fill of tick texts and axis label
+     * texts; defaults to *currentColor*.
+     */
+    color?: MarkOptions['stroke'];
+    /**
+     * A shorthand for setting both **fillOpacity** and **strokeOpacity**; affects
+     * the stroke opacity of tick vectors and grid rules, and the fill opacity of
+     * tick texts and axis label texts; defaults to 1 for axes and 0.1 for grids.
+     */
+    opacity?: MarkOptions['opacity'];
+}
+/** Options for the axis marks. */
+export interface AxisOptions extends GridOptions, MarkOptions, TextOptions, AxisScaleOptions {
+    /** The tick text **stroke**, say for a *white* outline to improve legibility; defaults to null. */
+    textStroke?: MarkOptions['stroke'];
+    /** The tick text **strokeOpacity**; defaults to 1; has no effect unless **textStroke** is set. */
+    textStrokeOpacity?: MarkOptions['strokeOpacity'];
+    /** The tick text **strokeWidth**; defaults to 4; has no effect unless **textStroke** is set. */
+    textStrokeWidth?: MarkOptions['strokeWidth'];
+}
+/** Options for the axisX and axisFx marks. */
+export interface AxisXOptions extends AxisOptions, Omit<TickXOptions, 'data'> {
+}
+/** Options for the axisY and axisFy marks. */
+export interface AxisYOptions extends AxisOptions, Omit<TickYOptions, 'data'> {
+}
+/** Options for the gridX and gridFx marks. */
+export interface GridXOptions extends GridOptions, Omit<RuleXOptions, 'data' | 'interval'> {
+}
+/** Options for the gridY and gridFy marks. */
+export interface GridYOptions extends GridOptions, Omit<RuleYOptions, 'data' | 'interval'> {
+}
+/** The axisX mark. */
+export interface AxisX extends AxisXOptions {
+    /**
+     * An axis mark to document the visual encoding of the horizontal position
+     * *x* scale, comprised of (up to) three marks: a vector for ticks, a text
+     * for tick labels, and another text for an axis label. The data defaults to
+     * tick values sampled from the *x* scale’s domain; if desired, use one of
+     * the **ticks**, **tickSpacing**, or **interval** options.
+     *
+     * The **facetAnchor** option defaults to *bottom-empty* if **anchor** is
+     * *bottom*, and *top-empty* if **anchor** is *top*. The default margins
+     * likewise depend on **anchor** as follows; in order of **marginTop**,
+     * **marginRight**, **marginBottom**, and **marginLeft**, in pixels:
+     *
+     * - *top* - 30, 20, 0, 20
+     * - *bottom* - 0, 20, 30, 20
+     *
+     * For simplicity, and for consistent layout across plots, default axis margins
+     * are not affected by tick labels. If tick labels are too long, either increase
+     * the margin or shorten the labels: use the *k* SI-prefix tick format; use the
+     * **transform** *y*-scale option to show thousands or millions; or use the
+     * **textOverflow** and **lineWidth** options to clip.
+     */
+    mark: 'axisX';
+}
+/** The axisFx mark. */
+export interface AxisFx extends AxisXOptions {
+    /**
+     * An axis mark to document the visual encoding of the horizontal facet
+     * position *fx* scale, comprised of (up to) three marks: a vector for ticks,
+     * a text for tick labels, and another text for an axis label. The data
+     * defaults to the *fx* scale’s domain; if desired, use one of the **ticks**,
+     * **tickSpacing**, or **interval** options.
+     *
+     * The **facetAnchor** and **frameAnchor** options defaults to **anchor**. The
+     * default margins likewise depend on **anchor** as follows; in order of
+     * **marginTop**, **marginRight**, **marginBottom**, and **marginLeft**, in
+     * pixels:
+     *
+     * - *top* - 30, 20, 0, 20
+     * - *bottom* - 0, 20, 30, 20
+     *
+     * For simplicity, and for consistent layout across plots, default axis margins
+     * are not affected by tick labels. If tick labels are too long, either increase
+     * the margin or shorten the labels: use the *k* SI-prefix tick format; use the
+     * **transform** *y*-scale option to show thousands or millions; or use the
+     * **textOverflow** and **lineWidth** options to clip.
+     */
+    mark: 'axisFx';
+}
+/** The axisY mark. */
+export interface AxisY extends AxisYOptions {
+    /**
+     * An axis mark to document the visual encoding of the vertical position *y*
+     * scale, comprised of (up to) three marks: a vector for ticks, a text for
+     * tick labels, and another text for an axis label. The data defaults to tick
+     * values sampled from the *y* scale’s domain; if desired, use one of the
+     * **ticks**, **tickSpacing**, or **interval** options.
+     *
+     * The **facetAnchor** option defaults to *right-empty* if **anchor** is
+     * *right*, and *left-empty* if **anchor** is *left*. The default margins
+     * likewise depend on **anchor** as follows; in order of **marginTop**,
+     * **marginRight**, **marginBottom**, and **marginLeft**, in pixels:
+     *
+     * - *right* - 20, 40, 20, 0
+     * - *left* - 20, 0, 20, 40
+     *
+     * For simplicity, and for consistent layout across plots, default axis
+     * margins are not affected by tick labels. If tick labels are too long,
+     * either increase the margin or shorten the labels: use the *k* SI-prefix
+     * tick format; or use the **textOverflow** and **lineWidth** options to
+     * clip.
+     */
+    mark: 'axisY';
+}
+/** The axisFy mark. */
+export interface AxisFy extends AxisYOptions {
+    /**
+     * An axis mark to document the visual encoding of the vertical facet
+     * position *fy* scale, comprised of (up to) three marks: a vector for ticks,
+     * a text for tick labels, and another text for an axis label. The data
+     * defaults to the *fy* scale’s domain; if desired, use one of the **ticks**,
+     * **tickSpacing**, or **interval** options.
+     *
+     * The **facetAnchor** option defaults to *right-empty* if **anchor** is
+     * *right*, and *left-empty* if **anchor** is *left*. The default margins
+     * likewise depend on **anchor** as follows; in order of **marginTop**,
+     * **marginRight**, **marginBottom**, and **marginLeft**, in pixels:
+     *
+     * - *right* - 20, 40, 20, 0
+     * - *left* - 20, 0, 20, 40
+     *
+     * For simplicity, and for consistent layout across plots, default axis
+     * margins are not affected by tick labels. If tick labels are too long,
+     * either increase the margin or shorten the labels: use the *k* SI-prefix
+     * tick format; or use the **textOverflow** and **lineWidth** options to
+     * clip.
+     */
+    mark: 'axisFy';
+}
+/** The gridX mark. */
+export interface GridX extends GridXOptions {
+    /**
+     * A horizontally-positioned ruleX mark (a vertical line, |) that renders a
+     * grid for the *x* scale. The data defaults to tick values sampled from the
+     * *x* scale’s domain; if desired, use one of the **ticks**, **tickSpacing**,
+     * or **interval** options.
+     */
+    mark: 'gridX';
+}
+/** The gridFx mark. */
+export interface GridFx extends GridXOptions {
+    /**
+     * A horizontally-positioned ruleX mark (a vertical line, |) that renders a
+     * grid for the *fx* scale. The data defaults to the *fx* scale’s domain;
+     * if desired, use the **ticks** option.
+     */
+    mark: 'gridFx';
+}
+/** The gridY mark. */
+export interface GridY extends GridYOptions {
+    /**
+     * A vertically-positioned ruleY mark (a horizontal line, —) that renders a
+     * grid for the *y* scale. The data defaults to tick values sampled from the
+     * *y* scale’s domain; if desired, use one of the **ticks**, **tickSpacing**,
+     * or **interval** options.
+     */
+    mark: 'gridY';
+}
+/** The gridFy mark. */
+export interface GridFy extends GridYOptions {
+    /**
+     * A vertically-positioned ruleY mark (a horizontal line, —) that renders a
+     * grid for the *fy* scale. The data defaults to the *fy* scale’s domain;
+     * if desired, use the **ticks** option.
+     */
+    mark: 'gridFy';
+}
+export {};

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

@@ -0,0 +1,150 @@
+import { ParamRef } from '../Param.js';
+import { Interval } from '../PlotTypes.js';
+import { ChannelValueIntervalSpec, ChannelValueSpec, InsetOptions, MarkData, MarkOptions, StackOptions } from './Marks.js';
+import { RectCornerOptions } from './Rect.js';
+/** Options for the barX and barY marks. */
+interface BarOptions extends MarkOptions, InsetOptions, RectCornerOptions, StackOptions {
+    /**
+     * How to convert a continuous value (**x** for barX, or **y** for barY) into
+     * an interval (**x1** and **x2** for barX, or **y1** and **y2** for barY);
+     * one of:
+     *
+     * - a named time interval such as *day* (for date intervals)
+     * - a number (for number intervals), defining intervals at integer multiples of *n*
+     *
+     * Setting this option disables the implicit stack transform (stackX for barX,
+     * or stackY for barY).
+     */
+    interval?: Interval | ParamRef;
+}
+/** Options for the barX mark. */
+export interface BarXOptions extends BarOptions {
+    /**
+     * The horizontal position (or length/width) channel, typically bound to the
+     * *x* scale.
+     *
+     * 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.
+     */
+    x?: ChannelValueIntervalSpec;
+    /**
+     * The required primary (starting, often left) horizontal position channel,
+     * typically bound to the *x* scale. Setting this option disables the
+     * implicit stackX transform.
+     *
+     * If *x* represents ordinal values, use a cell mark instead.
+     */
+    x1?: ChannelValueSpec;
+    /**
+     * The required secondary (ending, often right) horizontal position channel,
+     * typically bound to the *x* scale. Setting this option disables the
+     * implicit stackX transform.
+     *
+     * If *x* represents ordinal values, use a cell mark instead.
+     */
+    x2?: ChannelValueSpec;
+    /**
+     * The optional vertical position of the bar; a ordinal channel typically
+     * bound to the *y* scale. If not specified, the bar 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 rectX mark
+     * instead.
+     */
+    y?: ChannelValueSpec;
+}
+/** Options for the barY mark. */
+export interface BarYOptions extends BarOptions {
+    /**
+     * The vertical position (or length/height) channel, typically bound to the
+     * *y* scale.
+     *
+     * 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.
+     */
+    y?: ChannelValueIntervalSpec;
+    /**
+     * The required primary (starting, often bottom) vertical position channel,
+     * typically bound to the *y* scale. Setting this option disables the
+     * implicit stackY transform.
+     *
+     * If *y* represents ordinal values, use a cell mark instead.
+     */
+    y1?: ChannelValueSpec;
+    /**
+     * The required secondary (ending, often top) horizontal position channel,
+     * typically bound to the *y* scale. Setting this option disables the
+     * implicit stackY transform.
+     *
+     * If *y* represents ordinal values, use a cell mark instead.
+     */
+    y2?: ChannelValueSpec;
+    /**
+     * The optional horizontal position of the bar; a ordinal channel typically
+     * bound to the *x* scale. If not specified, the bar 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 rectY mark
+     * instead.
+     */
+    x?: ChannelValueSpec;
+}
+/** The barX mark. */
+export interface BarX extends MarkData, BarXOptions {
+    /**
+     * A horizontal bar mark. The required *x* values should be quantitative or
+     * temporal, 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.
+     *
+     * If *y* is quantitative, use the rectX mark instead.
+     * If *x* is ordinal, use the cell mark instead.
+     */
+    mark: 'barX';
+}
+/** The barY mark. */
+export interface BarY extends MarkData, BarYOptions {
+    /**
+     * A vertical bar mark. The required *y* values should be quantitative or
+     * temporal, 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.
+     *
+     * If *x* is quantitative, use the rectY mark instead.
+     * If *y* is ordinal, use the cell mark instead.
+     */
+    mark: 'barY';
+}
+export {};