@mathstack/viz 0.0.1-beta.0

package/lib/data-dimensions/continuous-quantitative/date-chart-position/date-chart-position-builder.d.ts

@@ -0,0 +1,39 @@
+import { ScaleTime } from 'd3';
+import { DataDimensionBuilder } from '../../dimension-builder';
+import { DateChartPositionDimension } from './date-chart-position';
+export declare class DateChartPositionDimensionBuilder<Datum> extends DataDimensionBuilder<Datum, Date> {
+    private _domain;
+    private _formatSpecifier;
+    private _scaleFn;
+    constructor();
+    /**
+     * OPTIONAL. Sets the domain of the scale.
+     *
+     * If not provided, the domain will be determined by the data.
+     */
+    domain(domain: null): this;
+    domain(domain: [Date, Date]): this;
+    /**
+     * OPTIONAL. Sets a format specifier that will be applied to values from this dimension for display purposes, for example, in a tooltip.
+     *
+     * This is a string that is passed to D3's timeFormat function.
+     *
+     * @default '%Y %m'
+     */
+    formatSpecifier(formatSpecifier: null): this;
+    formatSpecifier(formatSpecifier: string): this;
+    /**
+     * OPTIONAL. This is a D3 scale function that maps values from the dimension's domain to the dimension's range.
+     *
+     * @default d3.scaleUtc
+     */
+    scaleFn(scaleFn: null): this;
+    scaleFn(scaleFn: (domain?: Iterable<Date>, range?: Iterable<number>) => ScaleTime<number, number>): this;
+    /**
+     * @internal This function is for internal use only and should never be called by the user.
+     *
+     * @param dimensionName A user-intelligible name for the dimension being built. Used for error messages. Should be title cased.
+     */
+    _build(dimensionName: string): DateChartPositionDimension<Datum>;
+    private validateBuilder;
+}

package/lib/data-dimensions/continuous-quantitative/date-chart-position/date-chart-position-options.d.ts

@@ -0,0 +1,18 @@
+import { ScaleTime } from 'd3';
+import { DataDimensionOptions } from '../../dimension-options';
+export interface DateChartPositionDimensionOptions<Datum> extends DataDimensionOptions<Datum, Date> {
+    /**
+     * An optional, user-provided range of values that is used as the domain of the dimension's scale.
+     *
+     * If not provided by the user, it remains undefined.
+     */
+    domain: [Date, Date];
+    /**
+     * A format specifier that will be applied to the value of this dimension for display purposes.
+     */
+    readonly formatSpecifier: string;
+    /**
+     * The scale function for the dimension. This is a D3 scale function that maps values from the dimension's domain to the dimension's range.
+     */
+    scaleFn: (domain?: Iterable<Date>, range?: Iterable<number>) => ScaleTime<number, number>;
+}

package/lib/data-dimensions/continuous-quantitative/date-chart-position/date-chart-position.d.ts

@@ -0,0 +1,38 @@
+import { ScaleTime } from 'd3';
+import { DataDimension } from '../../dimension';
+import { DateChartPositionDimensionOptions } from './date-chart-position-options';
+/**
+ * A dimension that transforms Date values into a position on a chart.
+ *
+ * This dimension is used for the positional dimensions of a chart, such as x and y. The underlying scale will always be a [D3 time scale](https://d3js.org/d3-scale/time). The range of the scale will be a dimension from the chart.
+ *
+ * The generic is the type of the data that will be passed to the dimension.
+ *
+ * TESTABLE FUNCTIONALITY
+ *
+ * - It extracts values for the dimension from data.
+ *   - tested in: lines.cy.ts
+ * - It sets the domain of the dimension.
+ *   - tested in: lines.cy.ts
+ * - It creates and returns a scale from a range.
+ *   - tested in: lines.cy.ts
+ * - It checks if a value is in valid.
+ *   - tested in: lines.cy.ts
+ * - The domain will be unique values from the user-provided domain if the user provides a domain.
+ *   - tested in: date-chart-position.spec.ts
+ * - The domain will be unique values from the data if no custom domain is given by the user.
+ *   - tested in: date-chart-position.spec.ts
+ * - The domain can be set in reverse order.
+ *   - tested in: date-chart-position.spec.ts
+ */
+export declare class DateChartPositionDimension<Datum> extends DataDimension<Datum, Date> implements DateChartPositionDimensionOptions<Datum> {
+    private calculatedDomain;
+    readonly domain: [Date, Date];
+    readonly formatSpecifier: string;
+    scaleFn: (domain?: Iterable<Date>, range?: Iterable<number>) => ScaleTime<number, number>;
+    constructor(options: DateChartPositionDimensionOptions<Datum>);
+    setPropertiesFromData(data: Datum[]): void;
+    protected setDomain(): void;
+    getScaleFromRange(range: [number, number]): ScaleTime<number, number>;
+    isValidValue(x: unknown): boolean;
+}

