@uwdata/mosaic-spec 0.17.0 → 0.18.0

package/dist/src/spec/Input.d.ts

@@ -0,0 +1,213 @@
+import { ParamRef } from './Param.js';
+/** A menu input component. */
+export interface Menu {
+    /**
+     * A menu input widget.
+     */
+    input: 'menu';
+    /**
+     * The output selection. A selection clause is added for the
+     * currently selected menu option.
+     */
+    as?: ParamRef;
+    /**
+     * The database column name to use within generated selection clause
+     * predicates. Defaults to the `column` property.
+     */
+    field?: string;
+    /**
+     * The name of a database table to use as a data source for this widget.
+     * Used in conjunction with the `column` property.
+     */
+    from?: string;
+    /**
+     * The name of a database column from which to pull menu options.
+     * The unique column values are used as menu options.
+     * Used in conjunction with the `from` property.
+     */
+    column?: string;
+    /**
+     * A selection to filter the database table indicated by the `from` property.
+     */
+    filterBy?: ParamRef;
+    /**
+     * A text label for this input.
+     */
+    label?: string;
+    /**
+     * An array of menu options, as literal values or option objects.
+     * Option objects have a `value` property and an optional `label` property.
+     * If no label is provided, the string-coerced value is used.
+     */
+    options?: Array<any | {
+        value: any;
+        label?: string;
+    }>;
+    /**
+     * The initial selected menu value.
+     */
+    value?: any;
+}
+/** A search input component. */
+export interface Search {
+    /**
+     * A text search input widget.
+     */
+    input: 'search';
+    /**
+     * The output selection. A selection clause is added for the
+     * current text search query.
+     */
+    as?: ParamRef;
+    /**
+     * The database column name to use within generated selection clause
+     * predicates. Defaults to the `column` property.
+     */
+    field?: string;
+    /**
+     * The type of text search query to perform. One of:
+     * - `"contains"` (default): the query string may appear anywhere in the text
+     * - `"prefix"`: the query string must appear at the start of the text
+     * - `"suffix"`: the query string must appear at the end of the text
+     * - `"regexp"`: the query string is a regular expression the text must match
+     */
+    type?: 'contains' | 'prefix' | 'suffix' | 'regexp';
+    /**
+     * The name of a database table to use as an autocomplete data source
+     * for this widget. Used in conjunction with the `column` property.
+     */
+    from?: string;
+    /**
+     * The name of a database column from which to pull valid search results.
+     * The unique column values are used as search autocomplete values.
+     * Used in conjunction with the `from` property.
+     */
+    column?: string;
+    /**
+     * A selection to filter the database table indicated by the `from` property.
+     */
+    filterBy?: ParamRef;
+    /**
+     * A text label for this input.
+     */
+    label?: string;
+}
+/** A slider input component. */
+export interface Slider {
+    /**
+     * A slider input widget.
+     */
+    input: 'slider';
+    /**
+     * The output selection. A selection clause is added for the
+     * currently selected slider option.
+     */
+    as?: ParamRef;
+    /**
+     * The database column name to use within generated selection clause
+     * predicates. Defaults to the `column` property.
+     */
+    field?: string;
+    /**
+     * The type of selection clause predicate to generate if the **as** option
+     * is a Selection. If `'point'` (the default), the selection predicate is an
+     * equality check for the slider value. If `'interval'`, the predicate checks
+     * an interval from the minimum to the current slider value.
+     */
+    select?: 'point' | 'interval';
+    /**
+     * The name of a database table to use as a data source for this widget.
+     * Used in conjunction with the `column` property.
+     * The minimum and maximum values of the column determine the slider range.
+     */
+    from?: string;
+    /**
+     * The name of a database column whose values determine the slider range.
+     * Used in conjunction with the `from` property.
+     * The minimum and maximum values of the column determine the slider range.
+     */
+    column?: string;
+    /**
+     * A selection to filter the database table indicated by the `from` property.
+     */
+    filterBy?: ParamRef;
+    /**
+     * The minumum slider value.
+     */
+    min?: number;
+    /**
+     * The maximum slider value.
+     */
+    max?: number;
+    /**
+     * The slider step, the amount to increment between consecutive values.
+     */
+    step?: number;
+    /**
+     * A text label for this input.
+     */
+    label?: string;
+    /**
+     * The initial slider value.
+     */
+    value?: number;
+    /**
+     * The width of the slider in screen pixels.
+     */
+    width?: number;
+}
+/** A table grid view component. */
+export interface Table {
+    /**
+     * A table grid widget.
+     */
+    input: 'table';
+    /**
+     * The output selection. A selection clause is added for each
+     * currently selected table row.
+     */
+    as?: ParamRef;
+    /**
+     * The name of a database table to use as a data source for this widget.
+     */
+    from: string | ParamRef;
+    /**
+     * A list of column names to include in the table grid.
+     * If unspecified, all table columns are included.
+     */
+    columns?: string[];
+    /**
+     * A selection to filter the database table indicated by the `from` property.
+     */
+    filterBy?: ParamRef;
+    /**
+     * An object of per-column alignment values.
+     * Column names should be object keys, which map to alignment values.
+     * Valid alignment values are: `"left"`, `"right"`, `"center"`, and `"justify"`.
+     * By default, numbers are right-aligned and other values are left-aligned.
+     */
+    align?: {
+        [column: string]: 'left' | 'right' | 'center' | 'justify';
+    };
+    /**
+     * If a number, sets the total width of the table widget, in pixels.
+     * If an object, provides per-column pixel width values.
+     * Column names should be object keys, mapped to numeric width values.
+     */
+    width?: number | {
+        [column: string]: number;
+    };
+    /**
+     * The maximum width of the table widget, in pixels.
+     */
+    maxWidth?: number;
+    /**
+     * The height of the table widget, in pixels.
+     */
+    height?: number;
+    /**
+     * The number of rows load in a new batch upon table scroll.
+     */
+    rowBatch?: number;
+}
+//# sourceMappingURL=Input.d.ts.map

