LumenChartingLibraryWidgetOptions

Integration guide · Reference index

Public contract reference. This declaration describes types and callback shapes; availability is constrained by the linked integration guide and the runtime capability. Legacy product-specific fields are not a promise of implementation.

containerCopy Anchor Link

container: HTMLElement | string;

Use the type signature above and the integration guide for the owning capability.

datafeedCopy Anchor Link

datafeed: IBasicDataFeed | (IBasicDataFeed & IDatafeedQuotesApi);

Use the type signature above and the integration guide for the owning capability.

intervalCopy Anchor Link

interval: ResolutionString;

Use the type signature above and the integration guide for the owning capability.

symbolCopy Anchor Link

symbol?: string;

Use the type signature above and the integration guide for the owning capability.

auto_save_delayCopy Anchor Link

auto_save_delay?: number;

Use the type signature above and the integration guide for the owning capability.

pine_scriptCopy Anchor Link

pine_script?: PineScriptWidgetOptions;

Opt-in native Pine v5/v6 indicator execution and editor configuration.

autosizeCopy Anchor Link

autosize?: boolean;

Use the type signature above and the integration guide for the owning capability.

debugCopy Anchor Link

debug?: boolean;

Use the type signature above and the integration guide for the owning capability.

disabled_featuresCopy Anchor Link

disabled_features?: LumenChartingLibraryFeatureset[];

Use the type signature above and the integration guide for the owning capability.

drawings_accessCopy Anchor Link

drawings_access?: AccessList;

Use the type signature above and the integration guide for the owning capability.

enabled_featuresCopy Anchor Link

enabled_features?: LumenChartingLibraryFeatureset[];

Use the type signature above and the integration guide for the owning capability.

ai_commandsCopy Anchor Link

ai_commands?: AiCommandsOptions;

Programmatic command families that hosts (for example an AI assistant) can drive through the chart's command APIs. Every family is on when omitted; set one to false to switch it off.

• inspection: capability schema and exact-ID reads of drawings, studies and the chart.
• drawingSettings: settings, reset and local ref names (create, then group in the same batch) on drawing batches. Needs inspection.
• studies: study command changes and study inspection. Study save and restore keep working.
• chartSettings: chart type and main price scale commands. Needs inspection.

Unknown keys or non-boolean values are rejected when the widget is created.

Example:

ai_commands: { chartSettings: false },

fullscreenCopy Anchor Link

fullscreen?: boolean;

Use the type signature above and the integration guide for the owning capability.

library_pathCopy Anchor Link

library_path?: string;

Use the type signature above and the integration guide for the owning capability.

localeCopy Anchor Link

locale: LanguageCode;

Use the type signature above and the integration guide for the owning capability.

numeric_formattingCopy Anchor Link

numeric_formatting?: NumericFormattingParams;

Use the type signature above and the integration guide for the owning capability.

saved_dataCopy Anchor Link

saved_data?: object;

Use the type signature above and the integration guide for the owning capability.

saved_data_meta_infoCopy Anchor Link

saved_data_meta_info?: SavedStateMetaInfo;

Use the type signature above and the integration guide for the owning capability.

studies_accessCopy Anchor Link

studies_access?: AccessList;

Use the type signature above and the integration guide for the owning capability.

study_count_limitCopy Anchor Link

study_count_limit?: number;

Use the type signature above and the integration guide for the owning capability.

symbol_search_request_delayCopy Anchor Link

symbol_search_request_delay?: number;

Use the type signature above and the integration guide for the owning capability.

timeframeCopy Anchor Link

timeframe?: TimeframeOption;

Use the type signature above and the integration guide for the owning capability.

timezoneCopy Anchor Link

timezone?: "exchange" | Timezone;

Use the type signature above and the integration guide for the owning capability.

toolbar_bgCopy Anchor Link

toolbar_bg?: string;

Use the type signature above and the integration guide for the owning capability.

widthCopy Anchor Link

width?: number;

Use the type signature above and the integration guide for the owning capability.

heightCopy Anchor Link

height?: number;

Use the type signature above and the integration guide for the owning capability.

charts_storage_urlCopy Anchor Link

charts_storage_url?: string;

Use the type signature above and the integration guide for the owning capability.

charts_storage_api_versionCopy Anchor Link

charts_storage_api_version?: AvailableSaveloadVersions;

Use the type signature above and the integration guide for the owning capability.

client_idCopy Anchor Link

client_id?: string;

Use the type signature above and the integration guide for the owning capability.

user_idCopy Anchor Link

user_id?: string;

