Overview
Packages, entry points, page conventions, and version matrix for the Vela Pro API reference.
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()).
| Package | Import path | Contents | Exports | Reference |
|---|---|---|---|---|
@luxalgo/vela-pro | @luxalgo/vela-pro | enableVelaPro(), individual feature enablers, and core Vela Pro APIs | 265 | Split across nine feature pages (below) |
@luxalgo/vela-pro | @luxalgo/vela-pro/editor | Pine code editor enabler, handle, drafts, diagnostics, and language dataset types | 27 | Code editor |
@luxalgo/vela-pro | @luxalgo/vela-pro/plugin | Module authoring SDK (definePlugin, plugin context, and panel and UI helpers) | 93 | Module SDK |
@luxalgo/vela-pro-watchlist | @luxalgo/vela-pro-watchlist | Watchlist plugin, controller, standalone widgets, and storage port | 30 | Watchlist |
@luxalgo/vela-pro-alerts | @luxalgo/vela-pro-alerts | Alerts plugin, controller, backend port, alert dialog, and list widget | 34 | Alerts |
@luxalgo/vela-pro-dom | @luxalgo/vela-pro-dom | Order book (DOM) plugin, standalone ladder widget, and display settings | 14 | Order book |
@luxalgo/vela-pro-trading | @luxalgo/vela-pro-trading | Trading plugin, Broker port, PaperBroker, controller, and trading widgets | 83 | Trading |
@luxalgo/vela-pro-journal | @luxalgo/vela-pro-journal | Journal plugin, controller, storage port, widgets, and trade analytics | 64 | Journal |
@luxalgo/vela-pro-calendar | @luxalgo/vela-pro-calendar | Calendar plugin, data source port, controller, widget, and event types | 48 | Calendar |
Exports from the main @luxalgo/vela-pro entry point are organized by feature area across nine pages:
| Page | Contents | Symbols |
|---|---|---|
| Enablers and options | enableVelaPro(), individual feature enablers, and their configuration option types | 33 |
| Layout and panels | Side rail, bottom dock, panel descriptors, and DOM, icon, and formatting helpers | 38 |
| Chart types and order flow | Footprint, TPO, and order-flow data models, data engines, and aggregation helpers | 40 |
| Data feeds | Footprint feed and store, market depth, trade tape, and quote interfaces | 23 |
| Indicators | Indicator menu, favorites, indicator templates, and Pine Script® library resolver | 40 |
| Code editor | Pine code editor handle, enabler options, diagnostics, and /editor entry point types | 25 |
| Symbols | Symbol search dialog, custom sections, and market/venue parsing helpers | 21 |
| Drawings | Per-symbol drawing storage, drawing menus, radial tool wheel, and rich tooltip cards | 28 |
| Replay and strategy | Bar replay controls and strategy tester tracker, report builder, and metrics types | 16 |
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, andNamespaces) 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.
| Package | Version |
|---|---|
@luxalgo/vela-pro | 0.5.12 |
@luxalgo/vela-pro-watchlist | 0.1.2 |
@luxalgo/vela-pro-alerts | 0.1.2 |
@luxalgo/vela-pro-dom | 0.1.2 |
@luxalgo/vela-pro-trading | 0.1.2 |
@luxalgo/vela-pro-journal | 0.1.2 |
@luxalgo/vela-pro-calendar | 0.1.2 |
@luxalgo/vela | 0.10.9 |
@luxalgo/vela-ui | 0.4.2 |
@luxalgo/vela-pinets | 0.3.4 |