@graphysdk/theme-botanical 0.0.0-stage → 0.1.0

package/dist/page.d.ts

@@ -0,0 +1,9 @@
+/** The paper's tooth: faint speckle in the ink's colour over the paper's own, tiled. */
+export declare const buildPaperGrain: (paper: string, ink: string) => string;
+export interface PageColors {
+    ink: string;
+    leaf: string;
+    tape: string;
+}
+/** Tape and a sprig, as a data URI for the graph's `overlay`. */
+export declare const buildPage: ({ ink, leaf, tape }: PageColors) => string;

package/dist/renderer/area.d.ts

@@ -0,0 +1,5 @@
+import { ResolvedGeomRenderer } from '@graphysdk/react';
+/** Each area a watercolour wash, its edge inked by hand along the readings. */
+export declare const botanicalArea: ResolvedGeomRenderer;
+/** A filled radar: a wash inside a closed outline inked by hand. */
+export declare const botanicalRadarArea: ResolvedGeomRenderer;

package/dist/renderer/bar.d.ts

@@ -0,0 +1,7 @@
+import { ResolvedGeomRenderer } from '@graphysdk/react';
+/**
+ * Each bar drawn as a leaf blade in a field sketchbook: a sepia outline that wanders between corners
+ * it meets exactly, a watercolour wash inside, and a rib up the middle with veins leaving it towards
+ * the value. The hovered bar is drawn again in its hovered ink.
+ */
+export declare const botanicalBar: ResolvedGeomRenderer;

package/dist/renderer/hand.d.ts

@@ -0,0 +1,28 @@
+import { XYPoint } from '@graphysdk/react';
+/** A number from a string, so a shape wanders the same way every time it is drawn. */
+export declare const hashSeed: (text: string) => number;
+/** Numbers in `[0, 1)` from a seed, the same run of them for the same seed. */
+export declare const createRandom: (seed: number) => (() => number);
+export interface HandOptions {
+    /** How far, in pixels, the pen may stray from the true line between two of its points. */
+    wander: number;
+    seed: number;
+    closed?: boolean;
+    /** Pixels between the points the stroke is bent at. */
+    step?: number;
+    /**
+     * Whether the pen turns sharply at each given point, as it does at the corner of a box, rather
+     * than sweeping through it as it does along a stem.
+     */
+    cornered?: boolean;
+}
+/**
+ * A stroke through `points` as a hand draws it: it passes through every given point exactly, since
+ * those are where the readings are, and wanders smoothly between them.
+ */
+export declare const drawByHand: (points: readonly XYPoint[], { wander, seed, closed, step, cornered }: HandOptions) => string;
+/** A leaf as drawn in the margin: its base at the origin, its tip `length` along `angle` (radians). */
+export declare const buildLeaf: (base: XYPoint, length: number, breadth: number, angle: number) => {
+    blade: string;
+    rib: string;
+};

package/dist/renderer/ink.d.ts

@@ -0,0 +1,35 @@
+import { ReactNode } from 'react';
+import { XYPoint } from '@graphysdk/react';
+/** The sepia every outline, rib and vein is drawn in; colour is only ever the wash inside it. */
+export declare const INK: "#3A2C1E";
+export declare const INK_WIDTH = 1;
+export declare const VEIN_WIDTH = 0.6;
+export declare const VEIN_OPACITY = 0.7;
+/** An id a `url()` can name: React's own holds characters one cannot. */
+export declare const useDefId: (prefix: string) => string;
+interface WashProps {
+    path: string;
+    color: string;
+    /** How thick the wash is laid, before it pools. */
+    opacity: number;
+}
+/** A watercolour wash inside a shape: laid thin across it and darker along the edge, where it dried. */
+export declare const Wash: ({ path, color, opacity }: WashProps) => ReactNode;
+interface InkProps {
+    path: string;
+    width?: number;
+    opacity?: number;
+}
+/** A pen line in sepia, its ends round as a nib leaves them. */
+export declare const Ink: ({ path, width, opacity }: InkProps) => ReactNode;
+interface InkLeafProps {
+    base: XYPoint;
+    length: number;
+    angle: number;
+    color: string;
+    opacity?: number;
+    washOpacity?: number;
+}
+/** A small leaf: a wash of `color` inside a sepia outline, with its rib drawn down the middle. */
+export declare const InkLeaf: ({ base, length, angle, color, opacity, washOpacity }: InkLeafProps) => ReactNode;
+export {};

