Skip to content
silverpoint
Documentation menu

Charts · Distributions & comparisons

RidgelineChart

A kernel density per group on overlapping baselines. Family: Distributions & comparisons · chart 38 of 60.
Response time by serviceResponse time by service
Response time by service
servicenmedianpeak
Search60178.5182.41
Checkout60200.5138.06
Profile48120115.88
Reports36344.5308.09
Login248886.31
Response time by serviceResponse time by service
Response time by service
servicenmedianpeak
Search60178.5182.41
Checkout60200.5138.06
Profile48120115.88
Reports36344.5308.09
Login248886.31
mode="precision"
Response time by serviceResponse time by service
Response time by service
servicenmedianpeak
Search60178.5182.41
Checkout60200.5138.06
Profile48120115.88
Reports36344.5308.09
Login248886.31
substrate="green"
Response time by serviceResponse time by service
Response time by service
servicenmedianpeak
Search60178.5182.41
Checkout60200.5138.06
Profile48120115.88
Reports36344.5308.09
Login248886.31
ground="cyanotype"

Example

The chart above, in each framework. Pick a framework once and every example on the site follows it. `group_key` is required: one ridge per group.

shell
npm install @silverpoint/react @silverpoint/grounds @silverpoint/fonts
tsx
import '@silverpoint/fonts/fonts.css';
import '@silverpoint/grounds/styles.css';
import { RidgelineChart } from '@silverpoint/react/ridgeline-chart';

const data = [
  { service: 'Search', ms: 220 },
  { service: 'Search', ms: 177 },
  { service: 'Search', ms: 158 },
  { service: 'Search', ms: 199 },
  { service: 'Search', ms: 171 },
  { service: 'Search', ms: 138 },
  { service: 'Search', ms: 186 },
  { service: 'Search', ms: 207 },
  { service: 'Search', ms: 181 },
  { service: 'Search', ms: 187 },
  { service: 'Search', ms: 176 },
  { service: 'Search', ms: 187 },
  // … 216 more rows of the same shape
];

export default function App() {
  return (
    <div style={{ width: 480 }}>
      <RidgelineChart
        data={data}
        valueKey="ms"
        groupKey="service"
        title="Response time by service"
        unit="ms"
      />
    </div>
  );
}

Import

Each chart has its own subpath, so a bundle only carries the charts it uses. Every adapter also exports every chart from its barrel.

FrameworkImport
Reactimport { RidgelineChart } from '@silverpoint/react/ridgeline-chart';
Vueimport { SpRidgelineChart } from '@silverpoint/vue/ridgeline-chart';
Angularimport { SpRidgelineChart } from '@silverpoint/angular/ridgeline-chart'; // <sp-ridgeline-chart>
Reflexfrom reflex_silverpoint_react import ridgeline_chart

Props

The props RidgelineChart adds to the ones every chart takes. Accessor props (…Key, keys, names) name fields of your rows and are ignored without data.

React / AngularVueReflexTypeDescription
valueKeyvalue-keyvalue_keyAccessor<number | null | undefined>—
groupKeygroup-keygroup_keyAccessor<string | null | undefined>The group of an observation; one ridge per group.
bandwidthbandwidthbandwidthnumberKernel bandwidth in data units, shared by every group; Silverman's rule by default.
overlapoverlapoverlapnumberHow far a ridge reaches into the one behind it, 0-1; 0.5 by default.

Common props

Every chart also takes these. Framework conventions: camelCase in React and Angular, kebab-case in Vue templates, snake_case in Reflex. Read more about them.

Show the 22 common props
React / AngularVueReflexTypeDescription
datadatadatareadonly Datum[]Rows to draw. If omitted, the demo dataset is rendered (REQ-093) and the accessor props (…_key, keys, names) are ignored.
groundgroundgroundGroundRefStyle ground: silverpoint or cyanotype, or a ground object. Defaults to the app provider's, or silverpoint.
substratesubstratesubstrateSubstrateNamePrepared substrate within the ground (REQ-046).
modemodemodeInkModeink by default; precision disables inking (REQ-021).
seedseedseedSeedSeed. If omitted, it is derived from id stably (REQ-003).
idididstringStable identifier. If omitted, it is generated deterministically.
heightheightheightnumberHeight of the drawing area in px. Width is the container's unless pinned.
widthwidthwidthnumber—
chromechromechrome'card' | 'bare'card draws the full frame; bare only the drawing area (REQ-095).
hatchFillhatch-fillhatch_fill'tile' | 'per-shape'How areas are filled (REQ-029).
titletitletitlestring—
badgebadgebadgestring—
valuevaluevaluestring | number—
unitunitunitstring—
footerLeftfooter-leftfooter_leftstring—
footerRightfooter-rightfooter_rightstring—
labellabellabelstringAccessible name. If omitted, it is derived from title (REQ-120).
descriptiondescriptiondescriptionstringLong description for screen readers (REQ-120).
dataTabledata-tabledata_table'visible' | 'hidden' | 'none'Tabular alternative; hidden leaves it for assistive technology only (REQ-121).
localelocalelocalestring—
numberFormatnumber-formatnumber_formatIntl.NumberFormatOptions—
classNameclass-nameclass_namestring—

Events

Pointer and keyboard exploration are built in. The item under the pointer or focus is reported, and a click, Enter or Space selects it. The item is { seriesKey, index, datum, value, point: { x, y } }.

FrameworkActive itemSelectionCustom readout
ReactonActiveChangeonSelecttooltip={(item, readout) => …}
Vue@active-change@select<template #tooltip>
Angular(activeChange)(select)<ng-template spTooltip>
Reflexon_active_changeon_selecttooltip=tooltip_template(…)
Interaction and readouts →
Report it
Found something wrong with RidgelineChart? Open an issue on GitHub — the form comes pre-filled with the chart and the version.