Lumen ChartsLumen Charts
Api

ILumenChartingLibraryWidget

Download Markdown

Integration guide ยท Reference index

Runtime facade. Entries identify whether the current source exposes each member. Optional provider-dependent methods still require their configured capability.

The widget returned by new LumenChartingLibrary.widget(options). It owns the chart iframe, its charts and layout, and is disposed with remove().

loadAutomation

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

loadAutomation(): Promise<void>;

Explicitly load the optional automation asset before creating command adapters.

loadTrading

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

loadTrading(): Promise<void>;

Install optional trading assets for this widget collection; broker hydration is independent.

headerReady

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

headerReady(): Promise<void>;

Returns a promise that resolves once the chart frame has loaded and the header toolbar is ready to accept custom buttons and dropdowns. Rejects when the header is disabled.

onChartReady

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

onChartReady(callback: EmptyCallback): void;

Registers a callback that runs once the chart API is ready, or runs it immediately if the chart is already ready. Errors thrown by the callback are logged and do not stop other ready callbacks.

ParameterTypeRequired
callbackEmptyCallbackYes

onGrayedObjectClicked

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

onGrayedObjectClicked(callback: (obj: GrayedObject) => void): void;

Accepted for compatibility; has no effect.

ParameterTypeRequired
callback(obj: GrayedObject) => voidYes

onShortcut

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

onShortcut(
    shortCut: string | number | (string | number)[],
    callback: EmptyCallback,
  ): void;

Registers a keyboard shortcut inside the chart frame and calls callback with the keyboard event when it is pressed. The shortcut is registered after the chart frame loads.

ParameterTypeRequired
shortCutstring &#124; number &#124; (string &#124; number)[]Yes
callbackEmptyCallbackYes

subscribe

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

subscribe<EventName extends keyof SubscribeEventsMap>(
    event: EventName,
    callback: SubscribeEventsMap[EventName],
  ): void;

Subscribes callback to a widget event once the chart API is ready. Keep the same callback reference to remove it later with unsubscribe.

ParameterTypeRequired
eventEventNameYes
callbackSubscribeEventsMap[EventName]Yes

unsubscribe

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

unsubscribe<EventName extends keyof SubscribeEventsMap>(
    event: EventName,
    callback: SubscribeEventsMap[EventName],
  ): void;

Removes a callback previously added with subscribe. Subscriptions are matched by callback reference.

ParameterTypeRequired
eventEventNameYes
callbackSubscribeEventsMap[EventName]Yes

chart

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

chart(index?: number): IChartWidgetApi;

Returns the API for the visible chart at index in the layout, defaulting to the first chart. Throws a RangeError when the index is outside the visible charts.

ParameterTypeRequired
indexnumberNo

getLanguage

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

getLanguage(): LanguageCode;

Returns the locale the widget resolved at construction; unsupported locales fall back to en.

setSymbol

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

setSymbol(
    symbol: string,
    interval: ResolutionString,
    callback: EmptyCallback,
  ): void;

Changes the symbol of the active chart, or of all linked charts when symbol lock is on, and sets the interval when one is given. callback runs once data for the new interval is ready, or immediately when no interval is passed.

ParameterTypeRequired
symbolstringYes
intervalResolutionStringYes
callbackEmptyCallbackYes

remove

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

remove(): void;

Removes the chart frame from the page, detaches the window resize listener, and drops any pending onChartReady callbacks.

closePopupsAndDialogs

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

closePopupsAndDialogs(): void;

Closes the open chart dialog, or any open menus and popups, once the chart API is ready.

selectLineTool

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

selectLineTool(linetool: "icon", options?: IconOptions): void;

Selects the icon drawing tool on the active chart, using options to choose the icon.

ParameterTypeRequired
linetool"icon"Yes
optionsIconOptionsNo

selectLineTool (overload 2)

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

selectLineTool(linetool: "emoji", options?: EmojiOptions): void;

Selects the emoji drawing tool on the active chart, using options to choose the emoji.

ParameterTypeRequired
linetool"emoji"Yes
optionsEmojiOptionsNo

selectLineTool (overload 3)

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

selectLineTool(
    linetool: SupportedLineTools,
    options?: IconOptions | EmojiOptions,
  ): void;

