@ggts-sh/spec 0.43.0

package/src/generated/guide-reference-data.ts

@@ -0,0 +1,284 @@
+/**
+ * AUTO-GENERATED by scripts/gen-reference-catalogs.ts — do not edit by hand.
+ * Regenerate: bun run reference:catalogs:gen
+ *
+ * GUIDE_REFERENCE — per-guide API docs.
+ */
+export const GUIDE_REFERENCE_DATA = {
+  legend: {
+    name: "legend",
+    slug: "legend",
+    component: "GuideLegend",
+    typeLiteral: "legend",
+    schemaType: "LegendGuideSpec",
+    helper: "guideLegend",
+    helperAlias: "guide_legend",
+    summary:
+      "Discrete legend for one non-position aesthetic: title, placement rank, position, direction, key size, and collision. Default guide for categorical color, fill, size, shape, and other style channels.",
+    channels: ["color", "fill", "size", "linewidth", "alpha", "shape", "linetype"],
+    params: [
+      {
+        name: "title",
+        description:
+          "Optional guide title string (max 256 characters). Omit to use the scale or labs title.",
+        typeSummary: "string",
+        required: false,
+      },
+      {
+        name: "order",
+        description:
+          "Integer placement rank among sibling guides (−1024…1024). Lower values sort earlier. Not the plot-wide Legend entry-sort enum.",
+        typeSummary: "integer",
+        required: false,
+      },
+      {
+        name: "position",
+        description:
+          'Guide placement relative to the panel: "auto", "right", or "bottom". Auto picks a side from available space.',
+        typeSummary: '"auto" | "right" | "bottom"',
+        required: false,
+      },
+      {
+        name: "direction",
+        description:
+          'Layout of keys or the color ramp: "auto", "vertical", or "horizontal". Bottom placement usually forces horizontal.',
+        typeSummary: '"auto" | "vertical" | "horizontal"',
+        required: false,
+      },
+      {
+        name: "keySize",
+        description: "Legend key glyph size in pixels (4…48).",
+        typeSummary: "number",
+        required: false,
+      },
+      {
+        name: "collision",
+        description:
+          "How long labels behave when they do not fit: ellipsis, wrap (legend only), preserve (axis), auto (axis), or error.",
+        typeSummary: '"ellipsis" | "wrap" | "error"',
+        required: false,
+      },
+      {
+        name: "force",
+        description:
+          "When true, keep this guide even if the scale would normally suppress it (for example a single-level discrete scale).",
+        typeSummary: "boolean",
+        required: false,
+      },
+      {
+        name: "theme",
+        description:
+          "Bounded presentation overrides for this guide block (title/label size, gaps, colorbar size).",
+        typeSummary: "GuideThemeSpec",
+        required: false,
+      },
+    ],
+  },
+  colorbar: {
+    name: "colorbar",
+    slug: "colorbar",
+    component: "GuideColorbar",
+    typeLiteral: "colorbar",
+    schemaType: "ColorbarGuideSpec",
+    helper: "guideColorbar",
+    helperAlias: "guide_colorbar",
+    summary:
+      "Continuous color ramp for sequential color or fill scales. Shows ticks and labels along a vertical or horizontal bar; incompatible with discrete legends and binned colorsteps.",
+    channels: ["color", "fill"],
+    params: [
+      {
+        name: "title",
+        description:
+          "Optional guide title string (max 256 characters). Omit to use the scale or labs title.",
+        typeSummary: "string",
+        required: false,
+      },
+      {
+        name: "order",
+        description:
+          "Integer placement rank among sibling guides (−1024…1024). Lower values sort earlier. Not the plot-wide Legend entry-sort enum.",
+        typeSummary: "integer",
+        required: false,
+      },
+      {
+        name: "position",
+        description:
+          'Guide placement relative to the panel: "auto", "right", or "bottom". Auto picks a side from available space.',
+        typeSummary: '"auto" | "right" | "bottom"',
+        required: false,
+      },
+      {
+        name: "direction",
+        description:
+          'Layout of keys or the color ramp: "auto", "vertical", or "horizontal". Bottom placement usually forces horizontal.',
+        typeSummary: '"auto" | "vertical" | "horizontal"',
+        required: false,
+      },
+      {
+        name: "showTicks",
+        description: "When false, hide tick marks on the axis or colorbar.",
+        typeSummary: "boolean",
+        required: false,
+      },
+      {
+        name: "showLabels",
+        description:
+          "When false, hide tick or step labels on the axis, colorbar, or colorsteps guide.",
+        typeSummary: "boolean",
+        required: false,
+      },
+      {
+        name: "collision",
+        description:
+          "How long labels behave when they do not fit: ellipsis, wrap (legend only), preserve (axis), auto (axis), or error.",
+        typeSummary: '"ellipsis" | "error"',
+        required: false,
+      },
+      {
+        name: "force",
+        description:
+          "When true, keep this guide even if the scale would normally suppress it (for example a single-level discrete scale).",
+        typeSummary: "boolean",
+        required: false,
+      },
+      {
+        name: "theme",
+        description:
+          "Bounded presentation overrides for this guide block (title/label size, gaps, colorbar size).",
+        typeSummary: "GuideThemeSpec",
+        required: false,
+      },
+    ],
+  },
+  colorsteps: {
+    name: "colorsteps",
+    slug: "colorsteps",
+    component: "GuideColorsteps",
+    typeLiteral: "colorsteps",
+    schemaType: "ColorstepsGuideSpec",
+    helper: "guideColorsteps",
+    helperAlias: "guide_colorsteps",
+    summary:
+      "Binned color legend for binned color or fill scales. Step blocks with optional labels; use instead of legend or colorbar when the scale type is binned.",
+    channels: ["color", "fill"],
+    params: [
+      {
+        name: "title",
+        description:
+          "Optional guide title string (max 256 characters). Omit to use the scale or labs title.",
+        typeSummary: "string",
+        required: false,
+      },
+      {
+        name: "order",
+        description:
+          "Integer placement rank among sibling guides (−1024…1024). Lower values sort earlier. Not the plot-wide Legend entry-sort enum.",
+        typeSummary: "integer",
+        required: false,
+      },
+      {
+        name: "position",
+        description:
+          'Guide placement relative to the panel: "auto", "right", or "bottom". Auto picks a side from available space.',
+        typeSummary: '"auto" | "right" | "bottom"',
+        required: false,
+      },
+      {
+        name: "direction",
+        description:
+          'Layout of keys or the color ramp: "auto", "vertical", or "horizontal". Bottom placement usually forces horizontal.',
+        typeSummary: '"auto" | "vertical" | "horizontal"',
+        required: false,
+      },
+      {
+        name: "showLabels",
+        description:
+          "When false, hide tick or step labels on the axis, colorbar, or colorsteps guide.",
+        typeSummary: "boolean",
+        required: false,
+      },
+      {
+        name: "collision",
+        description:
+          "How long labels behave when they do not fit: ellipsis, wrap (legend only), preserve (axis), auto (axis), or error.",
+        typeSummary: '"ellipsis" | "error"',
+        required: false,
+      },
+      {
+        name: "force",
+        description:
+          "When true, keep this guide even if the scale would normally suppress it (for example a single-level discrete scale).",
+        typeSummary: "boolean",
+        required: false,
+      },
+      {
+        name: "theme",
+        description:
+          "Bounded presentation overrides for this guide block (title/label size, gaps, colorbar size).",
+        typeSummary: "GuideThemeSpec",
+        required: false,
+      },
+    ],
+  },
+  axis: {
+    name: "axis",
+    slug: "axis",
+    component: "GuideAxis",
+    typeLiteral: "axis",
+    schemaType: "AxisGuideSpec",
+    helper: "guideAxis",
+    helperAlias: "guide_axis",
+    summary:
+      "Axis guide for positional aesthetics x and y: title, tick marks, labels, and collision. Not valid on color, fill, or other style channels.",
+    channels: ["x", "y"],
+    params: [
+      {
+        name: "title",
+        description:
+          "Optional guide title string (max 256 characters). Omit to use the scale or labs title.",
+        typeSummary: "string",
+        required: false,
+      },
+      {
+        name: "showTicks",
+        description: "When false, hide tick marks on the axis or colorbar.",
+        typeSummary: "boolean",
+        required: false,
+      },
+      {
+        name: "showLabels",
+        description:
+          "When false, hide tick or step labels on the axis, colorbar, or colorsteps guide.",
+        typeSummary: "boolean",
+        required: false,
+      },
+      {
+        name: "collision",
+        description:
+          "How long labels behave when they do not fit: ellipsis, wrap (legend only), preserve (axis), auto (axis), or error.",
+        typeSummary: '"auto" | "preserve" | "ellipsis"',
+        required: false,
+      },
+      {
+        name: "theme",
+        description:
+          "Bounded presentation overrides for this guide block (title/label size, gaps, colorbar size).",
+        typeSummary: "GuideThemeSpec",
+        required: false,
+      },
+    ],
+  },
+  none: {
+    name: "none",
+    slug: "none",
+    component: "GuideNone",
+    typeLiteral: "none",
+    schemaType: "NoneGuideSpec",
+    helper: "guideNone",
+    helperAlias: "guide_none",
+    summary:
+      "Suppress the guide for one aesthetic entirely. Valid on every channel; useful to hide size or shape legends while keeping the mapping.",
+    channels: ["x", "y", "color", "fill", "size", "linewidth", "alpha", "shape", "linetype"],
+    params: [],
+  },
+} as const;