Enumerations and Constants
TradeScript prefers typed literal unions over classic TypeScript enums, so most "enumerations" appear as union type aliases (for example interval, chart-type, and order-status unions). What ships as runtime values are exported catalog constants — use BUILT_IN_INDICATORS, DRAWING_TOOLS, ALL_CHART_TYPES, and the interval/favorites constants when application UI needs the same catalog values as the chart.
Every entry below links to its full declaration in the domain reference.
Hard upper bound for one user message, including every follow-up tool round.
Explicit public-widget semantic inventory. This is intentionally not derived from JSX, callback names, or DOM shape. A visible affordance belongs to a declared controller/stream, a composed surface, o
The canonical reason ids explaining why an agentic control is unavailable on a target:
not-mounted, provider-unsupported, insufficient-data-quality, policy-denied, execution-mode-mismatch, `Identifiers of every SDK controller contract in the agentic catalog, spanning the widget/chart core (widget, chart, timeScale, data) through trading, risk, replay, workspace, and the terminal widget c
Exact ChartApi feature ownership. Every user-operable feature owns at least one standalone semantic control so browser UI and agentic transports share the same authority.
Exact storage ownership for the widget-level saved-layout controller.
Exact storage capability ownership for chart/replay controls.
Exact SDK-owned extractor identities. The bulk symbol/account/resource bindings are intentionally added separately; an extractor becomes public semantic authority only when its exact id is declared he
The complete frozen catalog of agent-callable control descriptors: every classified controller method from the authored control groups plus the projection-backed
chart.formatPrice and chart/widget sExact broad-input contracts implemented by the SDK policy validator. A new binding is authored here; registries and transports never derive one from a method name, argument position, or runtime object
Canonical SDK semantic decisions for callable controller methods. Protocol bridges consume this catalog; they must not classify methods independently.
Exact controller ownership/scope facts shared by every agent transport.
Exact market-data domains used by policy; providers never infer one from a method name.
Canonical JSON can expand each input code unit to a six-character escape. Seven additional characters encode the tuple brackets, quotes, and comma.
Widget methods whose authority only exists for a multi-chart assembly.
Identifiers of the numeric upper-bound policy constraints a host can impose on agentic access — history lookback (ms), row counts, subscription frequency (Hz) and buffer, and the trading quantity/noti
Maximum UTF-16 code units accepted for one caller-owned guarded operation id.
Public, transport-neutral guarded operation identity bounds.
Maximum UTF-16 code units accepted for a guarded operation namespace.
Exact SDK event identities with a portable projection contract below.
Constraints whose active value must be explicitly classified by every aggregate state/event projection.
Identifiers of the read-access control families used to group read controls for family-level permissioning (terminal, chart, market data, trading, risk, account, options, and the rest); the source of
Exact replay feature ownership. Registration consumes these ids without method-name inference.
Exact SDK-owned result-filter identities used to narrow readable results.
Identifier of one optimistic-concurrency revision domain: the chart-owned
ChartRevisionDomain values plus domains owned by standalone trading widgets such as risk, orderTicket, and depthLadderIdentifiers of the string-allowlist policy constraints a host can impose on agentic access — symbols, accounts, data domains and fields, customization paths, drawing kinds, resource ids and kinds, ord
Canonical semantic identities for controller event streams.
Exact SDK-owned subscription option bindings. These are direct input facts: they are checked after the option schema and before the provider subscribe function. No channel-name, controller-family, or
Explicit non-callable decisions; kept beside controls so audits have one SDK authority.
Flattened, reviewed list of controller methods deliberately excluded from the agent-callable surface — one entry per controller/method with the exclusion reason (callback wiring, host-owned lifecycle,
The merged map of every symbol/account result-filter implementation, combining the control-result, controller-state, and subscription-event filter maps into one id-keyed authority consumed by the SDK
Control ids (depth-ladder execution actions, panel-layout snapshots, replay operations, and
trading.getLogs) whose bound result filters deny by throwing whenever a symbol or account constraint is acPer-controller symbol/account constraint projection contracts for controller-state reads: most controllers declare a
filtered contract naming the exact allowedSymbols/allowedAccounts result filter tThe exact ids of the symbol/account result filters applied to subscription events (e.g.
data.bars.allowedSymbols, trading.events.allowedSymbolsAccounts), derived from the filtered event contracts The symbol/account filter implementations for subscription events, keyed by exact filter id (e.g.
data.quotes.allowedSymbols); each narrows or rejects one channel's event payload under active symbolThe controllers (
data, orderTicketLauncher, widgetBar, workspaceTabs) whose controller state is declared independent of symbol and account constraints, so their state projections need no allowThe subscription channels (
orderTicketLauncher.state, widgetBar.state, workspaceTabs.state) whose events are declared independent of symbol and account constraints, so they cross constrained reaThe symbol/account filter implementations for control invocation results, keyed by exact filter id (e.g.
trading.listAccounts.allowedAccounts); each narrows or rejects one control's read result undeThe exact ids of the symbol/account result filters applied to controller-state projections (e.g.
chart.controllerState.allowedSymbols), derived from the filtered controller-state contracts and mergeThe symbol/account filter implementations for controller-state projections, keyed by exact filter id (e.g.
chart.controllerState.allowedSymbols); each narrows one controller's aggregate state under Per-channel symbol/account constraint projection contracts covering every built-in subscription: filtered channels name the exact allowedSymbols/allowedAccounts event filter, and the three independent
Identifiers of the trade-access control families —
orders, positions, leverage, and emergency; the source of the AgenticTradeFamilyId union.The
SdkError code thrown when an access policy's trade grant declares an execution mode (e.g. paper) that does not match the broker's actual execution environment. Hosts can match this constant whExhaustive SDK-owned UI affordance inventory consumed unchanged by generators.
Built-in widget surface identities. New public agentic widget kinds must be declared here.
Identifiers of the write-access control families used to group non-financial state-mutating controls (layout, navigation, drawings, indicators, watchlists, customization, risk policy, and the rest); t
Every interval the SDK ships out of the box, ordered tick intervals first, then second intervals, then the default minute-through-month set.
Canonical registry of SDK-facing chart types. Single source of truth shared by the controller (supported list / validation), the engine (mapping to internal candle types), and the chart-type selector
Token set for a shipped preset.
Ids of every built-in shortcut action seeded by the SDK widget, in
BUILT_IN_ACTIONS order. Useful for hosts that remap, disable, or override built-ins by id.Catalog of the built-in default hotkey actions (undo/redo, zoom, symbol search, layout save/load, snapshots, scale toggles, drawing tools, alerts, and buy/sell intents) that the SDK widget seeds as or
Lists the stable id of every built-in chart control, in inventory order (one per entry in
BUILT_IN_CONTROLS). Use it to enumerate or validate control ids without carrying the full descriptors.The complete inventory of built-in visible chart controls, grouped by surface (period bar, drawing sidebar, chart canvas, pane headers, time scale). Each entry carries a stable public id, a built-in E
Catalog of the SDK's built-in market event types — news, company-calendar, corporate-action, market-structure, futures-lifecycle, and economic-calendar entries — each carrying its default marker style
Every surface that owns at least one control, in inventory order.
Stable chart customization action used by native chart UI to open the SDK hotkey editor.
Stamped on the widget root while any chart menu is open.
Every shipped preset id, in catalog order.
The frozen first-party theme catalog: all twelve shipped presets keyed by name, each carrying its label and description, base ground, derivation seed, derived UI tokens, plot color palette, and a read
DOM attribute that marks the element owning one resolved chart-theme scope.
Frozen list of every
--ts-chart-* CSS custom property the UI theme system can set — the union of all theme variable groups (buttons and button tones, surfaces, modals, controls, checkboxes, radios, Continuous 24x7 schedule (crypto): a single regular window per day in UTC.
Built-in English strings for every Agent Console label.
Default time-based interval set offered when neither the host nor the datafeed declares one:
1m through 30m, 1H through 4H, 1D, 1W, and 1M.The standard handle color — a clean professional blue. This is the app-wide accent used for control-point dots, arrow-mark resize handles and image handles.
The chart types favorited by default in the chart-type selector —
'candles', 'line', and 'area' — used whenever no user favorites are stored in localStorage.Drawing-tool catalog ids favourited by default when no stored or host-initialized favourites exist:
segment, horizontalStraightLine, rect, and text.Indicator catalog ids favourited by default when no stored or host-initialized favourites exist:
MA, EMA, RSI, and VOL.Default favourite intervals ('1m', '15m', '1h') for the period bar's quick-access row, used whenever localStorage holds no stored favourites and the host has not seeded any via `initializeFavoriteInte
Default entries of the mobile Time Interval sheet when the host supplies none: minute intervals from
1m to 30m, hour intervals 1H/2H/4H, and 1D/1W/1M.Default quick-interval shortcuts rendered beside the active-interval pill when the host supplies none:
1D, 1W, and 1M labelled Daily, Weekly, and Monthly.The two built-in session visibility profiles used when
SessionFilterOptions.visibilityProfiles is not supplied: 'regular' (regular-session bars only) and 'extended' (pre-market, regular, and posDefault map from a requested interval to the smaller source interval synthetic aggregation builds it from when no explicit
sourceIntervals rule is supplied — for example 2m/3m from 1m, 2H/`4The single source of truth for out-of-the-box widget hotkeys. Every chord in this table must be unique across every widget kind *and* must not collide with the chart's built-in shortcuts in `defaultSh
The states 'extended' mode shows: the full pre-market → regular → post-market day.
The shipped defaults, in hash order. Entry 0 is the
identity-1 token pair, entry 1 the identity-2 pair, and so on — the tokens are 1-indexed so they read naturally in CSS. (Written without the fulPalette registry: the shipped thermal ramp plus the TradeScript colormap family (matplotlib/seaborn anchor colors). Stops are evenly spaced and interpolated linearly in RGB.
Public semantic operations a MarketDataController can expose. The resolved manifest intersects the feed's async declaration with its callable methods.
Maximum number of chart panes a multi-chart layout may contain (16); layout builders clamp requested chart counts and leaf-id generation to this bound.
Every reserved chord, for settings UIs that want to list or grey them out.
One risk decision can carry any valid guarded effective operation identity.
Package and worker handshake version, sourced from the published package metadata.
Built-in second-based interval set:
1s, 5s, 10s, 15s, and 30s.Versioned ATR interpretation required by the first strategy draft schema.
The only strategy document version accepted by the first paper-agent boundary.
Versioned EMA interpretation required by the first strategy draft schema.
Built-in tick-count interval set:
1T, 5T, 10T, 25T, 50T, and 100T.The frozen SDK entry-point namespace:
installLease for authorization, the mount, createChart, and widget constructors, and version.Public semantic operations a TradingController can expose to host UIs and agentic transports. Support is declared by the controller; consumers must not infer it from broker names, feature-family strin
Runtime tuple of the line kinds rendered by the native pre-trade order draft —
entry, takeProfit, and stopLoss; backs the TradingDraftLineKind union and keys `TradingDraftOverlayStyle.kindStylRuntime tuple of the units
TradingExitDefaults values are expressed in — percent, price, pips, and amount; backs the TradingExitDefaultsMode union.Runtime tuple of order time-in-force types —
day, gtc, gtd, ioc, fok, and custom; backs the TradingOrderDurationType union used by TradingOrderDuration.type.Runtime tuple of order sides —
buy and sell; backs the TradingOrderSide union.Runtime tuple of every provider-neutral order-type semantic the SDK understands, from plain market/limit/stop orders through pegged, algorithmic, and auction (on-open/on-close) types; backs the `Tradi
US equities schedule (NYSE/Nasdaq): pre-market 04:00–09:30, regular 09:30–16:00, post-market 16:00–20:00 New York time, Monday through Friday. Exchange holidays are venue data — merge them in via `hol
CME globex-style futures schedule: opens 18:00 the prior day and closes 17:00 New York time, Monday through Friday trading days.
Weekday-continuous schedule modelling the documented Sunday-17:00-open to Friday-17:00-close New York convention: continuous trading from the Sunday evening open through the Friday afternoon close, wi
Workspace-scoped user-settings key used only for tab order and last active tab.
Related pages
- Type Reference — the literal unions most enumerations are expressed as.
- Interfaces — every public interface and class in one index.
- API Catalog — the same surface organized by product area.