package/lib/data-dimensions/continuous-quantitative/number-chart-position/domain-padding/concrete-domain-padding.d.ts

@@ -0,0 +1,5 @@
+import { PercentOverDomainPadding } from './percent-over/percent-over';
+import { PixelDomainPadding } from './pixel/pixel';
+import { RoundUpToIntervalDomainPadding } from './round-to-interval/round-to-interval';
+import { RoundUpToSigFigDomainPadding } from './round-to-sig-fig/round-to-sig-fig';
+export type ConcreteDomainPadding = RoundUpToSigFigDomainPadding | RoundUpToIntervalDomainPadding | PercentOverDomainPadding | PixelDomainPadding;

package/lib/data-dimensions/continuous-quantitative/number-chart-position/domain-padding/domain-padding.d.ts

@@ -0,0 +1,20 @@
+import { ScaleContinuousNumeric } from 'd3';
+import { ValueExtent } from '../../../../core/types/values';
+export declare enum DomainPaddingType {
+    roundUp = "roundUp",
+    roundInterval = "roundInterval",
+    percentOver = "percentOver",
+    numPixels = "numPixels"
+}
+export interface PaddedDomainArguments {
+    value?: number;
+    valueType: keyof typeof ValueExtent;
+    scaleFn?: (domain?: Iterable<number>, range?: Iterable<number>) => ScaleContinuousNumeric<number, number>;
+    unpaddedDomain?: [number, number];
+    dimensionRange?: [number, number];
+}
+export declare abstract class DomainPadding {
+    abstract getPaddedValue(args: PaddedDomainArguments): number;
+    getPaddedDomain(unpaddedDomain: [number, number], scaleFn: any, dimensionRange?: [number, number]): [number, number];
+    protected getPaddedDomainForPositiveAndNegativeValues(domainMinArgs: PaddedDomainArguments, domainMaxArgs: PaddedDomainArguments, ...args: any): [number, number];
+}

package/lib/data-dimensions/continuous-quantitative/number-chart-position/domain-padding/percent-over/percent-over-options.d.ts

@@ -0,0 +1,3 @@
+export interface PercentOverDomainPaddingOptions {
+    percentOver: number;
+}

package/lib/data-dimensions/continuous-quantitative/number-chart-position/domain-padding/percent-over/percent-over.d.ts

@@ -0,0 +1,9 @@
+import { DomainPadding, DomainPaddingType, PaddedDomainArguments } from '../domain-padding';
+import { PercentOverDomainPaddingOptions } from './percent-over-options';
+export declare class PercentOverDomainPadding extends DomainPadding implements PercentOverDomainPaddingOptions {
+    readonly percentOver: number;
+    readonly type: DomainPaddingType.percentOver;
+    constructor(options: PercentOverDomainPaddingOptions);
+    getPaddedValue(args: PaddedDomainArguments): number;
+    private getQuantitativeDomainMaxPercentOver;
+}

package/lib/data-dimensions/continuous-quantitative/number-chart-position/domain-padding/pixel/pixel-options.d.ts

@@ -0,0 +1,3 @@
+export interface PixelDomainPaddingOptions {
+    numPixels: number;
+}

package/lib/data-dimensions/continuous-quantitative/number-chart-position/domain-padding/pixel/pixel.d.ts

