@vitessce/statistical-plots 2.0.3 → 3.0.1

package/dist-tsc/CellSetExpressionPlot.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Gene expression histogram displayed as a bar chart,
+ * implemented with the VegaPlot component.
+ * @param {object} props
+ * @param {object[]} props.data The expression data, an array
+ * of objects with properties `value`, `gene`, and `set`.
+ * @param {number} props.domainMax The maximum gene expression value.
+ * @param {object[]} props.colors An object for each
+ * cell set, with properties `name` and `color`.
+ * @param {string} props.theme The name of the current Vitessce theme.
+ * @param {number} props.width The container width.
+ * @param {number} props.height The container height.
+ * @param {number} props.marginRight The size of the margin
+ * on the right side of the plot, to account for the vega menu button.
+ * By default, 90.
+ * @param {number} props.marginBottom The size of the margin
+ * on the bottom of the plot, to account for long x-axis labels.
+ * Default is allowing the component to automatically determine the margin.
+ * @param {string|null} props.featureValueTransformName A name
+ * for the feature value transformation function.
+ */
+export default function CellSetExpressionPlot(props: {
+    data: object[];
+    domainMax: number;
+    colors: object[];
+    theme: string;
+    width: number;
+    height: number;
+    marginRight: number;
+    marginBottom: number;
+    featureValueTransformName: string | null;
+}): JSX.Element;
+//# sourceMappingURL=CellSetExpressionPlot.d.ts.map

package/dist-tsc/CellSetExpressionPlot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CellSetExpressionPlot.d.ts","sourceRoot":"","sources":["../src/CellSetExpressionPlot.js"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH;IAjB2B,IAAI,EAApB,MAAM,EAAE;IAEM,SAAS,EAAvB,MAAM;IACU,MAAM,EAAtB,MAAM,EAAE;IAEM,KAAK,EAAnB,MAAM;IACQ,KAAK,EAAnB,MAAM;IACQ,MAAM,EAApB,MAAM;IACQ,WAAW,EAAzB,MAAM;IAGQ,YAAY,EAA1B,MAAM;IAGa,yBAAyB,EAA5C,MAAM,GAAC,IAAI;gBA6PrB"}

package/dist-tsc/CellSetExpressionPlot.js

