Vela, our next-generation charting platform, is live at vela.luxalgo.com.
LuxAlgo

Interface layout

Enable or disable Vela Pro features and modules, configure the topbar, side rail, and bottom dock, hide chart settings, and customize tooltips.

View as Markdown

Workspace layout and feature visibility are configured at two levels. Options passed to enableVelaPro() control which Vela Pro features, panels, and UI extensions are installed, while options passed to new VelaWorkspace() control the surrounding chrome provided by Vela's open-source core.

import { VelaWorkspace } from '@luxalgo/vela/workspace';
import { BinanceProvider } from '@luxalgo/vela/providers/binance';
import { enableVelaPro, REPLAY_ACTION_ID } from '@luxalgo/vela-pro';

enableVelaPro({
    orderBook: false, // disable the Order book panel
    indicatorTemplates: false, // disable the Indicator templates button
    sideRail: { exclude: ['dataWindow'] }, // hide the Data window button in the side rail
});

const workspace = new VelaWorkspace('#chart', {
    layout: false,
    symbol: 'BTCUSDT',
    timeframe: '60',
    live: true,
    providers: { binance: () => new BinanceProvider() },
    topbar: { left: ['symbol', 'timeframes', 'style', 'indicators', REPLAY_ACTION_ID, 'undo-redo'] },
    bottombar: false,
    settings: { hidden: ['advanced'] },
});
TaskConfiguration
Disable a Vela Pro feature or default moduleenableVelaPro({ replay: false, orderBook: false })
Remove or reorder topbar buttonstopbar: { left, right } on VelaWorkspace
Reorder or hide side rail buttonsenableVelaPro({ sideRail: { top, bottom, exclude } })
Remove the side railsideRail: false globally, or sidebar: false on an individual workspace
Remove the bottom dockbottomDock: false together with strategyTester: false
Hide the drawing toolbar, status line, or bottom bardrawingToolbar, statusline, and bottombar on VelaWorkspace
Hide tabs or rows in the chart settings dialogsettings: { hidden } on VelaWorkspace
Revert to plain tooltips or customize tooltip cardsrichTooltips on enableVelaPro()
Replace a built-in topbar buttonSlot override via registerWidgetAction()
Register a custom panel or toolbar buttonCustom panels and widgets

When the workspace container narrows below the mobile breakpoint, the interface switches to a compact mobile layout that organizes these entries into bottom sheets and overflow menus. See Responsive layout for mobile behavior.

Disabling features and modules

Every option in the table below is enabled by default when you call enableVelaPro(). Pass false to disable a feature, or pass an options object to configure it.

OptionUI and runtime contribution
footprintFootprint entry in the chart style menu, Footprint tab in chart settings, and Footprint context menu actions
tpoTPO entry in the chart style menu, TPO tab in chart settings, and TPO context menu actions
orderflowIndicatorsOrder-flow indicators in the indicator menu
indicatorLibraryVela Pro indicator menu on the Indicators button, favorites dropdown caret, and legend favorite stars (when false, the core indicator picker is used)
indicatorTemplatesIndicator templates button next to Indicators
replayReplay topbar button and interactive replay control bar
symbolSearchVela Pro symbol search dialog replacing the core symbol picker
radialWheelRadial picker for favorite drawing tools triggered by holding Alt
drawingMenusSearchable drawing tool flyout menus with tool description cards
richTooltipsStructured tooltip cards for toolbar and side rail controls
pineEngineDefault Pine Script® engine registration (when false, register a scripting engine manually)
codeEditorPine code editor side panel, rail button, and </> Edit code action on Pine Script® legend rows
strategyTesterStrategy Tester panel in the bottom dock and Strategy report action on strategy legend rows
sideRailRight-hand side rail hosting panel toggles and screenshot actions
bottomDockResizable bottom panel dock below the bottom bar
alertsAlerts side panel, Add alert context menu entries, chart alert price lines, and alert bell on script legend rows
watchlistWatchlist side panel
orderBookOrder book side panel
symbolDrawingsAutomatic per-symbol drawing persistence on each chart

Trading, Journal, and Calendar are opt-in packages rather than default features, so they are omitted from the table above. The API refers to modules as plugins, so pass opt-in modules in the plugins array of enableVelaPro({ plugins: [...] }), as covered in the Modules and widgets overview.

Keep two initialization behaviors in mind when disabling features:

  • enableVelaPro() installs each feature once per page load. Calling enableVelaPro() a second time cannot disable an already installed feature or update options set during the first call, so invoke it once with your complete configuration before constructing a workspace.
  • Enabling strategyTester automatically activates bottomDock so backtest reports have a host container. To remove the bottom dock completely, pass both bottomDock: false and strategyTester: false.

Topbar layout