@@ -0,0 +1,10 @@
+import { ScaleContinuousNumeric } from 'd3';
+import { DomainPadding, DomainPaddingType, PaddedDomainArguments } from '../domain-padding';
+import { PixelDomainPaddingOptions } from './pixel-options';
+export declare class PixelDomainPadding extends DomainPadding implements PixelDomainPaddingOptions {
+    readonly numPixels: number;
+    readonly type: DomainPaddingType.numPixels;
+    constructor(options: PixelDomainPaddingOptions);
+    getPaddedValue(args: PaddedDomainArguments): number;
+    protected getPaddedDomainForPositiveAndNegativeValues(domainMinArgs: PaddedDomainArguments, domainMaxArgs: PaddedDomainArguments, unpaddedDomain: [number, number], scaleFn: (domain?: Iterable<number>, range?: Iterable<number>) => ScaleContinuousNumeric<number, number>, dimensionRange: [number, number]): [number, number];
+}

package/lib/data-dimensions/continuous-quantitative/number-chart-position/domain-padding/round-to-interval/round-to-interval-options.d.ts

@@ -0,0 +1,3 @@
+export interface RoundUpToIntervalDomainPaddingOptions {
+    interval: (maxValue: number) => number;
+}

package/lib/data-dimensions/continuous-quantitative/number-chart-position/domain-padding/round-to-interval/round-to-interval.d.ts

@@ -0,0 +1,8 @@
+import { DomainPadding, DomainPaddingType, PaddedDomainArguments } from '../domain-padding';
+import { RoundUpToIntervalDomainPaddingOptions } from './round-to-interval-options';
+export declare class RoundUpToIntervalDomainPadding extends DomainPadding {
+    readonly type: DomainPaddingType.roundInterval;
+    readonly interval: (maxValue: number) => number;
+    constructor(options: RoundUpToIntervalDomainPaddingOptions);
+    getPaddedValue(args: PaddedDomainArguments): number;
+}

package/lib/data-dimensions/continuous-quantitative/number-chart-position/domain-padding/round-to-sig-fig/round-to-sig-fig-options.d.ts

@@ -0,0 +1,3 @@
+export interface RoundUpToSigFigDomainPaddingOptions {
+    sigFigures: (d: number) => number;
+}

package/lib/data-dimensions/continuous-quantitative/number-chart-position/domain-padding/round-to-sig-fig/round-to-sig-fig.d.ts

@@ -0,0 +1,8 @@
+import { DomainPadding, DomainPaddingType, PaddedDomainArguments } from '../domain-padding';
+import { RoundUpToSigFigDomainPaddingOptions } from './round-to-sig-fig-options';
+export declare class RoundUpToSigFigDomainPadding extends DomainPadding implements RoundUpToSigFigDomainPaddingOptions {
+    readonly sigFigures: (d: number) => number;
+    readonly type: DomainPaddingType.roundUp;
+    constructor(options: RoundUpToSigFigDomainPaddingOptions);
+    getPaddedValue(args: PaddedDomainArguments): number;
+}

package/lib/data-dimensions/continuous-quantitative/number-chart-position/number-chart-position-builder.d.ts

