@genome-spy/core 0.68.0 → 0.69.1

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

@@ -1,197 +0,0 @@
-import { Data } from "./data.js";
-import { Align, FontStyle, FontWeight } from "./font.js";
-import { Scale } from "./scale.js";
-import { LayerSpec, UnitSpec, ViewSpecBase, ViewBackground } from "./view.js";
-
-// TODO: Figure out how this could be moved to the app package and excluded
-// from the core package.
-
-/**
- * A view specification for a SampleView.
- * This is only functional in the GenomeSpy app.
- */
-export interface SampleSpec extends ViewSpecBase {
-    /**
-     * Sample metadata definition.
-     * If the object is empty, the sample identifiers will be inferred from the data.
-     */
-    samples: SampleDef;
-
-    /**
-     * An object defining the view background and outline. The background is
-     * repeated for each group.
-     */
-    view?: ViewBackground;
-    /**
-     * The view specification to be repeated for each sample.
-     */
-    spec: LayerSpec | UnitSpec;
-
-    stickySummaries?: boolean;
-}
-
-export type SampleAttributeType = "nominal" | "ordinal" | "quantitative";
-
-export interface SampleAttributeDef {
-    /**
-     * The attribute type. One of `"nominal"`, `"ordinal"`, or `"quantitative"`.
-     */
-    type?: SampleAttributeType;
-
-    /**
-     * Scale definition for the (default) color channel
-     */
-    scale?: Scale;
-
-    /**
-     * An optional scale definition for mapping the attribute to
-     * the width of a metadata rectangle.
-     */
-    barScale?: Scale;
-
-    /**
-     * Width of the column in pixels.
-     */
-    width?: number;
-
-    /**
-     * Whether the attribute is visible by default.
-     */
-    visible?: boolean;
-
-    /**
-     * The title of the attribute. Defaults to attribute name.
-     */
-    title?: string;
-}
-
-export interface SampleDef {
-    /**
-     * Optional metadata about the samples.
-     */
-    data?: Data;
-
-    /**
-     * If attributes form a hierarchy, specify the separator character to
-     * split the attribute names into paths.
-     */
-    attributeGroupSeparator?: string;
-
-    /**
-     * Explicitly specify the sample attributes.
-     */
-    attributes?: Record<string, SampleAttributeDef>;
-
-    /**
-     * Text in the label title
-     *
-     * **Default:** `"Sample name"`
-     */
-    labelTitleText?: string;
-
-    /**
-     * How much space in pixels to reserve for the labels.
-     *
-     * **Default:** `140`
-     */
-    labelLength?: number;
-
-    /**
-     * The font typeface. GenomeSpy uses [SDF](https://github.com/Chlumsky/msdfgen)
-     * versions of [Google Fonts](https://fonts.google.com/). Check their
-     * availability at the [A-Frame
-     * Fonts](https://github.com/etiennepinchon/aframe-fonts/tree/master/fonts)
-     * repository. System fonts are **not** supported.
-     *
-     * **Default value:** `"Lato"`
-     */
-    labelFont?: string;
-
-    /**
-     * The font style. Valid values: `"normal"` and `"italic"`.
-     *
-     * **Default value:** `"normal"`
-     */
-    labelFontStyle?: FontStyle;
-
-    /**
-     * The font weight. The following strings and numbers are valid values:
-     * `"thin"` (`100`), `"light"` (`300`), `"regular"` (`400`),
-     * `"normal"` (`400`), `"medium"` (`500`), `"bold"` (`700`),
-     * `"black"` (`900`)
-     *
-     * **Default value:** `"regular"`
-     */
-    labelFontWeight?: FontWeight;
-
-    /**
-     * The font size in pixels.
-     *
-     * **Default value:** `11`
-     */
-    labelFontSize?: number;
-
-    /**
-     * The horizontal alignment of the text. One of `"left"`, `"center"`, or `"right"`.
-     *
-     * **Default value:** `"left"`
-     */
-    labelAlign?: Align;
-
-    /**
-     * Default size (width) of the metadata attribute columns.
-     * Can be configured per attribute using the `attributes` property.
-     *
-     * **Default value:** `10`
-     */
-    attributeSize?: number;
-
-    /**
-     * The font typeface. GenomeSpy uses [SDF](https://github.com/Chlumsky/msdfgen)
-     * versions of [Google Fonts](https://fonts.google.com/). Check their
-     * availability at the [A-Frame
-     * Fonts](https://github.com/etiennepinchon/aframe-fonts/tree/master/fonts)
-     * repository. System fonts are **not** supported.
-     *
-     * **Default value:** `"Lato"`
-     */
-    attributeLabelFont?: string;
-
-    /**
-     * The font style. Valid values: `"normal"` and `"italic"`.
-     *
-     * **Default value:** `"normal"`
-     */
-    attributeLabelFontStyle?: FontStyle;
-
-    /**
-     * The font weight. The following strings and numbers are valid values:
-     * `"thin"` (`100`), `"light"` (`300`), `"regular"` (`400`),
-     * `"normal"` (`400`), `"medium"` (`500`), `"bold"` (`700`),
-     * `"black"` (`900`)
-     *
-     * **Default value:** `"regular"`
-     */
-    attributeLabelFontWeight?: FontWeight;
-
-    /**
-     * The font size in pixels.
-     *
-     * **Default value:** `11`
-     */
-    attributeLabelFontSize?: number;
-
-    /**
-     * Angle to be added to the default label angle (-90).
-     *
-     * **Default value:** `0`
-     */
-    attributeLabelAngle?: number;
-
-    /**
-     * Spacing between attribute columns in pixels.
-     *
-     * **Default value:** `1`
-     */
-    attributeSpacing?: number;
-}

