ggsvelte
GitHub
Navigate
On this page

ScaleColorGradientn

N-stop continuous color gradient from an ordered color list.

Defaults

helper
scaleColorGradientn
family
color-fill
aesthetic
color
scale type
sequential
options type
GradientnScaleOptions

Also exported as

  • ScaleColourGradientn

Svelte component

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

<GGPlot data={rows} aes={{ x: "x", y: "y", color: "group" }}>
  <ScaleColorGradientn />
  <GeomPoint />
</GGPlot>

JSON scales

{
  "scales": {
    "color": {
      "type": "sequential"
    }
  }
}

Params

domain

Array<DomainValue>

Explicit semantic domain. Manual/ordinal scales use ordered values; sequential/binned scales use [min, max].

breaks

Array<number | string>

Explicit semantic reference ticks for sequential colorbars or ordered boundaries for binned colorsteps.

reverse

boolean

Reverse the output color range. Default false.

transform

"identity" | "log10" | "sqrt"

Pre-training quantitative transform for sequential/binned color values. log10/sqrt require non-temporal values; ordinal, manual, and identity families do not accept a transform.

oob

"censor" | "squish"

Out-of-bounds policy for an explicit continuous/binned domain: "censor" (default) or "squish".

naValue

string

Color for null/missing values. Default9.

unknownValue

string

Color for invalid, out-of-domain, or unmapped values. Default9.

labels

string

Guide label format: numeric (".1f", ",d", ".0%") or temporal strftime-style text.

guide

GuideSpec

Guide presentation override (legend, colorbar, colorsteps, or none).

colours

string[]

Ordered #rgb/#rrggbb stops (British spelling alias of colors).

colors

string[]

Ordered #rgb/#rrggbb stops.

values

number[]

Optional stop positions in [0, 1] (or data units for some helpers).

Guide interaction

Colorbar guide by default for continuous ramps. Use guide helpers or guide: "none" to suppress.

Examples

← All scales · Palettes · Scales and guides

Docs