@motionscript/charts 0.1.0 → 0.1.1-alpha.1

package/src/bar-chart/shared.ts

@@ -1,149 +1,82 @@
-/**
- * Types and pure helpers specific to the {@link BarChart} family: how a row's
- * values become the spans its columns cover, how the value axis is scaled around
- * them, and the theme the bars add to the shared chart vocabulary.
- *
- * Everything a line or a pie chart would want too — what a series is, the axis
- * domain model, the theme leaf resolvers, the legend and plot-panel branches —
- * lives in `../kit/shared.ts` and is imported here.
- *
- * Kept renderer-agnostic (no `Node` imports) so a host's inspector mapping
- * can build a partial {@link BarChartTheme} without
- * pulling the components in.
- */
-
-import {
-  fillOps,
-  lerpNumber,
-  shadowOps,
-  strokeOps,
-  textOps,
-  type DataRecord,
-  type Fill,
-  type Shadow,
-  type ShadowResolved,
-  type Stroke,
-  type StrokeResolved,
-  type TextStyle,
-} from "@motionscript/sdk"
+import { Types, fillOps, type DataRecord, type Fill } from "@motionscript/sdk"
 
-import {
-  CHART_PALETTE,
-  DEFAULT_LEGEND,
-  DEFAULT_PLOT_AREA,
-  DEFAULT_SERIES_FILLS,
-  DEFAULT_X_AXIS,
-  DEFAULT_Y_AXIS,
-  SPOTLIGHT_DIM,
-  lerpAxisConfig,
-  lerpLegendConfig,
-  lerpPlotArea,
-  lerpSeriesFills,
-  niceStep,
-  num,
-  resolveAxisConfig,
-  resolveLegendConfig,
-  resolvePlotArea,
-  resolveSeriesFills,
-  text,
-  type AxisConfig,
-  type ChartSeries,
-  type LegendConfig,
-  type LegendTheme,
-  type PlotAreaConfig,
-  type Range,
-} from "../kit/shared"
+import { niceRange, num, text, type ChartSeries, type Range } from "../kit/shared"
 
-/**
- * One series in a {@link BarChart}: a column of the table drawn as one bar per
- * row — side by side with its siblings within each category's slot, or stacked
- * on top of them.
- *
- * The family-wide {@link ChartSeries} under a name that says what it draws here.
- */
+/** One bar per row, beside its siblings in the category slot or stacked on them: {@link ChartSeries} under the name for what it draws here. */
 export type BarSeries = ChartSeries
 
+/** How the series share a category: side by side, stacked, or stacked as shares of 100. */
+export type BarStack = "none" | "stacked" | "percent"
+
+/** Which way the bars grow: up from a category row, or right from a category column. */
+export type BarOrientation = "vertical" | "horizontal"
+
 /**
- * One drawn bar's span in **data units**: the value its base sits at and the
- * value its far end reaches.
- *
- * A span rather than a height because that is the one shape both modes fit. A
- * grouped bar runs from zero to its value; a stacked segment runs from the
- * running total below it to that total plus its own value. Negative values fall
- * out of the same arithmetic — the span simply runs the other way — so a chart
- * with a loss in it needs no special case, only a baseline that isn't the floor.
+ * One bar's span in data units. A span rather than a height because every mode
+ * fits it, and a negative value just runs the other way with no special case.
  */
 export interface BarSpan {
-  /** Value the bar's base sits at — 0 when grouped, the running total when stacked. */
+  /** Where the base sits: 0 apart, the running total below (or above, for a negative) when stacked. */
   from: number
-  /** Value its far end reaches. */
   to: number
-  /** The value this bar plots — `to - from`, kept for the figure printed on it. */
+  /** `to - from`. */
   value: number
+  /** Whether it ends its stack on its side of zero, so its far end is rounded. */
+  outer: boolean
 }
 
 /**
- * The spans one row's bars cover, one per series, in series order.
- *
- * Stacking is a running sum in the order the series are listed, which is also
- * the order they're drawn: series 0 sits on the baseline and each later one
- * rides on what's below it. A zero-valued series still yields a (degenerate)
- * span so the returned list stays index-aligned with the series list.
+ * One row's spans, in series order. Stacking keeps a running sum on each side
+ * of zero, so a negative value stacks downward from the baseline rather than
+ * eating into the positives. In `percent` each value is its share of the row's
+ * total magnitude. A zero value still yields a degenerate span, keeping the list
+ * index-aligned with the series. `weights` scale each series' contribution.
  */