package/dist/renderer/line.d.ts

@@ -0,0 +1,5 @@
+import { ResolvedGeomRenderer } from '@graphysdk/react';
+/** A line as a vine: a stem drawn by hand through every reading, putting out a leaf at each. */
+export declare const botanicalLine: ResolvedGeomRenderer;
+/** A radar's outline as a closed vine. */
+export declare const botanicalRadarLine: ResolvedGeomRenderer;

package/dist/renderer/paint.d.ts

@@ -0,0 +1,21 @@
+import { Observation, SceneLayerFor, StyleState } from '@graphysdk/react';
+/** What a filled shape is drawn with. */
+export interface ShapePaint {
+    color: string;
+    opacity: number;
+    fillOpacity: number;
+    /** The edge that parts it from its neighbours, or rules it when hovered. */
+    edge: string;
+    edgeWidth: number;
+}
+/** What a line is drawn with. Its rails take `color`; the ground shows between them. */
+export interface LinePaint {
+    color: string;
+    opacity: number;
+    width: number;
+    dashArray: string | undefined;
+}
+export type ReadShapePaint = (observation: Observation, state?: StyleState) => ShapePaint;
+export type ReadLinePaint = (observation: Observation, state?: StyleState) => LinePaint;
+export declare const useShapePaint: (layer: SceneLayerFor<"bar" | "point" | "tile" | "area">) => ReadShapePaint;
+export declare const useLinePaint: (layer: SceneLayerFor<"line">) => ReadLinePaint;

package/dist/renderer/plugins.d.ts

@@ -0,0 +1,7 @@
+import { ResolvedGeomRenderer } from '@graphysdk/react';
+/**
+ * Every built-in geom the theme repaints, under each coordinate system it is drawn in. Positions,
+ * scales and axes come from the compiled layer unchanged, and colour, opacity and ink width come from
+ * the stylesheet, so `style.geom.*` still decides what a shape is drawn with.
+ */
+export declare const botanicalPlugins: readonly ResolvedGeomRenderer[];

package/dist/renderer/point.d.ts

@@ -0,0 +1,5 @@
+import { ResolvedGeomRenderer } from '@graphysdk/react';
+/** Scatter and bubble: a fallen leaf centred on each reading. The hovered one is drawn again, larger. */
+export declare const botanicalPoint: ResolvedGeomRenderer;
+/** A radar's vertices as leaves. */
+export declare const botanicalRadarPoint: ResolvedGeomRenderer;

package/dist/renderer/shapes.d.ts

@@ -0,0 +1,2 @@
+import { GeomShapes } from '@graphysdk/react';
+export declare const botanicalShapes: GeomShapes;

package/dist/renderer/slice.d.ts

@@ -0,0 +1,7 @@
+import { ResolvedGeomRenderer } from '@graphysdk/react';
+/**
+ * Pie, donut, rose and radial bar as a flower: each slice a petal in a wandering sepia outline with a
+ * wash inside and veins fanning across it, paper between neighbours, and a seed head over a pie's
+ * middle, where its petals meet.
+ */
+export declare const botanicalSlice: ResolvedGeomRenderer;

package/dist/renderer/tile.d.ts

@@ -0,0 +1,3 @@
+import { ResolvedGeomRenderer } from '@graphysdk/react';
+/** Heatmap and waffle as a seed tray: each cell washed in its colour inside a hand-drawn outline. */
+export declare const botanicalTile: ResolvedGeomRenderer;

package/dist/renderer/trace.d.ts