Selects a drawing tool on the active chart so the next pointer action draws it, applying any creation options. cursor clears the selection, measure starts a temporary measurement, and tools that are only selectable are ignored.

ParameterTypeRequired
linetoolSupportedLineToolsYes
optionsIconOptions &#124; EmojiOptionsNo

selectedLineTool

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

selectedLineTool(): SupportedLineTools;

Returns the drawing tool currently selected on the active chart, or cursor when none is selected.

save

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

save(callback: (state: object) => void, options?: SaveChartOptions): void;

Serializes the current layout and passes the state object to callback synchronously. Throws in an analysis workspace, where each chart is saved automatically.

ParameterTypeRequired
callback(state: object) => voidYes
optionsSaveChartOptionsNo

load

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

load(state: object, extendedData?: SavedStateMetaInfo): void;

Replaces the current layout with a saved state, discarding charts the state does not use; extendedData sets the layout's id and name. Throws when the state cannot be restored or in an analysis workspace.

ParameterTypeRequired
stateobjectYes
extendedDataSavedStateMetaInfoNo

getSavedCharts

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

getSavedCharts(callback: (chartRecords: SaveLoadChartRecord[]) => void): void;

Fetches the list of saved layouts from the configured chart storage and passes the records to callback.

ParameterTypeRequired
callback(chartRecords: SaveLoadChartRecord[]) => voidYes

loadChartFromServer

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

loadChartFromServer(chartRecord: SaveLoadChartRecord): void;

Loads a saved layout from the configured chart storage and applies it to the widget. Records that are not valid storage records are ignored, and a load replaced by a later load does not apply.

ParameterTypeRequired
chartRecordSaveLoadChartRecordYes

saveChartToServer

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

saveChartToServer(
    onComplete?: EmptyCallback,
    onFail?: EmptyCallback,
    options?: SaveChartToServerOptions,
  ): void;

Saves the current layout to the configured chart storage, updating the current layout or creating a new one, and calls onComplete with the saved id and content. Calls onFail when the save fails or the layout has no name; saves run one at a time.

ParameterTypeRequired
onCompleteEmptyCallbackNo
onFailEmptyCallbackNo
optionsSaveChartToServerOptionsNo

removeChartFromServer

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

removeChartFromServer(
    chartId: string,
    onCompleteCallback: EmptyCallback,
  ): void;

Deletes the saved layout with chartId from the configured chart storage and calls onCompleteCallback when it finishes.

ParameterTypeRequired
chartIdstringYes
onCompleteCallbackEmptyCallbackYes

onContextMenu

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

onContextMenu(
    callback: (unixTime: number, price: number) => ContextMenuItem[],
  ): void;

Adds a callback whose items are merged into the chart pane's context menu, called with the time and price under the pointer when the menu opens.

ParameterTypeRequired
callback(unixTime: number, price: number) => ContextMenuItem[]Yes

createButton

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

createButton(options?: CreateHTMLButtonOptions): HTMLElement;

Adds a custom HTML button to the chart header and returns its element for you to fill and style. Throws if the header is not ready; wait for headerReady() first.

ParameterTypeRequired
optionsCreateHTMLButtonOptionsNo

createButton (overload 2)

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

createButton(options?: CreateChartUiStyledButtonOptions): void;

Adds a button styled like the built-in header controls, using the given label and click handler, and returns nothing. Throws if the header is not ready; wait for headerReady() first.

ParameterTypeRequired
optionsCreateChartUiStyledButtonOptionsNo

createButton (overload 3)

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

createButton(options?: CreateButtonOptions): HTMLElement | undefined;

Adds a custom button to the chart header and returns its element, or undefined for a chart-UI-styled button. Throws if the header is not ready; wait for headerReady() first.

ParameterTypeRequired
optionsCreateButtonOptionsNo

createDropdown

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

createDropdown(params: DropdownParams): Promise<IDropdownApi>;

Adds a dropdown to the chart header and resolves with an API to update or remove it once the header is ready. Throws when called without parameters and rejects when the header is disabled.

ParameterTypeRequired
paramsDropdownParamsYes

showNoticeDialog

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

showNoticeDialog(params: DialogParams<() => void>): void;