@@ -0,0 +1,248 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import React from 'react';
+import { clamp } from 'lodash-es';
+import { VegaPlot, VEGA_THEMES, DATASET_NAME } from '@vitessce/vega';
+import { colorArrayToString } from '@vitessce/sets-utils';
+import { capitalize } from '@vitessce/utils';
+/**
+ * Gene expression histogram displayed as a bar chart,
+ * implemented with the VegaPlot component.
+ * @param {object} props
+ * @param {object[]} props.data The expression data, an array
+ * of objects with properties `value`, `gene`, and `set`.
+ * @param {number} props.domainMax The maximum gene expression value.
+ * @param {object[]} props.colors An object for each
+ * cell set, with properties `name` and `color`.
+ * @param {string} props.theme The name of the current Vitessce theme.
+ * @param {number} props.width The container width.
+ * @param {number} props.height The container height.
+ * @param {number} props.marginRight The size of the margin
+ * on the right side of the plot, to account for the vega menu button.
+ * By default, 90.
+ * @param {number} props.marginBottom The size of the margin
+ * on the bottom of the plot, to account for long x-axis labels.
+ * Default is allowing the component to automatically determine the margin.
+ * @param {string|null} props.featureValueTransformName A name
+ * for the feature value transformation function.
+ */
+export default function CellSetExpressionPlot(props) {
+    const { domainMax = 100, colors, data, theme, width, height, marginRight = 90, marginBottom, obsType, featureValueType, featureValueTransformName, } = props;
+    // Get the max characters in an axis label for autsizing the bottom margin.
+    const maxCharactersForLabel = data.reduce((acc, val) => {
+        // eslint-disable-next-line no-param-reassign
+        acc = acc === undefined || val.set.length > acc ? val.set.length : acc;
+        return acc;
+    }, 0);
+    // Use a square-root term because the angle of the labels is 45 degrees (see below)
+    // so the perpendicular distance to the bottom of the labels is proportional to the
+    // square root of the length of the labels along the imaginary hypotenuse.
+    // 30 is an estimate of the pixel size of a given character and seems to work well.
+    const autoMarginBottom = marginBottom
+        || 30 + Math.sqrt(maxCharactersForLabel / 2) * 30;
+    // Manually set the color scale so that Vega-Lite does
+    // not choose the colors automatically.
+    const colorScale = {
+        domain: colors.map(d => d.name),
+        range: colors.map(d => colorArrayToString(d.color)),
+    };
+    const plotWidth = clamp(width - marginRight, 10, Infinity);
+    const plotHeight = clamp(height - autoMarginBottom, 10, Infinity);
+    const numBands = colors.length;
+    const bandWidth = plotWidth / numBands;
+    const rectColor = (theme === 'dark' ? 'white' : 'black');
+    const spec = {
+        $schema: 'https://vega.github.io/schema/vega/v5.json',
+        description: `A violin plot showing distributions of expression levels for selected ${obsType} sets.`,
+        width: plotWidth,
+        height: plotHeight,
+        config: {
+            ...VEGA_THEMES[theme],
+            axisBand: {
+                bandPosition: 1,
+                tickExtra: true,
+                tickOffset: 0,
+            },
+        },
+        signals: [
+            { name: 'bandWidth', value: bandWidth },
+            { name: 'width', value: plotWidth },
+            { name: 'height', value: plotHeight },
+            { name: 'trim', value: true },
+        ],
+        data: [
+            {
+                name: 'density',
+                source: DATASET_NAME,
+                transform: [
+                    {
+                        type: 'kde',
+                        field: 'value',
+                        groupby: ['set'],
+                        bandwidth: 0,
+                        extent: [0, domainMax],
+                    },
+                ],
+            },
+            {
+                name: 'stats',
+                source: DATASET_NAME,
+                transform: [
+                    {
+                        type: 'aggregate',
+                        groupby: ['set'],
+                        fields: ['value', 'value', 'value'],
+                        ops: ['q1', 'median', 'q3'],
+                        as: ['q1', 'median', 'q3'],
+                    },
+                ],
+            },
+        ],
+        scales: [
+            {
+                name: 'layout',
+                type: 'band',
+                range: 'width',
+                domain: { data: DATASET_NAME, field: 'set' },
+            },
+            {
+                name: 'yscale',
+                type: 'linear',
+                range: 'height',
+                domain: [0, domainMax],
+            },
+            {
+                name: 'wscale',
+                type: 'linear',
+                range: [0, { signal: 'bandWidth' }],
+                domain: { data: 'density', field: 'density' },
+            },
+            {
+                name: 'wscaleReversed',
+                type: 'linear',
+                reverse: true,
+                range: [0, { signal: 'bandWidth' }],
+                domain: { data: 'density', field: 'density' },
+            },
+            {
+                name: 'color',
+                type: 'ordinal',
+                ...colorScale,
+            },
+        ],
+        axes: [
+            {
+                orient: 'left',
+                scale: 'yscale',
+                zindex: 1,
+                title: (featureValueTransformName && featureValueTransformName !== 'None')
+                    ? [`${featureValueTransformName}-Transformed`, `${capitalize(featureValueType)} Values`]
+                    : `${capitalize(featureValueType)} Values`,
+            },
+            {
+                orient: 'bottom',
+                scale: 'layout',
+                tickCount: 5,
+                zindex: 1,
+                title: `${capitalize(obsType)} Set`,
+                labelAngle: -45,
+                labelAlign: 'right',
+            },
+        ],
+        marks: [
+            {
+                type: 'group',
+                from: {
+                    facet: {
+                        data: 'density',
+                        name: 'violin',
+                        groupby: 'set',
+                    },
+                },
+                encode: {
+                    enter: {
+                        xc: { scale: 'layout', field: 'set', band: 0.5 },
+                        width: { signal: 'bandWidth' },
+                        height: { signal: 'height' },
+                    },
+                },
+                data: [
+                    {
+                        name: 'summary',
+                        source: 'stats',
+                        transform: [
+                            {
+                                type: 'filter',
+                                expr: 'datum.set === parent.set',
+                            },
+                        ],
+                    },
+                ],
+                marks: [
+                    {
+                        type: 'area',
+                        orient: 'vertical',
+                        from: { data: 'violin' },
+                        encode: {
+                            enter: {
+                                fill: { scale: 'color', field: { parent: 'set' } },
+                            },
+                            update: {
+                                width: { scale: 'wscale', field: 'density' },
+                                xc: { signal: 'bandWidth / 2' },
+                                y2: { scale: 'yscale', field: 'value' },
+                                y: { scale: 'yscale', value: 0 },
+                            },
+                        },
+                    },
+                    {
+                        type: 'area',
+                        orient: 'vertical',
+                        from: { data: 'violin' },
+                        encode: {
+                            enter: {
+                                fill: { scale: 'color', field: { parent: 'set' } },
+                            },
+                            update: {
+                                width: { scale: 'wscaleReversed', field: 'density' },
+                                xc: { signal: 'bandWidth' },
+                                y2: { scale: 'yscale', field: 'value' },
+                                y: { scale: 'yscale', value: 0 },
+                            },
+                        },
+                    },
+                    {
+                        type: 'rect',
+                        from: { data: 'summary' },
+                        encode: {
+                            enter: {
+                                fill: { value: rectColor },
+                                width: { value: 2 },
+                            },
+                            update: {
+                                y: { scale: 'yscale', field: 'q1' },
+                                y2: { scale: 'yscale', field: 'q3' },
+                                xc: { signal: 'bandWidth / 2' },
+                            },
+                        },
+                    },
+                    {
+                        type: 'rect',
+                        from: { data: 'summary' },
+                        encode: {
+                            enter: {
+                                fill: { value: rectColor },
+                                height: { value: 2 },
+                                width: { value: 8 },
+                            },
+                            update: {
+                                y: { scale: 'yscale', field: 'median' },
+                                xc: { signal: 'bandWidth / 2' },
+                            },
+                        },
+                    },
+                ],
+            },
+        ],
+    };
+    return (_jsx(VegaPlot, { data: data, spec: spec }));
+}

