Charts · Lines
SparklineRows
| name | readout |
|---|---|
| API | 99.9% |
| Queue | 17 |
| Cache | 84% |
| Search | 170 |
| name | readout |
|---|---|
| API | 99.9% |
| Queue | 17 |
| Cache | 84% |
| Search | 170 |
| name | readout |
|---|---|
| API | 99.9% |
| Queue | 17 |
| Cache | 84% |
| Search | 170 |
| name | readout |
|---|---|
| API | 99.9% |
| Queue | 17 |
| Cache | 84% |
| Search | 170 |
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 { SparklineRows } from '@silverpoint/react/sparkline-rows';
const data = [
{ name: 'API', readout: '99.9%', points: [98, 99, 99, 97, 99, 100, 99, 100] },
{ name: 'Queue', points: [12, 18, 15, 22, 19, 25, 21, 17] },
{ name: 'Cache', readout: '84%', points: [70, 72, 78, 75, 80, 83, 81, 84] },
{ name: 'Search', points: [240, 220, 260, 210, 190, 205, 180, 170] },
];
export default function App() {
return (
<div style={{ width: 480 }}>
<SparklineRows
data={data}
nameKey="name"
readoutKey="readout"
seriesKey="points"
title="Service health"
/>
</div>
);
}npm install @silverpoint/vue @silverpoint/grounds @silverpoint/fonts<script setup lang="ts">
import '@silverpoint/fonts/fonts.css';
import '@silverpoint/grounds/styles.css';
import { SpSparklineRows } from '@silverpoint/vue/sparkline-rows';
const data = [
{ name: 'API', readout: '99.9%', points: [98, 99, 99, 97, 99, 100, 99, 100] },
{ name: 'Queue', points: [12, 18, 15, 22, 19, 25, 21, 17] },
{ name: 'Cache', readout: '84%', points: [70, 72, 78, 75, 80, 83, 81, 84] },
{ name: 'Search', points: [240, 220, 260, 210, 190, 205, 180, 170] },
];
</script>
<template>
<div style="width: 480px">
<SpSparklineRows
:data="data"
name-key="name"
readout-key="readout"
series-key="points"
title="Service health"
/>
</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 { SpSparklineRows } from '@silverpoint/angular/sparkline-rows';
@Component({
selector: 'app-root',
imports: [SpSparklineRows],
template: `
<div style="width: 480px">
<sp-sparkline-rows
[data]="data"
nameKey="name"
readoutKey="readout"
seriesKey="points"
title="Service health"
/>
</div>
`,
})
export class App {
protected readonly data = [
{ name: 'API', readout: '99.9%', points: [98, 99, 99, 97, 99, 100, 99, 100] },
{ name: 'Queue', points: [12, 18, 15, 22, 19, 25, 21, 17] },
{ name: 'Cache', readout: '84%', points: [70, 72, 78, 75, 80, 83, 81, 84] },
{ name: 'Search', points: [240, 220, 260, 210, 190, 205, 180, 170] },
];
}pip install reflex-silverpoint-reactimport reflex as rx
from reflex_silverpoint_react import sparkline_rows
DATA = [
{"name": "API", "readout": "99.9%", "points": [98, 99, 99, 97, 99, 100, 99, 100]},
{"name": "Queue", "points": [12, 18, 15, 22, 19, 25, 21, 17]},
{"name": "Cache", "readout": "84%", "points": [70, 72, 78, 75, 80, 83, 81, 84]},
{"name": "Search", "points": [240, 220, 260, 210, 190, 205, 180, 170]},
]
def index() -> rx.Component:
return rx.box(
sparkline_rows(
data=DATA,
name_key="name",
readout_key="readout",
series_key="points",
title="Service health",
),
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 { SparklineRows } from '@silverpoint/react/sparkline-rows'; |
| Vue | import { SpSparklineRows } from '@silverpoint/vue/sparkline-rows'; |
| Angular | import { SpSparklineRows } from '@silverpoint/angular/sparkline-rows'; // <sp-sparkline-rows> |
| Reflex | from reflex_silverpoint_react import sparkline_rows |
Props
The props SparklineRows 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 |
|---|---|---|---|---|
rows | rows | rows | number | Rows shown, from the first; all by default. |
nameKey | name-key | name_key | Accessor<string> | — |
readoutKey | readout-key | readout_key | Accessor<string | number | null | undefined> | The printed readout; the last value of the series by default. |
seriesKey | series-key | series_key | Accessor<readonly unknown[] | null | undefined> | The row's points: an array. |
pointKey | point-key | point_key | Accessor<number | null | undefined> | The value of one point; the point itself when it is a number, else its value. |
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(…) |