@@ -0,0 +1,71 @@
+import { ScaleContinuousNumeric } from 'd3';
+import { DataDimensionBuilder } from '../../dimension-builder';
+import { NumberChartPositionDimension } from './number-chart-position';
+export declare class NumberChartPositionDimensionBuilder<Datum> extends DataDimensionBuilder<Datum, number> {
+    private _domain;
+    private _formatSpecifier;
+    private _includeZeroInDomain;
+    private _domainPadding;
+    private _scaleFn;
+    constructor();
+    /**
+     * OPTIONAL. Sets the domain of the scale.
+     *
+     * Should be in the form of [min, max].
+     *
+     * If not provided, the domain will be determined by the data.
+     */
+    domain(domain: [number, number]): this;
+    domain(domain: null): this;
+    /**
+     * OPTIONAL. Sets a format specifier that will be applied to the value of this dimension for display purposes.
+     */
+    formatSpecifier(formatSpecifier: string): this;
+    formatSpecifier(formatSpecifier: null): this;
+    /**
+     * OPTIONAL. Sets a boolean that indicates whether the domain of the dimension's scale should include zero.
+     *
+     * @default true
+     */
+    includeZeroInDomain(includeZeroInDomain: boolean): this;
+    /**
+     * OPTIONAL. Adds additional space between data values and the edge of a chart by increasing the max value of the quantitative domain.
+     *
+     * For example, if the domain is [0, 100] and the percent is 0.1, the new domain will be [0, 110].
+     *
+     * @default 0.1
+     */
+    domainPaddingPercentOver(percentOver?: number): this;
+    /**
+     * OPTIONAL. Adds additional space between data values and the edge of a chart by increasing the max value of the quantitative domain so that it exceeds its original value by the specified number of pixels.
+     *
+     * @default 40
+     */
+    domainPaddingPixels(numPixels?: number): this;
+    /**
+     * OPTIONAL. Adds additional space between data values and the edge of a chart by increasing the max value to a number that is rounded up to the specified interval.
+     *
+     * @default () => 1
+     */
+    domainPaddingRoundUpToInterval(interval?: (d: number) => number): this;
+    /**
+     * OPTIONAL. Adds additional space between data values and the edge of a chart by increasing the max value to a number that is rounded up to the specified number of significant figures.
+     *
+     * @default () => 1
+     */
+    domainPaddingRoundUpToSigFig(sigFigures?: (d: number) => number): this;
+    /**
+     * OPTIONAL. This is a D3 scale function that maps values from the dimension's domain to the dimension's range.
+     *
+     * @default d3.scaleLinear
+     */
+    scaleFn(scaleFn: null): this;
+    scaleFn(scaleFn: (domain?: Iterable<number>, range?: Iterable<number>) => ScaleContinuousNumeric<number, number>): this;
+    /**
+     * @internal This method is not intended to be used by consumers of this library.
+     *
+     * @param dimensionName A user-intelligible name for the dimension being built. Used for error messages. Should be title cased.
+     */
+    _build(dimensionName: string): NumberChartPositionDimension<Datum>;
+    private validateBuilder;
+}

package/lib/data-dimensions/continuous-quantitative/number-chart-position/number-chart-position-options.d.ts

@@ -0,0 +1,5 @@
+import { NumberDimensionOptions } from '../number-dimension/number-dimension-options';
+import { ConcreteDomainPadding } from './domain-padding/concrete-domain-padding';
+export interface NumberChartPositionDimensionOptions<Datum> extends NumberDimensionOptions<Datum, number> {
+    domainPadding?: ConcreteDomainPadding;
+}

package/lib/data-dimensions/continuous-quantitative/number-chart-position/number-chart-position.d.ts

@@ -0,0 +1,30 @@
+import { ScaleContinuousNumeric } from 'd3';
+import { NumberDimension } from '../number-dimension/number-dimension';
+import { ConcreteDomainPadding } from './domain-padding/concrete-domain-padding';
+import { NumberChartPositionDimensionOptions } from './number-chart-position-options';
+/**
+ * A dimension that transforms number values into a position on a chart.
+ *
+ * This dimension is used for the positional dimensions of a chart, such as x and y. The resultant scale will confirm to the ScaleContinuousNumeric interface from @types/d3. The range of the scale will be a dimension from the chart.
+ *
+ * The generic is the type of the data that will be passed to the dimension.
+ *
+ * TESTABLE FUNCTIONALITY
+ *
+ * - It extracts values for the dimension from data.
+ *   - tested in: bars.cy.ts, dots.cy.ts, lines.cy.ts, stacked-bars.cy.ts
+ * - It sets the domain of the dimension.
+ *   - tested in: bars.cy.ts, dots.cy.ts, lines.cy.ts, stacked-bars.cy.ts
+ * - It creates and returns a scale from a range and the a padded domain if domain padding is provided.
+ *   - tested in: quantitative-domain-padding.cy.ts
+ * - It creates and returns a scale from a range and the regular domain if domain padding is not provided.
+ *   - tested in: bars.cy.ts, dots.cy.ts, lines.cy.ts, stacked-bars.cy.ts
+ */
+export declare class NumberChartPositionDimension<Datum> extends NumberDimension<Datum> implements NumberChartPositionDimensionOptions<Datum> {
+    readonly domainPadding?: ConcreteDomainPadding;
+    readonly scaleFn: (domain?: Iterable<number>, range?: Iterable<number>) => ScaleContinuousNumeric<number, number>;
+    constructor(options: NumberChartPositionDimensionOptions<Datum>);
+    setPropertiesFromData(data: Datum[]): void;
+    getScaleFromRange(range: [number, number]): ScaleContinuousNumeric<number, number, never>;
+    private getPaddedQuantitativeDomain;
+}