-export function barSpans(
-  row: DataRecord,
-  series: BarSeries[],
-  stacked: boolean
-): BarSpan[] {
-  let running = 0
-  return series.map((s) => {
-    const value = num(row, s.field)
-    if (!stacked) return { from: 0, to: value, value }
-    const from = running
-    running += value
-    return { from, to: running, value }
-  })
-}
-
-/**
- * The index of the series whose segment ends a row's stack — the one that gets
- * the rounded cap, so a stack reads as one capped column rather than a pile of
- * separate boxes. `-1` when every value in the row is zero.
- *
- * Read off the *last non-zero* series rather than the last one listed, so a
- * series that happens to be 0 in this row doesn't take the cap and leave the
- * segment below it square.
- */
-export function stackCapIndex(row: DataRecord, series: BarSeries[]): number {
-  let last = -1
-  for (let i = 0; i < series.length; i++) {
-    if (num(row, series[i].field) !== 0) last = i
+export function barSpans(row: DataRecord, series: readonly BarSeries[], stack: BarStack, weights: readonly number[] = []): BarSpan[] {
+  const weight = (i: number) => Math.max(0, weights[i] ?? 1)
+  if (stack !== "stacked" && stack !== "percent") {
+    return series.map((s) => {
+      const value = num(row, s.field)
+      return { from: 0, to: value, value, outer: true }
+    })
   }
-  return last
+  const values = series.map((s, i) => num(row, s.field) * weight(i))
+  const total = values.reduce((sum, v) => sum + Math.abs(v), 0)
+  const scaled = stack === "percent" ? values.map((v) => (total > 0 ? (v / total) * 100 : 0)) : values
+  let lastUp = -1
+  let lastDown = -1
+  scaled.forEach((v, i) => {
+    if (v > 0) lastUp = i
+    else if (v < 0) lastDown = i
+  })
+  let up = 0
+  let down = 0
+  return scaled.map((value, i) => {
+    if (value < 0) {
+      const from = down
+      down += value
+      return { from, to: down, value, outer: i === lastDown }
+    }
+    const from = up
+    up += value
+    return { from, to: up, value, outer: i === lastUp }
+  })
 }
 
-/** The captions beneath the baseline: one per row, read off the category column. */
 export function barCategories(data: DataRecord[], field: string): string[] {
   return data.map((row) => text(row, field))
 }
 
 /**
- * The `[min, max]` of everything the chart draws, **zero always included**.
- *
- * Zero is in the range whatever the data says, because a bar chart's baseline is
- * zero: a scale starting at 40 draws a column three times its neighbour for a
- * 10% difference, which is the classic way to lie with one. A chart that really
- * does want a cropped axis says so with an explicit range.
+ * The `[min, max]` of everything drawn, zero always included: a scale starting
+ * at 40 draws a bar three times its neighbour for a 10% difference. A cropped
+ * axis takes an explicit range.
  */
-export function barValueExtent(
-  data: DataRecord[],
-  series: BarSeries[],
-  stacked: boolean
-): Range {
+export function barValueExtent(data: DataRecord[], series: readonly BarSeries[], stack: BarStack, weights?: readonly number[]): Range {
   let lo = 0
   let hi = 0
   for (const row of data) {
-    for (const span of barSpans(row, series, stacked)) {
+    for (const span of barSpans(row, series, stack, weights)) {
       lo = Math.min(lo, span.from, span.to)
       hi = Math.max(hi, span.from, span.to)
     }
@@ -151,204 +84,43 @@ export function barValueExtent(
   return lo < hi ? [lo, hi] : [0, 1]
 }
 
-/**
- * Effective value scale: the explicit `range`, else the data's extent nudged out
- * to tidy step bounds so the markers read as round numbers.
- *
- * `divisions` is how many segments the auto-range is stepped into (one fewer
- * than the marker count), so the ticks the axis draws land on the bounds this
- * picks.
- */
+/** The explicit `range`, else the data's extent nudged to tidy bounds (a percent stack reads to 100); `divisions` (one fewer than the marker count) makes the drawn ticks land on them. */
 export function resolveBarScale(
   data: DataRecord[],
-  series: BarSeries[],
-  stacked: boolean,
+  series: readonly BarSeries[],
+  stack: BarStack,
   range: Range | undefined,
-  divisions: number
+  divisions: number,
+  weights?: readonly number[]
 ): Range {
   if (range) return range
-  const [lo, hi] = barValueExtent(data, series, stacked)
-  const segments = Math.max(1, Math.round(divisions))
-  const step = niceStep((hi - lo) / segments || 1)
-  return [Math.floor(lo / step) * step, Math.ceil(hi / step) * step]
+  const [lo, hi] = barValueExtent(data, series, stack, weights)
+  if (stack === "percent") return [lo < 0 ? -100 : 0, hi > 0 ? 100 : 0]
+  return niceRange([lo, hi], divisions)
 }
 
-// ---- Theme ---------------------------------------------------------------
-
-/** How the columns themselves are drawn and how the slot is divided up. */
-export interface BarStyleConfig {
-  /**
-   * Radius of a column's far-end corners, in px. Only the outer end rounds — an
-   * interior stacked segment stays square, so the stack reads as one column.
-   */
-  cornerRadius: number
-  /**
-   * Fraction of its category's slot the bars fill, `[0, 1]`. The remainder is
-   * the channel between one category and the next, which is what makes a bar
-   * chart read as groups rather than as a solid block.
-   */
-  slotFill: number
-  /** Gap between the grouped bars *within* one slot, in px. Ignored when stacked. */
-  groupGap: number
-  /** Optional outline on every column. */
-  stroke: Stroke
-  /** Optional drop shadow on every column. */
-  shadow: Shadow
-}
-
-/** A {@link BarChart}'s full, resolved visual theme. */
-export interface BarChartConfig {
-  /**
-   * Default per-series bar paint, cycled by series index (`i % length`). A
-   * series' own `fill`, when set, replaces its entry outright.
-   */
-  seriesFills: Fill[]
-  bar: BarStyleConfig
-  /** The category axis beneath the baseline. */
-  xAxis: AxisConfig
-  /** The numeric value axis up the left. */
-  yAxis: AxisConfig
-  plotArea: PlotAreaConfig
-  legend: LegendConfig
-  /** The figure printed on each column, when the chart prints them. */
-  valueStyle: TextStyle
-  /** How far everything *outside* a spotlit series or category fades. */
-  spotlight: { dimOpacity: number }
-}
-
-/** Author-facing partial theme — every branch optional and deep-merged. */
-export type BarChartTheme = {
-  seriesFills?: Fill[]
-  bar?: Partial<BarStyleConfig>
-  xAxis?: Partial<AxisConfig>
-  yAxis?: Partial<AxisConfig>
-  plotArea?: Partial<PlotAreaConfig>
-  legend?: LegendTheme
-  valueStyle?: TextStyle
-  spotlight?: Partial<BarChartConfig["spotlight"]>
-}
-
-/** The bar chart's out-of-the-box look. */
-export const DEFAULT_BAR_CHART_THEME: BarChartConfig = {
-  seriesFills: DEFAULT_SERIES_FILLS,
-  bar: {
-    cornerRadius: 6,
-    slotFill: 0.72,
-    groupGap: 6,
-    stroke: [],
-    shadow: [],
-  },
-  // A category axis names its slots, so its captions are set like a caption
-  // rather than like a numeric marker: same size, less weight than the line
-  // chart's ticks, and centred on the slot.
-  xAxis: {
-    ...DEFAULT_X_AXIS,
-    labelStyle: { ...DEFAULT_X_AXIS.labelStyle, fontWeight: 600 },
-    tickPadding: 16,
-  },
-  yAxis: DEFAULT_Y_AXIS,
-  plotArea: DEFAULT_PLOT_AREA,
-  legend: DEFAULT_LEGEND,
-  valueStyle: {
-    fontSize: 24,
-    fontWeight: 700,
-    textAlign: "center",
-    fill: CHART_PALETTE.markerColor,
-  },
-  spotlight: { dimOpacity: SPOTLIGHT_DIM },
-}
-
-function resolveBarStyle(
-  bar: Partial<BarStyleConfig> | undefined,
-  previous: BarStyleConfig
-): BarStyleConfig {
-  return {
-    cornerRadius: bar?.cornerRadius ?? previous.cornerRadius,
-    slotFill: bar?.slotFill ?? previous.slotFill,
-    groupGap: bar?.groupGap ?? previous.groupGap,
-    stroke: strokeOps.resolve(bar?.stroke ?? previous.stroke),
-    shadow: shadowOps.resolve(bar?.shadow ?? previous.shadow),
-  }
+/** Black or white, whichever reads on `fill`: a figure printed inside a bar. */
+export function inkOn(fill: Fill): string {
+  const layers = fillOps.resolve(fill)
+  const top = layers[layers.length - 1]
+  if (top?.type !== "solid") return "white"
+  const [r, g, b] = top.color
+  const lift = (c: number) => (c <= 0.03928 ? c / 12.92 : ((c + 0.055) / 1.055) ** 2.4)
+  const luminance = 0.2126 * lift(r) + 0.7152 * lift(g) + 0.0722 * lift(b)
+  return luminance > 0.4 ? "#0a0a0a" : "white"
 }
 
-function lerpBarStyle(
-  from: BarStyleConfig,
-  to: BarStyleConfig,
-  t: number
-): BarStyleConfig {
-  return {
-    cornerRadius: lerpNumber(from.cornerRadius, to.cornerRadius, t),
-    slotFill: lerpNumber(from.slotFill, to.slotFill, t),
-    groupGap: lerpNumber(from.groupGap, to.groupGap, t),
-    stroke: strokeOps.lerp(
-      from.stroke as StrokeResolved[],
-      to.stroke as StrokeResolved[],
-      t
-    ),
-    shadow: shadowOps.lerp(
-      from.shadow as ShadowResolved[],
-      to.shadow as ShadowResolved[],
-      t
-    ),
-  }
-}
-
-/**
- * {@link BarChart}'s `theme` entry's resolve: merges the author's partial
- * {@link BarChartTheme} onto `previous` (falling back to
- * {@link DEFAULT_BAR_CHART_THEME} on first resolution), fully resolving every
- * leaf so the tween below always has resolved data to interpolate.
- */
-export function resolveBarChartTheme(
-  theme: BarChartTheme | undefined,
-  previous?: BarChartConfig
-): BarChartConfig {
-  const base = previous ?? DEFAULT_BAR_CHART_THEME
-  return {
-    seriesFills: resolveSeriesFills(theme?.seriesFills, base.seriesFills),
-    bar: resolveBarStyle(theme?.bar, base.bar),
-    xAxis: resolveAxisConfig(theme?.xAxis, base.xAxis),
-    yAxis: resolveAxisConfig(theme?.yAxis, base.yAxis),
-    plotArea: resolvePlotArea(theme?.plotArea, base.plotArea),
-    legend: resolveLegendConfig(theme?.legend, base.legend),
-    valueStyle: textOps.resolveStyle(theme?.valueStyle, base.valueStyle),
-    spotlight: {
-      dimOpacity: theme?.spotlight?.dimOpacity ?? base.spotlight.dimOpacity,
-    },
-  }
-}
-
-/** {@link BarChart}'s `theme` entry's lerp — leaf by leaf. */
-export function lerpBarChartTheme(
-  from: BarChartConfig,
-  to: BarChartConfig,
-  t: number
-): BarChartConfig {
-  return {
-    seriesFills: lerpSeriesFills(from.seriesFills, to.seriesFills, t),
-    bar: lerpBarStyle(from.bar, to.bar, t),
-    xAxis: lerpAxisConfig(from.xAxis, to.xAxis, t),
-    yAxis: lerpAxisConfig(from.yAxis, to.yAxis, t),
-    plotArea: lerpPlotArea(from.plotArea, to.plotArea, t),
-    legend: lerpLegendConfig(from.legend, to.legend, t),
-    valueStyle: textOps.lerpStyle(from.valueStyle, to.valueStyle, t),
-    spotlight: {
-      dimOpacity: lerpNumber(
-        from.spotlight.dimOpacity,
-        to.spotlight.dimOpacity,
-        t
-      ),
-    },
-  }
+/** A bar chart's own look: how round and how wide the bars are. */
+export const BAR_MARKS = {
+  /** Radius of each bar's far corners; a stacked segment inside the stack stays square. */
+  barRadius: Types.number(10, { min: 0, max: 64, step: 1, unit: "px" }),
+  /** How much of its category slot a bar group fills, the rest spacing the groups. */
+  barWidth: Types.number(0.7, { min: 0.05, max: 1, step: 0.05 }),
+  /** Space between the bars of one group, side by side. */
+  barGap: Types.number(6, { min: 0, max: 40, step: 1, unit: "px" }),
 }
 
-/** The paint series `index` is drawn in: its own override, else the palette's entry. */
-export function resolveBarFill(
-  palette: Fill[],
-  series: BarSeries,
-  index: number
-): Fill {
-  if (series.fill != null) return fillOps.resolve(series.fill)
-  if (palette.length === 0) return "white"
-  return palette[index % palette.length]
+export const BAR_LABELS = {
+  /** Read as the chart is built: each bar's value past its end, inside it, or none. */
+  values: Types.oneOf(["none", "end", "inside"] as const, { animatable: false }),
 }

package/src/engine.ts

@@ -1,28 +1,19 @@
 /**
- * The chart **kit**: everything the three charts share, and the one thing a
- * copied chart does not copy.
- *
- * A copy of the line chart takes `line-chart/*` into your project and rewrites its
- * reach for these to `@motionscript/charts`, so the plot panel, the value
- * axis, the legend and the number formatting stay a real dependency. That is
- * not a size decision — it is the only arrangement that works.
- *
- * A chart identifies its own parts by component identity (`VerticalAxis.is`).
- * Copy `VerticalAxis` alongside your fork and there are now two of it — two
- * components answering one name, and whichever one your chart did not get is
- * a part it never finds, with no error. Keeping the kit external makes that
- * impossible rather than unlikely.
- *
- * It also means a fix to the axis reaches a forked chart without a re-add,
- * which is the half of the bargain you get back for it.
+ * The chart kit: what the five charts share, and what a copied chart does not
+ * copy. A chart finds its parts by component identity (`VerticalAxis.is`), so a
+ * second copy of `VerticalAxis` would be a second component that the chart never
+ * finds, with no error. Copies import the kit from `@motionscript/charts`.
  */
 export * from "./kit/shared"
+export * from "./kit/style"
 export * from "./kit/cartesian"
-export * from "./kit/chart-border"
 export * from "./kit/chart-canvas"
+export * from "./kit/horizontal-axis"
 export * from "./kit/chart-legend"
 export * from "./kit/entries"
 export * from "./kit/motion"
 export * from "./kit/paints"
+export * from "./kit/pie-legend"
+export * from "./kit/polar"
 export * from "./kit/vertical-axis"
 export * from "@motionscript/sdk/component"

package/src/index.ts

@@ -1,5 +1,7 @@
 export * from "./line-chart";
 export * from "./bar-chart";
 export * from "./pie-chart";
+export * from "./radar-chart";
+export * from "./radial-chart";
 export * from "./engine";
 export { NODES } from "./nodes";