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

Glossary

Definitions of core Vela Pro concepts, architectural terms, and API naming conventions with links to detailed guides.

View as Markdown

This glossary defines the architectural and domain terms used across the Vela Pro documentation, along with links to the primary guide for each concept.

Terminology

TermDefinitionGuide
active chartIn a multi-chart workspace, the chart currently targeted by shared chrome such as the topbar, drawing toolbar, and side panels. Returned by workspace.chart.Workspace layout
bottom dockThe resizable and maximizable panel region beneath the chart grid that hosts wide panels such as the trading panel and strategy tester, displaying one panel at a time.Workspace layout
cellThe API term for an individual chart slot inside a workspace grid (cells, cellId). A cell retains a stable identifier across symbol and layout changes.Workspace (Vela core)
chartA single chart instance inside a workspace displaying one symbol on one timeframe.Workspace layout
chart typeA price-series visualization selected from the topbar style menu, including built-in styles (candles, bars, line) as well as Footprint and TPO from Vela Pro.Chart types
controllerA programmatic handle for driving an installed module from application code, such as tradingController() or alertsController(). Returns null until enableVelaPro() installs the module.Modules and widgets
coreVela's open-source core (@luxalgo/vela), the charting library that Vela Pro extends with chart types, modules, and tools. Provides the chart model, VelaWorkspace, providers, drawings, and the plugin SDK.Why Vela Pro
depth feedOptional provider methods (subscribeBook and subscribeTrades, typed as DepthFeed) that stream order book snapshots and live trades to the Order Book module.Quotes and market depth
enablerA registration function such as enableFootprint() that activates an individual Vela Pro capability for workspaces constructed afterward. enableVelaPro() invokes all default enablers at once.Quickstart
engineA scripting runtime implementing the core's ScriptingEngine port to execute indicator scripts and emit plot primitives. Vela Pro registers the Pine Script® engine by default.Custom runtimes
featureA chart or shell capability registered by Vela Pro, such as Footprint charts, bar replay, the Pine code editor, or the side rail. Enabled by default in enableVelaPro() and individually disableable.Architecture
footprintA chart type that renders traded volume at each price level inside every bar, split between aggressive buyers and sellers.Footprint
footprint feedOptional provider methods (getFootprints, subscribeFootprints, and footprintCaps, typed as FootprintFeed) required by the Footprint chart type and order-flow indicators.Footprint data
indicator templateA named preset of a chart's active indicators (and optionally its symbol and timeframe) that users can save and apply to any chart.Indicator templates
layoutThe grid arrangement of charts inside a workspace, such as '4' or '2h'. Passing layout: false renders a single chart without multi-chart layout controls.Layouts and chart state
moduleA domain-specific workspace panel and widget package distributed under plugins/: Watchlist, Alerts, Order Book, Trading, Journal, and Calendar.Modules and widgets
native indicatorAn indicator computed directly in TypeScript/JavaScript via registerNativeIndicator rather than executed through a scripting engine. Vela Pro's sixteen order-flow studies are native indicators.Indicators and scripting
paneA horizontal band within a chart carrying an independent vertical value scale, consisting of the primary price pane on top and separate study panes below.API reference (Vela core)
paper brokerThe default in-browser simulated execution adapter (PaperBroker) used by the Trading module when no custom Broker is supplied.Trading
pluginThe SDK identifier used in code for a domain module (plugins, definePlugin, VelaProPlugin).Custom modules
portA typed service interface through which a module communicates with your backend or market data layer (Broker, AlertsBackend, JournalStore, WatchlistStorage, QuoteSource, DepthFeed, CalendarSource).Modules and widgets
providerAn object implementing the core's DataProvider contract to supply historical bars, symbol metadata, and real-time candle updates. Only getBars is mandatory.Data connectivity
renderer layerA custom canvas drawing pass registered via registerRendererLayer in the core SDK. Footprint, TPO, and volume profile studies render through custom layers.Plugin SDK (Vela core)
side railThe vertical toolbar along the right edge of a workspace containing toggle buttons for installed side panels and bottom dock panels.Workspace layout
state documentThe serializable JSON object returned by workspace.getState() and accepted by workspace.applyState(), capturing the grid layout and per-cell chart state.Layouts and chart state
storage adapterAn object implementing get, set, and optional remove (VelaStorage) used by a workspace or feature to persist state outside browser localStorage.Server-side storage
TPOTime Price Opportunity, a session profile chart type built from standard OHLCV candles that plots lettered time-period blocks at each traded price level.TPO
widgetA standalone, framework-agnostic UI component exported by a module (such as createWatchlist(props)) returning { el, update, destroy } for mounting anywhere on a page.Standalone widgets
workspaceAn instance of VelaWorkspace managing either a single chart (layout: false) or a multi-chart grid along with shared toolbars, panels, and persistence.Quickstart

API naming differences

Several TypeScript identifiers in the Vela and Vela Pro APIs use lower-level SDK names that differ from the user-facing terms used in this documentation:

API identifierDocumentation term
plugins, definePlugin, VelaProPluginModule
cells, cellId, workspace.cell()Chart within a workspace grid
shell (for example, registerShellDefaults in the core)Workspace and its surrounding interface chrome
WidgetContext, registerWidgetAction, registerWidgetAttachment (core plugin SDK)Workspace extension hooks (distinct from standalone Vela Pro module widgets)

On this page