Skip to content

Reference ​

tsx
import { Chart, Heatmap, SeriesLegend, Sparkline, Timeline, createChart, useChart } from '@adecore/charts';

Parts ​

Chart.Root owns the data, the scales, the cursor and the keyboard. Each part inside it draws one layer, in the order of the children: the grid first, then bands, series and markers. Chart.Tooltip, Chart.Legend and Chart.Table take their own places whatever their order.

PartDraws
Chart.RootThe box. Its width follows the container; its height is fixed.
Chart.GridGridlines on the ticks of the value axis, or of the x axis, or both.
Chart.XAxis, Chart.YAxisTicks and labels. The y axis measures its widest label.
Chart.GroupAxisA second row of labels, one per group of columns.
Chart.Line, Chart.AreaA line, and a line with its area filled.
Chart.Bars, Chart.BarColumns, side by side or stacked.
Chart.PointA dot per value; on a scatter the points the cursor moves between.
Chart.FrontierA band through the points nothing beats on both axes.
Chart.EndLabelsA label at the end of each series of a scatter.
Chart.Marker, Chart.BandA moment and a range, named in the tooltip.
Chart.RuleA line at a value, such as a reference, above the series.
Chart.TooltipThe card at the cursor.
Chart.LegendThe series with their color.
Chart.TableA toggle that shows every value as a table.
Chart.LayerA group in the plot for a drawing of the app's own.
Chart.GroupCharts that share one cursor.

A timeline has parts of its own: Timeline.Root, Timeline.Legend, Timeline.Axis, Timeline.Moment and Timeline.Rows.

Other components ​

Component
HeatmapA grid of cells shaded by value, such as events by weekday and hour.
SparklineA small line or row of columns without axes, for a list row or a tile.
SeriesLegendA list of many series beside a chart, with search and toggles. It reports what is off; the app decides what hiding means.

Exports ​

Every name @adecore/charts exports, read from its source. Anything not listed is internal. The package has no other entry point and no stylesheet.

NameKindSource
ChartBandPropstypeannotations
ChartMarkerPropstypeannotations
ChartRulePropstypeannotations
ChartBucketGrouptypeaxes
ChartGridPropstypeaxes
ChartGroupAxisPropstypeaxes
ChartXAxisPropstypeaxes
ChartYAxisPropstypeaxes
createChartfunctioncreate-chart
TypedCharttypecreate-chart
HeatmapcomponentHeatmap
HeatmapAxisItemtypeHeatmap
HeatmapCelltypeHeatmap
HeatmapPropstypeHeatmap
ChartGroupPropstypelayer
ChartLayerPropstypelayer
CHARTS_NAMESPACEconstlocales
CHARTS_RESOURCESconstlocales
ChartBuckettypeoverlays
ChartBucketValuetypeoverlays
ChartLegendPropstypeoverlays
ChartTableDatatypeoverlays
ChartTablePropstypeoverlays
ChartTooltipPropstypeoverlays
ChartTooltipPlacementtypeoverlays
ChartRootPropstypeRoot
ChartEndLabelsPropstypescatter
ChartFrontierPropstypescatter
ChartPointSeriestypescatter
SeriesLegendcomponentSeriesLegend
SeriesLegendGrouptypeSeriesLegend
SeriesLegendItemtypeSeriesLegend
SeriesLegendPropstypeSeriesLegend
ChartAreaPropstypeseries
ChartBarPropstypeseries
ChartBarTonetypeseries
ChartBarsPropstypeseries
ChartLinePropstypeseries
ChartPointPropstypeseries
SparklinecomponentSparkline
SparklinePropstypeSparkline
TimelineAxisPropstypetimeline
TimelineLegendPropstypetimeline
TimelineMomentPropstypetimeline
TimelineRootPropstypetimeline
TimelineRowStatetypetimeline
TimelineRowsPropstypetimeline
durationTicksfunctiontimeline-layout
TimelineKindtypetimeline-layout
TimelineSpantypetimeline-layout
useCharthookuse-chart
ChartApitypeuse-chart
ChartAccessortypetypes
ChartColortypetypes
ChartCurvetypetypes
ChartMargintypetypes
ChartNotetypetypes
ChartRecttypetypes
ChartRowstypetypes
ChartTonetypetypes
ChartXtypetypes
ChartXInputtypetypes
ChartXOptionstypetypes
ChartXScaletypetypes
ChartYOptionstypetypes
ChartYScaletypetypes
Chartnamespaceindex.parts
Timelinenamespacetimeline.parts

Licenses and third-party notices are listed in each package.