package/lib/data-dimensions/continuous-quantitative/number-dimension/number-dimension-options.d.ts

@@ -0,0 +1,8 @@
+import { ScaleContinuousNumeric } from 'd3';
+import { DataDimensionOptions } from '../../dimension-options';
+export interface NumberDimensionOptions<Datum, Range> extends DataDimensionOptions<Datum, number> {
+    domain: [number, number];
+    formatSpecifier: string;
+    includeZeroInDomain: boolean;
+    scaleFn: (domain?: Iterable<number>, range?: Iterable<Range>) => ScaleContinuousNumeric<Range, Range>;
+}

package/lib/data-dimensions/continuous-quantitative/number-dimension/number-dimension.d.ts

@@ -0,0 +1,28 @@
+import { DataDimension } from '../../dimension';
+/**
+ * An abstract dimension that for dimensions whose input values are numbers. It assumes that the domain is two numbers.
+ *
+ * The generic is the type of the data that will be passed to the dimension.
+ *
+ * TESTABLE FUNCTIONALITY
+ *
+ * - The domain will be the user=provided domain if the user provides a domain.
+ *    - tested in: number-dimension.spec.ts
+ * - The domain will be [min, max] of values if the user does not provide a domain.
+ *    - tested in: number-dimension.spec.ts
+ * - The domain will include 0 if includeZeroInDomain is true.
+ *    - tested in: number-dimension.spec.ts
+ * - domainIncludesZero will be true if 0 is in the domain.
+ *   - tested in: number-dimension.spec.ts
+ */
+export declare abstract class NumberDimension<Datum> extends DataDimension<Datum, number> {
+    protected calculatedDomain: [number, number];
+    readonly domain: [number, number];
+    domainIncludesZero: boolean;
+    readonly formatSpecifier: string;
+    readonly includeZeroInDomain: boolean;
+    setDomain(valuesOverride?: [number, number]): void;
+    protected getCalculatedDomain(domain: [number, number]): [number, number];
+    protected setDomainIncludesZero(): void;
+    isValidValue(x: unknown): boolean;
+}

package/lib/data-dimensions/continuous-quantitative/number-visual-value/number-visual-value-builder.d.ts

@@ -0,0 +1,69 @@
+import { ScaleContinuousNumeric } from 'd3';
+import { VisualValue } from '../../../core';
+import { DataDimensionBuilder } from '../../dimension-builder';
+import { NumberVisualValueDimension } from './number-visual-value';
+export declare class NumberVisualValueDimensionBuilder<Datum, Range extends VisualValue> extends DataDimensionBuilder<Datum, number> {
+    private _domain;
+    private _formatSpecifier;
+    private _includeZeroInDomain;
+    private _range;
+    private _scale;
+    private _scaleFn;
+    constructor();
+    /**
+     * OPTIONAL. Sets the domain of the scale.
+     *
+     * Should be in the form of [min, max].
+     *
+     * If not provided, the domain will be determined by the data.
+     */
+    domain(domain: null): this;
+    domain(domain: [number, number]): this;
+    /**
+     * OPTIONAL. Sets a format specifier that will be applied to the value of this dimension for display purposes.
+     */
+    formatSpecifier(formatSpecifier: null): this;
+    formatSpecifier(formatSpecifier: string): this;
+    /**
+     * OPTIONAL. Sets a boolean that indicates whether the domain of the dimension's scale should include zero.
+     *
+     * @default false
+     */
+    includeZeroInDomain(includeZeroInDomain: boolean): this;
+    /**
+     * OPTIONAL. Sets a range of visual values that will be the output from D3 scale linear.
+     *
+     * If not provided, a scale must be provided.
+     *
+     * For example, this could be a range of colors or sizes.
+     *
+     * To have all marks use the same visual value, use an array with a single element.
+     */
+    range(range: null): this;
+    range(range: [Range, Range]): this;
+    /**
+     * OPTIONAL. This is a D3 scale function that maps values from the dimension's domain to the dimension's range.
+     *
+     * If the user provides a custom scale function through the `scale` method, this will be ignored.
+     *
+     * @default d3.scaleLinear
+     */
+    scaleFn(scaleFn: null): this;
+    scaleFn(scaleFn: (domain?: Iterable<number>, range?: Iterable<Range>) => ScaleContinuousNumeric<Range, Range>): this;
+    /**
+     * OPTIONAL. Allows a user to set a completely custom scale that transforms the value returned by this dimension's valueAccessor into a visual value (string or number).
+     *
+     * If not provided, a range must be provided.
+     *
+     * If provided, this will override any values provided to domain, range, and scaleFn.
+     */
+    scale(scale: null): this;
+    scale(scale: (value: number) => Range): this;
+    /**
+     * @internal This method is not intended to be used by consumers of this library.
+     *
+     * @param dimensionName A user-intelligible name for the dimension being built. Used for error messages. Should be title cased.
+     */
+    _build(dimensionName: string): NumberVisualValueDimension<Datum, Range>;
+    private validateBuilder;
+}