package/dist/src/spec/Input.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Input.d.ts","sourceRoot":"","sources":["../../../src/spec/Input.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,8BAA8B;AAC9B,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,EAAE,CAAC,EAAE,QAAQ,CAAC;IACd;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,GAAG,GAAG;QAAE,KAAK,EAAE,GAAG,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACtD;;OAEG;IACH,KAAK,CAAC,EAAE,GAAG,CAAC;CACb;AAED,gCAAgC;AAChC,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC;IAChB;;;OAGG;IACH,EAAE,CAAC,EAAE,QAAQ,CAAC;IACd;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACnD;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,gCAAgC;AAChC,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,KAAK,EAAE,QAAQ,CAAC;IAChB;;;OAGG;IACH,EAAE,CAAC,EAAE,QAAQ,CAAC;IACd;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,MAAM,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC;IAC9B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,mCAAmC;AACnC,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IACf;;;OAGG;IACH,EAAE,CAAC,EAAE,QAAQ,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IACxB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB;;;;;OAKG;IACH,KAAK,CAAC,EAAE;QAAE,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAA;KAAE,CAAC;IACtE;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG;QAAE,CAAC,MAAM,EAAG,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAC/C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}

package/dist/src/spec/Interval.d.ts

@@ -0,0 +1,59 @@
+/** Date/time interval. */
+export type IntervalTransform = Years | Months | Days | Hours | Minutes | Seconds | Milliseconds | Microseconds;
+/** A date/time interval in units of years. */
+export interface Years {
+    /**
+     * A date/time interval in units of years.
+     */
+    years: number;
+}
+/** A date/time interval in units of months. */
+export interface Months {
+    /**
+     * A date/time interval in units of months.
+     */
+    months: number;
+}
+/** A date/time interval in units of days. */
+export interface Days {
+    /**
+     * A date/time interval in units of days.
+     */
+    days: number;
+}
+/** A date/time interval in units of hours. */
+export interface Hours {
+    /**
+     * A date/time interval in units of hours.
+     */
+    hours: number;
+}
+/** A date/time interval in units of minutes. */
+export interface Minutes {
+    /**
+     * A date/time interval in units of minutes.
+     */
+    minutes: number;
+}
+/** A date/time interval in units of seconds. */
+export interface Seconds {
+    /**
+     * A date/time interval in units of seconds.
+     */
+    seconds: number;
+}
+/** A date/time interval in units of milliseconds. */
+export interface Milliseconds {
+    /**
+     * A date/time interval in units of milliseconds.
+     */
+    milliseconds: number;
+}
+/** A date/time interval in units of microseconds. */
+export interface Microseconds {
+    /**
+     * A date/time interval in units of microseconds.
+     */
+    microseconds: number;
+}
+//# sourceMappingURL=Interval.d.ts.map

package/dist/src/spec/Interval.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Interval.d.ts","sourceRoot":"","sources":["../../../src/spec/Interval.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,MAAM,MAAM,iBAAiB,GACzB,KAAK,GACL,MAAM,GACN,IAAI,GACJ,KAAK,GACL,OAAO,GACP,OAAO,GACP,YAAY,GACZ,YAAY,CACb;AAEH,8CAA8C;AAC9C,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,+CAA+C;AAC/C,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,6CAA6C;AAC7C,MAAM,WAAW,IAAI;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,8CAA8C;AAC9C,MAAM,WAAW,KAAK;IACpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,gDAAgD;AAChD,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,gDAAgD;AAChD,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,qDAAqD;AACrD,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,qDAAqD;AACrD,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB"}

package/dist/src/spec/Param.d.ts

