<!-- Public documentation export; not library implementation source. -->
# LumenChartingLibraryWidgetOptions

[Integration guide](https://docs.lumencharts.com/charting-library/configuration/) · [Reference index](https://docs.lumencharts.com/charting-library/api/)

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.

## container {#container}

```ts
container: HTMLElement | string;
```

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

## datafeed {#datafeed}

```ts
datafeed: IBasicDataFeed | (IBasicDataFeed & IDatafeedQuotesApi);
```

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

## interval {#interval}

```ts
interval: ResolutionString;
```

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

## symbol {#symbol}

```ts
symbol?: string;
```

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

## auto_save_delay {#auto_save_delay}

```ts
auto_save_delay?: number;
```

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

## pine_script {#pine_script}

```ts
pine_script?: PineScriptWidgetOptions;
```

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

## autosize {#autosize}

```ts
autosize?: boolean;
```

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

## debug {#debug}

```ts
debug?: boolean;
```

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

## disabled_features {#disabled_features}

```ts
disabled_features?: LumenChartingLibraryFeatureset[];
```

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

## drawings_access {#drawings_access}

```ts
drawings_access?: AccessList;
```

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

## enabled_features {#enabled_features}

```ts
enabled_features?: LumenChartingLibraryFeatureset[];
```

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

## ai_commands {#ai_commands}

```ts
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:
```javascript
ai_commands: { chartSettings: false },
```

## fullscreen {#fullscreen}

```ts
fullscreen?: boolean;
```

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

## library_path {#library_path}

```ts
library_path?: string;
```

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

## locale {#locale}

```ts
locale: LanguageCode;
```

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

## numeric_formatting {#numeric_formatting}

```ts
numeric_formatting?: NumericFormattingParams;
```

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

## saved_data {#saved_data}

```ts
saved_data?: object;
```

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

## saved_data_meta_info {#saved_data_meta_info}

```ts
saved_data_meta_info?: SavedStateMetaInfo;
```

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

## studies_access {#studies_access}

```ts
studies_access?: AccessList;
```

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

## study_count_limit {#study_count_limit}

```ts
study_count_limit?: number;
```

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

## symbol_search_request_delay {#symbol_search_request_delay}

```ts
symbol_search_request_delay?: number;
```

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

## timeframe {#timeframe}

```ts
timeframe?: TimeframeOption;
```

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

## timezone {#timezone}

```ts
timezone?: "exchange" | Timezone;
```

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

## toolbar_bg {#toolbar_bg}

```ts
toolbar_bg?: string;
```

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

## width {#width}

```ts
width?: number;
```

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

## height {#height}

```ts
height?: number;
```

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

## charts_storage_url {#charts_storage_url}

```ts
charts_storage_url?: string;
```

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

## charts_storage_api_version {#charts_storage_api_version}

```ts
charts_storage_api_version?: AvailableSaveloadVersions;
```

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

## client_id {#client_id}

```ts
client_id?: string;
```

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

## user_id {#user_id}

```ts
user_id?: string;
```

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

## load_last_chart {#load_last_chart}

```ts
load_last_chart?: boolean;
```

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

## studies_overrides {#studies_overrides}

```ts
studies_overrides?: Partial<StudyOverrides>;
```

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

## custom_formatters {#custom_formatters}

```ts
custom_formatters?: CustomFormatters;
```

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

## overrides {#overrides}

```ts
overrides?: Partial<WidgetOverrides>;
```

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

## snapshot_url {#snapshot_url}

```ts
snapshot_url?: string;
```

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

## time_frames {#time_frames}

```ts
time_frames?: TimeFrameItem[];
```

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

## custom_css_url {#custom_css_url}

```ts
custom_css_url?: string;
```

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

## custom_font_family {#custom_font_family}

```ts
custom_font_family?: string;
```

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

## favorites {#favorites}

```ts
favorites?: Favorites<ChartTypeFavorites>;
```

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

## save_load_adapter {#save_load_adapter}

```ts
save_load_adapter?: IExternalSaveLoadAdapter;
```

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

## loading_screen {#loading_screen}

```ts
loading_screen?: LoadingScreenOptions;
```

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

## settings_adapter {#settings_adapter}

```ts
settings_adapter?: ISettingsAdapter;
```

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

## theme {#theme}

```ts
theme?: ThemeName;
```

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

## compare_symbols {#compare_symbols}

```ts
compare_symbols?: CompareSymbol[];
```

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

## custom_indicators_getter {#custom_indicators_getter}

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

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

## additional_symbol_info_fields {#additional_symbol_info_fields}

```ts
additional_symbol_info_fields?: AdditionalSymbolInfoField[];
```

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

## header_widget_buttons_mode {#header_widget_buttons_mode}

```ts
header_widget_buttons_mode?: HeaderWidgetButtonsMode;
```

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

## context_menu {#context_menu}

```ts
context_menu?: ContextMenuOptions;
```

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

## time_scale {#time_scale}

```ts
time_scale?: TimeScaleOptions;
```

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

## custom_translate_function {#custom_translate_function}

```ts
custom_translate_function?: CustomTranslateFunction;
```

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

## symbol_search_complete {#symbol_search_complete}

```ts
symbol_search_complete?: SymbolSearchCompleteOverrideFunction;
```

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

## settings_overrides {#settings_overrides}

```ts
settings_overrides?: Overrides;
```

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

## custom_timezones {#custom_timezones}

```ts
custom_timezones?: CustomAliasedTimezone[];
```

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

## custom_chart_description_function {#custom_chart_description_function}

```ts
custom_chart_description_function?: ChartDescriptorFunction;
```

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

## Related types

- [IBasicDataFeed](https://docs.lumencharts.com/charting-library/api/IBasicDataFeed)
- [IDatafeedQuotesApi](https://docs.lumencharts.com/charting-library/api/IDatafeedQuotesApi)
- [ResolutionString](https://docs.lumencharts.com/charting-library/api/ResolutionString)
- [PineScriptWidgetOptions](https://docs.lumencharts.com/charting-library/api/PineScriptWidgetOptions)
- [LumenChartingLibraryFeatureset](https://docs.lumencharts.com/charting-library/api/LumenChartingLibraryFeatureset)
- [AccessList](https://docs.lumencharts.com/charting-library/api/AccessList)
- [LanguageCode](https://docs.lumencharts.com/charting-library/api/LanguageCode)
- [NumericFormattingParams](https://docs.lumencharts.com/charting-library/api/NumericFormattingParams)
- [SavedStateMetaInfo](https://docs.lumencharts.com/charting-library/api/SavedStateMetaInfo)
- [TimeframeOption](https://docs.lumencharts.com/charting-library/api/TimeframeOption)
- [Timezone](https://docs.lumencharts.com/charting-library/api/Timezone)
- [AvailableSaveloadVersions](https://docs.lumencharts.com/charting-library/api/AvailableSaveloadVersions)
- [StudyOverrides](https://docs.lumencharts.com/charting-library/api/StudyOverrides)
- [CustomFormatters](https://docs.lumencharts.com/charting-library/api/CustomFormatters)
- [WidgetOverrides](https://docs.lumencharts.com/charting-library/api/WidgetOverrides)
- [TimeFrameItem](https://docs.lumencharts.com/charting-library/api/TimeFrameItem)
- [Favorites](https://docs.lumencharts.com/charting-library/api/Favorites)
- [ChartTypeFavorites](https://docs.lumencharts.com/charting-library/api/ChartTypeFavorites)
- [IExternalSaveLoadAdapter](https://docs.lumencharts.com/charting-library/api/IExternalSaveLoadAdapter)
- [LoadingScreenOptions](https://docs.lumencharts.com/charting-library/api/LoadingScreenOptions)
- [ISettingsAdapter](https://docs.lumencharts.com/charting-library/api/ISettingsAdapter)
- [ThemeName](https://docs.lumencharts.com/charting-library/api/ThemeName)
- [CompareSymbol](https://docs.lumencharts.com/charting-library/api/CompareSymbol)
- [PineJS](https://docs.lumencharts.com/charting-library/api/PineJS)
- [CustomIndicator](https://docs.lumencharts.com/charting-library/api/CustomIndicator)
- [AdditionalSymbolInfoField](https://docs.lumencharts.com/charting-library/api/AdditionalSymbolInfoField)
- [HeaderWidgetButtonsMode](https://docs.lumencharts.com/charting-library/api/HeaderWidgetButtonsMode)
- [ContextMenuOptions](https://docs.lumencharts.com/charting-library/api/ContextMenuOptions)
- [TimeScaleOptions](https://docs.lumencharts.com/charting-library/api/TimeScaleOptions)
- [CustomTranslateFunction](https://docs.lumencharts.com/charting-library/api/CustomTranslateFunction)
- [SymbolSearchCompleteOverrideFunction](https://docs.lumencharts.com/charting-library/api/SymbolSearchCompleteOverrideFunction)
- [Overrides](https://docs.lumencharts.com/charting-library/api/Overrides)
- [CustomAliasedTimezone](https://docs.lumencharts.com/charting-library/api/CustomAliasedTimezone)
- [ChartDescriptorFunction](https://docs.lumencharts.com/charting-library/api/ChartDescriptorFunction)

---
Documentation page: https://docs.lumencharts.com/charting-library/api/LumenChartingLibraryWidgetOptions