package/lib/data-dimensions/continuous-quantitative/number-visual-value/number-visual-value-options.d.ts

@@ -0,0 +1,6 @@
+import { VisualValue } from '../../../core/types/values';
+import { NumberDimensionOptions } from '../number-dimension/number-dimension-options';
+export interface NumberVisualValueDimensionOptions<Datum, Range extends VisualValue> extends NumberDimensionOptions<Datum, Range> {
+    range: [Range, Range];
+    scale: (value: number) => Range;
+}

package/lib/data-dimensions/continuous-quantitative/number-visual-value/number-visual-value.d.ts

@@ -0,0 +1,29 @@
+import { ScaleContinuousNumeric } from 'd3';
+import { VisualValue } from '../../../core';
+import { NumberDimension } from '../number-dimension/number-dimension';
+import { NumberVisualValueDimensionOptions } from './number-visual-value-options';
+/**
+ * A dimension that transforms number values into a value of type number or string.
+ *
+ * This dimension is intended to be used to set a visual property of an element in a chart.
+ *
+ * The first generic is the type of the data that will be passed to the dimension. The second generic is the type of the range of the scale / the output value.
+ *
+ * TESTABLE FUNCTIONALITY
+ *
+ * - It extracts values for the dimension from data.
+ *   - tested in: dots.cy.ts
+ * - It sets the domain of the dimension.
+ *   - tested in: dots.cy.ts
+ * - It set the scale from the calculated domain and the user-provided range of the user does not provide a scale.
+ *   - tested in: dots.cy.ts
+ */
+export declare class NumberVisualValueDimension<Datum, Range extends VisualValue> extends NumberDimension<Datum> {
+    readonly range: [Range, Range];
+    private scale;
+    readonly scaleFn: (domain?: Iterable<number>, range?: Iterable<Range>) => ScaleContinuousNumeric<Range, Range>;
+    constructor(options: NumberVisualValueDimensionOptions<Datum, Range>);
+    getScale(): (value: number) => Range;
+    setPropertiesFromData(data: Datum[]): void;
+    private setScale;
+}

package/lib/data-dimensions/dimension-builder.d.ts

@@ -0,0 +1,21 @@
+import { DataValue } from '../core/types/values';
+export declare abstract class DataDimensionBuilder<Datum, TDataValue extends DataValue> {
+    protected _formatFunction: (d: Datum) => string;
+    protected _valueAccessor: (d: Datum) => TDataValue;
+    /**
+     * OPTIONAL. Sets a function that will be applied to the value of this dimension for display purposes.
+     *
+     * If provided, this function will be used instead of the format specifier (available only for quantitative dimensions)
+     */
+    formatFunction(formatFunction: null): this;
+    formatFunction(formatFunction: (d: Datum) => string): this;
+    /**
+     * Sets a user-provided method that extracts the value for this dimension from a datum.
+     *
+     * REQUIRED. for quantitative dimensions.
+     *
+     * OPTIONAL. for categorical and ordinal dimensions, though if not provided, the properties of those dimensions cannot reflect the data values.
+     */
+    valueAccessor(valueAccessor: (d: Datum) => TDataValue): this;
+    protected validateValueAccessor(dimensionName: string): void;
+}