package/dist-tsc/CellSetExpressionPlotOptions.d.ts

@@ -0,0 +1,2 @@
+export default function CellSetExpressionPlotOptions(props: any): JSX.Element;
+//# sourceMappingURL=CellSetExpressionPlotOptions.d.ts.map

package/dist-tsc/CellSetExpressionPlotOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CellSetExpressionPlotOptions.d.ts","sourceRoot":"","sources":["../src/CellSetExpressionPlotOptions.js"],"names":[],"mappings":"AAIA,8EAoEC"}

package/dist-tsc/CellSetExpressionPlotOptions.js

@@ -0,0 +1,30 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import React from 'react';
+import { TableCell, TableRow, TextField } from '@material-ui/core';
+import { usePlotOptionsStyles, OptionsContainer, OptionSelect } from '@vitessce/vit-s';
+export default function CellSetExpressionPlotOptions(props) {
+    const { featureValueTransform, setFeatureValueTransform, featureValueTransformCoefficient, setFeatureValueTransformCoefficient, transformOptions, } = props;
+    const classes = usePlotOptionsStyles();
+    const handleTransformChange = (event) => {
+        setFeatureValueTransform(event.target.value === '' ? null : event.target.value);
+    };
+    // Feels a little hacky, but I think this is the best way to handle
+    // the limitations of the v4 material-ui number input.
+    const handleTransformCoefficientChange = (event) => {
+        const { value } = event.target;
+        if (!value) {
+            setFeatureValueTransformCoefficient(value);
+        }
+        else {
+            const newCoefficient = Number(value);
+            if (!Number.isNaN(newCoefficient) && newCoefficient >= 0) {
+                setFeatureValueTransformCoefficient(value);
+            }
+        }
+    };
+    return (_jsxs(OptionsContainer, { children: [_jsxs(TableRow, { children: [_jsx(TableCell, { className: classes.labelCell, children: "Transform" }), _jsx(TableCell, { className: classes.inputCell, children: _jsx(OptionSelect, { className: classes.select, value: featureValueTransform === null ? '' : featureValueTransform, onChange: handleTransformChange, inputProps: {
+                                id: 'scatterplot-transform-select',
+                            }, children: transformOptions.map(opt => (_jsx("option", { value: opt.value === null ? '' : opt.value, children: opt.name }, opt.name))) }, "gating-transform-select") })] }), _jsxs(TableRow, { children: [_jsx(TableCell, { className: classes.labelCell, children: "Transform Coefficient" }), _jsx(TableCell, { className: classes.inputCell, children: _jsx(TextField, { label: "Number", type: "number", onChange: handleTransformCoefficientChange, value: featureValueTransformCoefficient, InputLabelProps: {
+                                shrink: true,
+                            } }) })] }, "transform-coefficient-option-row")] }));
+}

