Skip to main content

Interface: ChartUtilities

Defined in: shared/types/chartHybrid.ts:199

Type-safe chart utility functions interface.

Remarks​

Interface for utility functions that work with both official Chart.js types and our custom business logic types.

Properties​

getPluginConfig()​

getPluginConfig: (options: _DeepPartialObject<CoreChartOptions<keyof ChartTypeRegistry> & ElementChartOptions<keyof ChartTypeRegistry> & PluginChartOptions<keyof ChartTypeRegistry> & DatasetChartOptions<keyof ChartTypeRegistry> & ScaleChartOptions<keyof ChartTypeRegistry>> | UptimeChartOptions, pluginId: string) => ChartLegendConfig | ChartTitleConfig | ChartTooltipConfig | undefined

Defined in: shared/types/chartHybrid.ts:208

Safely get plugin configuration from chart options.

Parameters​

options​

Chart options (hybrid or official)

_DeepPartialObject<CoreChartOptions<keyof ChartTypeRegistry> & ElementChartOptions<keyof ChartTypeRegistry> & PluginChartOptions<keyof ChartTypeRegistry> & DatasetChartOptions<keyof ChartTypeRegistry> & ScaleChartOptions<keyof ChartTypeRegistry>> | UptimeChartOptions

pluginId​

string

Plugin identifier

Returns​

ChartLegendConfig | ChartTitleConfig | ChartTooltipConfig | undefined

The plugin configuration when available; otherwise undefined.

getScaleConfig()​

getScaleConfig: (options: _DeepPartialObject<CoreChartOptions<keyof ChartTypeRegistry> & ElementChartOptions<keyof ChartTypeRegistry> & PluginChartOptions<keyof ChartTypeRegistry> & DatasetChartOptions<keyof ChartTypeRegistry> & ScaleChartOptions<keyof ChartTypeRegistry>> | UptimeChartOptions, scaleId: string) => ChartScaleConfig | undefined

Defined in: shared/types/chartHybrid.ts:221

Safely get scale configuration from chart options.

Parameters​

options​

Chart options (hybrid or official)

_DeepPartialObject<CoreChartOptions<keyof ChartTypeRegistry> & ElementChartOptions<keyof ChartTypeRegistry> & PluginChartOptions<keyof ChartTypeRegistry> & DatasetChartOptions<keyof ChartTypeRegistry> & ScaleChartOptions<keyof ChartTypeRegistry>> | UptimeChartOptions

scaleId​

string

Scale identifier

Returns​

ChartScaleConfig | undefined

The scale configuration when available; otherwise undefined.

toChartJsConfig()​

toChartJsConfig: <TType>(config: UptimeChartConfig<TType>) => { data: ChartData<ChartTypeRegistry[TType]>; options: ChartOptions<ChartTypeRegistry[TType]>; type: ChartTypeRegistry[TType]; }

Defined in: shared/types/chartHybrid.ts:233

Convert hybrid chart configuration to Chart.js official format.

Type Parameters​

TType​

TType extends keyof ChartTypeRegistry

Parameters​

config​

UptimeChartConfig<TType>

Hybrid chart configuration

Returns​

{ data: ChartData<ChartTypeRegistry[TType]>; options: ChartOptions<ChartTypeRegistry[TType]>; type: ChartTypeRegistry[TType]; }

A Chart.js-compatible configuration bundle.

data​

data: ChartData<ChartTypeRegistry[TType]>

options​

options: ChartOptions<ChartTypeRegistry[TType]>

type​

type: ChartTypeRegistry[TType]