package/lib/data-dimensions/dimension-options.d.ts

@@ -0,0 +1,11 @@
+import { DataValue } from '../core/types/values';
+export interface DataDimensionOptions<Datum, TDataValue extends DataValue> {
+    /**
+     * A function that will be applied to the value of this dimension for display purposes. If provided, this function will be used instead of the format specifier (available only for quantitative dimensions)
+     */
+    formatFunction: (d: Datum) => string;
+    /**
+     * A user-provided method that extracts the value for this dimension from a datum. If the dimension is continuous (number of Date), a user *must* provide this method.
+     */
+    valueAccessor: (d: Datum) => TDataValue;
+}

package/lib/data-dimensions/dimension.d.ts

@@ -0,0 +1,16 @@
+import { DataValue } from '../core/types/values';
+import { DataDimensionOptions } from './dimension-options';
+export declare abstract class DataDimension<Datum, TDataValue extends DataValue> implements DataDimensionOptions<Datum, TDataValue> {
+    readonly dimensionType: 'number' | 'ordinal' | 'date';
+    readonly formatFunction: (d: Datum) => string;
+    readonly valueAccessor: (d: Datum) => TDataValue;
+    /**
+     * An array of values for this dimension, extracted from the data using the value accessor.
+     * @see {@link valueAccessor}
+     */
+    values: TDataValue[];
+    abstract setPropertiesFromData(data: Datum[], ...args: any): void;
+    protected abstract setDomain(...args: any): void;
+    protected setValues(data: Datum[]): void;
+    constructor(dimensionType: 'number' | 'ordinal' | 'date');
+}

package/lib/data-dimensions/index.d.ts

@@ -0,0 +1,9 @@
+export * from '../fill-definitions/fill-definitions';
+export * from './continuous-quantitative/date-chart-position/date-chart-position-options';
+export * from './continuous-quantitative/number-chart-position/domain-padding/percent-over/percent-over-options';
+export * from './continuous-quantitative/number-chart-position/domain-padding/pixel/pixel-options';
+export * from './continuous-quantitative/number-chart-position/domain-padding/round-to-interval/round-to-interval-options';
+export * from './continuous-quantitative/number-chart-position/domain-padding/round-to-sig-fig/round-to-sig-fig-options';
+export * from './continuous-quantitative/number-chart-position/number-chart-position-options';
+export * from './ordinal/ordinal-chart-position/ordinal-chart-position-options';
+export * from './ordinal/ordinal-visual-value/ordinal-visual-value-options';

package/lib/data-dimensions/ordinal/ordinal-chart-position/ordinal-chart-position-builder.d.ts

@@ -0,0 +1,53 @@
+import { DataValue } from '../../../core/types/values';
+import { DataDimensionBuilder } from '../../dimension-builder';
+import { OrdinalChartPositionDimension } from './ordinal-chart-position';
+export declare class OrdinalChartPositionDimensionBuilder<Datum, Domain extends DataValue> extends DataDimensionBuilder<Datum, Domain> {
+    private _align;
+    private _domain;
+    private _paddingInner;
+    private _paddingOuter;
+    constructor();
+    /**
+     * OPTIONAL. Sets the alignment of the ordinal scale and is provided to [D3's align method](https://d3js.org/d3-scale/band#band_align)
+     *
+     * The value must be between 0 and 1.
+     *
+     * @default 0.5.
+     */
+    align(align: null): this;
+    align(align: number): this;
+    /**
+     * OPTIONAL. Sets an array of ordinal values that will be used to define the domain of the scale.
+     *
+     * If not provided, the domain will be determined by the data.
+     */
+    domain(domain: null): this;
+    domain(domain: Domain[]): this;
+    /**
+     * OPTIONAL. Sets the inner padding of the ordinal scale and is provided to [D3's paddingInner method](https://d3js.org/d3-scale/band#band_paddingInner)
+     *
+     * Will have no effect if the scale is a point scale.
+     *
+     * The value must be between 0 and 1.
+     *
+     * @default 0.1.
+     */
+    paddingInner(paddingInner: null): this;
+    paddingInner(paddingInner: number): this;
+    /**
+     * OPTIONAL. Sets the outer padding of the ordinal scale and is provided to [D3's paddingOuter method](https://d3js.org/d3-scale/band#band_paddingOuter)
+     *
+     * The value must be between 0 and 1.
+     *
+     * @default 0.1.
+     */
+    paddingOuter(paddingOuter: null): this;
+    paddingOuter(paddingOuter: number): this;
+    /**
+     * @internal This method is not intended to be used by consumers of this library.
+     *
+     * @param dimensionName A user-intelligible name for the dimension being built. Used for error messages. Should be title cased.
+     */
+    _build(scaleType: 'band' | 'point', dimensionName: string): OrdinalChartPositionDimension<Datum, Domain>;
+    private validateDimension;
+}

