Skip to content
silverpoint
Documentation menu

Charts · Radial

OrbitChart

Nested elliptical orbits with markers along them. Family: Radial · chart 33 of 60.
Seasonal peaksSeasonal peaks
Seasonal peaks
orbitperiodvalue
20230.0812
20230.3330
20230.6118
20230.924
20240.1220
20240.442
20240.6615
20240.8733
20250.0526
20250.2938
20250.5550
20250.8121
Seasonal peaksSeasonal peaks
Seasonal peaks
orbitperiodvalue
20230.0812
20230.3330
20230.6118
20230.924
20240.1220
20240.442
20240.6615
20240.8733
20250.0526
20250.2938
20250.5550
20250.8121
mode="precision"
Seasonal peaksSeasonal peaks
Seasonal peaks
orbitperiodvalue
20230.0812
20230.3330
20230.6118
20230.924
20240.1220
20240.442
20240.6615
20240.8733
20250.0526
20250.2938
20250.5550
20250.8121
substrate="green"
Seasonal peaksSeasonal peaks
Seasonal peaks
orbitperiodvalue
20230.0812
20230.3330
20230.6118
20230.924
20240.1220
20240.442
20240.6615
20240.8733
20250.0526
20250.2938
20250.5550
20250.8121
ground="cyanotype"

Example

The chart above, in each framework. Pick a framework once and every example on the site follows it.

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

const data = [
  { label: '2023', markers: [{ period: 0.08, value: 12 }, { period: 0.33, value: 30 }, { period: 0.61, value: 18 }, { period: 0.9, value: 24 }] },
  { label: '2024', markers: [{ period: 0.12, value: 20 }, { period: 0.4, value: 42 }, { period: 0.66, value: 15 }, { period: 0.87, value: 33 }] },
  { label: '2025', markers: [{ period: 0.05, value: 26 }, { period: 0.29, value: 38 }, { period: 0.55, value: 50 }, { period: 0.81, value: 21 }] },
];

export default function App() {
  return (
    <div style={{ width: 480 }}>
      <OrbitChart
        data={data}
        markerKey="markers"
        periodKey="period"
        title="Seasonal peaks"
      />
    </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 { OrbitChart } from '@silverpoint/react/orbit-chart';
Vueimport { SpOrbitChart } from '@silverpoint/vue/orbit-chart';
Angularimport { SpOrbitChart } from '@silverpoint/angular/orbit-chart'; // <sp-orbit-chart>
Reflexfrom reflex_silverpoint_react import orbit_chart

Props

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

React / AngularVueReflexTypeDescription
orbitsorbitsorbitsnumberOrbits shown, from the inside out; all by default.
markerKeymarker-keymarker_keyAccessor<readonly unknown[] | null | undefined>A row's markers; 'markers' by default.
periodKeyperiod-keyperiod_keyAccessor<number | null | undefined>A marker's period, 0-1 over the cycle; 'period' 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 OrbitChart? Open an issue on GitHub — the form comes pre-filled with the chart and the version.