svelteplot 0.0.1-alpha.8 → 0.1.3-next.11

package/dist/marks/helpers/Regression.svelte

@@ -0,0 +1,174 @@
+<script module lang="ts">
+    import type { BaseMarkProps, ChannelAccessor, FacetContext, PlotContext } from '../../types.js';
+
+    type RegressionType = 'linear' | 'quad' | 'poly' | 'exp' | 'log' | 'pow' | 'loess';
+
+    export type RegressionMarkProps = BaseMarkProps & {
+        x: ChannelAccessor;
+        y: ChannelAccessor;
+        type: RegressionType;
+        /**
+         * If order is specified, sets the regression's order to the specified number.
+         * For example, if order is set to 4, the regression generator will perform a
+         * fourth-degree polynomial regression. Likewise, if order is set to 2, the
+         * regression generator will perform a quadratic regression. Be careful about
+         * attempting to fit your data with higher order polynomials; though the
+         * regression line will fit your data with a high determination coefficient,
+         * it may have little predictive power for data outside of your domain.
+         */
+        order: number;
+        // for log
+        base: number;
+        // for loess
+        span: number;
+        // for confidence bands
+        confidence: number;
+    };
+</script>
+
+<script lang="ts">
+    import { getContext } from 'svelte';
+    import { Line, Area } from '../../index.js';
+
+    import {
+        regressionLinear,
+        regressionQuad,
+        regressionPoly,
+        regressionExp,
+        regressionLog,
+        regressionPow,
+        regressionLoess
+    } from 'd3-regression/dist/d3-regression.esm.js';
+    import { resolveChannel } from '../../helpers/resolve.js';
+    import { confidenceInterval } from '../../helpers/math.js';
+    import callWithProps from '../../helpers/callWithProps.js';
+    import { isDate } from '../../helpers/typeChecks';
+
+    const regressions = new Map<RegressionType, typeof regressionLinear>([
+        ['linear', regressionLinear],
+        ['quad', regressionQuad],
+        ['poly', regressionPoly],
+        ['exp', regressionExp],
+        ['log', regressionLog],
+        ['pow', regressionPow],
+        ['loess', regressionLoess]
+    ]);
+
+    function maybeRegression(name: string) {
+        name = `${name}`.toLowerCase();
+        if (regressions.has(name)) return regressions.get(name);
+        throw new Error('unknown regression ' + name);
+    }
+
+    const { getPlotState } = getContext<PlotContext>('svelteplot');
+    let plot = $derived(getPlotState());
+
+    let {
+        data,
+        dependent,
+        type = 'linear',
+        order = 3,
+        base = 2.71828,
+        span = 0.3,
+        confidence = 0.99,
+        class: className = null,
+        ...options
+    }: RegressionMarkProps & { dependent: 'x' | 'y' } = $props();
+
+    const { getTestFacet } = getContext<FacetContext>('svelteplot/facet');
+    let testFacet = $derived(getTestFacet());
+
+    let filteredData = $derived(data.filter((d) => testFacet(d, options)));
+
+    let independent: 'x' | 'y' = $derived(dependent === 'x' ? 'y' : 'x');
+
+    let regressionFn = $derived(maybeRegression(type));
+
+    let regression = $derived(
+        callWithProps(regressionFn, [], {
+            x: (d) => resolveChannel(independent, d, options),
+            y: (d) => resolveChannel(dependent, d, options),
+            ...(type === 'poly' ? { order } : {}),
+            ...(type === 'log' ? { base } : {}),
+            ...(!type.startsWith('loess') ? { domain: plot.scales[independent].domain } : {}),
+            ...(type === 'loess' ? { bandwidth: span } : {})
+        })(filteredData)
+    );
+
+    let regrPoints = $derived([
+        ...new Set([
+            plot.scales[independent].domain[0],
+            ...plot.scales[independent].fn.ticks(40),
+            plot.scales[independent].domain[1]
+        ])
+    ]);
+
+    let regrData = $derived(
+        regression.predictMany
+            ? regression.predictMany(regrPoints).map((__y, i) => ({ __x: regrPoints[i], __y }))
+            : regression.predict
+              ? regrPoints.map((__x) => {
+                    // const __x = x;
+                    const __y = regression.predict(__x);
+                    return { __x, __y };
+                })
+              : regression.map(([__x, __y]) => ({
+                    __x: plot.scales[independent].type === 'time' ? new Date(__x) : __x,
+                    __y
+                }))
+    );
+
+    let stroke = $derived(
+        options.stroke != null ? resolveChannel('stroke', filteredData[0], options) : null
+    );
+
+    let confBandGen = $derived(
+        confidence !== false
+            ? confidenceInterval(
+                  data
+                      .map((d) => ({
+                          x: resolveChannel(independent, d, options),
+                          y: resolveChannel(dependent, d, options)
+                      }))
+                      .filter(
+                          ({ x, y }) => (Number.isFinite(x) || isDate(x)) && Number.isFinite(y)
+                      ),
+                  regression.predict,
+                  1 - confidence
+              )
+            : null
+    );
+
+    let confBandData = $derived(
+        confidence !== false && regression.predict
+            ? regrPoints.map((x) => {
+                  const { x: __x, left, right } = confBandGen(x);
+                  return { __x, __y1: left, __y2: right };
+              })
+            : []
+    );
+</script>
+
+{#if filteredData.length}
+    <g class="regression-{independent} {className || ''}">
+        <Line
+            data={regrData}
+            {...{
+                ...options,
+                fx: null,
+                fy: null,
+                stroke,
+                x: dependent === 'y' ? '__x' : '__y',
+                y: dependent === 'y' ? '__y' : '__x'
+            }} />
+        {#if confBandData.length}
+            <Area
+                data={confBandData}
+                {...dependent === 'y'
+                    ? { x1: '__x', y1: '__y1', y2: '__y2' }
+                    : { y1: '__x', x1: '__y1', x2: '__y2' }}
+                fill={stroke || 'currentColor'}
+                opacity={0.15} />
+        {/if}
+    </g>
+{/if}

package/dist/marks/helpers/Regression.svelte.d.ts

@@ -0,0 +1,26 @@
+import type { BaseMarkProps, ChannelAccessor } from '../../types.js';
+type RegressionType = 'linear' | 'quad' | 'poly' | 'exp' | 'log' | 'pow' | 'loess';
+export type RegressionMarkProps = BaseMarkProps & {
+    x: ChannelAccessor;
+    y: ChannelAccessor;
+    type: RegressionType;
+    /**
+     * If order is specified, sets the regression's order to the specified number.
+     * For example, if order is set to 4, the regression generator will perform a
+     * fourth-degree polynomial regression. Likewise, if order is set to 2, the
+     * regression generator will perform a quadratic regression. Be careful about
+     * attempting to fit your data with higher order polynomials; though the
+     * regression line will fit your data with a high determination coefficient,
+     * it may have little predictive power for data outside of your domain.
+     */
+    order: number;
+    base: number;
+    span: number;
+    confidence: number;
+};
+type $$ComponentProps = RegressionMarkProps & {
+    dependent: 'x' | 'y';
+};
+declare const Regression: import("svelte").Component<$$ComponentProps, {}, "">;
+type Regression = ReturnType<typeof Regression>;
+export default Regression;

package/dist/marks/helpers/events.d.ts

@@ -0,0 +1,8 @@
+import type { BaseMarkProps, DataRecord, PlotState } from '../../types.js';
+export declare function addEventHandlers(node: SVGElement, { options, datum, getPlotState }: {
+    options: BaseMarkProps;
+    datum: DataRecord;
+    getPlotState: () => PlotState;
+}): {
+    destroy(): void;
+};

package/dist/marks/helpers/events.js

@@ -0,0 +1,74 @@
+import { invert, pick } from 'es-toolkit';
+import { RAW_VALUE } from '../../transforms/recordize.js';
+import { INDEX } from '../../constants.js';
+export function addEventHandlers(node, { options, datum, getPlotState }) {
+    const events = pick(options, [
+        'onclick',
+        'oncontextmenu',
+        'ondblclick',
+        'ondrag',
+        'ondragend',
+        'ondragenter',
+        'ondragleave',
+        'ondragover',
+        'ondragstart',
+        'ondrop',
+        'onmousedown',
+        'onmouseenter',
+        'onmouseleave',
+        'onmousemove',
+        'onmouseout',
+        'onmouseup',
+        'onwheel',
+        'ontouchcancel',
+        'ontouchend',
+        'ontouchmove'
+    ]);
+    const listeners = new Map();
+    // attach event handlers
+    for (const [eventName, eventHandler] of Object.entries(events)) {
+        if (eventHandler) {
+            const wrappedHandler = (origEvent) => {
+                const { scales } = getPlotState();
+                if (origEvent.layerX !== undefined) {
+                    if (scales.projection) {
+                        const [x, y] = scales.projection.invert([
+                            origEvent.layerX,
+                            origEvent.layerY
+                        ]);
+                        origEvent.dataX = x;
+                        origEvent.dataY = y;
+                    }
+                    else {
+                        origEvent.dataX = invertScale(scales.x, origEvent.layerX);
+                        origEvent.dataY = invertScale(scales.y, origEvent.layerY);
+                    }
+                }
+                eventHandler(origEvent, datum.hasOwnProperty(RAW_VALUE) ? datum[RAW_VALUE] : datum, datum[INDEX]);
+            };
+            listeners.set(eventName, wrappedHandler);
+            node.addEventListener(eventName.substring(2), wrappedHandler);
+        }
+    }
+    if (events.onclick || events.onmousedown || events.onmouseup) {
+        // force role button
+        node.setAttribute('role', 'button');
+    }
+    return {
+        destroy() {
+            for (const [eventName, handler] of listeners.entries()) {
+                node.removeEventListener(eventName.substring(2), handler);
+            }
+        }
+    };
+}
+function invertScale(scale, position) {
+    if (scale.type === 'band') {
+        // invert band scale since scaleBand doesn't have an invert function
+        const eachBand = scale.fn.step();
+        console.log({ eachBand, position });
+        const index = Math.floor(position / eachBand);
+        return scale.fn.domain()[index];
+    }
+    return scale.fn.invert ? scale.fn.invert(position) : undefined;
+}

package/dist/transforms/bin.d.ts

@@ -0,0 +1,51 @@
+import type { DataRecord, RawValue } from '../types.js';
+import type { TransformArg } from '../types.js';
+import { type ThresholdCountGenerator } from 'd3-array';
+import { Reducer, type ReducerName } from '../helpers/reduce.js';
+type NamedThresholdsGenerator = 'auto' | 'scott' | 'sturges' | 'freedman-diaconis';
+type BinBaseOptions = {
+    domain?: [number, number];
+    thresholds?: NamedThresholdsGenerator | number | number[] | ThresholdCountGenerator;
+    interval?: number | string;
+    cumulative?: false | 1 | -1;
+    reverse?: boolean;
+};
+type ReducerOption = ReducerName | ((group: DataRecord[]) => RawValue);
+type AdditionalOutputChannels = Partial<{
+    fill: ReducerOption;
+    stroke: ReducerOption;
+    r: ReducerOption;
+    opacity: ReducerOption;
+    fillOpacity: ReducerOption;
+    strokeOpacity: ReducerOption;
+}>;
+export type BinXOptions = BinBaseOptions & AdditionalOutputChannels & Partial<{
+    y: typeof Reducer;
+    y1: typeof Reducer;
+    y2: typeof Reducer;
+}>;
+export type BinYOptions = BinBaseOptions & AdditionalOutputChannels & Partial<{
+    x: typeof Reducer;
+    x1: typeof Reducer;
+    x2: typeof Reducer;
+}>;
+type BinOptions = BinBaseOptions & AdditionalOutputChannels;
+/**
+ * Bins on x. Also groups on y and the first channel of z, fill, or stroke, if any.
+ *
+ * @param param0
+ * @param options
+ */
+export declare function binX<T>({ data, ...channels }: TransformArg<T, DataRecord>, options?: BinXOptions): TransformArg<T, DataRecord>;
+/**
+ * Bins on y. Also groups on y and the first channel of z, fill, or stroke, if any.
+ *
+ * @param param0
+ * @param options
+ */
+export declare function binY<T>({ data, ...channels }: TransformArg<T, DataRecord>, options?: BinYOptions): TransformArg<T, DataRecord>;
+/**
+ * for binning in x and y dimension simulatenously
+ */
+export declare function bin<T>({ data, ...channels }: TransformArg<T, DataRecord>, options?: BinOptions): TransformArg<T, DataRecord>;
+export {};

package/dist/transforms/bin.js

@@ -0,0 +1,171 @@
+import { resolveChannel } from '../helpers/resolve.js';
+import { maybeInterval } from '../helpers/autoTicks.js';
+import { bin as d3Bin, extent, groups as d3Groups, thresholdFreedmanDiaconis, thresholdScott, thresholdSturges } from 'd3-array';
+import { Reducer, reduceOutputs } from '../helpers/reduce.js';
+import { groupFacetsAndZ } from '../helpers/group.js';
+import { isDate } from '../helpers/typeChecks';
+const ThresholdGenerators = {
+    auto: thresholdScott,
+    scott: thresholdScott,
+    sturges: thresholdSturges,
+    'freedman-diaconis': thresholdFreedmanDiaconis
+};
+function binBy(byDim, { data, ...channels }, options) {
+    const { domain, thresholds = 'auto', interval } = options;
+    const bin = d3Bin();
+    if (domain)
+        bin.domain(domain);
+    if (interval) {
+        const [lo, hi] = extent(data.map((d) => resolveChannel(byDim, d, channels)));
+        bin.thresholds(maybeInterval(interval).range(lo, hi));
+    }
+    else if (thresholds)
+        bin.thresholds(
+        // use a generator
+        typeof thresholds === 'string' && ThresholdGenerators[thresholds] !== undefined
+            ? ThresholdGenerators[thresholds]
+            : thresholds);
+    // channels.x is the input
+    bin.value((d) => resolveChannel(byDim, d, channels));
+    // y, y1, y2, fill, stroke, etc are outputs
+    const outputs = [
+        ...(byDim === 'x' ? ['y', 'y1', 'y2'] : ['x', 'x1', 'x2']),
+        'fill',
+        'stroke',
+        'r',
+        'opacity',
+        'fillOpacity',
+        'strokeOpacity'
+    ];
+    let newChannels = {
+        [byDim === 'x' ? 'insetLeft' : 'insetTop']: 0.5,
+        [byDim === 'x' ? 'insetRight' : 'insetBottom']: 0.5,
+        ...channels,
+        [`${byDim}`]: `__${byDim}`,
+        [`${byDim}1`]: `__${byDim}1`,
+        [`${byDim}2`]: `__${byDim}2`,
+        [`__${byDim}_origField`]: typeof channels[byDim] === 'string' ? channels[byDim] : null
+    };
+    const newData = [];
+    let passedGroups = [];
+    const bins = bin(data);
+    (options.cumulative < 0 ? bins.toReversed() : bins).forEach((group) => {
+        const itemBinProps = {
+            [`__${byDim}1`]: group.x0,
+            [`__${byDim}2`]: group.x1,
+            [`__${byDim}`]: isDate(group.x0)
+                ? new Date(Math.round((group.x0.getTime() + group.x1.getTime()) * 0.5))
+                : (group.x0 + group.x1) * 0.5
+        };
+        if (options.cumulative)
+            passedGroups = [...passedGroups, ...group];
+        const newGroupChannels = groupFacetsAndZ(options.cumulative ? passedGroups : group, channels, (items, itemGroupProps) => {
+            const item = { ...itemBinProps, ...itemGroupProps };
+            reduceOutputs(item, items, options, outputs, channels, newChannels);
+            newData.push(item);
+        });
+        newChannels = { ...newChannels, ...newGroupChannels };
+    });
+    return { data: options.reverse ? newData.toReversed() : newData, ...newChannels };
+}
+/**
+ * Bins on x. Also groups on y and the first channel of z, fill, or stroke, if any.
+ *
+ * @param param0
+ * @param options
+ */
+export function binX({ data, ...channels }, options = { thresholds: 'auto', cumulative: false }) {
+    return binBy('x', { data, ...channels }, options);
+}
+/**
+ * Bins on y. Also groups on y and the first channel of z, fill, or stroke, if any.
+ *
+ * @param param0
+ * @param options
+ */
+export function binY({ data, ...channels }, options = { thresholds: 'auto', cumulative: false }) {
+    return binBy('y', { data, ...channels }, options);
+}
+/**
+ * for binning in x and y dimension simulatenously
+ */
+export function bin({ data, ...channels }, options = { thresholds: 'auto', cumulative: false }) {
+    const { domain, thresholds = 'auto', interval, cumulative = false } = options;
+    const binX = d3Bin();
+    const binY = d3Bin();
+    if (domain) {
+        // this really doesn't make sense...
+        binX.domain(domain);
+        binY.domain(domain);
+    }
+    // channels.x is the input
+    binX.value((d) => resolveChannel('x', d, channels));
+    binY.value((d) => resolveChannel('y', d, channels));
+    if (interval) {
+        const [xlo, xhi] = extent(data.map((d) => resolveChannel('x', d, channels)));
+        const [ylo, yhi] = extent(data.map((d) => resolveChannel('y', d, channels)));
+        binX.thresholds(maybeInterval(interval).range(xlo, xhi));
+        binY.thresholds(maybeInterval(interval).range(ylo, yhi));
+    }
+    else if (thresholds) {
+        // when binning in x and y, we need to ensure we are using consistent thresholds
+        const t = typeof thresholds === 'string' && ThresholdGenerators[thresholds] !== undefined
+            ? ThresholdGenerators[thresholds]
+            : thresholds;
+        binX.thresholds(t);
+        binY.thresholds(t);
+        const yThresholds = binY(data)
+            .slice(1)
+            .map((g) => g.x0);
+        binY.thresholds(yThresholds);
+    }
+    // y, y1, y2, fill, stroke, etc are outputs
+    const outputs = ['fill', 'stroke', 'r', 'opacity', 'fillOpacity', 'strokeOpacity'];
+    let newChannels = {
+        inset: 0.5,
+        ...channels,
+        x: '__x',
+        x1: '__x1',
+        x2: '__x2',
+        y: '__y',
+        y1: '__y1',
+        y2: '__y2',
+        __x_origField: typeof channels.x === 'string' ? channels.x : null,
+        __y_origField: typeof channels.y === 'string' ? channels.y : null
+    };
+    const groupBy = channels.z ? 'z' : channels.fill ? 'fill' : channels.stroke ? 'stroke' : true;
+    const groupByPropName = groupBy !== true && typeof channels[groupBy] === 'string' ? channels[groupBy] : '__group';
+    if (groupBy !== true)
+        newChannels[groupBy] = groupByPropName;
+    // consistent intervals
+    const newData = [];
+    binX(data).forEach((groupX) => {
+        const newRecordBaseX = {
+            __x1: groupX.x0,
+            __x2: groupX.x1,
+            __x: isDate(groupX.x0)
+                ? new Date(Math.round((groupX.x0.getTime() + groupX.x1.getTime()) * 0.5))
+                : (groupX.x0 + groupX.x1) * 0.5
+        };
+        binY(groupX).forEach((groupY) => {
+            const newRecordBaseY = {
+                ...newRecordBaseX,
+                __y1: groupY.x0,
+                __y2: groupY.x1,
+                __y: isDate(groupY.x0)
+                    ? new Date(Math.round((groupY.x0.getTime() + groupY.x1.getTime()) * 0.5))
+                    : (groupY.x0 + groupY.x1) * 0.5
+            };
+            const newGroupChannels = groupFacetsAndZ(groupY, channels, (items, itemGroupProps) => {
+                const newRecord = {
+                    ...newRecordBaseY,
+                    ...itemGroupProps
+                };
+                reduceOutputs(newRecord, items, options, outputs, channels, newChannels);
+                newData.push(newRecord);
+            });
+            newChannels = { ...newChannels, ...newGroupChannels };
+        });
+    });
+    return { data: options.reverse ? newData.toReversed() : newData, ...newChannels };
+}

package/dist/transforms/bollinger.d.ts

@@ -0,0 +1,21 @@
+import type { DataRecord, TransformArg } from '../types.js';
+export type BollingerOptions = {
+    /**
+     * the window size (the window transform’s k option), an integer; defaults to 20
+     */
+    n?: number;
+    /**
+     * the band radius, a number representing a multiple of standard deviations; defaults to 2
+     */
+    k?: number;
+};
+export declare function bollingerX(args: TransformArg<DataRecord>, options?: BollingerOptions): TransformArg<DataRecord>;
+export declare function bollingerY(args: TransformArg<DataRecord>, options?: BollingerOptions): TransformArg<DataRecord>;
+export declare function bollingerDim(dim: 'x' | 'y', { data, ...channels }: TransformArg<DataRecord>, options?: BollingerOptions): {
+    data: {
+        __x: import("../types.js").RawValue;
+        __lo: number;
+        __avg: number;
+        __hi: number;
+    }[];
+};

package/dist/transforms/bollinger.js

@@ -0,0 +1,53 @@
+import { resolveChannel } from '../helpers/resolve.js';
+export function bollingerX(args, options = {}) {
+    return bollingerDim('x', args, options);
+}
+export function bollingerY(args, options = {}) {
+    return bollingerDim('y', args, options);
+}
+export function bollingerDim(dim, { data, ...channels }, options = {}) {
+    const { n = 20, k = 2 } = options;
+    const bands = bollinger(data.map((datum) => resolveChannel(dim, datum, channels)), n, [-k, 0, k]);
+    const otherDim = dim === 'x' ? 'y' : 'x';
+    return {
+        data: data.map((datum, i) => ({
+            __x: resolveChannel(otherDim, datum, channels),
+            __lo: bands[0][i],
+            __avg: bands[1][i],
+            __hi: bands[2][i]
+        })),
+        ...channels,
+        [otherDim]: '__x',
+        [dim]: '__avg',
+        [`${otherDim}1`]: '__x',
+        [`${dim}1`]: '__lo',
+        [`${dim}2`]: '__hi'
+    };
+}
+/**
+ * taken from https://observablehq.com/@d3/bollinger-bands/
+ */
+function bollinger(values, N, K) {
+    let i = 0;
+    let sum = 0;
+    let sumSquared = 0;
+    // initialize bands
+    const bands = K.map(() => new Float64Array(values.length).fill(NaN));
+    // compute sum and square of sums
+    for (let n = Math.min(N - 1, values.length); i < n; ++i) {
+        const value = values[i];
+        (sum += value), (sumSquared += value ** 2);
+    }
+    for (let n = values.length, m = bands.length; i < n; ++i) {
+        const value = values[i];
+        (sum += value), (sumSquared += value ** 2);
+        const mean = sum / N;
+        const deviation = Math.sqrt((sumSquared - sum ** 2 / N) / (N - 1));
+        for (let j = 0; j < K.length; ++j) {
+            bands[j][i] = mean + deviation * K[j];
+        }
+        const value0 = values[i - N + 1];
+        (sum -= value0), (sumSquared -= value0 ** 2);
+    }
+    return bands;
+}

package/dist/transforms/centroid.d.ts

@@ -0,0 +1,9 @@
+import type { DataRecord, TransformArg } from '../types.js';
+export declare function geoCentroid({ data, ...options }: TransformArg<DataRecord>): {
+    x: (d: any) => any;
+    y: (d: any) => any;
+    data: {
+        __centroid__: [number, number];
+        ___orig___?: import("../types.js").RawValue | [import("../types.js").RawValue, import("../types.js").RawValue];
+    }[];
+};

package/dist/transforms/centroid.js

@@ -0,0 +1,13 @@
+import { resolveProp } from '../helpers/resolve.js';
+import { geoCentroid as d3GeoCentroid } from 'd3-geo';
+export function geoCentroid({ data, ...options }) {
+    return {
+        data: data.map((d) => ({
+            ...d,
+            __centroid__: d3GeoCentroid(resolveProp(options.geometry, d, d))
+        })),
+        ...options,
+        x: (d) => d.__centroid__[0],
+        y: (d) => d.__centroid__[1]
+    };
+}

package/dist/transforms/facet.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/transforms/facet.js

@@ -0,0 +1 @@
+export {};

package/dist/transforms/filter.d.ts

@@ -0,0 +1,2 @@
+import type { DataRecord, TransformArg } from '../types.js';
+export declare function filter({ data, ...channels }: TransformArg<DataRecord>): TransformArg<DataRecord>;

package/dist/transforms/filter.js

@@ -0,0 +1,8 @@
+import { testFilter } from '../helpers/index.js';
+export function filter({ data, ...channels }) {
+    return {
+        data: data.filter((d) => testFilter(d, channels)),
+        ...channels,
+        filter: null
+    };
+}