@@ -0,0 +1,24 @@
+import { ReactNode } from 'react';
+import { Observation, SceneLayer } from '@graphysdk/react';
+import { PixelSize, Projection } from './utils/projections';
+/** One group's path in panel pixels, with the observation its paint is read for. */
+export interface Trace {
+    key: string;
+    path: string;
+    observation: Observation;
+}
+/** One trace per group, from whatever turns a group's observations into its path. */
+export declare const readTraces: (layer: SceneLayer, buildPath: (observations: Observation[]) => string | null) => Trace[];
+/** A radar group's closed outline in panel pixels, its vertices in angular order so it never crosses itself. */
+export declare const buildRadarPath: (observations: Observation[], panel: PixelSize) => string | null;
+interface HoverLeafProps {
+    geom: 'line' | 'area';
+    observation: Observation;
+    panel: PixelSize;
+    project: Projection;
+    color: string;
+    opacity: number;
+}
+/** The hovered reading on a line or an area: a leaf in the trace's colour, sprung from the reading. */
+export declare const HoverLeaf: ({ geom, observation, panel, project, color, opacity }: HoverLeafProps) => ReactNode;
+export {};

package/dist/renderer/utils/paths.d.ts

@@ -0,0 +1,7 @@
+import { PixelSize } from './projections';
+/**
+ * A path written in the unit square, in the panel's pixels. An ink line is measured in pixels on every
+ * side, which a path stretched by a transform is not. Reads the commands a line or an area is written
+ * in; an arc is not one of them.
+ */
+export declare const scalePathToPanel: (path: string, panel: PixelSize) => string;

package/dist/renderer/utils/projections.d.ts

@@ -0,0 +1,16 @@
+import { Observation, XYPoint } from '@graphysdk/react';
+export interface PixelSize {
+    width: number;
+    height: number;
+}
+export interface PixelRect extends PixelSize {
+    x: number;
+    y: number;
+}
+/** Where an observation is drawn in the panel, in pixels; `null` for one missing a position. */
+export type Projection = (observation: Observation, panel: PixelSize) => XYPoint | null;
+export declare const projectCartesian: Projection;
+export declare const projectPolar: Projection;
+/** The whole panel, for a shape that may reach any part of it. */
+export declare const toPanelBounds: (panel: PixelSize) => PixelRect;
+export declare const toClosedPath: (points: XYPoint[]) => string;

package/dist/styles.d.ts

@@ -0,0 +1,34 @@
+import { Stylesheet } from '@graphysdk/react';
+export declare const BOTANICAL_COLORS: {
+    readonly paper: "#F4EEDD";
+    readonly raised: "#FBF8EE";
+    readonly text: "#1E2A21";
+    readonly secondary: "#4A5648";
+    readonly rule: "#CFC7B0";
+    readonly edge: "#BFB79E";
+    readonly ink: "#3A2C1E";
+    readonly tape: "#D9C89A";
+};
+export declare const BOTANICAL_HUES: {
+    readonly forest: "#2E5E3B";
+    readonly petal: "#C4607C";
+    readonly bark: "#5C4033";
+    readonly sage: "#6E8A5A";
+    readonly berry: "#8C2A3C";
+    readonly gold: "#9A7A1E";
+    readonly gentian: "#4A6A8C";
+    readonly leaf: "#4E8A4A";
+};
+/**
+ * The order groups take their colours in. A pale colour follows each dark one and no two greens
+ * meet, so neighbours in a stack or a legend differ in both lightness and hue.
+ */
+export declare const BOTANICAL_PALETTE: readonly string[];
+/** For a colour that stands for a number: from a pale sage to a deep forest green. */
+export declare const BOTANICAL_COLORMAP: readonly string[];
+/**
+ * Ivory paper inside a thin dark frame, hairline rules for the values and none for the categories,
+ * a fine baseline, thin lines, and flat square shapes parted by a line in the paper's colour. Nothing
+ * casts a shadow. A shape is forest green until a graph maps its colour.
+ */
+export declare const botanicalStyles: Stylesheet;

package/fonts.css

@@ -0,0 +1,2 @@
+/* Kalam for the gardener's hand and Cormorant Garamond for the italic notes, the faces the theme's stylesheet names. Import this once, before the first graph is measured. */
+@import url('https://fonts.googleapis.com/css2?family=Cormorant+Garamond:ital,wght@0,500;0,600;1,500;1,600&family=Kalam:wght@300;400;700&display=swap');

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.