Skip to main content

Indicators API

Add built-in indicators by catalog id. Register a custom indicator module during application startup, then add and configure it through the same chart APIs.

Search 30 supported indicators contracts below. Expand a result to see its TypeScript declaration, properties, methods, parameters, return values, and errors. Share a filtered URL or a symbol anchor when another engineer needs the same contract.

Start here​

Browse the reference​

Interfaces 23

Placement and initial configuration accepted when adding a built-in catalog indicator to a chart.
Catalog descriptor for one built-in indicator: identity, display names, default pane placement, and the input/style descriptors used to build settings UI and defaults.
Structured lookup for the native built-in indicator catalog.
Live native handle for an existing indicator. It wraps the TradeScript indicator lifecycle APIs and intentionally avoids renderer-specific indicator internals.
Minimal number-formatting contract returned by ChartApi.priceFormatter(), producing the same formatting as the main-series price scale (tooltip overrides first, then symbol price-format metadata).
Per-object capability flags carried on ChartObjectNode.actions, declaring which operations the object's owner supports so object-tree UIs can enable or hide the matching controls.
Grouping folder an object owner can attach to its nodes so object-tree UIs can bucket related objects under one labeled heading.
One entry in the chart's object tree, as returned by ChartApi.listObjects/getObject or supplied by a ChartObjectProvider. Describes the object's identity, placement, visibility/lock/selection state, and supported actions.
Partial update applied to a chart object via ChartApi.updateObject, or forwarded to a provider's updateObject; only the fields present are changed.
Host-implemented source of external objects for the chart's object tree, registered via ChartApi.setObjectProviders/addObjectProvider or the widget objectProviders option. The SDK lists its nodes alongside native objects and forwards update, remove, selection, and properties-dialog requests back to it.
The chart's current object selection, as returned by ChartApi.getSelection, carried by the selection-change event, and forwarded to object providers.
Context handed to ChartObjectProvider.showPropertiesDialog when the SDK asks a provider to open its own properties UI. Extends the dialog options with the target entity and a state-reporting callback.
Options accepted by ChartApi.showPropertiesDialog to hint how a properties request should be routed to an editor.
Payload of the show-properties-dialog UI command asking the widget shell to open a native properties editor; the shell reports the outcome through resolve.
A compiled custom-indicator definition: declarative identity, pane placement, formatting, and input specs together with the pure run function the host executes over bars to produce plots, markers, alerts, and draw commands.
Overrides deep-merged into the clone created by ChartIndicatorHandle.duplicate; any IndicatorDefinition field may be overridden, and id optionally fixes the new indicator's id instead of letting the SDK allocate the next stable one.
Definition of one indicator instance, used to create and update indicators.
Filter for ChartApi.getIndicators. Matchers are ANDed; omit all to return everything.
Describes one configurable input of a catalog indicator, used to render input editors and validate indicator inputs values.
Strict native properties patch for existing built-in indicators. Unlike the broad persistence-oriented IndicatorDefinition patch accepted by updateIndicator, input and style fields are validated against the built-in indicator catalog and nested inputs / styles / metadata records are deep merged so a partial property edit does not erase sibling state.
Describes one styleable property of a catalog indicator, used by settings UIs and by catalog-validated style defaults and patches.
Payload of the properties-dialog-change chart event, reporting that a native properties dialog opened or closed for a chart entity.
Request sent to the host datafeed for one secondary series.

Type aliases 7

Alias of ChartObjectKind naming a chart entity's category (series, drawing, indicator, comparison, pane, order, and so on); used by surfaces such as properties dialogs that speak in entities.
Category of a chart object node — series, drawing, indicator, comparison, pane, price-scale, order, position, execution, annotation, or 'unknown' for uncategorized entries. Also aliased as ChartEntityKind for properties-dialog routing.
Whether ChartApi.moveObject inserts the moved object before or after the target object in the z-order stack.
Z-order move applied by ChartApi.reorderObject: one step 'up' or 'down', or straight to the 'top' or 'bottom' of the stack.
Default pane placement of a catalog indicator: main and overlay render on the main price pane, separate renders in its own sub-pane.
Price-scale placement for an indicator: as-series shares the host series scale, new-left and new-right create an independent scale on that side, and no-scale renders without a price scale.
Host-supplied loader invoked once per resolved secondary symbol to fetch that security's bars from the host datafeed; may return the bars synchronously or as a promise.