package/dist-tsc/CellSetExpressionPlotSubscriber.d.ts

@@ -0,0 +1,16 @@
+/**
+ * A subscriber component for `CellSetExpressionPlot`,
+ * which listens for gene selection updates and
+ * `GRID_RESIZE` events.
+ * @param {object} props
+ * @param {function} props.removeGridComponent The grid component removal function.
+ * @param {object} props.coordinationScopes An object mapping coordination
+ * types to coordination scopes.
+ * @param {string} props.theme The name of the current Vitessce theme.
+ */
+export function CellSetExpressionPlotSubscriber(props: {
+    removeGridComponent: Function;
+    coordinationScopes: object;
+    theme: string;
+}): JSX.Element;
+//# sourceMappingURL=CellSetExpressionPlotSubscriber.d.ts.map

package/dist-tsc/CellSetExpressionPlotSubscriber.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CellSetExpressionPlotSubscriber.d.ts","sourceRoot":"","sources":["../src/CellSetExpressionPlotSubscriber.js"],"names":[],"mappings":"AAiGA;;;;;;;;;GASG;AACH;IAL2B,mBAAmB;IACrB,kBAAkB,EAAhC,MAAM;IAEQ,KAAK,EAAnB,MAAM;gBAsHhB"}

package/dist-tsc/CellSetExpressionPlotSubscriber.js

