Chart API Reference

Public props and slots for Typlog chart adapters.
alpha

ChartRoot ​

PropDefaultType
config
–
ChartConfig

Series metadata used by ChartLegend and ChartTooltip.

ChartRoot exposes a scoped default slot, { mounted }, which is false during SSR and the initial render and becomes true after mount. Render client-only Unovis containers with v-if="mounted" inside this slot. Standard DOM and ARIA attributes are forwarded to the root primitive.

ChartLegend ​

PropDefaultType
align"start"
"start""center""end"

Alignment of legend entries within the legend.

ariaLabel"Chart legend"
string

Accessible name for the legend list.

orientation"horizontal"
"vertical""horizontal"

Layout direction for legend entries.

ChartTooltip ​

PropDefaultType
contentComponentChartTooltipContent
Component

Vue component rendered as the tooltip content.

contentProps{}
Record<string, unknown>

Props passed to contentComponent in addition to payload, config, and x.

targets
–
ChartTooltipTarget[]

Unovis primitives that should automatically trigger the themed tooltip.

ChartTooltip can generate Unovis triggers from targets. Supported primitives are Donut, GroupedBar, and StackedBar; pass a descriptor with primitive and an optional payload mapper when the default data mapping is not enough. Explicit triggers override generated triggers for the same selector.

ChartCrosshair ​

PropDefaultType
contentComponentChartTooltipContent
Component

Vue component rendered as the crosshair tooltip content.

contentProps{}
Record<string, unknown>

Props passed to contentComponent in addition to payload, config, and x.

ChartTooltipContent ​

PropDefaultType
config{}
ChartConfig

Series metadata. Passed automatically by createChartTooltipTemplate.

hideIndicator
–
boolean

Hides series indicators without removing icons.

hideLabel
–
boolean

Hides the tooltip label.

indicator"dot"
ChartTooltipIndicator

Indicator displayed beside each series.

labelFormatter
–
((value: stringnumberDate) => string)

Formats the final tooltip label. Priority: hideLabel, labelKey, role-x field, crosshair x.

labelKey
–
string

Uses a payload or config key instead of the role-x value or crosshair x.

payload{}
Record<string, unknown>

Values keyed by the matching ChartConfig series key.

valueFormatter
–
((value: unknown, key: string) => string)

Formats a series value.

x
–
stringnumberDate

Domain value displayed as the tooltip label.

Last updated Sep 6, 2026
States