Use the type signature above and the integration guide for the owning capability.

load_last_chartCopy Anchor Link

load_last_chart?: boolean;

Use the type signature above and the integration guide for the owning capability.

studies_overridesCopy Anchor Link

studies_overrides?: Partial<StudyOverrides>;

Use the type signature above and the integration guide for the owning capability.

custom_formattersCopy Anchor Link

custom_formatters?: CustomFormatters;

Use the type signature above and the integration guide for the owning capability.

overridesCopy Anchor Link

overrides?: Partial<WidgetOverrides>;

Use the type signature above and the integration guide for the owning capability.

snapshot_urlCopy Anchor Link

snapshot_url?: string;

Use the type signature above and the integration guide for the owning capability.

time_framesCopy Anchor Link

time_frames?: TimeFrameItem[];

Use the type signature above and the integration guide for the owning capability.

custom_css_urlCopy Anchor Link

custom_css_url?: string;

Use the type signature above and the integration guide for the owning capability.

custom_font_familyCopy Anchor Link

custom_font_family?: string;

Use the type signature above and the integration guide for the owning capability.

favoritesCopy Anchor Link

favorites?: Favorites<ChartTypeFavorites>;

Use the type signature above and the integration guide for the owning capability.

save_load_adapterCopy Anchor Link

save_load_adapter?: IExternalSaveLoadAdapter;

Use the type signature above and the integration guide for the owning capability.

loading_screenCopy Anchor Link

loading_screen?: LoadingScreenOptions;

Use the type signature above and the integration guide for the owning capability.

settings_adapterCopy Anchor Link

settings_adapter?: ISettingsAdapter;

Use the type signature above and the integration guide for the owning capability.

themeCopy Anchor Link

theme?: ThemeName;

Use the type signature above and the integration guide for the owning capability.

compare_symbolsCopy Anchor Link

compare_symbols?: CompareSymbol[];

Use the type signature above and the integration guide for the owning capability.

custom_indicators_getterCopy Anchor Link

custom_indicators_getter?: (
    PineJS: PineJS,
  ) => Promise<readonly CustomIndicator[]>;

Use the type signature above and the integration guide for the owning capability.

additional_symbol_info_fieldsCopy Anchor Link

additional_symbol_info_fields?: AdditionalSymbolInfoField[];

Use the type signature above and the integration guide for the owning capability.

header_widget_buttons_modeCopy Anchor Link

header_widget_buttons_mode?: HeaderWidgetButtonsMode;

Use the type signature above and the integration guide for the owning capability.

context_menuCopy Anchor Link

context_menu?: ContextMenuOptions;

Use the type signature above and the integration guide for the owning capability.

time_scaleCopy Anchor Link

time_scale?: TimeScaleOptions;

Use the type signature above and the integration guide for the owning capability.

custom_translate_functionCopy Anchor Link

custom_translate_function?: CustomTranslateFunction;

Use the type signature above and the integration guide for the owning capability.

symbol_search_completeCopy Anchor Link

symbol_search_complete?: SymbolSearchCompleteOverrideFunction;

Use the type signature above and the integration guide for the owning capability.

settings_overridesCopy Anchor Link

settings_overrides?: Overrides;

Use the type signature above and the integration guide for the owning capability.

custom_timezonesCopy Anchor Link

custom_timezones?: CustomAliasedTimezone[];

Use the type signature above and the integration guide for the owning capability.

custom_chart_description_functionCopy Anchor Link

custom_chart_description_function?: ChartDescriptorFunction;

Use the type signature above and the integration guide for the owning capability.

Related typesCopy Anchor Link

• IBasicDataFeed
• IDatafeedQuotesApi
• ResolutionString
• PineScriptWidgetOptions
• LumenChartingLibraryFeatureset
• AccessList
• LanguageCode
• NumericFormattingParams
• SavedStateMetaInfo
• TimeframeOption
• Timezone
• AvailableSaveloadVersions
• StudyOverrides
• CustomFormatters
• WidgetOverrides
• TimeFrameItem
• Favorites
• ChartTypeFavorites
• IExternalSaveLoadAdapter
• LoadingScreenOptions
• ISettingsAdapter
• ThemeName
• CompareSymbol
• PineJS
• CustomIndicator
• AdditionalSymbolInfoField
• HeaderWidgetButtonsMode
• ContextMenuOptions
• TimeScaleOptions
• CustomTranslateFunction
• SymbolSearchCompleteOverrideFunction
• Overrides
• CustomAliasedTimezone
• ChartDescriptorFunction