@@ -0,0 +1,64 @@
+export type ParamRef = `$${string}`;
+/** Base properties shared by Param definitions. */
+export interface ParamBase {
+    /**
+     * The type of reactive parameter. One of:
+     * - `"value"` (default) for a standard `Param`
+     * - `"intersect"` for a `Selection` that intersects clauses (logical "and")
+     * - `"union"` for a `Selection` that unions clauses (logical "or")
+     * - `"single"` for a `Selection` that retains a single clause only
+     * - `"crossfilter"` for a cross-filtered intersection `Selection`
+     */
+    select?: 'value';
+}
+/** A Param definition. */
+export interface Param extends ParamBase {
+    /**
+     * The initial parameter value.
+     */
+    value: ParamValue;
+}
+/** A Date-valued Param definition. */
+export interface ParamDate extends ParamBase {
+    /**
+     * The initial parameter value as an ISO date/time
+     * string to be parsed to a Date object.
+     */
+    date: string;
+}
+/** Literal Param values. */
+export type ParamLiteral = null | string | number | boolean;
+/** Valid Param values. */
+export type ParamValue = ParamLiteral | Array<ParamLiteral | ParamRef>;
+/** A Selection definition. */
+export interface Selection {
+    /**
+     * The type of reactive parameter. One of:
+     * - `"value"` (default) for a standard `Param`
+     * - `"intersect"` for a `Selection` that intersects clauses (logical "and")
+     * - `"union"` for a `Selection` that unions clauses (logical "or")
+     * - `"single"` for a `Selection` that retains a single clause only
+     * - `"crossfilter"` for a cross-filtered intersection `Selection`
+     */
+    select: 'crossfilter' | 'intersect' | 'single' | 'union';
+    /**
+     * A flag for cross-filtering, where selections made in a plot filter others
+     * but not oneself (default `false`, except for `crossfilter` selections).
+     */
+    cross?: boolean;
+    /**
+     * A flag for setting an initial empty selection state. If true, a selection
+     * with no clauses corresponds to an empty selection with no records. If
+     * false, a selection with no clauses selects all values.
+     */
+    empty?: boolean;
+    /**
+     * Upstream selections whose clauses should be included as part of this
+     * selection. Any clauses or activations published to the upstream
+     * selections will be relayed to this selection.
+     */
+    include?: ParamRef | ParamRef[];
+}
+/** A Param or Selection definition. */
+export type ParamDefinition = ParamValue | Param | ParamDate | Selection;
+//# sourceMappingURL=Param.d.ts.map

package/dist/src/spec/Param.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Param.d.ts","sourceRoot":"","sources":["../../../src/spec/Param.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,IAAI,MAAM,EAAE,CAAC;AAEpC,mDAAmD;AACnD,MAAM,WAAW,SAAS;IACxB;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,0BAA0B;AAC1B,MAAM,WAAW,KAAM,SAAQ,SAAS;IACtC;;OAEG;IACH,KAAK,EAAE,UAAU,CAAC;CACnB;AAED,sCAAsC;AACtC,MAAM,WAAW,SAAU,SAAQ,SAAS;IAC1C;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,4BAA4B;AAC5B,MAAM,MAAM,YAAY,GACpB,IAAI,GACJ,MAAM,GACN,MAAM,GACN,OAAO,CAAC;AAEZ,0BAA0B;AAC1B,MAAM,MAAM,UAAU,GAClB,YAAY,GACZ,KAAK,CAAC,YAAY,GAAG,QAAQ,CAAC,CAAC;AAEnC,8BAA8B;AAC9B,MAAM,WAAW,SAAS;IACxB;;;;;;;OAOG;IACH,MAAM,EAAE,aAAa,GAAG,WAAW,GAAG,QAAQ,GAAG,OAAO,CAAC;IAEzD;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,OAAO,CAAC,EAAE,QAAQ,GAAG,QAAQ,EAAE,CAAC;CACjC;AAED,uCAAuC;AACvC,MAAM,MAAM,eAAe,GACvB,UAAU,GACV,KAAK,GACL,SAAS,GACT,SAAS,CAAC"}

package/dist/src/spec/Plot.d.ts

@@ -0,0 +1,15 @@
+import { PlotAttributes } from './PlotAttribute.js';
+import { PlotInteractor } from './PlotInteractor.js';
+import { PlotLegend } from './PlotLegend.js';
+import { PlotMark } from './PlotMark.js';
+/** A plot component. */
+export interface Plot extends PlotAttributes {
+    /**
+     * An array of plot marks, interactors, or legends.
+     * Marks are graphical elements that make up plot layers.
+     * Unless otherwise configured, interactors will use the nearest
+     * previous mark as a basis for which data fields to select.
+     */
+    plot: (PlotMark | PlotInteractor | PlotLegend)[];
+}
+//# sourceMappingURL=Plot.d.ts.map

package/dist/src/spec/Plot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plot.d.ts","sourceRoot":"","sources":["../../../src/spec/Plot.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,wBAAwB;AACxB,MAAM,WAAW,IAAK,SAAQ,cAAc;IAC1C;;;;;OAKG;IACH,IAAI,EAAE,CAAC,QAAQ,GAAG,cAAc,GAAG,UAAU,CAAC,EAAE,CAAC;CAClD"}