Shows a message dialog with title, body and one OK button, then calls callback when it is dismissed. Waits for the chart UI to mount, or calls the callback if the UI is unavailable.

ParameterTypeRequired
paramsDialogParams<() => void>Yes

showConfirmDialog

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

showConfirmDialog(params: DialogParams<(confirmed: boolean) => void>): void;

Shows a dialog with title, body, OK and Cancel, then calls callback with true for OK and false for Cancel or dismissal. Waits for the chart UI to mount, or reports false if the UI is unavailable.

ParameterTypeRequired
paramsDialogParams<(confirmed: boolean) => void>Yes

showSymbolSearchDialog

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

showSymbolSearchDialog(): void;

Open symbol search for the active chart.

showLoadChartDialog

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

showLoadChartDialog(): void;

Opens the dialog for loading a saved layout.

showSaveAsChartDialog

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

showSaveAsChartDialog(): void;

Opens the dialog for saving the current layout under a new name.

symbolInterval

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

symbolInterval(): SymbolIntervalResult;

Returns the active chart's symbol and interval, along with its display symbol when one is resolved.

mainSeriesPriceFormatter

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

mainSeriesPriceFormatter(): INumberFormatter;

Returns the price formatter for the active chart's main series, which uses the series precision and symbol information.

getIntervals

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

getIntervals(): string[];

Returns the intervals the active chart offers: the datafeed's supported resolutions, or the current interval when the datafeed declares none.

getStudiesList

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

getStudiesList(): string[];

Returns the names of all indicators in the study library, excluding hidden ones.

getStudyInputs

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

getStudyInputs(studyName: string): StudyInputInformation[];

Returns the inputs of the indicator whose name matches studyName, ignoring case. Throws when no indicator matches.

ParameterTypeRequired
studyNamestringYes

getStudyStyles

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

getStudyStyles(studyName: string): StudyStyleInfo;

Returns the plot and style metadata of the indicator whose name matches studyName, ignoring case. Throws when no indicator matches.

ParameterTypeRequired
studyNamestringYes

addCustomCSSFile

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

addCustomCSSFile(url: string): void;

Adds a stylesheet link to the chart frame. Call it after the chart frame has loaded.

ParameterTypeRequired
urlstringYes

applyOverrides

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

applyOverrides<TOverrides extends Partial<ChartPropertiesOverrides>>(
    overrides: TOverrides,
  ): void;

Applies chart property overrides to every chart in the layout once the chart frame loads and keeps them in the widget options. Throws when the overrides select the volume footprint style without the chart_style_volume_footprint feature.

ParameterTypeRequired
overridesTOverridesYes

Failure conditions: Volume footprint requires the chart_style_volume_footprint feature.

applyStudiesOverrides

Limited. The overrides are stored but not yet applied to indicators.

applyStudiesOverrides(overrides: object): void;

Records indicator default overrides on every chart. The current runtime stores them but does not apply them to existing or new indicators yet.

ParameterTypeRequired
overridesobjectYes

watchList

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

watchList(): Promise<IWatchListApi>;

Resolves with the watchlist API, or with null when widgetbar.watchlist is not enabled.

news

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

news(): Promise<INewsApi>;

Returns a promise for the news panel API, which refreshes headlines for the active symbol from the configured news provider or RSS feeds. Resolves to null unless widgetbar.news is enabled in the widget options.

widgetbar

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

widgetbar(): Promise<IWidgetbarApi>;

Returns a promise for the widget bar API, which shows and hides right-toolbar pages such as the data window. When the right_toolbar feature is disabled, requests to open a page are ignored.

activeChart

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

activeChart(): IChartWidgetApi;

Returns the API of the chart that is currently active in the layout. Throws if the chart frame has not loaded yet.

pineWorkspace

Capability-dependent. Requires the matching optional feature/provider and valid chart binding.

pineWorkspace(): Promise<PineEditorWorkspaceApi | null>;

Returns the host-facing Pine editor facade when Pine is enabled for this widget.

pineRuntime

Capability-dependent. Requires the matching optional feature/provider and valid chart binding.

pineRuntime(): Promise<PineChartRuntimeApi | null>;