@@ -0,0 +1,111 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import React, { useMemo } from 'react';
+import { TitleInfo, useCoordination, useLoaders, useUrls, useReady, useGridItemSize, useFeatureSelection, useObsSetsData, useObsFeatureMatrixIndices, useFeatureLabelsData, } from '@vitessce/vit-s';
+import { ViewType, COMPONENT_COORDINATION_TYPES } from '@vitessce/constants-internal';
+import { VALUE_TRANSFORM_OPTIONS, capitalize, getValueTransformFunction } from '@vitessce/utils';
+import { treeToObjectsBySetNames, treeToSetSizesBySetNames, mergeObsSets } from '@vitessce/sets-utils';
+import CellSetExpressionPlotOptions from './CellSetExpressionPlotOptions.js';
+import CellSetExpressionPlot from './CellSetExpressionPlot.js';
+import { useStyles } from './styles.js';
+/**
+ * Get expression data for the cells
+ * in the selected cell sets.
+ * @param {object} expressionMatrix
+ * @param {string[]} expressionMatrix.rows Cell IDs.
+ * @param {string[]} expressionMatrix.cols Gene names.
+ * @param {Uint8Array} expressionMatrix.matrix The
+ * flattened expression matrix as a typed array.
+ * @param {object} cellSets The cell sets from the dataset.
+ * @param {object} additionalCellSets The user-defined cell sets
+ * from the coordination space.
+ * @param {array} geneSelection Array of selected genes.
+ * @param {array} cellSetSelection Array of selected cell set paths.
+ * @param {object[]} cellSetColor Array of objects with properties
+ * @param {string|null} featureValueTransform The name of the
+ * feature value transform function.
+ * @param {number} featureValueTransformCoefficient A coefficient
+ * to be used in the transform function.
+ * @param {string} theme "light" or "dark" for the vitessce theme
+ * `path` and `color`.
+ */
+function useExpressionByCellSet(expressionData, obsIndex, cellSets, additionalCellSets, geneSelection, cellSetSelection, cellSetColor, featureValueTransform, featureValueTransformCoefficient, theme) {
+    const mergedCellSets = useMemo(() => mergeObsSets(cellSets, additionalCellSets), [cellSets, additionalCellSets]);
+    // From the expression matrix and the list of selected genes / cell sets,
+    // generate the array of data points for the plot.
+    const [expressionArr, expressionMax] = useMemo(() => {
+        if (mergedCellSets && cellSetSelection
+            && geneSelection && geneSelection.length >= 1
+            && expressionData) {
+            const cellObjects = treeToObjectsBySetNames(mergedCellSets, cellSetSelection, cellSetColor, theme);
+            const firstGeneSelected = geneSelection[0];
+            // Create new cellColors map based on the selected gene.
+            let exprMax = -Infinity;
+            const cellIndices = {};
+            for (let i = 0; i < obsIndex.length; i += 1) {
+                cellIndices[obsIndex[i]] = i;
+            }
+            const exprValues = cellObjects.map((cell) => {
+                const cellIndex = cellIndices[cell.obsId];
+                const value = expressionData[0][cellIndex];
+                const transformFunction = getValueTransformFunction(featureValueTransform, featureValueTransformCoefficient);
+                const transformedValue = transformFunction(value);
+                exprMax = Math.max(transformedValue, exprMax);
+                return { value: transformedValue, gene: firstGeneSelected, set: cell.name };
+            });
+            return [exprValues, exprMax];
+        }
+        return [null, null];
+    }, [expressionData, obsIndex, geneSelection, theme,
+        mergedCellSets, cellSetSelection, cellSetColor,
+        featureValueTransform, featureValueTransformCoefficient,
+    ]);
+    // From the cell sets hierarchy and the list of selected cell sets,
+    // generate the array of set sizes data points for the bar plot.
+    const setArr = useMemo(() => (mergedCellSets && cellSetSelection && cellSetColor
+        ? treeToSetSizesBySetNames(mergedCellSets, cellSetSelection, cellSetSelection, cellSetColor, theme)
+        : []), [mergedCellSets, cellSetSelection, cellSetColor, theme]);
+    return [expressionArr, setArr, expressionMax];
+}
+/**
+ * A subscriber component for `CellSetExpressionPlot`,
+ * which listens for gene selection updates and
+ * `GRID_RESIZE` events.
+ * @param {object} props
+ * @param {function} props.removeGridComponent The grid component removal function.
+ * @param {object} props.coordinationScopes An object mapping coordination
+ * types to coordination scopes.
+ * @param {string} props.theme The name of the current Vitessce theme.
+ */
+export function CellSetExpressionPlotSubscriber(props) {
+    const { coordinationScopes, removeGridComponent, theme, } = props;
+    const classes = useStyles();
+    const loaders = useLoaders();
+    // Get "props" from the coordination space.
+    const [{ dataset, obsType, featureType, featureValueType, featureSelection: geneSelection, featureValueTransform, featureValueTransformCoefficient, obsSetSelection: cellSetSelection, obsSetColor: cellSetColor, additionalObsSets: additionalCellSets, }, { setFeatureValueTransform, setFeatureValueTransformCoefficient, }] = useCoordination(COMPONENT_COORDINATION_TYPES[ViewType.OBS_SET_FEATURE_VALUE_DISTRIBUTION], coordinationScopes);
+    const [width, height, containerRef] = useGridItemSize();
+    const transformOptions = VALUE_TRANSFORM_OPTIONS;
+    // Get data from loaders using the data hooks.
+    // eslint-disable-next-line no-unused-vars
+    const [expressionData, loadedFeatureSelection, featureSelectionStatus] = useFeatureSelection(loaders, dataset, false, geneSelection, { obsType, featureType, featureValueType });
+    // TODO: support multiple feature labels using featureLabelsType coordination values.
+    const [{ featureLabelsMap }, featureLabelsStatus, featureLabelsUrls] = useFeatureLabelsData(loaders, dataset, false, {}, {}, { featureType });
+    const [{ obsIndex }, matrixIndicesStatus, matrixIndicesUrls] = useObsFeatureMatrixIndices(loaders, dataset, false, { obsType, featureType, featureValueType });
+    const [{ obsSets: cellSets }, obsSetsStatus, obsSetsUrls] = useObsSetsData(loaders, dataset, true, {}, {}, { obsType });
+    const isReady = useReady([
+        featureSelectionStatus,
+        matrixIndicesStatus,
+        obsSetsStatus,
+        featureLabelsStatus,
+    ]);
+    const urls = useUrls([
+        featureLabelsUrls,
+        matrixIndicesUrls,
+        obsSetsUrls,
+    ]);
+    const [expressionArr, setArr, expressionMax] = useExpressionByCellSet(expressionData, obsIndex, cellSets, additionalCellSets, geneSelection, cellSetSelection, cellSetColor, featureValueTransform, featureValueTransformCoefficient, theme);
+    const firstGeneSelected = geneSelection && geneSelection.length >= 1
+        ? (featureLabelsMap?.get(geneSelection[0]) || geneSelection[0])
+        : null;
+    const selectedTransformName = transformOptions.find(o => o.value === featureValueTransform)?.name;
+    return (_jsx(TitleInfo, { title: `Expression by ${capitalize(obsType)} Set${(firstGeneSelected ? ` (${firstGeneSelected})` : '')}`, removeGridComponent: removeGridComponent, urls: urls, theme: theme, isReady: isReady, options: (_jsx(CellSetExpressionPlotOptions, { featureValueTransform: featureValueTransform, setFeatureValueTransform: setFeatureValueTransform, featureValueTransformCoefficient: featureValueTransformCoefficient, setFeatureValueTransformCoefficient: setFeatureValueTransformCoefficient, transformOptions: transformOptions })), children: _jsx("div", { ref: containerRef, className: classes.vegaContainer, children: expressionArr ? (_jsx(CellSetExpressionPlot, { domainMax: expressionMax, colors: setArr, data: expressionArr, theme: theme, width: width, height: height, obsType: obsType, featureValueType: featureValueType, featureValueTransformName: selectedTransformName })) : (_jsxs("span", { children: ["Select a ", featureType, "."] })) }) }));
+}

