@graphysdk/geom-boxplot 0.0.0-stage → 0.1.0

package/dist/renderer/boxplot-edit-outline.d.ts

@@ -0,0 +1,6 @@
+import { EditOutlineShape, GeomEditOutlineShapesRendererInput } from '@graphysdk/react';
+/**
+ * What point and edit outlines round the boxes they take: each box as its region, notched or not, each whisker
+ * and cap as the stroke it is painted, and each outlier and mean marker at its painted size.
+ */
+export declare const getBoxplotEditOutlineShapes: ({ layer, coordSystem, panelRect, styleReaders, }: GeomEditOutlineShapesRendererInput) => EditOutlineShape[];

package/dist/renderer/boxplot-highlight.d.ts

@@ -0,0 +1,16 @@
+import { GeomStyleReaders, MainAxis, SceneLayer } from '@graphysdk/react';
+import { PanelSize } from './utils/panel-path';
+interface HighlightedBoxesProps {
+    layer: SceneLayer;
+    /** The whole layer the matched observations were taken from. */
+    sourceLayer: SceneLayer;
+    mainAxis: MainAxis;
+    panelSize: PanelSize;
+    styleReaders: GeomStyleReaders;
+}
+/**
+ * Repaints the matched boxes and outliers above the dimmed layer. A matched box raises its outliers with it,
+ * so a highlight on a summary column (`boxplotQ3`, which an outlier does not carry) still shows the box whole.
+ */
+export declare const HighlightedBoxes: ({ layer, sourceLayer, mainAxis, panelSize, styleReaders }: HighlightedBoxesProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/renderer/boxplot-hover.d.ts

@@ -0,0 +1,16 @@
+import { GeomStyleReaders, HoverHit, MainAxis, SceneLayer } from '@graphysdk/react';
+import { PanelSize } from './utils/panel-path';
+interface HoveredBoxesProps {
+    layer: SceneLayer;
+    primary: HoverHit;
+    mainAxis: MainAxis;
+    panelSize: PanelSize;
+    styleReaders: GeomStyleReaders;
+}
+/**
+ * The hovered box, with the outliers standing over it, or the hovered outlier alone, repainted above the
+ * dimmed layer. The engine groups a dodged box with the rest of its band, as it does a grouped bar, but the
+ * tooltip reads the one box's summary, or the one outlier's value, so only that is raised.
+ */
+export declare const HoveredBoxes: ({ layer, primary, mainAxis, panelSize, styleReaders }: HoveredBoxesProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/renderer/boxplot-layer.d.ts

@@ -0,0 +1,18 @@
+import { GeomStyleReaders, LayerIntroPlan, MainAxis, SceneLayer } from '@graphysdk/react';
+import { PanelSize } from './utils/panel-path';
+interface BoxplotLayerProps {
+    layer: SceneLayer;
+    mainAxis: MainAxis;
+    panelSize: PanelSize;
+    styleReaders: GeomStyleReaders;
+    shouldAnimateTransitions: boolean;
+    intro: LayerIntroPlan | null | undefined;
+}
+/**
+ * The layer's own paint. The engine plans a `rects` layer's entrance as a grow from the axis, which would
+ * draw each box as a length rising from zero; a box encodes where values sit, so the whole layer fades up on
+ * the plan's clock instead. The fade is independent of `shouldAnimateTransitions`: it rides the group rather
+ * than moving the marks, so it plays even when data changes snap.
+ */
+export declare const BoxplotLayer: ({ layer, mainAxis, panelSize, styleReaders, shouldAnimateTransitions, intro, }: BoxplotLayerProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/renderer/boxplot-paint.d.ts

@@ -0,0 +1,28 @@
+import { GeomStyleReaders, MainAxis, SceneLayer } from '@graphysdk/react';
+import { Box, Outlier } from '../utils/read-boxplot';
+import { BoxplotKeys } from './utils/boxplot-keys';
+import { PanelSize } from './utils/panel-path';
+/**
+ * What one pass paints: every whisker below, every box above them with its median and mean, and the outliers
+ * on top.
+ */
+export interface BoxplotPaintProps {
+    boxes: readonly Box[];
+    outliers: readonly Outlier[];
+    mainAxis: MainAxis;
+    /** A notched box is a path, which has no percentage units, so it is drawn in the panel's pixels. */
+    panelSize: PanelSize;
+    /** The layer the marks are drawn from, so a notched box's path redraws on a resize rather than morphing. */
+    source: SceneLayer;
+    styleReaders: GeomStyleReaders;
+    /** What identifies each mark across a data change, so a spring moves a mark rather than swapping it. */
+    keys: BoxplotKeys;
+    /** Paints in the `hovered` state. */
+    isHovered?: boolean;
+    /**
+     * Whether marks spring to their new positions when the data changes. The hover and highlight repaints
+     * mount and unmount with the interaction, so only the layer's own paint animates.
+     */
+    shouldAnimateTransitions?: boolean;
+}
+export declare const BoxplotPaint: ({ boxes, outliers, mainAxis, panelSize, source, styleReaders, keys, isHovered, shouldAnimateTransitions, }: BoxplotPaintProps) => import("react/jsx-runtime").JSX.Element;

package/dist/renderer/boxplot.d.ts

@@ -0,0 +1,15 @@
+import { BoundGeomRendererDefinition } from '@graphysdk/react';
+import { BoxplotGeom } from '../engine/boxplot.geom';
+/**
+ * The boxplot plugin: pass it to `createGraphyKit({ plugins: [boxplot] })` for `kit.geom.boxplot()`.
+ *
+ * @example
+ *   const kit = createGraphyKit({ plugins: [boxplot] });
+ *   const spec = kit.pipe(
+ *     kit.createSpec({ x: 'team', y: 'salary' }),
+ *     kit.geom.boxplot(),
+ *     kit.scale.x.discrete(),
+ *     kit.scale.y.continuous()
+ *   );
+ */
+export declare const boxplot: BoundGeomRendererDefinition<BoxplotGeom>;

package/dist/renderer/utils/box-geometry.d.ts

@@ -0,0 +1,36 @@
+import { MainAxis, XYPoint } from '@graphysdk/react';
+import { Box } from '../../utils/read-boxplot';
+/** A box in the `[0, 1]` view box, from its top left, y growing downward. */
+export interface ViewBoxRect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+/** A straight line in the `[0, 1]` view box. */
+export interface ViewBoxSegment {
+    from: XYPoint;
+    to: XYPoint;
+}
+/** One whisker: the stem from the box to its reach, and the cap across its end. */
+export interface Whisker {
+    side: 'lower' | 'upper';
+    stem: ViewBoxSegment;
+    cap: ViewBoxSegment;
+}
+/** The box from the first quartile to the third, across its share of the band. */
+export declare const readBoxRect: (box: Box, mainAxis: MainAxis) => ViewBoxRect;
+/**
+ * A notched box's outline, clockwise from the first quartile: each side pinches in to the median across the
+ * notch. A notch reaching past a quartile is drawn as it falls, folding over the box's end, as ggplot2 draws
+ * it: the median's interval is wider than the box, which is worth seeing. `null` for a box with no notch.
+ */
+export declare const readNotchedOutline: (box: Box, mainAxis: MainAxis) => XYPoint[] | null;
+/** The median line, across the box's width at the median: its full width, or the notch's waist. */
+export declare const readMedianSegment: (box: Box, mainAxis: MainAxis) => ViewBoxSegment;
+/** Where the mean marker sits, on the box's centre line; `null` for a box that shows no mean. */
+export declare const readMeanPoint: (box: Box, mainAxis: MainAxis) => XYPoint | null;
+/** The whiskers that reach past the box; one that ends on its quartile draws nothing. */
+export declare const readWhiskers: (box: Box, mainAxis: MainAxis) => Whisker[];
+/** A point placed by its main-axis and value-axis fractions, in the view box. */
+export declare const toViewBox: (mainAxis: MainAxis, main: number, cross: number) => XYPoint;

package/dist/renderer/utils/boxplot-keys.d.ts

@@ -0,0 +1,22 @@
+import { Observation, SceneLayer } from '@graphysdk/react';
+import { Box, Outlier } from '../../utils/read-boxplot';
+export interface BoxplotKeys {
+    /** What a box and the outliers standing over it share: its category and group. */
+    readBoxKey: (observation: Observation) => string;
+    /** One key per outlier of a list, in its order: its box's key and its value, then which repeat of it it is. */
+    readOutlierKeys: (outliers: readonly Outlier[]) => string[];
+}
+/**
+ * A box keys on its category and group, read from the raw values rather than the band: the band moves with
+ * the domain, the very change a mark should spring through, not remount on. An outlier keys on its value
+ * too, so one that stays an outlier across a data change springs to its new place.
+ */
+export declare const createBoxplotKeys: (layer: SceneLayer) => BoxplotKeys;
+/**
+ * The source outliers a highlight matched. An outlier keeps its whole row, so it is found by every value it
+ * carries: two outliers of one box and value that differ elsewhere (`region`) are told apart, and two that
+ * differ nowhere no predicate could tell apart either.
+ */
+export declare const selectMatchedOutliers: (sourceLayer: SceneLayer, sourceOutliers: readonly Outlier[], matchedOutliers: readonly Outlier[]) => Outlier[];
+/** The outliers standing over any of the given boxes: a hovered or highlighted box raises its own. */
+export declare const selectOutliersOfBoxes: (outliers: readonly Outlier[], boxes: readonly Box[], readBoxKey: BoxplotKeys["readBoxKey"]) => Outlier[];

package/dist/renderer/utils/panel-path.d.ts

@@ -0,0 +1,15 @@
+import { XYPoint } from '@graphysdk/react';
+import { ViewBoxRect, ViewBoxSegment } from './box-geometry';
+/** The panel's paint size, in pixels. */
+export interface PanelSize {
+    width: number;
+    height: number;
+}
+/** A view-box point in panel pixels from the top left. */
+export declare const scaleToPanel: (point: XYPoint, panelSize: PanelSize) => XYPoint;
+/** A closed polygon through view-box points, in the panel's pixels. */
+export declare const toPolygonPathData: (points: readonly XYPoint[], panelSize: PanelSize) => string;
+/** A view-box rect as a closed path in the panel's pixels, clockwise from its top left. */
+export declare const toRectPathData: (rect: ViewBoxRect, panelSize: PanelSize) => string;
+/** A view-box segment as an open path in the panel's pixels. */
+export declare const toSegmentPathData: (segment: ViewBoxSegment, panelSize: PanelSize) => string;

package/dist/utils/boxplot-columns.d.ts

@@ -0,0 +1,32 @@
+/**
+ * The columns `compile()` writes and the renderer reads, beside the position columns. The values sit in the
+ * units of the variable `y` maps, and carry its format, so the tooltip reads them like the value axis. Authors name them
+ * in a `highlight` or an entry's `where`, so they are part of the geom's API.
+ */
+export declare const BOXPLOT_COLUMNS: {
+    /** The first quartile, where the box starts. */
+    readonly q1: "boxplotQ1";
+    /** The median, where the line across the box sits. */
+    readonly median: "boxplotMedian";
+    /** The third quartile, where the box ends. */
+    readonly q3: "boxplotQ3";
+    /** The lowest value the lower whisker reaches: the smallest one inside its fence. */
+    readonly lowerWhisker: "boxplotLowerWhisker";
+    /** The highest value the upper whisker reaches: the largest one inside its fence. */
+    readonly upperWhisker: "boxplotUpperWhisker";
+    /** How many values the box summarises, outliers included. */
+    readonly count: "boxplotCount";
+    /** The mean of the values the box summarises, outliers included. */
+    readonly mean: "boxplotMean";
+    /** The lower end of the notch: the median's rough 95% interval. */
+    readonly notchLower: "boxplotNotchLower";
+    /** The upper end of the notch. */
+    readonly notchUpper: "boxplotNotchUpper";
+    /**
+     * With `varwidth`, the box's width as a fraction of its share of the band, by the root of its count against
+     * the layer's largest; empty otherwise.
+     */
+    readonly relativeWidth: "boxplotRelativeWidth";
+    /** A value beyond a whisker, on an outlier's own observation; empty on a box's. */
+    readonly outlier: "boxplotOutlier";
+};

package/dist/utils/read-boxplot.d.ts

@@ -0,0 +1,43 @@
+import { MainAxis, Observation } from '@graphysdk/react';
+/** A box placed by its share of the band on the main axis and its summary on the other, each a `[0, 1]` fraction. */
+export interface Box {
+    observation: Observation;
+    /** The box's two edges on the main axis: its group's share of the band once dodged. */
+    start: number;
+    end: number;
+    lowerWhisker: number;
+    q1: number;
+    median: number;
+    q3: number;
+    upperWhisker: number;
+    /** Where the mean marker sits; `null` unless the layer shows it. */
+    mean: number | null;
+    /** The notch's two ends around the median; `null` unless the layer notches its boxes. */
+    notch: {
+        lower: number;
+        upper: number;
+    } | null;
+}
+/** A value past its box's whiskers, standing on the box's centre line. */
+export interface Outlier {
+    observation: Observation;
+    /** The centre of its box's share of the band. */
+    band: number;
+    value: number;
+}
+export interface Boxplot {
+    boxes: Box[];
+    outliers: Outlier[];
+}
+/** The centre line a box's whiskers and outliers stand on. */
+export declare const readBoxCentre: (box: Pick<Box, "start" | "end">) => number;
+/**
+ * Reads where a box sits. The flip is already baked into the position columns, so under `coord.flip()` the
+ * box's edges are `yMin`/`yMax` and its whiskers run `xMin` to `xMax`; the median and quartiles are scaled on the value
+ * axis whatever the flip. `null` for an outlier's observation or a box missing a position.
+ */
+export declare const readBox: (observation: Observation, mainAxis: MainAxis) => Box | null;
+/** Reads where an outlier sits; `null` for a box's observation. */
+export declare const readOutlier: (observation: Observation, mainAxis: MainAxis) => Outlier | null;
+/** Reads every box and outlier of a layer, skipping an observation missing a position. */
+export declare const readBoxplot: (observations: Iterable<Observation>, mainAxis: MainAxis) => Boxplot;

package/licenses/PolyForm-Free-Trial-1.0.0.md

@@ -0,0 +1,93 @@
+# PolyForm Free Trial License 1.0.0
+
+<https://polyformproject.org/licenses/free-trial/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree
+to them as both strict obligations and conditions to all
+your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software
+to do everything you might do with the software that would
+otherwise infringe the licensor's copyright in it for any
+permitted purpose. However, you may only make changes or
+new works based on the software according to [Changes and New
+Works License](#changes-and-new-works-license), and you may
+not distribute copies of the software.
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to
+make changes and new works based on the software for any
+permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that
+covers patent claims the licensor can license, or becomes able
+to license, that you would infringe by using the software.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## Free Trial
+
+Use to evaluate whether the software suits a particular
+application for less than 32 consecutive calendar days, on
+behalf of you or your company, is use for a permitted purpose.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of
+your licenses to anyone else, or prevent the licensor from
+granting licenses to anyone else. These terms do not imply
+any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If
+your company makes such a claim, your patent license ends
+immediately for work on behalf of your company.
+
+## Violations
+
+If you violate any of these terms, or do anything with the
+software not covered by your licenses, all your licenses
+end immediately.
+
+## No Liability
+
+_**As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be liable
+to you for any damages arising out of these terms or the use
+or nature of the software, under any kind of legal claim.**_
+
+## Definitions
+
+The **licensor** is the individual or entity offering these
+terms, and the **software** is the software the licensor makes
+available under these terms.
+
+**You** refers to the individual or entity agreeing to these
+terms.
+
+**Your company** is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+organizations that have control over, are under the control of,
+or are under common control with that organization. **Control**
+means ownership of substantially all the assets of an entity,
+or the power to direct its management and policies by vote,
+contract, or otherwise. Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the
+software under these terms.
+
+**Use** means anything you do with the software requiring one
+of your licenses.

package/licenses/PolyForm-NonCommercial-1.0.0.md

@@ -0,0 +1,131 @@
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree
+to them as both strict obligations and conditions to all
+your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the
+software to do everything you might do with the software
+that would otherwise infringe the licensor's copyright
+in it for any permitted purpose. However, you may
+only distribute the software according to [Distribution
+License](#distribution-license) and make changes or new works
+based on the software according to [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license
+to distribute copies of the software. Your license
+to distribute covers distributing the software with
+changes and new works permitted by [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of
+the software from you also gets a copy of these terms or the
+URL for them above, as well as copies of any plain-text lines
+beginning with `Required Notice:` that the licensor provided
+with the software. For example:
+
+> Required Notice: Copyright Graphy Technologies Ltd. (https://graphy.dev)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to
+make changes and new works based on the software for any
+permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that
+covers patent claims the licensor can license, or becomes able
+to license, that you would infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for
+the benefit of public knowledge, personal study, private
+entertainment, hobby projects, amateur pursuits, or religious
+observance, without any anticipated commercial application,
+is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution,
+public research organization, public safety or health
+organization, environmental protection organization,
+or government institution is use for a permitted purpose
+regardless of the source of funding or obligations resulting
+from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of
+your licenses to anyone else, or prevent the licensor from
+granting licenses to anyone else. These terms do not imply
+any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If
+your company makes such a claim, your patent license ends
+immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have
+violated any of these terms, or done anything with the software
+not covered by your licenses, your licenses can nonetheless
+continue if you come into full compliance with these terms,
+and take practical steps to correct past violations, within
+32 days of receiving notice. Otherwise, all your licenses
+end immediately.
+
+## No Liability
+
+_**As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be liable
+to you for any damages arising out of these terms or the use
+or nature of the software, under any kind of legal claim.**_
+
+## Definitions
+
+The **licensor** is the individual or entity offering these
+terms, and the **software** is the software the licensor makes
+available under these terms.
+
+**You** refers to the individual or entity agreeing to these
+terms.
+
+**Your company** is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+organizations that have control over, are under the control of,
+or are under common control with that organization. **Control**
+means ownership of substantially all the assets of an entity,
+or the power to direct its management and policies by vote,
+contract, or otherwise. Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the
+software under these terms.
+
+**Use** means anything you do with the software requiring one
+of your licenses.

package/licenses/PolyForm-Small-Business-1.0.0.md

@@ -0,0 +1,121 @@
+# PolyForm Small Business License 1.0.0
+
+<https://polyformproject.org/licenses/small-business/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree
+to them as both strict obligations and conditions to all
+your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the
+software to do everything you might do with the software
+that would otherwise infringe the licensor's copyright
+in it for any permitted purpose. However, you may
+only distribute the software according to [Distribution
+License](#distribution-license) and make changes or new works
+based on the software according to [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license
+to distribute copies of the software. Your license
+to distribute covers distributing the software with
+changes and new works permitted by [Changes and New Works
+License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of
+the software from you also gets a copy of these terms or the
+URL for them above, as well as copies of any plain-text lines
+beginning with `Required Notice:` that the licensor provided
+with the software. For example:
+
+> Required Notice: Copyright Graphy Technologies Ltd. (https://graphy.dev)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to
+make changes and new works based on the software for any
+permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that
+covers patent claims the licensor can license, or becomes able
+to license, that you would infringe by using the software.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the
+law. These terms do not limit them.
+
+## Small Business
+
+Use of the software for the benefit of your company is use for
+a permitted purpose if your company has fewer than 100 total
+individuals working as employees and independent contractors,
+and less than 1,000,000 USD (2019) total revenue in the prior
+tax year. Adjust this revenue threshold for inflation according
+to the United States Bureau of Labor Statistics' consumer price
+index for all urban consumers, U.S. city average, for all items,
+not seasonally adjusted, with 1982–1984=100 reference base.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of
+your licenses to anyone else, or prevent the licensor from
+granting licenses to anyone else. These terms do not imply
+any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or
+contributes to infringement of any patent, your patent license
+for the software granted under these terms ends immediately. If
+your company makes such a claim, your patent license ends
+immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have
+violated any of these terms, or done anything with the software
+not covered by your licenses, your licenses can nonetheless
+continue if you come into full compliance with these terms,
+and take practical steps to correct past violations, within
+32 days of receiving notice. Otherwise, all your licenses
+end immediately.
+
+## No Liability
+
+_**As far as the law allows, the software comes as is, without
+any warranty or condition, and the licensor will not be liable
+to you for any damages arising out of these terms or the use
+or nature of the software, under any kind of legal claim.**_
+
+## Definitions
+
+The **licensor** is the individual or entity offering these
+terms, and the **software** is the software the licensor makes
+available under these terms.
+
+**You** refers to the individual or entity agreeing to these
+terms.
+
+**Your company** is any legal entity, sole proprietorship,
+or other kind of organization that you work for, plus all
+organizations that have control over, are under the control of,
+or are under common control with that organization. **Control**
+means ownership of substantially all the assets of an entity,
+or the power to direct its management and policies by vote,
+contract, or otherwise. Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the
+software under these terms.
+
+**Use** means anything you do with the software requiring one
+of your licenses.