Returns a promise for the Pine chart runtime API once the chart frame has loaded. Resolves to null when pine_script.enabled is not set.

activeChartIndex

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

activeChartIndex(): number;

Returns the zero-based index of the active chart in the current layout.

setActiveChart

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

setActiveChart(index: number): void;

Makes the chart at the given zero-based index active. Indices outside the visible charts are ignored, and a maximized layout stays maximized on the newly active chart.

ParameterTypeRequired
indexnumberYes

chartsCount

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

chartsCount(): number;

Returns the number of charts visible in the current layout.

unloadUnusedCharts

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

unloadUnusedCharts(): void;

Destroys charts kept in memory beyond the current layout's visible count, such as those left over after switching to a layout with fewer charts.

layout

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

layout(): LayoutType;

Returns the current multi-chart layout type, falling back to the single-chart layout when the stored value is not a public layout.

setLayout

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

setLayout(layout: LayoutType): void;

Switches the widget to the given multi-chart layout, adding or hiding charts to match and emitting layout_about_to_be_changed and layout_changed. Unknown layout types are ignored; it throws when the layout needs more charts than allowed or when an analysis workspace manages the layout.

ParameterTypeRequired
layoutLayoutTypeYes

layoutName

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

layoutName(): string;

Returns the current layout type; this is the same value as layout().

resetCache

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

resetCache(): void;

Reset cached bar data for all chart sessions owned by this widget.

resetLayoutSizes

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

resetLayoutSizes(disableUndo?: boolean): void;

Restores the default split sizes of the charts in a multi-chart layout. The disableUndo argument is accepted but ignored.

ParameterTypeRequired
disableUndobooleanNo

changeTheme

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

changeTheme(
    themeName: ThemeName,
    options?: ChangeThemeOptions,
  ): Promise<void>;

Switches every chart to the dark or light theme (any other name selects light), reapplies the user's saved chart defaults for that theme, and emits theme_changed. The options argument is ignored and the promise resolves once the theme is applied.

ParameterTypeRequired
themeNameThemeNameYes
optionsChangeThemeOptionsNo

getTheme

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

getTheme(): ThemeName;

Returns the current theme name, either light or dark.

takeScreenshot

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

takeScreenshot(): void;

Captures an image of the visible charts once the chart API is ready and emits onScreenshotReady with the resulting image data URL.

takeClientScreenshot

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

takeClientScreenshot(
    options?: Partial<ClientSnapshotOptions> & { onlyActiveChart?: boolean; chartIndex?: number },
  ): Promise<string>;

Captures the visible charts in the browser and resolves with an image data URL (PNG or SVG), also emitting onScreenshotReady. Options can limit the capture to the active chart or one chart index; it rejects when the requested chart is unavailable.

ParameterTypeRequired
optionsPartial<ClientSnapshotOptions> & { onlyActiveChart?: boolean; chartIndex?: number }No

Failure conditions: Chart capture is unavailable.

lockAllDrawingTools

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

lockAllDrawingTools(): IWatchedValue<boolean>;

Returns a watched value of whether the active chart's drawings are locked against moving and editing. setValue(true) locks them; it follows the active chart.

hideAllDrawingTools

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

hideAllDrawingTools(): IWatchedValue<boolean>;

Returns a watched value of whether the active chart's drawings are hidden. setValue(true) hides them and drops them from the selection; it follows the active chart.

magnetEnabled

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

magnetEnabled(): IWatchedValue<boolean>;

Returns a watched value that turns the drawing magnet on or off. It starts from the saved preference or the magnet widget option, defaults to false, and saves each change to settings storage.

magnetMode

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

magnetMode(): IWatchedValue<number>;

Returns a watched value holding the drawing magnet mode, 0 or 1. It starts from the saved preference or the magnetMode widget option and saves each change to settings storage.

symbolSync

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

symbolSync(): IWatchedValue<boolean>;

Returns a watched value that controls whether charts in a multi-chart layout share the same symbol.

intervalSync

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

intervalSync(): IWatchedValue<boolean>;

Returns a watched value that controls whether charts in a multi-chart layout share the same interval.

crosshairSync

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

crosshairSync(): IWatchedValue<boolean>;

Returns a watched value that controls whether the crosshair position is mirrored across charts in a multi-chart layout.