package/dist-tsc/CellSetSizesPlot.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Cell set sizes displayed as a bar chart,
+ * implemented with the VegaPlot component.
+ * @param {object} props
+ * @param {object[]} props.data The set size data, an array
+ * of objects with properties `name`, `key`, `color`, and `size`.
+ * @param {string} props.theme The name of the current Vitessce theme.
+ * @param {number} props.width The container width.
+ * @param {number} props.height The container height.
+ * @param {number} props.marginRight The size of the margin
+ * on the right side of the plot, to account for the vega menu button.
+ * By default, 90.
+ * @param {number} props.marginBottom The size of the margin
+ * on the bottom of the plot, to account for long x-axis labels.
+ * By default, 120.
+ * @param {number} props.keyLength The length of the `key` property of
+ * each data point. Assumes all key strings have the same length.
+ * By default, 36.
+ */
+export default function CellSetSizesPlot(props: {
+    data: object[];
+    theme: string;
+    width: number;
+    height: number;
+    marginRight: number;
+    marginBottom: number;
+    keyLength: number;
+}): JSX.Element;
+//# sourceMappingURL=CellSetSizesPlot.d.ts.map

package/dist-tsc/CellSetSizesPlot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CellSetSizesPlot.d.ts","sourceRoot":"","sources":["../src/CellSetSizesPlot.js"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;GAkBG;AACH;IAf2B,IAAI,EAApB,MAAM,EAAE;IAEM,KAAK,EAAnB,MAAM;IACQ,KAAK,EAAnB,MAAM;IACQ,MAAM,EAApB,MAAM;IACQ,WAAW,EAAzB,MAAM;IAGQ,YAAY,EAA1B,MAAM;IAGQ,SAAS,EAAvB,MAAM;gBAuJhB"}