package/lib/data-dimensions/ordinal/ordinal-chart-position/ordinal-chart-position-options.d.ts

@@ -0,0 +1,8 @@
+import { DataValue } from '../../../core/types/values';
+import { DataDimensionOptions } from '../../dimension-options';
+export interface OrdinalChartPositionDimensionOptions<Datum, Domain extends DataValue> extends DataDimensionOptions<Datum, Domain> {
+    align: number;
+    domain: Domain[];
+    paddingInner: number;
+    paddingOuter: number;
+}

package/lib/data-dimensions/ordinal/ordinal-chart-position/ordinal-chart-position.d.ts

@@ -0,0 +1,44 @@
+import { ScaleBand, ScalePoint } from 'd3';
+import { DataValue } from '../../../core/types/values';
+import { DataDimension } from '../../dimension';
+import { OrdinalChartPositionDimensionOptions } from './ordinal-chart-position-options';
+/**
+ * A dimension that transforms string / number / Date values into a position on a chart.
+ *
+ * This dimension is used for the positional dimensions of a chart, such as x and y. The underlying scale will always be a [D3 band scale](https://d3js.org/d3-scale/band). The range of the scale will be a dimension from the chart.
+ *
+ * The first generic is the type of the data that will be passed to the dimension. The second generic is the type of the value that will be used to position the data on the chart.
+ *
+ * TESTABLE FUNCTIONALITY
+ *
+ * - It extracts values for the dimension from data.
+ *   - tested in: bars.cy.ts, dots.cy.ts, stacked-bars.cy.ts
+ * - It sets the domain of the dimension.
+ *   - tested in: bars.cy.ts, dots.cy.ts
+ * - It checks if a value is in the domain.
+ *   - tested in: bars.cy.ts
+ * - It creates a scale from a range.
+ *   - tested in: bars.cy.ts, dots.cy.ts
+ * - The domain will be unique values from the user-provided domain if the user provides a domain.
+ *   - tested in: ordinal-chart-position.spec.ts
+ * - The domain will be unique values from the data if no custom domain is given by the user.
+ *   - tested in: ordinal-chart-position.spec.ts
+ * - The domain can be set in reverse order.
+ *   - tested in: ordinal-chart-position.spec.ts
+ */
+export declare class OrdinalChartPositionDimension<Datum, Domain extends DataValue> extends DataDimension<Datum, Domain> implements OrdinalChartPositionDimensionOptions<Datum, Domain> {
+    readonly align: number;
+    private _calculatedDomain;
+    readonly domain: Domain[];
+    private internSetDomain;
+    readonly paddingInner: number;
+    readonly paddingOuter: number;
+    private scaleFn;
+    readonly valueAccessor: (d: Datum, ...args: any) => Domain;
+    constructor(scaleType: 'band' | 'point', options: OrdinalChartPositionDimensionOptions<Datum, Domain>);
+    get calculatedDomain(): Domain[];
+    setPropertiesFromData(data: Datum[], reverseDomain?: boolean): void;
+    protected setDomain(reverseDomain: boolean): void;
+    domainIncludes(value: Domain): boolean;
+    getScaleFromRange(range: [number, number]): ScaleBand<Domain> | ScalePoint<Domain>;
+}