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

Overview

Packages, entry points, page conventions, and version matrix for the Vela Pro API reference.

View as Markdown

This section documents every public function, class, interface, type alias, enum, and constant exported by Vela Pro. All declarations and member descriptions are generated from the TypeScript source of Vela Pro 0.5.12 and match the published .d.ts type definitions.

For conceptual guides, integration patterns, and runnable examples, start with Quickstart and Architecture.

Packages and entry points

Vela Pro is distributed as the main @luxalgo/vela-pro package (with three entry points) and six standalone module packages. In the TypeScript API, modules use the plugin naming convention (definePlugin, VelaProPlugin, and the plugins option on enableVelaPro()).

PackageImport pathContentsExportsReference
@luxalgo/vela-pro@luxalgo/vela-proenableVelaPro(), individual feature enablers, and core Vela Pro APIs265Split across nine feature pages (below)
@luxalgo/vela-pro@luxalgo/vela-pro/editorPine code editor enabler, handle, drafts, diagnostics, and language dataset types27Code editor
@luxalgo/vela-pro@luxalgo/vela-pro/pluginModule authoring SDK (definePlugin, plugin context, and panel and UI helpers)93Module SDK
@luxalgo/vela-pro-watchlist@luxalgo/vela-pro-watchlistWatchlist plugin, controller, standalone widgets, and storage port30Watchlist
@luxalgo/vela-pro-alerts@luxalgo/vela-pro-alertsAlerts plugin, controller, backend port, alert dialog, and list widget34Alerts
@luxalgo/vela-pro-dom@luxalgo/vela-pro-domOrder book (DOM) plugin, standalone ladder widget, and display settings14Order book
@luxalgo/vela-pro-trading@luxalgo/vela-pro-tradingTrading plugin, Broker port, PaperBroker, controller, and trading widgets83Trading
@luxalgo/vela-pro-journal@luxalgo/vela-pro-journalJournal plugin, controller, storage port, widgets, and trade analytics64Journal
@luxalgo/vela-pro-calendar@luxalgo/vela-pro-calendarCalendar plugin, data source port, controller, widget, and event types48Calendar

Exports from the main @luxalgo/vela-pro entry point are organized by feature area across nine pages:

PageContentsSymbols
Enablers and optionsenableVelaPro(), individual feature enablers, and their configuration option types33
Layout and panelsSide rail, bottom dock, panel descriptors, and DOM, icon, and formatting helpers38
Chart types and order flowFootprint, TPO, and order-flow data models, data engines, and aggregation helpers40
Data feedsFootprint feed and store, market depth, trade tape, and quote interfaces23
IndicatorsIndicator menu, favorites, indicator templates, and Pine Script® library resolver40
Code editorPine code editor handle, enabler options, diagnostics, and /editor entry point types25
SymbolsSymbol search dialog, custom sections, and market/venue parsing helpers21
DrawingsPer-symbol drawing storage, drawing menus, radial tool wheel, and rich tooltip cards28
Replay and strategyBar replay controls and strategy tester tracker, report builder, and metrics types16

Page conventions

  • Import paths: Each page states its default import path at the top. Individual entries note when a symbol is imported from a different path or re-exported from multiple paths.
  • Grouping and order: Symbols are grouped by kind (Functions, Classes, Interfaces and types, Constants, and Namespaces) and sorted alphabetically within each group.
  • Signatures and defaults: Function signatures are formatted by the TypeScript type checker. Parameters with default values appear as optional (?), with default values listed beneath the signature or in the parameter table.
  • Member tables: Interfaces, object type aliases, enums, and classes include a member table whenever members have documentation comments. Optional members end with ?. Long member types are truncated in table cells; see the TypeScript declaration block above the table for the full type.
  • Class visibility: Class declarations include public constructors, properties, accessors, and methods. Private and protected members are omitted.
  • Unexported supporting types: When a public declaration references an unexported helper type from the same package, that helper declaration is included beneath the entry.
  • Cross-references: Each entry lists related Vela Pro symbols under "See also" and external upstream types under "From". Symbols re-exported from another entry point appear in the "Re-exports" table at the bottom of the page.

Types such as WidgetContext, ChartClient, and DataProvider are defined in Vela's open-source core (@luxalgo/vela). See the core API reference and Plugin SDK documentation for their definitions.

Package versions

This reference was generated from the package versions listed below, along with the core and PineTS packages installed in the build environment.

PackageVersion
@luxalgo/vela-pro0.5.12
@luxalgo/vela-pro-watchlist0.1.2
@luxalgo/vela-pro-alerts0.1.2
@luxalgo/vela-pro-dom0.1.2
@luxalgo/vela-pro-trading0.1.2
@luxalgo/vela-pro-journal0.1.2
@luxalgo/vela-pro-calendar0.1.2
@luxalgo/vela0.10.9
@luxalgo/vela-ui0.4.2
@luxalgo/vela-pinets0.3.4

On this page