Charts · Flows
ChordRing
Directed flows between categories around a circle. Family: Flows · chart 22 of 60.
| flow | value |
|---|---|
| Home → Shop | 42 |
| Home → Blog | 28 |
| Blog → Shop | 16 |
| Shop → Cart | 35 |
| Cart → Shop | 12 |
| Blog → Home | 9 |
| Help → Cart | 7 |
| Shop → Help | 11 |
| flow | value |
|---|---|
| Home → Shop | 42 |
| Home → Blog | 28 |
| Blog → Shop | 16 |
| Shop → Cart | 35 |
| Cart → Shop | 12 |
| Blog → Home | 9 |
| Help → Cart | 7 |
| Shop → Help | 11 |
| flow | value |
|---|---|
| Home → Shop | 42 |
| Home → Blog | 28 |
| Blog → Shop | 16 |
| Shop → Cart | 35 |
| Cart → Shop | 12 |
| Blog → Home | 9 |
| Help → Cart | 7 |
| Shop → Help | 11 |
| flow | value |
|---|---|
| Home → Shop | 42 |
| Home → Blog | 28 |
| Blog → Shop | 16 |
| Shop → Cart | 35 |
| Cart → Shop | 12 |
| Blog → Home | 9 |
| Help → Cart | 7 |
| Shop → Help | 11 |
Example
The chart above, in each framework. Pick a framework once and every example on the site follows it.
npm install @silverpoint/react @silverpoint/grounds @silverpoint/fontsimport '@silverpoint/fonts/fonts.css';
import '@silverpoint/grounds/styles.css';
import { ChordRing } from '@silverpoint/react/chord-ring';
const data = [
{ source: 'Home', target: 'Shop', value: 42 },
{ source: 'Home', target: 'Blog', value: 28 },
{ source: 'Blog', target: 'Shop', value: 16 },
{ source: 'Shop', target: 'Cart', value: 35 },
{ source: 'Cart', target: 'Shop', value: 12 },
{ source: 'Blog', target: 'Home', value: 9 },
{ source: 'Help', target: 'Cart', value: 7 },
{ source: 'Shop', target: 'Help', value: 11 },
];
export default function App() {
return (
<div style={{ width: 480 }}>
<ChordRing
data={data}
sourceKey="source"
targetKey="target"
valueKey="value"
title="Navigation between sections"
/>
</div>
);
}npm install @silverpoint/vue @silverpoint/grounds @silverpoint/fonts<script setup lang="ts">
import '@silverpoint/fonts/fonts.css';
import '@silverpoint/grounds/styles.css';
import { SpChordRing } from '@silverpoint/vue/chord-ring';
const data = [
{ source: 'Home', target: 'Shop', value: 42 },
{ source: 'Home', target: 'Blog', value: 28 },
{ source: 'Blog', target: 'Shop', value: 16 },
{ source: 'Shop', target: 'Cart', value: 35 },
{ source: 'Cart', target: 'Shop', value: 12 },
{ source: 'Blog', target: 'Home', value: 9 },
{ source: 'Help', target: 'Cart', value: 7 },
{ source: 'Shop', target: 'Help', value: 11 },
];
</script>
<template>
<div style="width: 480px">
<SpChordRing
:data="data"
source-key="source"
target-key="target"
value-key="value"
title="Navigation between sections"
/>
</div>
</template>npm install @silverpoint/angular @silverpoint/grounds @silverpoint/fonts// src/styles.css:
// @import '@silverpoint/fonts/fonts.css';
// @import '@silverpoint/grounds/styles.css';
import { Component } from '@angular/core';
import { SpChordRing } from '@silverpoint/angular/chord-ring';
@Component({
selector: 'app-root',
imports: [SpChordRing],
template: `
<div style="width: 480px">
<sp-chord-ring
[data]="data"
sourceKey="source"
targetKey="target"
valueKey="value"
title="Navigation between sections"
/>
</div>
`,
})
export class App {
protected readonly data = [
{ source: 'Home', target: 'Shop', value: 42 },
{ source: 'Home', target: 'Blog', value: 28 },
{ source: 'Blog', target: 'Shop', value: 16 },
{ source: 'Shop', target: 'Cart', value: 35 },
{ source: 'Cart', target: 'Shop', value: 12 },
{ source: 'Blog', target: 'Home', value: 9 },
{ source: 'Help', target: 'Cart', value: 7 },
{ source: 'Shop', target: 'Help', value: 11 },
];
}pip install reflex-silverpoint-reactimport reflex as rx
from reflex_silverpoint_react import chord_ring
DATA = [
{"source": "Home", "target": "Shop", "value": 42},
{"source": "Home", "target": "Blog", "value": 28},
{"source": "Blog", "target": "Shop", "value": 16},
{"source": "Shop", "target": "Cart", "value": 35},
{"source": "Cart", "target": "Shop", "value": 12},
{"source": "Blog", "target": "Home", "value": 9},
{"source": "Help", "target": "Cart", "value": 7},
{"source": "Shop", "target": "Help", "value": 11},
]
def index() -> rx.Component:
return rx.box(
chord_ring(
data=DATA,
source_key="source",
target_key="target",
value_key="value",
title="Navigation between sections",
),
width="480px",
)
app = rx.App()
app.add_page(index)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.
| Framework | Import |
|---|---|
| React | import { ChordRing } from '@silverpoint/react/chord-ring'; |
| Vue | import { SpChordRing } from '@silverpoint/vue/chord-ring'; |
| Angular | import { SpChordRing } from '@silverpoint/angular/chord-ring'; // <sp-chord-ring> |
| Reflex | from reflex_silverpoint_react import chord_ring |
Props
The props ChordRing adds to the ones every chart takes. Accessor props (…Key, keys, names) name fields of your rows and are ignored without data.
| React / Angular | Vue | Reflex | Type | Description |
|---|---|---|---|---|
sourceKey | source-key | source_key | Accessor<string | number> | — |
targetKey | target-key | target_key | Accessor<string | number> | — |
valueKey | value-key | value_key | Accessor<number | null | undefined> | — |
maxCategories | max-categories | max_categories | number | Categories drawn; past it the smallest merge into "Other" (SP010). 12 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 / Angular | Vue | Reflex | Type | Description |
|---|---|---|---|---|
data | data | data | readonly Datum[] | Rows to draw. If omitted, the demo dataset is rendered (REQ-093) and the accessor props (…_key, keys, names) are ignored. |
ground | ground | ground | GroundRef | Style ground: silverpoint or cyanotype, or a ground object. Defaults to the app provider's, or silverpoint. |
substrate | substrate | substrate | SubstrateName | Prepared substrate within the ground (REQ-046). |
mode | mode | mode | InkMode | ink by default; precision disables inking (REQ-021). |
seed | seed | seed | Seed | Seed. If omitted, it is derived from id stably (REQ-003). |
id | id | id | string | Stable identifier. If omitted, it is generated deterministically. |
height | height | height | number | Height of the drawing area in px. Width is the container's unless pinned. |
width | width | width | number | — |
chrome | chrome | chrome | 'card' | 'bare' | card draws the full frame; bare only the drawing area (REQ-095). |
hatchFill | hatch-fill | hatch_fill | 'tile' | 'per-shape' | How areas are filled (REQ-029). |
title | title | title | string | — |
badge | badge | badge | string | — |
value | value | value | string | number | — |
unit | unit | unit | string | — |
footerLeft | footer-left | footer_left | string | — |
footerRight | footer-right | footer_right | string | — |
label | label | label | string | Accessible name. If omitted, it is derived from title (REQ-120). |
description | description | description | string | Long description for screen readers (REQ-120). |
dataTable | data-table | data_table | 'visible' | 'hidden' | 'none' | Tabular alternative; hidden leaves it for assistive technology only (REQ-121). |
locale | locale | locale | string | — |
numberFormat | number-format | number_format | Intl.NumberFormatOptions | — |
className | class-name | class_name | string | — |
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 } }.
| Framework | Active item | Selection | Custom readout |
|---|---|---|---|
| React | onActiveChange | onSelect | tooltip={(item, readout) => …} |
| Vue | @active-change | @select | <template #tooltip> |
| Angular | (activeChange) | (select) | <ng-template spTooltip> |
| Reflex | on_active_change | on_select | tooltip=tooltip_template(…) |
Report it
Found something wrong with ChordRing? Open an issue on GitHub — the form comes pre-filled with the chart and the version.