Configuration

A chart is fully described by a single ChartOptions object — it is serializable, type-safe, and works identically in Charts.create and chart.update.

A minimal working example:

import { Charts } from 'grafit-charts';

const chart = Charts.create({
  container: document.getElementById('app')!, // where to render
  data: [
    { month: 'Jan', plan: 120, fact: 134 },
    { month: 'Feb', plan: 125, fact: 118 },
  ],
  series: [
    { type: 'bar', xField: 'month', yField: 'plan', name: 'Plan' },
    { type: 'line', xField: 'month', yField: 'fact', name: 'Actual' },
  ],
});

That is all you need: axes, legend, tooltips, highlighting and the entry animation are enabled by default.

Data and series

data is an array of flat objects. Series contain no data of their own — they reference fields via xField/yField (specialized series have their own fields: angleField, sizeField, openField…).

series is a discriminated union on the type field: after type: 'bar', TypeScript suggests only bar options and won't let you pass options that belong to other series. All 27 series types are listed in the “Series” section; their shared options are on the Common series options page.

Axes

If axes are not specified, the widget creates them itself: category at the bottom + number on the left (the other way around for horizontal bars; scatter/histogram request a numeric X axis; heatmap gets categorical axes with no lines or grid). An explicit axes block is needed when you want a different axis type, label formatting, crossLines, etc. — see Axes.

axes: [
  { type: 'time', position: 'bottom', label: { format: '%d %b' } },
  { type: 'number', position: 'left', nice: true },
],

A second value axis on the opposite side gets its own scale; keys on each axis says which series it carries — see Two value axes.

A polar chart — radar, rose, radial bars — has two axes rather than a list of them, so it reads axes as a pair: angle for the categories around the rim and radius for the value rings.

axes: {
  angle: { title: { text: 'Month' } },
  radius: { min: 0, max: 60, ringCount: 3 },
},

See Polar axes.

Size

Without width/height the chart tracks its container via ResizeObserver — size the container with CSS. Numeric width/height fix the size.

Titles, padding, background

Option	Type	Default	Description
title.text	string	—	chart title
title.textAlign	'left' | 'center' | 'right'	'center'	horizontal alignment
title.fontSize	Pixels	17	title font size
title.color	ColorValue	foreground	color
title.position	'top' | 'bottom'	'top'	above or below the plot
title.padding	PaddingValue	8 below the title	padding around the title text; by default only the plot-facing side
title.wrap	boolean	true	break long text onto several lines
subtitle.text	string	—	subtitle (muted, same options)
subtitle.padding	PaddingValue	8 below the subtitle	padding around the subtitle text
padding	PaddingValue	{ top: 12, right: 20, bottom: 12, left: 20 }	outer chart padding: 12, [12, 20], [12, 20, 12, 20] or { top, right, bottom, left }
background.fill	ColorValue	theme background	backdrop fill
background.visible	boolean	true	whether to draw the background

All caption options with live examples: Title and subtitle.

Overlays and loading

Option	Type	Default	Description
loading	boolean	false	show the “Loading data…” overlay
overlays.loading.text	string	from locale	loading overlay text
overlays.noData.text	string	from locale	text shown when data is empty
overlays.error.text	string	from locale	text shown when nothing could be drawn

A series handed scales its marks cannot be drawn on — bars against a value axis of categories, a time axis whose values are no dates — is left out rather than taken as an error: the chart draws everything else, states the reason once in the console, and shows the error overlay only when nothing was drawn at all. A render is called from the animation tick and from a ResizeObserver, where a throw would be an unhandled error every frame, so it never throws.

Conventions

• *Field / *Name — “data key / display name” pairs: *Field points to a field in data, *Name is shown in the legend and the tooltip.
• { enabled } — every optional block (legend, tooltip, axis.label, series.marker, …) is toggled with this flag; a block without enabled: false is enabled.
• format / formatter — value formatting as a string (',.2f', '.0%', '%d %b') or as a function; functions are isolated leaves — the rest of the object is JSON-serializable.
• Mutations of the object you passed in are not tracked — update the chart via its methods.

Updating and instance methods

await chart.updateDelta({ theme: 'dark' }); // targeted change
await chart.update(buildOptions(newData)); // full replacement

Method	Description
update(options)	full options replacement; the Promise resolves after rendering
updateDelta(patch)	deep merge: objects are merged, arrays are replaced as a whole
getOptions()	current options
getState() / setState(state)	zoom and hidden series — see State
waitForUpdate()	wait for a scheduled render (and for pending web fonts)
showTooltip / clickNode / setSelection / zoomTo / …	drive the interactions from code — see Programmatic control
getImageDataURL(opts?)	PNG/JPEG as a data URL
download(opts?)	download an image ({ fileName?, fileFormat? })
destroy()	release the DOM and subscriptions

All root-level blocks

Block	What it does	Read more
container, data, series, axes	chart foundation	above on this page
width, height	fixed size	Size
title, subtitle	titles	Titles
padding, background	padding and background	Titles
loading, overlays	overlays	Overlays
theme	theme name or object	Themes
fonts	redraw once a web font has loaded	Themes
legend	legend	Legend
gradientLegend	color scale for colorField series	Heatmap
tooltip	tooltips (modes, position, snapping)	Tooltip
highlight	hover highlighting and dimming	Tooltip
crosshair	crosshair	Crosshair
zoom, navigator	zoom and range bar	Zoom
sync	synchronizing multiple charts	State
selection	data selection	Data selection
listeners	chart events	Events
annotations	lines/ranges/text on the chart	Annotations
animation	entry and updates	State
initialState	initial zoom/hidden series	State
contextMenu	right-click menu	State
locale	UI strings	Accessibility