Skip to content
silverpoint
Documentation menu

Charts · Bars

PyramidChart

Stacked tiers whose width encodes the value (0-100). Family: Bars · chart 11 of 60.
HeadcountHeadcount
Headcount
labelwidth
Leads18
Managers42
Specialists70
Staff100
HeadcountHeadcount
Headcount
labelwidth
Leads18
Managers42
Specialists70
Staff100
mode="precision"
HeadcountHeadcount
Headcount
labelwidth
Leads18
Managers42
Specialists70
Staff100
substrate="green"
HeadcountHeadcount
Headcount
labelwidth
Leads18
Managers42
Specialists70
Staff100
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 { PyramidChart } from '@silverpoint/react/pyramid-chart';

const data = [
  { label: 'Leads', width: 18 },
  { label: 'Managers', width: 42 },
  { label: 'Specialists', width: 70 },
  { label: 'Staff', width: 100 },
];

export default function App() {
  return (
    <div style={{ width: 480 }}>
      <PyramidChart
        data={data}
        labelKey="label"
        widthKey="width"
        title="Headcount"
      />
    </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 { PyramidChart } from '@silverpoint/react/pyramid-chart';
Vueimport { SpPyramidChart } from '@silverpoint/vue/pyramid-chart';
Angularimport { SpPyramidChart } from '@silverpoint/angular/pyramid-chart'; // <sp-pyramid-chart>
Reflexfrom reflex_silverpoint_react import pyramid_chart

Props

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

React / AngularVueReflexTypeDescription
labelKeylabel-keylabel_keyAccessor<string>—
widthKeywidth-keywidth_keyAccessor<number | null | undefined>—
toneKeytone-keytone_keyAccessor<number | null | undefined>—

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 PyramidChart? Open an issue on GitHub — the form comes pre-filled with the chart and the version.