package/dist-tsc/CellSetSizesPlot.js

@@ -0,0 +1,149 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import React, { useCallback } from 'react';
+import { clamp } from 'lodash-es';
+import { VegaPlot, VEGA_THEMES } from '@vitessce/vega';
+import { colorArrayToString } from '@vitessce/sets-utils';
+import { capitalize, getDefaultColor } from '@vitessce/utils';
+/**
+ * Cell set sizes displayed as a bar chart,
+ * implemented with the VegaPlot component.
+ * @param {object} props
+ * @param {object[]} props.data The set size data, an array
+ * of objects with properties `name`, `key`, `color`, and `size`.
+ * @param {string} props.theme The name of the current Vitessce theme.
+ * @param {number} props.width The container width.
+ * @param {number} props.height The container height.
+ * @param {number} props.marginRight The size of the margin
+ * on the right side of the plot, to account for the vega menu button.
+ * By default, 90.
+ * @param {number} props.marginBottom The size of the margin
+ * on the bottom of the plot, to account for long x-axis labels.
+ * By default, 120.
+ * @param {number} props.keyLength The length of the `key` property of
+ * each data point. Assumes all key strings have the same length.
+ * By default, 36.
+ */
+export default function CellSetSizesPlot(props) {
+    const { data: rawData, theme, width, height, marginRight = 90, marginBottom = 120, keyLength = 36, obsType, onBarSelect, } = props;
+    // Add a property `keyName` which concatenates the key and the name,
+    // which is both unique and can easily be converted
+    // back to the name by taking a substring.
+    // Add a property `colorString` which contains the `[r, g, b]` color
+    // after converting to a color hex string.
+    const data = rawData.map(d => ({
+        ...d,
+        keyName: d.key + d.name,
+        colorString: colorArrayToString(d.color),
+    }));
+    // Get an array of keys for sorting purposes.
+    const keys = data.map(d => d.keyName);
+    const colorScale = {
+        // Manually set the color scale so that Vega-Lite does
+        // not choose the colors automatically.
+        domain: data.map(d => d.key),
+        range: data.map((d) => {
+            const [r, g, b] = !d.isGrayedOut ? d.color : getDefaultColor(theme);
+            return `rgba(${r}, ${g}, ${b}, 1)`;
+        }),
+    };
+    const captializedObsType = capitalize(obsType);
+    const spec = {
+        mark: { type: 'bar', stroke: 'black', cursor: 'pointer' },
+        params: [
+            {
+                name: 'highlight',
+                select: {
+                    type: 'point',
+                    on: 'mouseover',
+                },
+            },
+            {
+                name: 'select',
+                select: 'point',
+            },
+            {
+                name: 'bar_select',
+                select: {
+                    type: 'point',
+                    on: 'click[event.shiftKey === false]',
+                    fields: ['setNamePath', 'isGrayedOut'],
+                    empty: 'none',
+                },
+            },
+            {
+                name: 'shift_bar_select',
+                select: {
+                    type: 'point',
+                    on: 'click[event.shiftKey]',
+                    fields: ['setNamePath', 'isGrayedOut'],
+                    empty: 'none',
+                },
+            },
+        ],
+        encoding: {
+            x: {
+                field: 'keyName',
+                type: 'nominal',
+                axis: { labelExpr: `substring(datum.label, ${keyLength})` },
+                title: 'Cell Set',
+                sort: keys,
+            },
+            y: {
+                field: 'size',
+                type: 'quantitative',
+                title: `${captializedObsType} Set Size`,
+            },
+            color: {
+                field: 'key',
+                type: 'nominal',
+                scale: colorScale,
+                legend: null,
+            },
+            tooltip: {
+                field: 'size',
+                type: 'quantitative',
+            },
+            fillOpacity: {
+                condition: {
+                    param: 'select',
+                    value: 1,
+                },
+                value: 0.3,
+            },
+            strokeWidth: {
+                condition: [
+                    {
+                        param: 'select',
+                        empty: false,
+                        value: 1,
+                    },
+                    {
+                        param: 'highlight',
+                        empty: false,
+                        value: 2,
+                    },
+                ],
+                value: 0,
+            },
+        },
+        width: clamp(width - marginRight, 10, Infinity),
+        height: clamp(height - marginBottom, 10, Infinity),
+        config: VEGA_THEMES[theme],
+    };
+    const handleSignal = (name, value) => {
+        if (name === 'bar_select') {
+            onBarSelect(value.setNamePath, value.isGrayedOut[0]);
+        }
+        else if (name === 'shift_bar_select') {
+            const isGrayedOut = false;
+            const selectOnlyEnabled = true;
+            onBarSelect(value.setNamePath, isGrayedOut, selectOnlyEnabled);
+        }
+    };
+    const signalListeners = { bar_select: handleSignal, shift_bar_select: handleSignal };
+    const getTooltipText = useCallback(item => ({
+        [`${captializedObsType} Set`]: item.datum.name,
+        [`${captializedObsType} Set Size`]: item.datum.size,
+    }), [captializedObsType]);
+    return (_jsx(VegaPlot, { data: data, spec: spec, signalListeners: signalListeners, getTooltipText: getTooltipText }));
+}

