Skip to main content

ChartUpdater

FitFileViewer - API Documentation v30.0.1

FitFileViewer - API Documentation / utils/charts/core/chartUpdater / ChartUpdater

Variable: ChartUpdater

const ChartUpdater: { dataChange: (newData: unknown) => Promise<boolean>; getStatus: () => ChartUpdateSystemStatus; isModernSystemAvailable: () => boolean; settingChange: (settingName: string, newValue: unknown, container?: HTMLElement | null) => Promise<boolean>; tabActivation: () => Promise<boolean>; themeChange: (newTheme: string) => Promise<boolean>; update: (reason: string, container?: HTMLElement | null) => Promise<boolean>; }

Defined in: utils/charts/core/chartUpdater.ts:175

Convenience API for common chart update triggers.

Type Declaration​

dataChange​

dataChange: (newData: unknown) => Promise<boolean> = updateChartsForDataChange

Handle data changes with proper chart updates.

Parameters​

newData​

unknown

New data object.

Returns​

Promise<boolean>

Whether the update request was accepted.

getStatus​

getStatus: () => ChartUpdateSystemStatus = getChartUpdateSystemStatus

Get status information about the chart update system.

Returns​

ChartUpdateSystemStatus

Current chart update system status.

isModernSystemAvailable​

isModernSystemAvailable: () => boolean = isModernChartSystemAvailable

Check if chart state manager is available and initialized.

Returns​

boolean

Whether the modern chart state manager can accept render requests.

settingChange​

settingChange: (settingName: string, newValue: unknown, container?: HTMLElement | null) => Promise<boolean> = updateChartsForSettingChange

Handle setting changes with debounced chart updates.

Parameters​

settingName​

string

Name of the changed setting.

newValue​

unknown

New setting value.

container?​

HTMLElement | null

Optional chart container element.

Returns​

Promise<boolean>

Whether the update request was accepted.

tabActivation​

tabActivation: () => Promise<boolean> = updateChartsForTabActivation

Handle tab activation with proper chart updates.

Returns​

Promise<boolean>

Whether the update request was accepted.

themeChange​

themeChange: (newTheme: string) => Promise<boolean> = updateChartsForThemeChange

Handle theme changes with proper chart updates.

Parameters​

newTheme​

string

The new theme name.

Returns​

Promise<boolean>

Whether the update request was accepted or rendered.

Throws​

Re-throws chart state manager or fallback render failures.

update​

update: (reason: string, container?: HTMLElement | null) => Promise<boolean> = updateCharts

Unified interface for triggering chart updates.

Parameters​

reason​

string

Reason for the chart update.

container?​

HTMLElement | null

Optional chart container element.

Returns​

Promise<boolean>

Whether the update request was accepted or rendered.

Throws​

Re-throws chart state manager or fallback render failures.