# Enablers and options (/vela-pro/api/enablers)



`enableVelaPro()` enables the full Vela Pro feature set in a single call, while individual feature enablers let you register specific capabilities selectively. Call enablers once before constructing a workspace or chart so the SDK registries are populated at initialization time.

Import symbols on this page from `@luxalgo/vela-pro`. Related guides: [Quickstart](/vela-pro/get-started/quickstart), [Architecture](/vela-pro/get-started/architecture).

## Functions [#functions]

### `enableBottomDock` [#enablebottomdock]

Enable the BOTTOM DOCK on every shell built afterwards: a panel area under the charts for the registered bottom panels (Pro's trading panel and strategy tester, a host's own), resizable from its top edge, maximizable, and closed until a panel (or its rail button) opens it. Its open tab and height persist with the shell's state document. Call ONCE, before constructing shells. Idempotent.

```typescript
function enableBottomDock(opts?: EnableBottomDockOptions): void
```

See also: [`EnableBottomDockOptions`](/vela-pro/api/enablers#enablebottomdockoptions).

### `enableCodeEditor` [#enablecodeeditor]

Enable the PINE CODE EDITOR: a resizable side panel with syntax highlighting, completion, hover documentation, signature help, colour swatches, diagnostics and a logs strip, that runs the script on the chart it is docked to. Registers a side panel, so every widget and workspace built afterwards has it: call ONCE, before constructing them (`widget.refreshActions()` picks it up on an already-built one). Idempotent. Host code drives it through [`codeEditor`](/vela-pro/api/code-editor#codeeditor).

The editor is engine-agnostic: it executes through `chart.runIndicator`, so it drives whichever engine is registered for Pine ([`enablePineEngine`](/vela-pro/api/enablers#enablepineengine), or a per-widget `engines` factory). With no Pine engine registered, running reports that rather than painting.

Also exported from `@luxalgo/vela-pro/editor`.

```typescript
function enableCodeEditor(opts?: EnableCodeEditorOptions): void
```

See also: [`EnableCodeEditorOptions`](/vela-pro/api/enablers#enablecodeeditoroptions).

### `enableDrawingMenus` [#enabledrawingmenus]

Enable the refined DRAWING MENUS on every shell built afterwards. Call ONCE. Idempotent.

```typescript
function enableDrawingMenus(opts?: EnableDrawingMenusOptions): void
```

See also: [`EnableDrawingMenusOptions`](/vela-pro/api/enablers#enabledrawingmenusoptions).

### `enableFootprint` [#enablefootprint]

Enable the FOOTPRINT chart type: registers the style (chart-type registry), its data engine, its renderer layer, its settings tab, and its icon into Vela's public SDK registries. Call ONCE, before constructing charts/widgets. Idempotent.

Data comes from the chart's registered provider when it implements the [`FootprintFeed`](/vela-pro/api/data-feeds#footprintfeed) surface; on providers without it, the style still registers but the engine logs a warning and pushes nothing.

```typescript
function enableFootprint(): void
```

### `enableIndicatorLibrary` [#enableindicatorlibrary]

Enable the INDICATOR LIBRARY MENU: registers a widget attachment (one menu per shell, plus the favorites caret beside Indicators) and a topbar action that takes over the shell's `'indicators'` slot. Button, mobile stop and `/` all route to this menu, and the built-in picker never constructs. Also registers a star on every legend row (the same store the dialog stars into). No shell option needed (the historical `indicatorPicker: false` is harmless but redundant). Call ONCE, before constructing charts/widgets. Idempotent.

```typescript
function enableIndicatorLibrary(opts?: EnableIndicatorLibraryOptions): void
```

See also: [`EnableIndicatorLibraryOptions`](/vela-pro/api/enablers#enableindicatorlibraryoptions).

### `enableIndicatorTemplates` [#enableindicatortemplates]

Enable INDICATOR TEMPLATES on every shell built afterwards. Call ONCE. Idempotent.

```typescript
function enableIndicatorTemplates(opts?: EnableIndicatorTemplatesOptions): IndicatorTemplatesController
```

See also: [`EnableIndicatorTemplatesOptions`](/vela-pro/api/enablers#enableindicatortemplatesoptions), [`IndicatorTemplatesController`](/vela-pro/api/indicators#indicatortemplatescontroller-class).

### `enableOrderflowIndicators` [#enableorderflowindicators]

Enable the ORDER-FLOW INDICATORS: Volume Delta, CVD, Trade Count, Trade Count Delta, Cumulative Trade Count Delta, Session Volume Profile, Rolling Volume Profile, Fixed/Visible/Rolling/Session Range Volume Tails (all footprint-fed, picker-gated to footprint-capable providers), Footprint / Visible Range Footprint (same gate; one per-bar instance, no multi-footprint strip), Volume Bubbles (same gate; volume dots / buy-sell pies per price bucket), Bar Stats (same gate; a per-bar stats table on its own unscaled pane) and TPO (plain OHLCV), plus the widget attachment that gives the Fixed tails variant its two-click range placement. Call ONCE, before constructing charts/widgets. Idempotent.

```typescript
function enableOrderflowIndicators(_opts?: EnableOrderflowIndicatorsOptions): void
```

See also: [`EnableOrderflowIndicatorsOptions`](/vela-pro/api/enablers#enableorderflowindicatorsoptions).

### `enablePineEngine` [#enablepineengine]

Enable PINE as the default scripting engine: registers the `@luxalgo/vela-pinets` engine into Vela's default-engine registry, so EVERY widget and workspace cell built afterwards executes Pine indicators with no per-construction wiring (one engine instance per chart). Call ONCE, before constructing charts/widgets. Idempotent.

```typescript
function enablePineEngine(opts?: EnablePineEngineOptions): void
```

See also: [`EnablePineEngineOptions`](/vela-pro/api/enablers#enablepineengineoptions).

### `enableRadialWheel` [#enableradialwheel]

Enable the RADIAL TOOL WHEEL: hold the trigger key (Alt by default) over the chart to open a radial picker of the user's FAVORITE drawing tools (starred in the toolbar flyouts), aim with the pointer, release to arm. Registers a widget attachment, so every widget built afterwards gets it: call ONCE, before constructing widgets (`widget.refreshActions()` picks it up on an already-built widget). Idempotent.

```typescript
function enableRadialWheel(opts?: EnableRadialWheelOptions): void
```

See also: [`EnableRadialWheelOptions`](/vela-pro/api/enablers#enableradialwheeloptions).

### `enableReplay` [#enablereplay]

Enable BAR REPLAY: a Replay button right of Indicators that asks for a start bar (click it on the chart), then rewinds the chart there and offers Start bar (re-pick), play/pause, next bar, a speed multiplier, the host's own `controls`, a jump to a date, a slider across the loaded history, a pin and exit on a control bar the user can move. The button's icon is Vela's `replay` icon, the same one the widget's replay watermark wears. Every widget built afterwards gets it: call ONCE, before constructing widgets (`widget.refreshActions()` picks it up on an already-built one). Idempotent.

```typescript
function enableReplay(opts?: EnableReplayOptions): void
```

See also: [`EnableReplayOptions`](/vela-pro/api/enablers#enablereplayoptions).

### `enableRichTooltips` [#enablerichtooltips]

Turn the chart controls' tooltips into cards on every shell built afterwards. Call ONCE. Idempotent.

```typescript
function enableRichTooltips(opts?: EnableRichTooltipsOptions): void
```

See also: [`EnableRichTooltipsOptions`](/vela-pro/api/enablers#enablerichtooltipsoptions).

### `enableSchemeTracking` [#enableschemetracking]

Keep `data-vp-scheme` on every shell built afterwards (idempotent).

```typescript
function enableSchemeTracking(): void
```

### `enableSideRail` [#enablesiderail]

Enable the SIDE RAIL on every shell built afterwards: Vela's sidebar, laid out as Pro's terminal (the screenshot menu, the side panels, the inspection panels and Pro's own entries), with hover cards. A host that passes `sidebar` itself keeps its own. Call ONCE, before constructing shells. Idempotent.

```typescript
function enableSideRail(opts?: EnableSideRailOptions): void
```

See also: [`EnableSideRailOptions`](/vela-pro/api/enablers#enablesiderailoptions).

### `enableStrategyTester` [#enablestrategytester]

Enable the STRATEGY TESTER: a bottom-dock panel with the active chart's strategy backtest (Performance, Trades analysis and Trades log). Turns the bottom dock on with its defaults when it is off; call [`enableBottomDock`](/vela-pro/api/enablers#enablebottomdock) first to give the dock options. Call ONCE, before constructing shells. Idempotent.

```typescript
function enableStrategyTester(opts?: EnableStrategyTesterOptions): void
```

See also: [`EnableStrategyTesterOptions`](/vela-pro/api/enablers#enablestrategytesteroptions).

### `enableSymbolDrawings` [#enablesymboldrawings]

Keep the drawings of every chart PER SYMBOL, on every shell built afterwards: a switch to another symbol takes them off the chart and shows that symbol's, saved as they change in a store of their own. Call ONCE, before constructing shells. Idempotent.

```typescript
function enableSymbolDrawings(opts?: EnableSymbolDrawingsOptions): void
```

See also: [`EnableSymbolDrawingsOptions`](/vela-pro/api/enablers#enablesymboldrawingsoptions).

### `enableSymbolSearch` [#enablesymbolsearch]

Enable Pro's SYMBOL SEARCH on every shell built afterwards. Call ONCE, before constructing shells. Idempotent.

```typescript
function enableSymbolSearch(opts?: EnableSymbolSearchOptions): void
```

See also: [`EnableSymbolSearchOptions`](/vela-pro/api/enablers#enablesymbolsearchoptions).

### `enableTpo` [#enabletpo]

Enable the TPO (Market Profile) chart type: registers the style, its data engine, its renderer layer, its settings tab, and its icon into Vela's public SDK registries. Call ONCE, before constructing charts/widgets. Idempotent.

Data needs nothing beyond the provider's required OHLCV surface: the engine fetches block-interval candles through the chart's registered provider, so every provider serves TPO as it is.

```typescript
function enableTpo(): void
```

### `enableVelaPro` [#enablevelapro]

Enable EVERY Vela Pro feature with one call: the batteries-included form of the fine-grained enablers ([`enableFootprint`](/vela-pro/api/enablers#enablefootprint), [`enableTpo`](/vela-pro/api/enablers#enabletpo), [`enableOrderflowIndicators`](/vela-pro/api/enablers#enableorderflowindicators), [`enableIndicatorLibrary`](/vela-pro/api/enablers#enableindicatorlibrary), [`enableRadialWheel`](/vela-pro/api/enablers#enableradialwheel), [`enableReplay`](/vela-pro/api/enablers#enablereplay), [`enablePineEngine`](/vela-pro/api/enablers#enablepineengine), [`enableCodeEditor`](/vela-pro/api/enablers#enablecodeeditor), [`enableStrategyTester`](/vela-pro/api/enablers#enablestrategytester)), which stay exported for à-la-carte setups. Same rules as every enabler: call ONCE, before constructing charts/widgets. Idempotent: each underlying enabler installs once, so a second call (even with different options) installs nothing new. `watermark` is the exception, and it is not an install: a second call re-states the corner mark for the charts built after it.

```typescript
function enableVelaPro(opts?: EnableVelaProOptions): void
```

See also: [`EnableVelaProOptions`](/vela-pro/api/enablers#enablevelaprooptions).

## Interfaces and types [#interfaces-and-types]

### `EnableBottomDockOptions` [#enablebottomdockoptions]

Options for [`enableBottomDock`](/vela-pro/api/enablers#enablebottomdock).

```typescript
interface EnableBottomDockOptions {
    height?: number;
    minHeight?: number;
    chartFloor?: number;
    railItems?: boolean;
    panels?: readonly string[];
}
```

| Member        | Type                | Description                                                                     |
| ------------- | ------------------- | ------------------------------------------------------------------------------- |
| `height?`     | `number`            | Height the dock opens at, px (default 300). The user's drag is remembered.      |
| `minHeight?`  | `number`            | The dock's floor, px (default 140).                                             |
| `chartFloor?` | `number`            | What the charts keep above an open dock, px (default 220).                      |
| `railItems?`  | `boolean`           | Show each panel as a rail button in the side rail (default true).               |
| `panels?`     | `readonly string[]` | Panel ids the dock hosts; panels not listed are left out. Default: every panel. |

### `EnableCodeEditorOptions` [#enablecodeeditoroptions]

Options for [`enableCodeEditor`](/vela-pro/api/enablers#enablecodeeditor).

Also exported from `@luxalgo/vela-pro/editor`.

```typescript
interface EnableCodeEditorOptions {
    order?: number;
    width?: number;
    minWidth?: number;
    maxWidth?: number;
    overlay?: boolean;
    maximizable?: boolean;
    persist?: boolean | string;
    storage?: VelaStorage;
    diagnostics?: boolean;
    initialSource?: string;
    colors?: PineEditorColors;
    legendAction?: boolean;
    workerUrl?: string;
}
```

| Member           | Type                | Description                                                                                                                                                                                                                                                                                                                                    |
| ---------------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `order?`         | `number`            | Sort key among the panel buttons (the shell's own are 10 and 20). Default 30.                                                                                                                                                                                                                                                                  |
| `width?`         | `number`            | Declared width in px, and where a double-click on the drag handle returns. Default 800: comfortably past the 600 px threshold below which the minimap hides itself, so the editor opens with one and a typical Pine line fits beside it.                                                                                                       |
| `minWidth?`      | `number`            |                                                                                                                                                                                                                                                                                                                                                |
| `maxWidth?`      | `number`            |                                                                                                                                                                                                                                                                                                                                                |
| `overlay?`       | `boolean`           | Float the panel OVER the chart's right edge instead of docking beside it: the chart keeps its width and layout while you edit, and a pin in the header lets the user dock it as a column whenever they prefer (remembered with the shell state). Default true; `false` docks the editor permanently, like the shell's own panels, with no pin. |
| `maximizable?`   | `boolean`           | A Maximize button in the header that spreads the editor over every chart, and restores it (also `codeEditor().maximize()`). Default true.                                                                                                                                                                                                      |
| `persist?`       | `boolean \| string` | Keep the script across reloads. `true` uses the default key, a string names one. Default true: the shell's state document stores indicators by manifest name, so without this a script typed here would be gone on the next load.                                                                                                              |
| `storage?`       | `VelaStorage`       | Where the draft goes. Default `localStorage`.                                                                                                                                                                                                                                                                                                  |
| `diagnostics?`   | `boolean`           | Static checks and run-failure markers. Default true.                                                                                                                                                                                                                                                                                           |
| `initialSource?` | `string`            | The script a fresh editor opens on, when no draft is stored.                                                                                                                                                                                                                                                                                   |
| `colors?`        | `PineEditorColors`  | Custom colours, one key per token role: see [`PineEditorColors`](/vela-pro/api/code-editor#pineeditorcolors).                                                                                                                                                                                                                                  |
| `legendAction?`  | `boolean`           | The `</>` icon on every SCRIPT indicator's legend row (opens that indicator's source in the editor). `false` removes it: the editor itself is untouched. Default true.                                                                                                                                                                         |
| `workerUrl?`     | `string`            | Serve Monaco's worker from this URL instead of a Blob URL: for pages under a Content Security Policy that does not allow `worker-src blob:`.                                                                                                                                                                                                   |

See also: [`PineEditorColors`](/vela-pro/api/code-editor#pineeditorcolors). From `@luxalgo/vela/widget`: `VelaStorage`.

### `EnableDrawingMenusOptions` [#enabledrawingmenusoptions]

Options for [`enableDrawingMenus`](/vela-pro/api/enablers#enabledrawingmenus).

```typescript
interface EnableDrawingMenusOptions {
    decorate?: (menu: HTMLElement, host: HTMLElement) => (() => void) | void;
    searchFrom?: number;
    cards?: boolean;
    toolbarTips?: boolean;
    descriptions?: Record<string, string>;
}
```

| Member          | Type                                                             | Description                                                                         |
| --------------- | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `decorate?`     | `(menu: HTMLElement, host: HTMLElement) => (() => void) \| void` | Replace Pro's treatment of a menu with your own; return its cleanup.                |
| `searchFrom?`   | `number`                                                         | The search field, on menus of at least this many tools (default 8; 0 turns it off). |
| `cards?`        | `boolean`                                                        | A card per tool on hover (default true).                                            |
| `toolbarTips?`  | `boolean`                                                        | The toolbar's button tips as cards (default true).                                  |
| `descriptions?` | `Record<string, string>`                                         | More tool descriptions (or new text for Pro's), by the name the toolbar shows.      |

### `EnableIndicatorLibraryOptions` [#enableindicatorlibraryoptions]

Options for [`enableIndicatorLibrary`](/vela-pro/api/enablers#enableindicatorlibrary).

```typescript
interface EnableIndicatorLibraryOptions {
    libraryUrl?: string;
    basics?: readonly BuiltinIndicator[];
    favorites?: IndicatorFavoritesStorage;
    sections?: readonly IndicatorMenuSection[];
}
```

| Member        | Type                              | Description                                                                                                                                                                                                                                                                                                                                                      |
| ------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `libraryUrl?` | `string`                          | Origin serving the library API (`/api/library/**`). Defaults to the public `DEFAULT_LIBRARY_URL`; point it at a same-origin proxy when the host page cannot reach the public origin cross-site.                                                                                                                                                                  |
| `basics?`     | `readonly BuiltinIndicator[]`     | The Basic tab's name → library-slug list (replaces the built-in default).                                                                                                                                                                                                                                                                                        |
| `favorites?`  | `IndicatorFavoritesStorage`       | Where favorites persist: the product decision is a SERVER backend, so this is the seam to hand your API to (`load` once at startup, debounced `save` after each change). Defaults to a localStorage adapter so dev pages work with no wiring.                                                                                                                    |
| `sections?`   | `readonly IndicatorMenuSection[]` | Host-supplied menu tabs (a personal script list, a team catalog, …), rendered in the rail right after Favorites, in declaration order. Each section names its items through `list()` (called afresh on every menu open) and resolves one item's Pine source through `source(id)` on click; rows join the menu's search and reload-persistence like library rows. |

See also: [`BuiltinIndicator`](/vela-pro/api/indicators#builtinindicator), [`IndicatorFavoritesStorage`](/vela-pro/api/indicators#indicatorfavoritesstorage), [`IndicatorMenuSection`](/vela-pro/api/indicators#indicatormenusection).

### `EnableIndicatorTemplatesOptions` [#enableindicatortemplatesoptions]

Options for [`enableIndicatorTemplates`](/vela-pro/api/enablers#enableindicatortemplates).

```typescript
interface EnableIndicatorTemplatesOptions {
    storage?: IndicatorTemplatesStorage;
    canCreate?: () => boolean;
    recent?: number;
}
```

| Member       | Type                        | Description                                                               |
| ------------ | --------------------------- | ------------------------------------------------------------------------- |
| `storage?`   | `IndicatorTemplatesStorage` | Where templates are kept. Default: the browser's localStorage.            |
| `canCreate?` | `() => boolean`             | Asked before every save; return false to stop it (and show the user why). |
| `recent?`    | `number`                    | How many templates the dropdown lists (default 5).                        |

See also: [`IndicatorTemplatesStorage`](/vela-pro/api/indicators#indicatortemplatesstorage).

### `EnableOrderflowIndicatorsOptions` [#enableorderflowindicatorsoptions]

Options for [`enableOrderflowIndicators`](/vela-pro/api/enablers#enableorderflowindicators).

```typescript
type EnableOrderflowIndicatorsOptions = {};
```

### `EnablePineEngineOptions` [#enablepineengineoptions]

Options for [`enablePineEngine`](/vela-pro/api/enablers#enablepineengine).

```typescript
interface EnablePineEngineOptions {
    engine?: 'worker' | 'inprocess';
    props?: PropsFilter;
    defaultProps?: Record<string, InputValue>;
    footprints?: boolean | FootprintSource;
    importResolver?: PineLibraryResolver;
}
```

| Member            | Type                         | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ----------------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `engine?`         | `'worker' \| 'inprocess'`    | Which engine form every chart gets: `'worker'` (default: Pine runs off the main thread, heavy scripts never block the chart) or `'inprocess'`. Hosts with a strict CSP that cannot allow `worker-src blob:` should pass a per-widget `engines` factory configured with the addon's `workerUrl` option instead: the instance option wins over this default for the same language.                                                                                                                 |
| `props?`          | `PropsFilter`                | Which scripts expose their declaration props (the settings dialog's "Properties" tab: `initial_capital`, `precision`, …). &#x2A;*Default `'strategy'`**: strategies get the tab, plain indicators don't (the split traders expect). `'all'` shows it for every script, `'none'` for none, and an explicit array WHITELISTS prop keys: only those entries appear, in the array's order. Presentation-only: hidden props keep their script-declared values, and `handle.setProps()` still applies. |
| `defaultProps?`   | `Record<string, InputValue>` | Host-level defaults for declaration props, applied beneath script-declared values (a script that declares the prop keeps its own value). Example: `{ initial_capital: 50000 }` backtests every capital-silent strategy from 50k.                                                                                                                                                                                                                                                                 |
| `footprints?`     | `boolean \| FootprintSource` | Order flow for Pine's `request.footprint()`. `false` leaves the surface off (`request.footprint()` answers `na`); a custom `FootprintSource` replaces the default source for hosts with their own order-flow feed.                                                                                                                                                                                                                                                                               |
| `importResolver?` | `PineLibraryResolver`        | Where the libraries of `import <user>/<library>/<version>` statements come from: typically [`pineLibraryResolver`](/vela-pro/api/indicators#pinelibraryresolver) pointed at the host's library files. Asked when a script is prepared, on the main thread. Absent ≡ a script with an `import` fails to run.                                                                                                                                                                                      |

From `@luxalgo/vela-pinets`: `FootprintSource`, `PineLibraryResolver`, `PropsFilter`. From `@luxalgo/vela/plugin`: `InputValue`.

### `EnableRadialWheelOptions` [#enableradialwheeloptions]

Options for [`enableRadialWheel`](/vela-pro/api/enablers#enableradialwheel): the wheel's own options, under the enabler naming every feature uses.

```typescript
type EnableRadialWheelOptions = RadialWheelOptions;
```

See also: [`RadialWheelOptions`](/vela-pro/api/drawings#radialwheeloptions).

### `EnableReplayOptions` [#enablereplayoptions]

Options for [`enableReplay`](/vela-pro/api/enablers#enablereplay).

```typescript
interface EnableReplayOptions {
    controls?: readonly ReplayBarControl[];
    pickShade?: ReplayPickShade | false;
    defaultSpeed?: number;
    keys?: boolean;
}
```

| Member          | Type                          | Description                                                                                        |
| --------------- | ----------------------------- | -------------------------------------------------------------------------------------------------- |
| `controls?`     | `readonly ReplayBarControl[]` | Extra dropdowns on the control bar, in order.                                                      |
| `pickShade?`    | `ReplayPickShade \| false`    | The veil over the bars after the pick line while picking a start bar; `false` leaves them in view. |
| `defaultSpeed?` | `number`                      | The speed a replay starts at, one of the bar's speeds (default 1).                                 |
| `keys?`         | `boolean`                     | Space plays or pauses a running replay, Shift+→ steps one update (default true).                   |

See also: [`ReplayBarControl`](/vela-pro/api/replay-and-strategy#replaybarcontrol), [`ReplayPickShade`](/vela-pro/api/replay-and-strategy#replaypickshade).

### `EnableRichTooltipsOptions` [#enablerichtooltipsoptions]

Options for [`enableRichTooltips`](/vela-pro/api/enablers#enablerichtooltips).

```typescript
interface EnableRichTooltipsOptions {
    cards?: Record<string, TooltipCard>;
}
```

| Member   | Type                          | Description                                                        |
| -------- | ----------------------------- | ------------------------------------------------------------------ |
| `cards?` | `Record<string, TooltipCard>` | More cards (or new text for Pro's), by the name the tooltip shows. |

See also: [`TooltipCard`](/vela-pro/api/drawings#tooltipcard).

### `EnableSideRailOptions` [#enablesiderailoptions]

Options for [`enableSideRail`](/vela-pro/api/enablers#enablesiderail).

```typescript
interface EnableSideRailOptions {
    top?: readonly string[];
    bottom?: readonly string[];
    exclude?: readonly string[];
    hints?: Readonly<Record<string, RailHint>>;
}
```

| Member     | Type                                 | Description                                                                               |
| ---------- | ------------------------------------ | ----------------------------------------------------------------------------------------- |
| `top?`     | `readonly string[]`                  | Ids top to bottom in the upper section (`'panels'`, `'items'` flow slots, `'\|'` groups). |
| `bottom?`  | `readonly string[]`                  | Ids top to bottom in the lower section.                                                   |
| `exclude?` | `readonly string[]`                  | Ids never shown (not in the user's menu either).                                          |
| `hints?`   | `Readonly<Record<string, RailHint>>` | Hover-card copy by id, over Pro's defaults.                                               |

See also: [`RailHint`](/vela-pro/api/layout#railhint).

### `EnableStrategyTesterOptions` [#enablestrategytesteroptions]

Options for [`enableStrategyTester`](/vela-pro/api/enablers#enablestrategytester).

```typescript
interface EnableStrategyTesterOptions {
    autoOpen?: boolean;
    order?: number;
    legendAction?: boolean;
}
```

| Member          | Type      | Description                                                                                 |
| --------------- | --------- | ------------------------------------------------------------------------------------------- |
| `autoOpen?`     | `boolean` | Open the bottom dock on the tester when a strategy first reports a backtest (default true). |
| `order?`        | `number`  | Order among the bottom panels (default 20, after Trading).                                  |
| `legendAction?` | `boolean` | A button on strategies' legend rows that opens the report (default true).                   |

### `EnableSymbolDrawingsOptions` [#enablesymboldrawingsoptions]

Options for [`enableSymbolDrawings`](/vela-pro/api/enablers#enablesymboldrawings).

```typescript
interface EnableSymbolDrawingsOptions {
    storage?: SymbolDrawingsStorage;
    chartKey?: (chart: { cellId: string; host: HTMLElement }) => string;
    symbolKey?: (symbol: string) => string;
}
```

| Member       | Type                                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ------------ | ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `storage?`   | `SymbolDrawingsStorage`                                    | Where the drawings are kept. Default: the browser's localStorage, under `vela-pro.drawings`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `chartKey?`  | `(chart: { cellId: string; host: HTMLElement }) => string` | Names a chart in the storage. Charts given the same name share their saved drawings. Default: the id of the element the shell was built in (the nearest one up the tree, `shell` without any) and the cell's id. A page with several shells in containers without ids should name them here, or they share one set of drawings. It is read at EVERY save and load, not once: a host that shows several documents on one chart (tabs, named layouts) returns the current document's name, and each keeps its own drawings per symbol. Change what it returns BEFORE applying the document. |
| `symbolKey?` | `(symbol: string) => string`                               | Names a symbol in the storage. Default: its ticker without the venue in front, so `BTCUSDT` and `binance:BTCUSDT` are one symbol, and so is the same ticker on another venue. A page where one ticker names different instruments on different venues keeps the venue here: `symbolKey: (symbol) => symbol.toLowerCase()`.                                                                                                                                                                                                                                                                |

See also: [`SymbolDrawingsStorage`](/vela-pro/api/drawings#symboldrawingsstorage).

### `EnableSymbolSearchOptions` [#enablesymbolsearchoptions]

Options for [`enableSymbolSearch`](/vela-pro/api/enablers#enablesymbolsearch).

```typescript
interface EnableSymbolSearchOptions {
    picker?: (ctx: WidgetContext) => SymbolPickerLike;
    inspector?: boolean;
    quotes?: QuoteSource | false;
    sparkline?: boolean;
    venueIcon?: (venue: string) => string | undefined;
    takeOver?: boolean;
    indicatorInputs?: boolean;
}
```

| Member             | Type                                       | Description                                                                                                                            |
| ------------------ | ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
| `picker?`          | `(ctx: WidgetContext) => SymbolPickerLike` | Build the picker a shell opens. Default: Pro's [`SymbolPicker`](/vela-pro/api/symbols#symbolpicker-class); return your own to swap it. |
| `inspector?`       | `boolean`                                  | The details beside the results (default true).                                                                                         |
| `quotes?`          | `QuoteSource \| false`                     | The inspector's quote. Default: from the chart's providers; `false` leaves it out.                                                     |
| `sparkline?`       | `boolean`                                  | The quote's sparkline of recent closes, under the price (default true).                                                                |
| `venueIcon?`       | `(venue: string) => string \| undefined`   | A venue's logo, shown beside its name.                                                                                                 |
| `takeOver?`        | `boolean`                                  | Replace the shell's own symbol search (default true).                                                                                  |
| `indicatorInputs?` | `boolean`                                  | Symbol fields in indicator settings open the picker (default true).                                                                    |

See also: [`QuoteSource`](/vela-pro/api/data-feeds#quotesource), [`SymbolPickerLike`](/vela-pro/api/symbols#symbolpickerlike). From `@luxalgo/vela/plugin`: `WidgetContext`.

### `EnableVelaProOptions` [#enablevelaprooptions]

Options for [`enableVelaPro`](/vela-pro/api/enablers#enablevelapro): every feature is ON by default; set a feature key to `false` to skip it, or to an options object to enable it WITH those options.

```typescript
interface EnableVelaProOptions {
    watermark?: boolean | string;
    footprint?: boolean;
    tpo?: boolean;
    orderflowIndicators?: boolean;
    indicatorLibrary?: boolean | EnableIndicatorLibraryOptions;
    radialWheel?: boolean | EnableRadialWheelOptions;
    replay?: boolean | EnableReplayOptions;
    pineEngine?: boolean | EnablePineEngineOptions;
    codeEditor?: boolean | EnableCodeEditorOptions;
    sideRail?: boolean | EnableSideRailOptions;
    bottomDock?: boolean | EnableBottomDockOptions;
    strategyTester?: boolean | EnableStrategyTesterOptions;
    alerts?: boolean | EnableAlertsOptions;
    watchlist?: boolean | EnableWatchlistOptions;
    orderBook?: boolean | EnableOrderBookOptions;
    plugins?: readonly VelaProPlugin[];
    symbolSearch?: boolean | EnableSymbolSearchOptions;
    richTooltips?: boolean | EnableRichTooltipsOptions;
    drawingMenus?: boolean | EnableDrawingMenusOptions;
    indicatorTemplates?: boolean | EnableIndicatorTemplatesOptions;
    symbolDrawings?: boolean | EnableSymbolDrawingsOptions;
}
```

| Member                 | Type                                         | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ---------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `watermark?`           | `boolean \| string`                          | The mark in the chart's bottom-left corner. &#x2A;*Default `false`**: a Vela Pro page carries no open-source attribution mark. `true` keeps Vela's own mark; a non-empty STRING puts yours there instead: it is inserted as HTML inside the corner's wrapper, so plain text works as plain text and markup as markup. Developer-supplied branding only: never route user input into it. Applies to every chart built afterwards (the widget's, each workspace cell's and a bare `new Vela()`) through Vela's `registerRendererDefaults`. A host that sets `chart.renderer.set('attribution', …)` itself still wins on that chart. |
| `footprint?`           | `boolean`                                    | The footprint chart type.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `tpo?`                 | `boolean`                                    | The TPO (Market Profile) chart type.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `orderflowIndicators?` | `boolean`                                    | The order-flow indicators (Volume Delta, CVD, trade counts, Session VP, overlay Footprint / TPO / Visible Range Footprint).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `indicatorLibrary?`    | `boolean \| EnableIndicatorLibraryOptions`   | The tabbed indicator library menu (Favorites, Built-ins, LuxAlgo) replacing the built-in picker.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `radialWheel?`         | `boolean \| EnableRadialWheelOptions`        | The radial drawing-tool wheel.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `replay?`              | `boolean \| EnableReplayOptions`             | Bar replay (topbar button, start-bar pick, playback controls).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `pineEngine?`          | `boolean \| EnablePineEngineOptions`         | Pine as the default scripting engine.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `codeEditor?`          | `boolean \| EnableCodeEditorOptions`         | The Pine code editor side panel.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `sideRail?`            | `boolean \| EnableSideRailOptions`           | The side rail: Vela's sidebar on the right edge, laid out as Pro's (the screenshot menu, the side-panel toggles, Pro's rail items), with hover cards. A host's own `sidebar` option wins.                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `bottomDock?`          | `boolean \| EnableBottomDockOptions`         | The tabbed bottom dock under the charts (trading panel, strategy tester, host panels).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `strategyTester?`      | `boolean \| EnableStrategyTesterOptions`     | The strategy tester in the bottom dock (Performance, Trades analysis, Trades log).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `alerts?`              | `boolean \| EnableAlertsOptions`             | Price and script alerts: the dialog, the lines on the chart, the Alerts panel.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `watchlist?`           | `boolean \| EnableWatchlistOptions`          | The watchlist side panel (lists, sections, live quotes, symbol details).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `orderBook?`           | `boolean \| EnableOrderBookOptions`          | The order book side panel (book, DOM ladder, trades tape).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `plugins?`             | `readonly VelaProPlugin[]`                   | Plugins to install beside the built-in ones (the watchlist, the order book and alerts): `plugins: [trading(), journal()]`. Each installs after the plugins it requires; one whose requirement is missing is left out, with a console error naming it.                                                                                                                                                                                                                                                                                                                                                                             |
| `symbolSearch?`        | `boolean \| EnableSymbolSearchOptions`       | Pro's symbol picker in place of the shell's (market tabs, venue filter, an inspector).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `richTooltips?`        | `boolean \| EnableRichTooltipsOptions`       | The chart controls' tooltips as cards (icon, name, what it does, shortcut).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `drawingMenus?`        | `boolean \| EnableDrawingMenusOptions`       | The drawing toolbar's menus as a refined list (search, sections, cards) and its tips as cards.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `indicatorTemplates?`  | `boolean \| EnableIndicatorTemplatesOptions` | Indicator templates: a topbar button to save a chart's indicators and apply them anywhere.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `symbolDrawings?`      | `boolean \| EnableSymbolDrawingsOptions`     | Drawings per symbol: each chart keeps its own drawings for each symbol, in a store of their own. Switching symbol takes them off the chart, coming back puts them on again, and a reload keeps them whether or not the shell's state is saved.                                                                                                                                                                                                                                                                                                                                                                                    |

See also: [`EnableAlertsOptions`](/vela-pro/api/alerts#enablealertsoptions), [`EnableBottomDockOptions`](/vela-pro/api/enablers#enablebottomdockoptions), [`EnableCodeEditorOptions`](/vela-pro/api/enablers#enablecodeeditoroptions), [`EnableDrawingMenusOptions`](/vela-pro/api/enablers#enabledrawingmenusoptions), [`EnableIndicatorLibraryOptions`](/vela-pro/api/enablers#enableindicatorlibraryoptions), [`EnableIndicatorTemplatesOptions`](/vela-pro/api/enablers#enableindicatortemplatesoptions), [`EnableOrderBookOptions`](/vela-pro/api/order-book#enableorderbookoptions), [`EnablePineEngineOptions`](/vela-pro/api/enablers#enablepineengineoptions), [`EnableRadialWheelOptions`](/vela-pro/api/enablers#enableradialwheeloptions), [`EnableReplayOptions`](/vela-pro/api/enablers#enablereplayoptions), [`EnableRichTooltipsOptions`](/vela-pro/api/enablers#enablerichtooltipsoptions), [`EnableSideRailOptions`](/vela-pro/api/enablers#enablesiderailoptions), [`EnableStrategyTesterOptions`](/vela-pro/api/enablers#enablestrategytesteroptions), [`EnableSymbolDrawingsOptions`](/vela-pro/api/enablers#enablesymboldrawingsoptions), [`EnableSymbolSearchOptions`](/vela-pro/api/enablers#enablesymbolsearchoptions), [`EnableWatchlistOptions`](/vela-pro/api/watchlist#enablewatchlistoptions), [`VelaProPlugin`](/vela-pro/api/module-sdk#velaproplugin).