timeSync

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

timeSync(): IWatchedValue<boolean>;

Returns a watched value that controls whether charts in a multi-chart layout follow the same time position.

dateRangeSync

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

dateRangeSync(): IWatchedValue<boolean>;

Returns a watched value that controls whether charts in a multi-chart layout share the same visible date range.

startFullscreen

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

startFullscreen(): void;

Requests browser fullscreen for the active chart's root element and emits fullscreen_changed with true.

exitFullscreen

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

exitFullscreen(): void;

Leaves browser fullscreen and emits fullscreen_changed with false.

undoRedoState

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

undoRedoState(): UndoRedoState;

Returns whether the active chart currently has an action to undo and an action to redo.

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

navigationButtonsVisibility(): IWatchedValue<VisibilityType>;

Returns a watched value of the active chart's navigation button visibility (default visibleOnMouseOver). Setting it changes the active chart.

paneButtonsVisibility

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

paneButtonsVisibility(): IWatchedValue<VisibilityType>;

Returns a watched value of the active chart's pane button visibility (default visibleOnMouseOver). Setting it changes the active chart.

dateFormat

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

dateFormat(): IWatchedValue<DateFormat>;

Returns a watched value of the active chart's date format (default dd MMM 'yy). Setting it changes the active chart.

timeHoursFormat

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

timeHoursFormat(): IWatchedValue<TimeHoursFormat>;

Returns a watched value of the active chart's time format (default 24-hours). Setting it changes the active chart.

currencyAndUnitVisibility

Limited. The chart shows no currency or unit label, so the value stays alwaysOff.

currencyAndUnitVisibility(): IWatchedValue<VisibilityType>;

Returns a watched value fixed at alwaysOff: the chart shows no currency or unit label, so setting it has no effect.

setDebugMode

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

setDebugMode(enabled: boolean): void;

Stores the debug flag in the chart frame's options. The runtime does not read it after startup, so it has no visible effect.

ParameterTypeRequired
enabledbooleanYes

drawOnAllChartsEnabled

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

drawOnAllChartsEnabled(): IWatchedValue<boolean>;

Returns a watched value, false by default, that controls whether new drawings are synced to every chart in a multi-chart layout.

clearUndoHistory

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

clearUndoHistory(): void;

Clears the undo and redo history of the active chart.

setSaveStatus

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

setSaveStatus(status: "saving" | "saved" | "failed" | "load-failed" | null): void;

Shows how the host's autosave is going in the header's save/load slot. Requires the header_save_status featureset; null hides it. Clicking a failed status raises save_status_retry_requested.

ParameterTypeRequired
status"saving" &#124; "saved" &#124; "failed" &#124; "load-failed" &#124; nullYes

supportedChartTypes

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

supportedChartTypes(): IWatchedValueReadonly<ChartStyle[]>;

Returns a read-only watched value listing the chart styles the runtime supports. It updates when the high-low style feature is turned on or off.

watermark

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

watermark(): IWatermarkApi;

Returns the watermark API for the active chart, which controls the watermark's color, visibility and text content.

customSymbolStatus

Limited. Statuses are stored but not yet drawn on the chart.

customSymbolStatus(): ICustomSymbolStatusApi;

Returns the store for custom symbol statuses: symbol(id) returns a chainable adapter for visibility, icon, colour, tooltip and drop-down content, and hideAll() hides every status. The chart keeps these values but does not draw them yet.

setCSSCustomProperty

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

setCSSCustomProperty(customPropertyName: string, value: string): void;

Sets a CSS custom property on the chart frame's body element. Throws when the name does not start with --.

ParameterTypeRequired
customPropertyNamestringYes
valuestringYes

Failure conditions: customPropertyName should begin with a double hyphen.

getCSSCustomPropertyValue

Runtime-backed. Use after chart readiness unless this is a readiness or disposal method.

getCSSCustomPropertyValue(customPropertyName: string): string;

Returns the value of a CSS custom property from the chart frame's body, preferring an inline value over the computed style. Throws when the name does not start with --.

ParameterTypeRequired
customPropertyNamestringYes

Failure conditions: customPropertyName should begin with a double hyphen.

On this page