The core renders the topbar and configures its visible items through the topbar workspace option, which accepts left and right arrays. Any side you omit retains its default list (['symbol', 'timeframes', 'style', 'layout', 'indicators', 'actions', 'undo-redo'] on the left, and ['actions', 'alerts', 'panels', 'screenshot'] on the right). The 'actions' token marks the slot where buttons registered by Vela Pro and custom plugins appear unless positioned by explicit ID.

Vela Pro exports action ID constants so you can position its topbar buttons explicitly:

ButtonAction IDDefault placement
Indicators'indicators'Core 'indicators' slot (overridden by the Vela Pro indicator menu)
Indicator templatesINDICATOR_TEMPLATES_ACTION_ID ('vela-pro.indicator-templates')Left side, adjacent to 'indicators'
ReplayREPLAY_ACTION_ID ('vela-pro.replay')Left side, inside the 'actions' slot

Declaring an array for left or right specifies the complete list of entries rendered on that side. Any ID omitted from that array is hidden, including Vela Pro buttons when 'actions' is also omitted. In the example at the top of this page, REPLAY_ACTION_ID is included explicitly so Replay renders, whereas Indicator templates is omitted and stays hidden even if indicatorTemplates is enabled. Hiding a topbar entry also removes its mobile menu row and disables its keyboard shortcut.

With Vela Pro defaults active, the right side of the topbar contains no visible built-in buttons because side panel toggles and Screenshot move into the side rail, and the Alerts module hides the core bell icon in favor of the rail's Alerts button. Set enableVelaPro({ alerts: { topbarBell: true } }) to retain the topbar bell button and wire it to open the Alerts panel.

Keep 'screenshot' present in topbar.right whenever the side rail's Screenshot button is enabled. The rail Screenshot action triggers image capture through the hidden core screenshot control. If you remove 'screenshot' from topbar.right or override the 'screenshot' slot with a custom action, also add 'vela-pro.screenshot' to sideRail.exclude so the rail does not display an inactive download button.

See Composing the topbar in the core documentation for every built-in topbar entry and layout rule.

Side rail layout

The sideRail feature enables and configures the core sidebar for every workspace constructed afterward. Its top and bottom arrays list entries from top to bottom within each section:

import { enableVelaPro } from '@luxalgo/vela-pro';

enableVelaPro({
    sideRail: {
        top: ['vela-pro.watchlist', 'vela-pro.alerts', '|', 'panels'],
        bottom: ['items', '|', 'vela-pro.screenshot'],
        exclude: ['objects', 'dataWindow'],
        hints: { 'vela-pro.screenshot': { description: 'Save or copy a snapshot of your ACME charts.' } },
    },
});
OptionDefaultDescription
top['vela-pro.screenshot', '|', 'panels']Ordered entries in the upper rail section
bottom['objects', 'dataWindow', '|', 'items']Ordered entries anchored to the bottom of the rail
exclude[]Entry IDs hidden from the side rail
hintsBuilt-in descriptionsTooltip card overrides keyed by entry ID ({ description, shortcut? })

Each entry in top or bottom can be one of the following tokens:

  • A side panel ID such as 'vela-pro.watchlist', or the core 'objects' and 'dataWindow' panels (see Workspace layout for all panel IDs).
  • 'vela-pro.screenshot' for the Screenshot menu button.
  • 'bottom:<panel-id>' for a bottom dock panel toggle, such as 'bottom:vela-pro.trading'.
  • 'panels' for all registered side panels not placed explicitly, and 'items' for all remaining rail action buttons (Screenshot, bottom dock toggles, and custom sidebar actions).
  • '|' for a horizontal divider.

The sideRail.hints map sets tooltip card text for 'vela-pro.screenshot', 'objects', 'dataWindow', and custom panels. Vela Pro modules register their panel descriptions during module installation after sideRail.hints is read, so module defaults take precedence over hints. To customize a Vela Pro module's tooltip card, call describeRailEntry('vela-pro.watchlist', { description }) from @luxalgo/vela-pro after enableVelaPro().

Rail ordering is fixed in configuration; users cannot reorder or hide rail buttons in the UI. Passing a sidebar option on an individual VelaWorkspace overrides the global sideRail configuration for that workspace (sidebar: false hides the rail on that instance, and { top, bottom } applies a custom order where the core API names the 'items' catch-all slot 'actions').

When the side rail is disabled, side panel buttons and Screenshot return to the topbar. Bottom dock panels have no topbar button when the rail is disabled, so open them programmatically using bottomDock().

Bottom dock

The bottom dock sits beneath the bottom bar, remains collapsed until a panel opens, and displays one panel at a time.

OptionDefaultDescription
height300Initial open height in pixels (user drag adjustments are persisted)
minHeight140Minimum height in pixels when resizing
chartFloor220Minimum vertical height in pixels reserved for the chart area above an open dock
railItemstrueAutomatically adds a toggle button to the side rail for each dock panel
panelsAll registered dock panelsAllowlist of panel IDs hosted by the dock; unlisted panels are excluded

