@graphysdk/theme-chalkboard 0.0.0-stage → 0.1.0

package/dist/renderer/area.d.ts

@@ -0,0 +1,5 @@
+import { ResolvedGeomRenderer } from '@graphysdk/react';
+/** Each area shaded with the side of its chalk, its top edge drawn by hand along the readings. */
+export declare const chalkboardArea: ResolvedGeomRenderer;
+/** A filled radar: shaded inside a closed chalk outline. */
+export declare const chalkboardRadarArea: ResolvedGeomRenderer;

package/dist/renderer/bar.d.ts

@@ -0,0 +1,8 @@
+import { ResolvedGeomRenderer } from '@graphysdk/react';
+/**
+ * Each bar as a teacher draws one on the board: outlined twice in its chalk, the two passes wandering
+ * their own ways between corners both meet exactly, and shaded inside with the side of the stick in
+ * broad strokes that skip. Each chalk is shaded at its own angle. The hovered bar is shaded again,
+ * closer, and outlined in white.
+ */
+export declare const chalkboardBar: ResolvedGeomRenderer;

package/dist/renderer/chalk.d.ts

@@ -0,0 +1,34 @@
+import { ReactNode } from 'react';
+import { PixelRect } from './utils/projections';
+/** The direction a shape in `color` is shaded in: each chalk of the box has its own. */
+export declare const readShadeAngle: (color: string, fallback?: number) => number;
+/** An id a `url()` can name: React's own holds characters one cannot. */
+export declare const useDefId: (prefix: string) => string;
+interface ChalkLineProps {
+    path: string;
+    color: string;
+    width: number;
+    seed: number;
+    opacity?: number;
+}
+/** A stroke of chalk along `path`: a body, a press that skips, and a grain of dabs, all drawn. */
+export declare const ChalkLine: ({ path, color, width, seed, opacity }: ChalkLineProps) => ReactNode;
+interface ChalkShadingProps {
+    /** The shape shaded; the strokes are clipped to it, so none crosses its edge. */
+    region: string;
+    /** A box round the shape, which the strokes are laid across. */
+    bounds: PixelRect;
+    color: string;
+    angle: number;
+    spacing: number;
+    width: number;
+    seed: number;
+    /** The stylesheet's `fillAlpha`: how hard the chalk is pressed. */
+    pressure: number;
+}
+/**
+ * A shape shaded with the side of the chalk: the board under it rubbed clean, a little dust, then
+ * broad strokes at `angle` that skip, each with a fine grain along it. Clipped to `region`.
+ */
+export declare const ChalkShading: ({ region, bounds, color, angle, spacing, width, seed, pressure, }: ChalkShadingProps) => ReactNode;
+export {};

package/dist/renderer/hand.d.ts

@@ -0,0 +1,62 @@
+import { XYPoint } from '@graphysdk/react';
+import { PixelRect } from './utils/projections';
+/** 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 chalk 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 chalk 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 curve.
+     */
+    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;
+export declare const format: (value: number) => string;
+export interface DashOptions {
+    /** The shortest and longest run of chalk before it skips, in pixels. */
+    run: readonly [number, number];
+    /** The shortest and longest skip, where the chalk rode over the pits of the board. */
+    skip: readonly [number, number];
+}
+/**
+ * Where a stick of chalk skips as it is dragged: runs of chalk broken by short gaps of bare board, as
+ * an SVG dash array. The skips are drawn gaps, not noise, so the stroke keeps its smooth edge.
+ */
+export declare const buildChalkSkips: ({ run, skip }: DashOptions, seed: number) => string;
+export interface HatchOptions {
+    /** The direction the strokes run in, in radians from the horizontal. */
+    angle: number;
+    /** Pixels between neighbouring strokes. */
+    spacing: number;
+    seed: number;
+}
+/**
+ * Parallel strokes laid across `bounds` at `angle`, as a teacher shades a shape with the side of the
+ * chalk: each stroke drawn by hand, its spacing a little uneven. The strokes run past the bounds, so
+ * whatever draws them clips them to the shape they shade.
+ */
+export declare const buildHatch: (bounds: PixelRect, { angle, spacing, seed }: HatchOptions) => string;
+/** A cross as a teacher plots a reading: two short strokes whose crossing sits exactly on `centre`. */
+export declare const buildCross: (centre: XYPoint, reach: number, seed: number) => string;
+/**
+ * A circle as a hand draws one in a single sweep: it starts somewhere on the rim and runs a little past
+ * where it began, the run past drifting off the rim by up to `drift` pixels, as a hand lifting away
+ * does. Every point of the first full turn is bent at the true radius.
+ */
+export declare const drawCircleByHand: (centre: XYPoint, radius: number, { seed, overshoot, wander, drift }: {
+    seed: number;
+    overshoot: number;
+    wander: number;
+    drift?: number;
+}) => string;

