Skip to content
silverpoint
Documentation menu

Charts · Radial

VolvelleChart

Concentric categorical rings read against one index. Family: Radial · chart 32 of 60.
Duty rotaDuty rota
Duty rota
ringsegmentunder the index
DayMonno
DayTueno
DayWedno
DayThuno
DayFrino
DaySatyes
DaySunno
ShiftEarlyno
ShiftLateno
ShiftNightyes
TeamAtlasno
TeamBorealisno
TeamCygnusno
TeamDracono
TeamEridanusyes
Duty rotaDuty rota
Duty rota
ringsegmentunder the index
DayMonno
DayTueno
DayWedno
DayThuno
DayFrino
DaySatyes
DaySunno
ShiftEarlyno
ShiftLateno
ShiftNightyes
TeamAtlasno
TeamBorealisno
TeamCygnusno
TeamDracono
TeamEridanusyes
mode="precision"
Duty rotaDuty rota
Duty rota
ringsegmentunder the index
DayMonno
DayTueno
DayWedno
DayThuno
DayFrino
DaySatyes
DaySunno
ShiftEarlyno
ShiftLateno
ShiftNightyes
TeamAtlasno
TeamBorealisno
TeamCygnusno
TeamDracono
TeamEridanusyes
substrate="green"
Duty rotaDuty rota
Duty rota
ringsegmentunder the index
DayMonno
DayTueno
DayWedno
DayThuno
DayFrino
DaySatyes
DaySunno
ShiftEarlyno
ShiftLateno
ShiftNightyes
TeamAtlasno
TeamBorealisno
TeamCygnusno
TeamDracono
TeamEridanusyes
ground="cyanotype"

Example

The chart above, in each framework. Pick a framework once and every example on the site follows it. Each row is a ring: a `label` and its `segments`, from the inside out.

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

const data = [
  { label: 'Day', segments: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun'] },
  { label: 'Shift', segments: ['Early', 'Late', 'Night'] },
  { label: 'Team', segments: ['Atlas', 'Borealis', 'Cygnus', 'Draco', 'Eridanus'] },
];

export default function App() {
  return (
    <div style={{ width: 480 }}>
      <VolvelleChart
        data={data}
        indexRing={1}
        indexValue="Night"
        title="Duty rota"
      />
    </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 { VolvelleChart } from '@silverpoint/react/volvelle-chart';
Vueimport { SpVolvelleChart } from '@silverpoint/vue/volvelle-chart';
Angularimport { SpVolvelleChart } from '@silverpoint/angular/volvelle-chart'; // <sp-volvelle-chart>
Reflexfrom reflex_silverpoint_react import volvelle_chart

Props

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

React / AngularVueReflexTypeDescription
ringsringsringsnumberRings shown, from the inside out; all by default.
indexRingindex-ringindex_ringnumberThe ring whose segment is brought under the index, 0-based; 0 by default.
indexValueindex-valueindex_valuestringThe segment of indexRing under the index; its first segment 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 VolvelleChart? Open an issue on GitHub — the form comes pre-filled with the chart and the version.