ggsvelte
GitHub
Navigate
On this page

GuideNone

Suppress the guide for one aesthetic entirely. Valid on every channel; useful to hide size or shape legends while keeping the mapping.

Channels

Bind this guide with the shell channel prop (or the matching key under guides in JSON). Only these aesthetics validate:

  • x
  • y
  • color
  • fill
  • size
  • linewidth
  • alpha
  • shape
  • linetype

Suppress any aesthetic's guide while keeping the scale mapping. Common for hiding a size or shape legend.

Svelte component

import { GGPlot, GeomPoint, GuideNone } from "@ggsvelte/svelte";

<GGPlot data={rows} aes={{ x: "displ", y: "hwy", color: "class" }}>
  <GeomPoint />
  <GuideNone channel="x" />
</GGPlot>

JSON and helpers

import { guideNone, guides } from "@ggsvelte/spec";

guides({ x: guideNone() })
// → { guides: { x: { type: "none" } } }
{
  "guides": {
    "x": { "type": "none" }
  }
}

Helper: guideNone (alias guide_none). Schema type: NoneGuideSpec. Portable type: "none".

Props

Every shell takes a required channel prop (not part of the portable guide object — it is the key under guides). Options below map 1:1 to the guide JSON fields.

channel required

"x" | "y" | "color" | "fill" | "size" | "linewidth" | "alpha" | "shape" | "linetype"

Aesthetic this guide configures. Must be one of the channels listed above.

GuideNone has no option props beyond channel.

← All guides · Positions · Scales and guides

Docs