package/dist-tsc/CellSetSizesPlotSubscriber.d.ts

@@ -0,0 +1,18 @@
+/**
+ * A subscriber component for `CellSetSizePlot`,
+ * which listens for cell sets data updates and
+ * `GRID_RESIZE` events.
+ * @param {object} props
+ * @param {function} props.removeGridComponent The grid component removal function.
+ * @param {function} props.onReady The function to call when the subscriptions
+ * have been made.
+ * @param {string} props.theme The name of the current Vitessce theme.
+ * @param {string} props.title The component title.
+ */
+export function CellSetSizesPlotSubscriber(props: {
+    removeGridComponent: Function;
+    onReady: Function;
+    theme: string;
+    title: string;
+}): JSX.Element;
+//# sourceMappingURL=CellSetSizesPlotSubscriber.d.ts.map

package/dist-tsc/CellSetSizesPlotSubscriber.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CellSetSizesPlotSubscriber.d.ts","sourceRoot":"","sources":["../src/CellSetSizesPlotSubscriber.js"],"names":[],"mappings":"AAgBA;;;;;;;;;;GAUG;AACH;IAN2B,mBAAmB;IACnB,OAAO;IAET,KAAK,EAAnB,MAAM;IACQ,KAAK,EAAnB,MAAM;gBA2HhB"}