Use bottomDock(workspace.root) to open, close, or toggle a bottom dock panel from custom application UI:

import type { VelaWorkspace } from '@luxalgo/vela/workspace';
import { bottomDock } from '@luxalgo/vela-pro';

declare const workspace: VelaWorkspace;

document.querySelector('#positions')?.addEventListener('click', () => {
    bottomDock(workspace.root)?.toggle('vela-pro.trading');
});

Built-in bottom dock panel IDs are 'vela-pro.strategy' for the Strategy Tester and 'vela-pro.trading' for the Trading panel.

Workspace chrome toggles

The following VelaWorkspace boolean options default to true and hide individual chrome regions when set to false:

OptionEffect when false
drawingToolbarHides the left-hand drawing toolbar while keeping drawings accessible via the radial wheel, keyboard shortcuts, and chart.drawings
drawingsHides the entire drawing UI, including the desktop toolbar and the mobile drawings sheet, while keeping the chart.drawings API active
statuslineHides the OHLCV and symbol status line at the top of each chart
bottombarHides the bottom bar containing date range chips, session switcher, clock, and time zone picker
watermarkHides the background symbol watermark behind the price pane (configure the corner attribution mark via enableVelaPro({ watermark }), as covered in Theming and branding)

Chart settings visibility

Pass dot-separated setting paths in settings.hidden on VelaWorkspace to remove entire tabs, groups, or individual rows from the chart settings dialog (for example 'advanced', 'canvas.grid', or 'scales.price-scale.countdown'). Vela Pro chart-type tabs use the IDs 'type:footprint' and 'type:tpo'.

Hiding an entry only removes its control from the settings dialog; the setting retains its configured value and continues to apply to the chart, which lets you lock specific visual options. To inspect every registered setting ID on a live chart instance, call listSettingsIds():

import type { VelaWorkspace } from '@luxalgo/vela/workspace';

declare const workspace: VelaWorkspace;

console.log(workspace.chart.renderer.listSettingsIds());

See the settings option in the core documentation for the built-in setting ID reference.

Tooltip cards

When richTooltips is enabled, recognized workspace controls display structured tooltip cards with an icon, title, one-line description, and keyboard shortcut badge. Pass richTooltips: false to revert to standard plain-text tooltips.

Use richTooltips.cards to define tooltip cards for custom toolbar buttons or override built-in card text, keyed by the button's tooltip label:

import { enableVelaPro } from '@luxalgo/vela-pro';

enableVelaPro({
    richTooltips: {
        cards: {
            'Export trades': { description: 'Download the trades of this account as a CSV file.', shortcut: 'Mod+E' },
            Replay: { description: 'Step through historical sessions one bar at a time.' },
        },
    },
});

Join keys in shortcut with +, using Mod to display ⌘ on macOS and Ctrl on Windows and Linux. Side rail buttons read their card text from sideRail.hints and describeRailEntry() rather than richTooltips.cards.

Replacing built-in buttons

Two built-in topbar entries, 'indicators' and 'screenshot', support slot overrides. Registering a widget action under either ID replaces the built-in button, its mobile menu entry, and its keyboard shortcut. Because Vela Pro's indicator menu claims the 'indicators' slot by default, set indicatorLibrary: false before registering a custom 'indicators' action:

import { registerWidgetAction, type WidgetContext } from '@luxalgo/vela/plugin';
import { enableVelaPro } from '@luxalgo/vela-pro';

declare const myStudies: { open(ctx: WidgetContext): void };

enableVelaPro({ indicatorLibrary: false });

registerWidgetAction({
    id: 'indicators',
    target: 'topbar',
    label: 'Studies',
    icon: 'indicators',
    run: (ctx) => myStudies.open(ctx),
});

Other built-in topbar controls (symbol, timeframes, style, layout, undo-redo, alerts, and panels) reflect live workspace state and cannot be overridden via registerWidgetAction(). To replace one, omit its token from topbar and insert a custom action ID in its position. To customize the symbol search modal while keeping the built-in symbol button, configure a custom picker in symbolSearch instead (see Symbol search).

See slot overrides and widget actions in the core plugin SDK documentation for full details.

Localization

Setting locale on VelaWorkspace together with a registered locale pack translates core UI controls (built-in topbar items, the drawing toolbar and tool labels, and built-in chart settings) and formats chart axis numbers and timestamps according to that locale. See Localization in the core documentation for locale registration.

In the current version, Vela Pro UI strings do not follow the workspace locale option. Labels on Vela Pro buttons, panels, menus, dialogs, tooltip cards, and Footprint or TPO settings remain in English, and Vela Pro module tables format numbers and dates using a fixed English locale. Labels on custom panels and widget actions registered by your application can use core localized messages, which VelaWorkspace translates normally.

On this page