package/dist/src/view/paramMediator.d.ts

@@ -1,168 +0,0 @@
-/**
- * @param {any} x
- * @returns {x is import("../spec/parameter.js").ExprRef}
- */
-export function isExprRef(x: any): x is import("../spec/parameter.js").ExprRef;
-/**
- * Removes ExprRef from the type and checks that the value is not an ExprRef.
- * This is designed to be used with `activateExprRefProps`.
- *
- * @param {T | import("../spec/parameter.js").ExprRef} x
- * @template T
- * @returns {T}
- */
-export function withoutExprRef<T>(x: T | import("../spec/parameter.js").ExprRef): T;
-/**
- * @param {Parameter} param
- * @returns {param is import("../spec/parameter.js").VariableParameter}
- */
-export function isVariableParameter(param: import("../spec/parameter.js").Parameter): param is import("../spec/parameter.js").VariableParameter;
-/**
- * @param {Parameter} param
- * @returns {param is import("../spec/parameter.js").SelectionParameter}
- */
-export function isSelectionParameter(param: import("../spec/parameter.js").Parameter): param is import("../spec/parameter.js").SelectionParameter;
-/**
- * Computes the default value for a parameter specification.
- *
- * @param {Parameter} param
- * @param {ParamMediator} [paramMediator]
- * @param {ExprRefFunction} [exprFn]
- * @returns {any}
- */
-export function getDefaultParamValue(param: import("../spec/parameter.js").Parameter, paramMediator?: ParamMediator, exprFn?: ExprRefFunction): any;
-/**
- * Takes a record of properties that may have ExprRefs as values. Converts the
- * ExprRefs to getters and setups a listener that is called when any of the
- * expressions (upstream parameters) change.
- *
- * @param {ParamMediator} paramMediator
- * @param {T} props The properties object
- * @param {(props: (keyof T)[]) => void} [listener] Listener to be called when any of the expressions change
- * @returns T
- * @template {Record<string, any | import("../spec/parameter.js").ExprRef>} T
- */
-export function activateExprRefProps<T extends Record<string, any | import("../spec/parameter.js").ExprRef>>(paramMediator: ParamMediator, props: T, listener?: (props: (keyof T)[]) => void): T;
-/**
- * Validates a parameter name. If the name is invalid, throws an error.
- * Otherwise, returns the name.
- *
- * @param {string} name
- * @returns {string} the name
- */
-export function validateParameterName(name: string): string;
-/**
- * Creates a function that always returns the same value.
- * Provides functionality for creating a constant expression reference.
- * They just do nothing.
- *
- * @param {any} value
- * @returns {ExprRefFunction}
- */
-export function makeConstantExprRef(value: any): ExprRefFunction;
-/**
- * A class that manages parameters and expressions.
- * Supports nesting and scoped parameters.
- *
- * TODO: The proposed JavaScript signals may provide a better way to implement this.
- * https://github.com/proposal-signals/proposal-signals
- *
- * @typedef {import("../utils/expression.js").ExpressionFunction & { addListener: (listener: () => void) => void, removeListener: (listener: () => void) => void, invalidate: () => void, identifier: () => string}} ExprRefFunction
- */
-export default class ParamMediator {
-    /**
-     * @param {() => ParamMediator} [parentFinder]
-     *      An optional function that returns the parent mediator.
-     *      N.B. The function must always return the same mediator for the same parent,
-     *      i.e., the changing the structure of the hierarchy is NOT supported.
-     */
-    constructor(parentFinder?: () => ParamMediator);
-    /**
-     * @type {Map<string, Set<() => void>>}
-     * @protected
-     */
-    protected paramListeners: Map<string, Set<() => void>>;
-    /**
-     * @param {Parameter} param
-     * @returns {ParameterSetter}
-     */
-    registerParam(param: import("../spec/parameter.js").Parameter): (value: any) => void;
-    /**
-     *
-     * @param {string} paramName
-     * @param {T} initialValue
-     * @param {boolean} [passive] If true, the setter will not notify listeners when the value changes.
-     * @returns {(value: T) => void}
-     * @template T
-     */
-    allocateSetter<T>(paramName: string, initialValue: T, passive?: boolean): (value: T) => void;
-    /**
-     * Gets an existing setter for a parameter. Throws if the setter is not found.
-     * @param {string} paramName
-     */
-    getSetter(paramName: string): (value: any) => void;
-    /**
-     * Get the value of a parameter from this mediator.
-     * @param {string} paramName
-     */
-    getValue(paramName: string): any;
-    /**
-     * Subscribe to changes of a parameter's value. The listener is called only
-     * when the stored value changes. For expression parameters, the listener is
-     * called when upstream changes re-evaluate to a different value.
-     *
-     * @param {string} paramName
-     * @param {() => void} listener
-     * @returns {() => void}
-     */
-    subscribe(paramName: string, listener: () => void): () => void;
-    /**
-     * Get the value of a parameter from this mediator or the ancestors.
-     * @param {string} paramName
-     */
-    findValue(paramName: string): any;
-    /**
-     * Returns configs for all parameters that have been registered using `registerParam`.
-     */
-    get paramConfigs(): ReadonlyMap<string, import("../spec/parameter.js").Parameter>;
-    /**
-     *
-     * @param {string} paramName
-     * @returns {ParamMediator}
-     */
-    findMediatorForParam(paramName: string): ParamMediator;
-    /**
-     * Parse expr and return a function that returns the value of the parameter.
-     *
-     * @param {string} expr
-     */
-    createExpression(expr: string): ExprRefFunction;
-    /**
-     * A convenience method for evaluating an expression.
-     *
-     * @param {string} expr
-     */
-    evaluateAndGet(expr: string): any;
-    /**
-     * Returns true if this ParamMediator has any parameters that are point selections.
-     * Point selections necessitate the use of uniqueIds in the data.
-     *
-     * @returns {boolean}
-     */
-    hasPointSelections(): boolean;
-    #private;
-}
-/**
- * A class that manages parameters and expressions.
- * Supports nesting and scoped parameters.
- *
- * TODO: The proposed JavaScript signals may provide a better way to implement this.
- * https://github.com/proposal-signals/proposal-signals
- */
-export type ExprRefFunction = import("../utils/expression.js").ExpressionFunction & {
-    addListener: (listener: () => void) => void;
-    removeListener: (listener: () => void) => void;
-    invalidate: () => void;
-    identifier: () => string;
-};
-//# sourceMappingURL=paramMediator.d.ts.map

