Shared Configuration Options
These are the top-level properties available on every RadiantChartOptions object, shared across all chart types. Options marked Pro require a Pro license.
Data
| Property ↑ | Type | Default | Required | Description |
|---|---|---|---|---|
dataCore | object[] | — | Yes | Array of data objects powering the chart. |
seriesCore | SeriesOptions[] | — | Yes | One or more series configurations. |
dataCoreArray of data objects powering the chart.
Type:
object[]Default: —seriesCoreOne or more series configurations.
Type:
SeriesOptions[]Default: —Title & Subtitle
| Property ↑ | Type | Default | Required | Description |
|---|---|---|---|---|
subtitleCore | { text, fontSize?, fill? } | — | No | Subtitle below the title. |
titleCore | { text, fontSize?, fill? } | — | No | Main chart title. |
subtitleCoreSubtitle below the title.
Type:
{ text, fontSize?, fill? }Default: —titleCoreMain chart title.
Type:
{ text, fontSize?, fill? }Default: —Legend
| Property ↑ | Type | Default | Required | Description |
|---|---|---|---|---|
legendCore | { enabled, position, type, listeners } | { enabled: false } | No | Legend configuration. |
legendCoreLegend configuration.
Type:
{ enabled, position, type, listeners }Default: { enabled: false }Axes
| Property ↑ | Type | Default | Required | Description |
|---|---|---|---|---|
axesPro | AxisConfig[] | — | No | Multi-axis definitions. |
showXAxisCore | boolean | true | No | Show or hide the x-axis. |
showYAxisCore | boolean | true | No | Show or hide the left y-axis. |
showYAxisRightCore | boolean | false | No | Show a right-side y-axis. |
axesProMulti-axis definitions.
Type:
AxisConfig[]Default: —showXAxisCoreShow or hide the x-axis.
Type:
booleanDefault: trueshowYAxisCoreShow or hide the left y-axis.
Type:
booleanDefault: trueshowYAxisRightCoreShow a right-side y-axis.
Type:
booleanDefault: falseAnimation
| Property ↑ | Type | Default | Required | Description |
|---|---|---|---|---|
animationCore | { enabled, duration, type } | { enabled: true, duration: 600 } | No | Global animation settings. |
animationCoreGlobal animation settings.
Type:
{ enabled, duration, type }Default: { enabled: true, duration: 600 }Padding
| Property ↑ | Type | Default | Required | Description |
|---|---|---|---|---|
paddingCore | { top, right, bottom, left, inner } | { top: 20, right: 20, bottom: 20, left: 20 } | No | Chart padding in pixels. |
paddingCoreChart padding in pixels.
Type:
{ top, right, bottom, left, inner }Default: { top: 20, right: 20, bottom: 20, left: 20 }Crosshair & Tooltip
| Property ↑ | Type | Default | Required | Description |
|---|---|---|---|---|
crosshairCore | { x?: boolean, y?: boolean } | — | No | Crosshair lines on hover. |
tooltipCore | { enabled, mode, sticky, snap, crosshair, renderer } | { enabled: true } | No | Tooltip configuration. |
crosshairCoreCrosshair lines on hover.
Type:
{ x?: boolean, y?: boolean }Default: —tooltipCoreTooltip configuration.
Type:
{ enabled, mode, sticky, snap, crosshair, renderer }Default: { enabled: true }Toolbar & Listeners
| Property ↑ | Type | Default | Required | Description |
|---|---|---|---|---|
listenersCore | { nodeClick, nodeDoubleClick } | — | No | Data-point interaction callbacks. |
onFocusChangeCore | (index: number | null) => void | — | No | Keyboard focus callback. |
toolbarCore | { showExport?: boolean } | — | No | Toolbar with export button. |
listenersCoreData-point interaction callbacks.
Type:
{ nodeClick, nodeDoubleClick }Default: —onFocusChangeCoreKeyboard focus callback.
Type:
(index: number | null) => voidDefault: —toolbarCoreToolbar with export button.
Type:
{ showExport?: boolean }Default: —Theme
| Property ↑ | Type | Default | Required | Description |
|---|---|---|---|---|
themeCore | 'light' | 'dark' | 'system' | 'light' | No | Colour theme for the chart. |
themeCoreColour theme for the chart.
Type:
'light' | 'dark' | 'system'Default: 'light'Rendering & Performance
| Property ↑ | Type | Default | Required | Description |
|---|---|---|---|---|
modePro | 'canvas' | 'webgl' | 'webgpu' | 'canvas' | No | Rendering pipeline. |
modeProRendering pipeline.
Type:
'canvas' | 'webgl' | 'webgpu'Default: 'canvas'Annotations & Facets
| Property ↑ | Type | Default | Required | Description |
|---|---|---|---|---|
annotationsPro | Annotation[] | — | No | Overlay annotations (lines, bands, labels). |
facetKeyPro | string | — | No | Key to split chart into small multiples. |
annotationsProOverlay annotations (lines, bands, labels).
Type:
Annotation[]Default: —facetKeyProKey to split chart into small multiples.
Type:
stringDefault: —Colour Scale
| Property ↑ | Type | Default | Required | Description |
|---|---|---|---|---|
colorScalePro | { scheme, min, max, colors } | — | No | Continuous colour scale for heatmaps. |
colorScaleProContinuous colour scale for heatmaps.
Type:
{ scheme, min, max, colors }Default: —Indicators
| Property ↑ | Type | Default | Required | Description |
|---|---|---|---|---|
indicatorsPro | { type, period, sourceKey, stroke }[] | — | No | Technical indicator overlays (SMA, EMA). |
indicatorsProTechnical indicator overlays (SMA, EMA).
Type:
{ type, period, sourceKey, stroke }[]Default: —Accessibility
| Property ↑ | Type | Default | Required | Description |
|---|---|---|---|---|
cameraPro | { position, target, fov } | — | No | 3D camera configuration. |
sonificationPro | boolean | { enabled, frequencyMin, frequencyMax, speed } | false | No | Audio data sonification. |
cameraPro3D camera configuration.
Type:
{ position, target, fov }Default: —sonificationProAudio data sonification.
Type:
boolean | { enabled, frequencyMin, frequencyMax, speed }Default: falseAll Options
Complete list of all shared configuration options.
| Property ↑ | Type | Default | Required | Description |
|---|---|---|---|---|
animationCore | { enabled, duration, type } | { enabled: true, duration: 600 } | No | Global animation settings. |
annotationsPro | Annotation[] | — | No | Overlay annotations (lines, bands, labels). |
axesPro | AxisConfig[] | — | No | Multi-axis definitions. |
cameraPro | { position, target, fov } | — | No | 3D camera configuration. |
colorScalePro | { scheme, min, max, colors } | — | No | Continuous colour scale for heatmaps. |
crosshairCore | { x?: boolean, y?: boolean } | — | No | Crosshair lines on hover. |
dataCore | object[] | — | Yes | Array of data objects powering the chart. |
facetKeyPro | string | — | No | Key to split chart into small multiples. |
indicatorsPro | { type, period, sourceKey, stroke }[] | — | No | Technical indicator overlays (SMA, EMA). |
legendCore | { enabled, position, type, listeners } | { enabled: false } | No | Legend configuration. |
listenersCore | { nodeClick, nodeDoubleClick } | — | No | Data-point interaction callbacks. |
modePro | 'canvas' | 'webgl' | 'webgpu' | 'canvas' | No | Rendering pipeline. |
navigatorPro | { enabled, height, mask, handles, onRangeChange } | — | No | Bottom-docked minimap navigator. |
onFocusChangeCore | (index: number | null) => void | — | No | Keyboard focus callback. |
paddingCore | { top, right, bottom, left, inner } | { top: 20, right: 20, bottom: 20, left: 20 } | No | Chart padding in pixels. |
seriesCore | SeriesOptions[] | — | Yes | One or more series configurations. |
showXAxisCore | boolean | true | No | Show or hide the x-axis. |
showYAxisCore | boolean | true | No | Show or hide the left y-axis. |
showYAxisRightCore | boolean | false | No | Show a right-side y-axis. |
sonificationPro | boolean | { enabled, frequencyMin, frequencyMax, speed } | false | No | Audio data sonification. |
subtitleCore | { text, fontSize?, fill? } | — | No | Subtitle below the title. |
themeCore | 'light' | 'dark' | 'system' | 'light' | No | Colour theme for the chart. |
titleCore | { text, fontSize?, fill? } | — | No | Main chart title. |
toolbarCore | { showExport?: boolean } | — | No | Toolbar with export button. |
tooltipCore | { enabled, mode, sticky, snap, crosshair, renderer } | { enabled: true } | No | Tooltip configuration. |
zoomPro | boolean | { enabled, modifierKey } | false | No | Pan and zoom behaviour. |
animationCoreGlobal animation settings.
Type:
{ enabled, duration, type }Default: { enabled: true, duration: 600 }annotationsProOverlay annotations (lines, bands, labels).
Type:
Annotation[]Default: —axesProMulti-axis definitions.
Type:
AxisConfig[]Default: —cameraPro3D camera configuration.
Type:
{ position, target, fov }Default: —colorScaleProContinuous colour scale for heatmaps.
Type:
{ scheme, min, max, colors }Default: —crosshairCoreCrosshair lines on hover.
Type:
{ x?: boolean, y?: boolean }Default: —dataCoreArray of data objects powering the chart.
Type:
object[]Default: —facetKeyProKey to split chart into small multiples.
Type:
stringDefault: —indicatorsProTechnical indicator overlays (SMA, EMA).
Type:
{ type, period, sourceKey, stroke }[]Default: —legendCoreLegend configuration.
Type:
{ enabled, position, type, listeners }Default: { enabled: false }listenersCoreData-point interaction callbacks.
Type:
{ nodeClick, nodeDoubleClick }Default: —modeProRendering pipeline.
Type:
'canvas' | 'webgl' | 'webgpu'Default: 'canvas'navigatorProBottom-docked minimap navigator.
Type:
{ enabled, height, mask, handles, onRangeChange }Default: —onFocusChangeCoreKeyboard focus callback.
Type:
(index: number | null) => voidDefault: —paddingCoreChart padding in pixels.
Type:
{ top, right, bottom, left, inner }Default: { top: 20, right: 20, bottom: 20, left: 20 }seriesCoreOne or more series configurations.
Type:
SeriesOptions[]Default: —showXAxisCoreShow or hide the x-axis.
Type:
booleanDefault: trueshowYAxisCoreShow or hide the left y-axis.
Type:
booleanDefault: trueshowYAxisRightCoreShow a right-side y-axis.
Type:
booleanDefault: falsesonificationProAudio data sonification.
Type:
boolean | { enabled, frequencyMin, frequencyMax, speed }Default: falsesubtitleCoreSubtitle below the title.
Type:
{ text, fontSize?, fill? }Default: —themeCoreColour theme for the chart.
Type:
'light' | 'dark' | 'system'Default: 'light'titleCoreMain chart title.
Type:
{ text, fontSize?, fill? }Default: —toolbarCoreToolbar with export button.
Type:
{ showExport?: boolean }Default: —tooltipCoreTooltip configuration.
Type:
{ enabled, mode, sticky, snap, crosshair, renderer }Default: { enabled: true }zoomProPan and zoom behaviour.
Type:
boolean | { enabled, modifierKey }Default: falseWas this article helpful?