package/dist/renderer/line.d.ts

@@ -0,0 +1,8 @@
+import { ResolvedGeomRenderer } from '@graphysdk/react';
+/**
+ * A line as a teacher plots one: a cross at each reading, crossing exactly on it, and a stroke of
+ * chalk drawn by hand through every one. Readings packed too close for crosses keep the stroke alone.
+ */
+export declare const chalkboardLine: ResolvedGeomRenderer;
+/** A radar's outline as a closed chalk stroke, crossed at its readings. */
+export declare const chalkboardRadarLine: 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 chalk takes `color`. */
+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 chalk width come
+ * from the stylesheet, so `style.geom.*` still decides what a shape is drawn with.
+ */
+export declare const chalkboardPlugins: readonly ResolvedGeomRenderer[];

package/dist/renderer/point.d.ts

@@ -0,0 +1,8 @@
+import { ResolvedGeomRenderer } from '@graphysdk/react';
+/**
+ * Scatter and bubble: a small chalk ring drawn carefully round each reading, a little dust rubbed
+ * inside it. The hovered one is ringed again, as a teacher rings the one being talked about.
+ */
+export declare const chalkboardPoint: ResolvedGeomRenderer;
+/** A radar's vertices as chalk rings. */
+export declare const chalkboardRadarPoint: ResolvedGeomRenderer;

package/dist/renderer/shapes.d.ts

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

package/dist/renderer/slice.d.ts

@@ -0,0 +1,7 @@
+import { ResolvedGeomRenderer } from '@graphysdk/react';
+/**
+ * Pie and donut as a teacher draws one on the board: a circle in one sweep of white chalk that runs
+ * past where it began, spokes ruled out to it, and each slice shaded with the side of its own chalk,
+ * neighbours at different angles. A rose's and a radial bar's slices are each outlined on their own.
+ */
+export declare const chalkboardSlice: ResolvedGeomRenderer;

package/dist/renderer/tile.d.ts

@@ -0,0 +1,6 @@
+import { ResolvedGeomRenderer } from '@graphysdk/react';
+/**
+ * Heatmap and waffle: each cell rubbed in with its chalk inside a hand-drawn edge, streaked along the
+ * row where the side of the stick went over it, bare board between cells. The hovered cell is outlined.
+ */
+export declare const chalkboardTile: ResolvedGeomRenderer;

package/dist/renderer/trace.d.ts

@@ -0,0 +1,26 @@
+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 HoverRingProps {
+    geom: 'line' | 'area' | 'point';
+    observation: Observation;
+    panel: PixelSize;
+    project: Projection;
+    color: string;
+    opacity: number;
+    /** How far out from the reading the ring is drawn, past whatever already marks it. */
+    radius?: number;
+}
+/** The hovered reading, ringed in its chalk the way a teacher rings the answer, centred on the reading. */
+export declare const HoverRing: ({ geom, observation, panel, project, color, opacity, radius, }: HoverRingProps) => 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,33 @@
+import { Stylesheet } from '@graphysdk/react';
+export declare const CHALKBOARD_COLORS: {
+    readonly board: "#27362F";
+    readonly wiped: "#1F2C26";
+    readonly chalk: "#F4F1E8";
+    readonly dusty: "#C9D1C8";
+    readonly grid: "rgba(244, 241, 232, 0.24)";
+    readonly edge: "rgba(244, 241, 232, 0.45)";
+    readonly axis: "rgba(244, 241, 232, 0.85)";
+    readonly wood: "#86643F";
+    readonly woodLight: "#A88456";
+    readonly woodDark: "#4F3923";
+    readonly felt: "#5E5A55";
+};
+/** The chalks of the box. */
+export declare const CHALKBOARD_CHALKS: {
+    readonly white: "#F4F1E8";
+    readonly yellow: "#F7DC6F";
+    readonly pink: "#F49AC2";
+    readonly blue: "#8FD3F4";
+    readonly green: "#A8E6A1";
+    readonly orange: "#F9A65A";
+};
+/** The order groups take their chalks in. */
+export declare const CHALKBOARD_PALETTE: readonly string[];
+/** For a colour that stands for a number: from a thin rub of blue chalk to white pressed hard. */
+export declare const CHALKBOARD_COLORMAP: readonly string[];
+/**
+ * The chalkboard look: a smeared board in a wooden frame with a ledge along its foot, chalk axes on the
+ * left and bottom, a dashed grid, and shapes outlined and shaded in chalk by the theme's repaints. A
+ * shape is white until a graph maps its colour.
+ */
+export declare const chalkboardStyles: Stylesheet;

package/fonts.css

@@ -0,0 +1,2 @@
+/* Gochi Hand, the handwriting the theme's stylesheet names. Import this once, before the first graph is measured. */
+@import url('https://fonts.googleapis.com/css2?family=Gochi+Hand&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.