package/dist/src/view/paramMediator.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"paramMediator.d.ts","sourceRoot":"","sources":["../../../src/view/paramMediator.js"],"names":[],"mappings":"AAiXA;;;GAGG;AACH,6BAHW,GAAG,GACD,CAAC,IAAI,OAAO,sBAAsB,EAAE,OAAO,CAIvD;AAED;;;;;;;GAOG;AACH,+BAHa,CAAC,KADH,CAAC,GAAG,OAAO,sBAAsB,EAAE,OAAO,GAExC,CAAC,CAWb;AAED;;;GAGG;AACH,sFAFa,KAAK,IAAI,OAAO,sBAAsB,EAAE,iBAAiB,CAIrE;AAED;;;GAGG;AACH,uFAFa,KAAK,IAAI,OAAO,sBAAsB,EAAE,kBAAkB,CAItE;AAED;;;;;;;GAOG;AACH,sGAJW,aAAa,WACb,eAAe,GACb,GAAG,CAwCf;AAED;;;;;;;;;;GAUG;AACH,qCAF4E,CAAC,SAA/D,MAAM,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,sBAAsB,EAAE,OAAO,CAAE,iBAJhE,aAAa,SACb,CAAC,aACD,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,IAAI,GAuCjB,CAAC,CACtB;AAED;;;;;;GAMG;AACH,4CAHW,MAAM,GACJ,MAAM,CAUlB;AAED;;;;;;;GAOG;AACH,2CAHW,GAAG,GACD,eAAe,CAY3B;AArhBD;;;;;;;;GAQG;AACH;IA2BI;;;;;OAKG;IACH,2BALW,MAAM,aAAa,EAU7B;IA7BD;;;OAGG;IACH,0BAHU,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,IAAI,CAAC,CAAC,CAGvB;IA2Bf;;;OAGG;IACH,wEAzCqB,GAAG,KAAK,IAAI,CAkGhC;IAED;;;;;;;OAOG;IACH,eAFa,CAAC,aAJH,MAAM,gBACN,CAAC,YACD,OAAO,GACL,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,CAgC9B;IAED;;;OAGG;IACH,qBAFW,MAAM,WAjIc,GAAG,KAAK,IAAI,CAyI1C;IAED;;;OAGG;IACH,oBAFW,MAAM,OAIhB;IAED;;;;;;;;OAQG;IACH,qBAJW,MAAM,YACN,MAAM,IAAI,GACR,MAAM,IAAI,CAmBtB;IAED;;;OAGG;IACH,qBAFW,MAAM,OAKhB;IAED;;OAEG;IACH,oBACsB,WAAW,CAAC,MAAM,2CAAY,CAGnD;IAED;;;;OAIG;IACH,gCAHW,MAAM,GACJ,aAAa,CAQzB;IAID;;;;OAIG;IACH,uBAFW,MAAM,mBAuFhB;IAED;;;;OAIG;IACH,qBAFW,MAAM,OAKhB;IAED;;;;;OAKG;IACH,sBAFa,OAAO,CAiBnB;;CACJ;;;;;;;;8BA7VY,OAAO,wBAAwB,EAAE,kBAAkB,GAAG;IAAE,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;IAAC,cAAc,EAAE,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;IAAC,UAAU,EAAE,MAAM,IAAI,CAAC;IAAC,UAAU,EAAE,MAAM,MAAM,CAAA;CAAC"}