Skip to content
silverpoint
Documentation menu

Charts · Lines

KpiCard

A metric, its delta, and an area sparkline of the series. Family: Lines · chart 4 of 60.
OrdersOrders
Orders
pointvalue
1118
2124
3121
4132
5140
6136
7129
8142
9151
10147
11155
12162
13158
14171
OrdersOrders
Orders
pointvalue
1118
2124
3121
4132
5140
6136
7129
8142
9151
10147
11155
12162
13158
14171
mode="precision"
OrdersOrders
Orders
pointvalue
1118
2124
3121
4132
5140
6136
7129
8142
9151
10147
11155
12162
13158
14171
substrate="green"
OrdersOrders
Orders
pointvalue
1118
2124
3121
4132
5140
6136
7129
8142
9151
10147
11155
12162
13158
14171
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 { KpiCard } from '@silverpoint/react/kpi-card';

const data = [
  { value: 118 },
  { value: 124 },
  { value: 121 },
  { value: 132 },
  { value: 140 },
  { value: 136 },
  { value: 129 },
  { value: 142 },
  { value: 151 },
  { value: 147 },
  { value: 155 },
  { value: 162 },
  // … 2 more rows of the same shape
];

export default function App() {
  return (
    <div style={{ width: 480 }}>
      <KpiCard
        data={data}
        valueKey="value"
        title="Orders"
        metric="orders per day"
        delta={8.2}
      />
    </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 { KpiCard } from '@silverpoint/react/kpi-card';
Vueimport { SpKpiCard } from '@silverpoint/vue/kpi-card';
Angularimport { SpKpiCard } from '@silverpoint/angular/kpi-card'; // <sp-kpi-card>
Reflexfrom reflex_silverpoint_react import kpi_card

Props

The props KpiCard 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>—
metricmetricmetricstringThe metric's name, printed under the figure.
deltadeltadeltanumberSigned change, printed with its sign and a direction mark.
deltaTonedelta-tonedelta_tone'up' | 'down' | 'flat'Direction of the mark; from the sign of delta 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 KpiCard? Open an issue on GitHub — the form comes pre-filled with the chart and the version.