Release v31.0.0 (from 028f81fbf6fef55e9694e5df4bd5106cc04c188a)

This commit is contained in:
jenkins
2026-03-05 21:03:46 +00:00
committed by Edward Dewhurst
parent 6fe5436603
commit c8eebb69a4
3622 changed files with 7663 additions and 6956 deletions

View File

@@ -15,6 +15,7 @@ declare const dateFormatFunctions: {
readonly "dd MMM 'yy": (date: Date, local: boolean) => string;
readonly "MMM 'yy": (date: Date, local: boolean) => string;
readonly "MMM dd, yyyy": (date: Date, local: boolean) => string;
readonly "MMM d, yyyy": (date: Date, local: boolean) => string;
readonly "MMM yyyy": (date: Date, local: boolean) => string;
readonly "MMM dd": (date: Date, local: boolean) => string;
readonly "dd MMM": (date: Date, local: boolean) => string;
@@ -82,6 +83,23 @@ export declare const enum SearchInitiationPoint {
Compare = "compare",
IndicatorInputs = "indicatorInputs"
}
export declare const enum Status {
Offline = 0,
Resolving = 1,
Loading = 2,
Ready = 3,
InvalidSymbol = 4,
Snapshot = 5,
EOD = 6,
Pulse = 7,
Delayed = 8,
DelayedSteaming = 9,
NoBars = 10,
Replay = 11,
Error = 12,
CalculationError = 13,
UnsupportedResolution = 14
}
export declare const widget: ChartingLibraryWidgetConstructor;
export declare enum ActionId {
ChartAddIndicatorToAllCharts = "Chart.AddIndicatorToAllCharts",
@@ -225,6 +243,7 @@ export declare enum ActionId {
ChartSourceVisualOrderSendBackward = "Chart.Source.VisualOrder.SendBackward",
ChartSourceVisualOrderSendToBack = "Chart.Source.VisualOrder.SendToBack",
ChartSourceResetInputPoints = "Chart.Source.ResetInputPoints",
ChartOpenTableView = "Chart.OpenTableView",
ChartTimeScaleReset = "Chart.TimeScale.Reset",
ChartUndo = "Chart.Undo",
ChartSourceIntervalsVisibility = "Chart.Source.IntervalsVisibility",
@@ -538,6 +557,7 @@ export declare enum StandardFormatterName {
FormatQuantity = "formatQuantity",
FormatPrice = "formatPrice",
FormatPriceForexSup = "formatPriceForexSup",
FormatExitLevels = "formatExitLevels",
FormatPriceInCurrency = "formatPriceInCurrency",
IntegerSeparated = "integerSeparated",
LocalDate = "localDate",
@@ -577,7 +597,7 @@ export declare enum StudyPlotDisplayTarget {
DataWindow = 2,
PriceScale = 4,
StatusLine = 8,
All = 15
All = 4294967295
}
export declare enum StudyPlotType {
Line = "line",
@@ -2066,6 +2086,8 @@ export interface BracketOrderBase extends PlacedOrderBase {
parentId: string;
/** Type of the bracket's parent. */
parentType: ParentType;
/** Exit level ID. The way we distinguish exit levels */
exitLevelId?: string;
}
export interface Brackets {
/** Stop loss */
@@ -2076,6 +2098,11 @@ export interface Brackets {
takeProfit?: number;
/** Trailing Stop Pips */
trailingStopPips?: number;
/**
* [Exit levels](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/trading-concepts/brackets#multiple-exit-levels) associated with the position/order.
* Used when {@link BrokerConfigFlags.supportMultipleExitLevels} is enabled.
*/
exitLevels?: ExitLevel[];
}
export interface BrokerConfigFlags {
/**
@@ -2155,20 +2182,26 @@ export interface BrokerConfigFlags {
supportCloseIndividualPosition?: boolean;
/**
* Enables order price editing.
* If you set this flag to `false`, the price control in the _Order Ticket_ will be disabled when users modify orders.
* If you set this flag to `false`, the price control in the [_Order Ticket_](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/order-ticket) will be disabled when users modify orders.
*
* To completely disable the ability to modify an order (including hiding the _Modify_ button and disabling drag-and-drop actions on the chart), this flag must be set to `false` in conjunction with {@link BrokerConfigFlags.supportEditAmount} and {@link BrokerConfigFlags.supportModifyBrackets}.
* @default true
*/
supportModifyOrderPrice?: boolean;
/**
* Enables order quantity editing.
* If you set this flag to `false`, the quantity control in the _Order Ticket_ will be disabled when users modify orders.
* If you set this flag to `false`, the quantity control in the [_Order Ticket_](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/order-ticket) will be disabled when users modify orders.
*
* To completely disable the ability to modify an order (including hiding the _Modify_ button and disabling drag-and-drop actions on the chart), this flag must be set to `false` in conjunction with {@link BrokerConfigFlags.supportModifyOrderPrice} and {@link BrokerConfigFlags.supportModifyBrackets}.
* @default true
*/
supportEditAmount?: boolean;
/**
* Enables order brackets editing.
* If you set this flag to `false`, the bracket's control in the Order Ticket will be disabled,
* Enables [order brackets](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/trading-concepts/brackets) editing.
* If you set this flag to `false`, the bracket's control in the [_Order Ticket_](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/order-ticket) will be disabled,
* and the _Modify_ button will be hidden from the chart and in the [Account Manager](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/account-manager/).
*
* To completely disable the ability to modify an order (including hiding the _Modify_ button and disabling drag-and-drop actions on the chart), this flag must be set to `false` in conjunction with {@link BrokerConfigFlags.supportModifyOrderPrice} and {@link BrokerConfigFlags.supportEditAmount}.
* @default true
*/
supportModifyBrackets?: boolean;
@@ -2339,6 +2372,11 @@ export interface BrokerConfigFlags {
* @default false
*/
supportCryptoExchangeOrderTicket?: boolean;
/**
* This flag automatically switches Order Ticket to the Crypto Exchange mode if symbol type is `crypto`
* @default false
*/
supportSymbolSpecificCryptoOrderTicket?: boolean;
/**
* Enables displaying Profit & Loss values in instrument currency.
* @default false
@@ -2413,6 +2451,11 @@ export interface BrokerConfigFlags {
* @default false
*/
requiresFIFOCloseIndividualPositions?: boolean;
/**
* Enables [multiple exit levels](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/trading-concepts/brackets#multiple-exit-levels) (multiple take-profit and stop-loss orders) for a single parent order or position.
* When enabled, the [Order Ticket](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/order-ticket) allows users to *Add level* for brackets.
*/
supportMultipleExitLevels?: boolean;
/**
* Allows brokers to add their own parameters that will be displayed in Order info.
* @default false
@@ -2457,12 +2500,10 @@ export interface BrokerCustomUI {
/**
* Override properties that can be used within {@link TradingCustomization.brokerOrder} of the {@link TradingTerminalWidgetOptions.trading_customization} object.
*
* In a property name, "normal" indicates the line is active and visible in the UI, while "disabled" means the line is inactive, such as when another dialog is open.
* These properties follow a hierarchical naming pattern: `{Side}.{State}.{Element}.{Property}`.
* Refer to [Override properties](https://www.tradingview.com/charting-library-docs/latest/customization/overrides/trading-overrides#override-properties) section for a detailed explanation of this naming pattern.
*/
export interface BrokerOrderOverrides {
"buy.normal.anchor.backgroundColor": string;
"buy.normal.anchor.borderColor": string;
"buy.normal.anchor.shadowColor": string;
"buy.normal.borderBackgroundColor": string;
"buy.normal.borderColor": string;
"buy.normal.close.activeColor": string;
@@ -2477,7 +2518,6 @@ export interface BrokerOrderOverrides {
"buy.normal.disabledLineColor": string;
"buy.normal.informer.backgroundColor": string;
"buy.normal.informer.iconColor": string;
"buy.normal.labelTickColor": string;
"buy.normal.lineColor": string;
"buy.normal.negativePlColor": string;
"buy.normal.pointBackgroundColor": string;
@@ -2492,9 +2532,6 @@ export interface BrokerOrderOverrides {
"buy.normal.text.dividerColor": string;
"buy.normal.text.textColor": string;
"buy.normal.text.activeColor": string;
"buy.disabled.anchor.backgroundColor": string;
"buy.disabled.anchor.borderColor": string;
"buy.disabled.anchor.shadowColor": string;
"buy.disabled.borderBackgroundColor": string;
"buy.disabled.borderColor": string;
"buy.disabled.close.activeColor": string;
@@ -2509,7 +2546,6 @@ export interface BrokerOrderOverrides {
"buy.disabled.disabledLineColor": string;
"buy.disabled.informer.backgroundColor": string;
"buy.disabled.informer.iconColor": string;
"buy.disabled.labelTickColor": string;
"buy.disabled.lineColor": string;
"buy.disabled.negativePlColor": string;
"buy.disabled.pointBackgroundColor": string;
@@ -2524,9 +2560,6 @@ export interface BrokerOrderOverrides {
"buy.disabled.text.dividerColor": string;
"buy.disabled.text.textColor": string;
"buy.disabled.text.activeColor": string;
"sell.normal.anchor.backgroundColor": string;
"sell.normal.anchor.borderColor": string;
"sell.normal.anchor.shadowColor": string;
"sell.normal.borderBackgroundColor": string;
"sell.normal.borderColor": string;
"sell.normal.close.activeColor": string;
@@ -2541,7 +2574,6 @@ export interface BrokerOrderOverrides {
"sell.normal.disabledLineColor": string;
"sell.normal.informer.backgroundColor": string;
"sell.normal.informer.iconColor": string;
"sell.normal.labelTickColor": string;
"sell.normal.lineColor": string;
"sell.normal.negativePlColor": string;
"sell.normal.pointBackgroundColor": string;
@@ -2556,9 +2588,6 @@ export interface BrokerOrderOverrides {
"sell.normal.text.dividerColor": string;
"sell.normal.text.textColor": string;
"sell.normal.text.activeColor": string;
"sell.disabled.anchor.backgroundColor": string;
"sell.disabled.anchor.borderColor": string;
"sell.disabled.anchor.shadowColor": string;
"sell.disabled.borderBackgroundColor": string;
"sell.disabled.borderColor": string;
"sell.disabled.close.activeColor": string;
@@ -2573,7 +2602,6 @@ export interface BrokerOrderOverrides {
"sell.disabled.disabledLineColor": string;
"sell.disabled.informer.backgroundColor": string;
"sell.disabled.informer.iconColor": string;
"sell.disabled.labelTickColor": string;
"sell.disabled.lineColor": string;
"sell.disabled.negativePlColor": string;
"sell.disabled.pointBackgroundColor": string;
@@ -2588,9 +2616,6 @@ export interface BrokerOrderOverrides {
"sell.disabled.text.dividerColor": string;
"sell.disabled.text.textColor": string;
"sell.disabled.text.activeColor": string;
"takeProfit.normal.anchor.backgroundColor": string;
"takeProfit.normal.anchor.borderColor": string;
"takeProfit.normal.anchor.shadowColor": string;
"takeProfit.normal.borderBackgroundColor": string;
"takeProfit.normal.borderColor": string;
"takeProfit.normal.close.activeColor": string;
@@ -2605,7 +2630,6 @@ export interface BrokerOrderOverrides {
"takeProfit.normal.disabledLineColor": string;
"takeProfit.normal.informer.backgroundColor": string;
"takeProfit.normal.informer.iconColor": string;
"takeProfit.normal.labelTickColor": string;
"takeProfit.normal.lineColor": string;
"takeProfit.normal.negativePlColor": string;
"takeProfit.normal.pointBackgroundColor": string;
@@ -2622,9 +2646,6 @@ export interface BrokerOrderOverrides {
"takeProfit.normal.text.activeColor": string;
"takeProfit.normal.text.hintAreaColor": string;
"takeProfit.normal.movingBackgroundColor": string;
"takeProfit.disabled.anchor.backgroundColor": string;
"takeProfit.disabled.anchor.borderColor": string;
"takeProfit.disabled.anchor.shadowColor": string;
"takeProfit.disabled.borderBackgroundColor": string;
"takeProfit.disabled.borderColor": string;
"takeProfit.disabled.close.activeColor": string;
@@ -2639,7 +2660,6 @@ export interface BrokerOrderOverrides {
"takeProfit.disabled.disabledLineColor": string;
"takeProfit.disabled.informer.backgroundColor": string;
"takeProfit.disabled.informer.iconColor": string;
"takeProfit.disabled.labelTickColor": string;
"takeProfit.disabled.lineColor": string;
"takeProfit.disabled.negativePlColor": string;
"takeProfit.disabled.pointBackgroundColor": string;
@@ -2656,9 +2676,6 @@ export interface BrokerOrderOverrides {
"takeProfit.disabled.text.activeColor": string;
"takeProfit.disabled.text.hintAreaColor": string;
"takeProfit.disabled.movingBackgroundColor": string;
"stopLoss.normal.anchor.backgroundColor": string;
"stopLoss.normal.anchor.borderColor": string;
"stopLoss.normal.anchor.shadowColor": string;
"stopLoss.normal.borderBackgroundColor": string;
"stopLoss.normal.borderColor": string;
"stopLoss.normal.close.activeColor": string;
@@ -2673,7 +2690,6 @@ export interface BrokerOrderOverrides {
"stopLoss.normal.disabledLineColor": string;
"stopLoss.normal.informer.backgroundColor": string;
"stopLoss.normal.informer.iconColor": string;
"stopLoss.normal.labelTickColor": string;
"stopLoss.normal.lineColor": string;
"stopLoss.normal.negativePlColor": string;
"stopLoss.normal.pointBackgroundColor": string;
@@ -2690,9 +2706,6 @@ export interface BrokerOrderOverrides {
"stopLoss.normal.text.activeColor": string;
"stopLoss.normal.text.hintAreaColor": string;
"stopLoss.normal.movingBackgroundColor": string;
"stopLoss.disabled.anchor.backgroundColor": string;
"stopLoss.disabled.anchor.borderColor": string;
"stopLoss.disabled.anchor.shadowColor": string;
"stopLoss.disabled.borderBackgroundColor": string;
"stopLoss.disabled.borderColor": string;
"stopLoss.disabled.close.activeColor": string;
@@ -2707,7 +2720,6 @@ export interface BrokerOrderOverrides {
"stopLoss.disabled.disabledLineColor": string;
"stopLoss.disabled.informer.backgroundColor": string;
"stopLoss.disabled.informer.iconColor": string;
"stopLoss.disabled.labelTickColor": string;
"stopLoss.disabled.lineColor": string;
"stopLoss.disabled.negativePlColor": string;
"stopLoss.disabled.pointBackgroundColor": string;
@@ -2728,7 +2740,8 @@ export interface BrokerOrderOverrides {
/**
* Override properties that can be used within {@link TradingCustomization.brokerPosition} of the {@link TradingTerminalWidgetOptions.trading_customization} object.
*
* In a property name, "normal" indicates the line is active and visible in the UI, while "disabled" means the line is inactive, such as when another dialog is open.
* These properties follow a hierarchical naming pattern: `{Side}.{State}.{Element}.{Property}`.
* Refer to [Override properties](https://www.tradingview.com/charting-library-docs/latest/customization/overrides/trading-overrides#override-properties) section for a detailed explanation of this naming pattern.
*/
export interface BrokerPositionOverrides {
"buy.normal.borderBackgroundColor": string;
@@ -2898,17 +2911,21 @@ export interface CalloutLineToolOverrides {
/** Default value: `200` */
"linetoolcallout.wordWrapWidth": number;
}
export interface CandleStylePreferences {
/** Body color for an up candle */
upColor: string;
/** Body color for a down candle */
downColor: string;
export interface CandleStyleNonThemePreferences {
/** Whether to draw the candle wick */
drawWick: boolean;
/** Whether to draw the candle body border */
drawBorder: boolean;
/** Bar color determined by previous close value */
barColorsOnPrevClose: boolean;
/** Whether to draw the candle body */
drawBody: boolean;
}
export interface CandleStylePreferences extends CandleStyleNonThemePreferences {
/** Body color for an up candle */
upColor: string;
/** Body color for a down candle */
downColor: string;
/** Candle border color */
borderColor: string;
/** Up candle border color */
@@ -2921,8 +2938,6 @@ export interface CandleStylePreferences {
wickUpColor: string;
/** Down candle wick color */
wickDownColor: string;
/** Bar color determined by previous close value */
barColorsOnPrevClose: boolean;
}
/**
* Overrides for the 'Chaikin Money Flow' indicator.
@@ -4692,11 +4707,11 @@ export interface ChartingLibraryWidgetOptions {
* library_path: "charting_library/",
* ```
*
* * If you would like to host the library on a separate origin to the page containing the chart then please view the following guide: [Hosting the library on a separate origin](https://www.tradingview.com/charting-library-docs/latest/getting_started/Hosting-Library-Cross-Origin).
* * If you would like to host the library on a separate origin to the page containing the chart then please view the following guide: [Hosting the library on a separate origin](https://www.tradingview.com/charting-library-docs/latest/configuration/Hosting-Library-Cross-Origin).
*/
library_path?: string;
/**
* Locale to be used by the library. See [Localization](https://www.tradingview.com/charting-library-docs/latest/core_concepts/Localization) section for details.
* Locale to be used by the library. See [Localization](https://www.tradingview.com/charting-library-docs/latest/configuration/Localization) section for details.
*
* ```javascript
* locale: 'en',
@@ -5013,7 +5028,7 @@ export interface ChartingLibraryWidgetOptions {
* If you want to customize fonts outside the chart, for example, within [Watchlist](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/Watch-List) or another widget,
* you should use the {@link ChartingLibraryWidgetOptions.custom_css_url} property to provide custom CSS styles.
*
* Specify `custom_font_family` in [Widget Constructor](https://www.tradingview.com/charting-library-docs/latest/core_concepts/Widget-Constructor) as follows:
* Specify `custom_font_family` in [Widget Constructor](https://www.tradingview.com/charting-library-docs/latest/configuration/Widget-Constructor) as follows:
*
* ```javascript
* custom_font_family: "'Inconsolata', monospace",
@@ -7212,6 +7227,8 @@ export interface Execution extends CustomFields {
time: number;
/** Commission amount for executed trade */
commission?: number;
/** Fee amount for executed trade */
fee?: number;
/** Net amount for executed trade */
netAmount?: number;
}
@@ -7246,6 +7263,37 @@ export interface ExecutionLineToolOverrides {
/** Default value: `undefined` */
"linetoolexecution.tooltip": string;
}
/**
* Describes a specific [exit level](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/trading-concepts/brackets#multiple-exit-levels) (bracket) for an order or position.
* Used when {@link BrokerConfigFlags.supportMultipleExitLevels} is enabled.
*/
export interface ExitLevel {
/** Unique identifier for the exit level. */
id: string;
/** Quantity to close at this level. */
qty: number;
/** Take profit price. */
takeProfit?: number;
/** Stop loss price. */
stopLoss?: number;
/** Guaranteed stop loss price. */
guaranteedStop?: number;
/** Trailing stop value in pips. */
trailingStopPips?: number;
/**
* Indicates whether the exit level already exists.
* @default true
*/
isExisting?: boolean;
}
export interface ExitLevelTemplate extends ExitLevel {
tpPips?: number;
slPips?: number;
tpRiskInPercent?: number;
slRiskInPercent?: number;
tpParentPricePercent?: number;
slParentPricePercent?: number;
}
export interface ExportDataOptions {
/**
* Optional timestamp of the first exported bar.
@@ -10650,7 +10698,7 @@ export interface IChartWidgetApi {
*/
onSymbolChanged(): ISubscription<(symbol: LibrarySymbolInfo) => void>;
/**
* Get a subscription object for the chart resolution (interval) changing. This method also allows you to track whether the chart's [date range](https://www.tradingview.com/charting-library-docs/latest/getting_started/glossary#date-range) is changed.
* Get a subscription object for the chart resolution (interval) changing. This method also allows you to track whether the chart's [date range](https://www.tradingview.com/charting-library-docs/latest/resources/glossary#date-range) is changed.
* The `timeframe` argument represents if a user clicks on the [time frame toolbar](https://www.tradingview.com/charting-library-docs/latest/ui_elements/Time-Scale#time-frame-toolbar) or changes the date range manually.
* If `timeframe` is `undefined`, you can change a date range before data loading starts.
* To do this, you can specify a time frame value or a certain date range.
@@ -11610,7 +11658,7 @@ export interface IChartWidgetApi {
}
/**
* The main interface for interacting with the library, returned by {@link ChartingLibraryWidgetConstructor}.
* For more information, refer to the [Widget methods](https://www.tradingview.com/charting-library-docs/latest/core_concepts/widget-methods) article.
* For more information, refer to the [Widget methods](https://www.tradingview.com/charting-library-docs/latest/configuration/widget-methods) article.
*/
export interface IChartingLibraryWidget {
/**
@@ -11636,7 +11684,7 @@ export interface IChartingLibraryWidget {
* To do this, pass a keyboard shortcut and a callback function as parameters.
* The library invokes the callback when the `shortCut` keys are pressed.
*
* Note that the `shortCut` argument depends on the key types. Refer to the [Manage shortcuts](https://www.tradingview.com/charting-library-docs/latest/getting_started/Shortcuts#manage-shortcuts) section for more information and examples.
* Note that the `shortCut` argument depends on the key types. Refer to the [Manage shortcuts](https://www.tradingview.com/charting-library-docs/latest/configuration/Shortcuts#manage-shortcuts) section for more information and examples.
*
* @param shortCut A number, a string, or an array of numbers and strings.
* @param callback A function that is called when the `shortCut` keys are pressed.
@@ -14111,6 +14159,10 @@ export interface ISeriesApi {
chartStyleProperties<T extends ChartStyle>(chartStyle: T): SeriesPreferencesMap[T];
/** Sets properties for a specific chart style */
setChartStyleProperties<T extends ChartStyle>(chartStyle: T, newPrefs: DeepPartial<SeriesPreferencesMap[T]>): void;
/**
* Returns a watched value representing the current series status.
*/
statusVW(): IWatchedValueReadonly<Status>;
}
/**
* Properties of the {@link ChartingLibraryWidgetOptions.settings_adapter} property that allows saving [user settings](https://www.tradingview.com/charting-library-docs/latest/saving_loading/user-settings) to your preferred storage, including server-side.
@@ -14554,9 +14606,9 @@ export interface ITimeScaleApi {
rightOffsetChanged(): ISubscription<(rightOffset: number) => void>;
/** To set a new right offset */
setRightOffset(offset: number): void;
/** Sets a new [bar spacing](https://www.tradingview.com/charting-library-docs/latest/getting_started/glossary#bar-spacing). You can call {@link barSpacing} to get the current value. */
/** Sets a new [bar spacing](https://www.tradingview.com/charting-library-docs/latest/resources/glossary#bar-spacing). You can call {@link barSpacing} to get the current value. */
setBarSpacing(newBarSpacing: number): void;
/** Returns the current [bar spacing](https://www.tradingview.com/charting-library-docs/latest/getting_started/glossary#bar-spacing). */
/** Returns the current [bar spacing](https://www.tradingview.com/charting-library-docs/latest/resources/glossary#bar-spacing). */
barSpacing(): number;
/** Returns the current right offset */
rightOffset(): number;
@@ -14945,6 +14997,11 @@ export interface IndividualPositionBase {
price: number;
/** Determines whether individual position can be closed */
canBeClosed?: boolean;
/**
* [Exit levels](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/trading-concepts/brackets#multiple-exit-levels) associated with the position.
* Used when {@link BrokerConfigFlags.supportMultipleExitLevels} is enabled.
*/
exitLevels?: ExitLevel[];
}
/**
* Override properties for the Infoline drawing tool.
@@ -15374,6 +15431,16 @@ export interface LeastSquaresMovingAverageIndicatorOverrides {
"plot.color": string;
[key: string]: StudyOverrideValueType;
}
export interface LevelsFormatterProperties {
base: [
priceProperty: string
];
withLevels: [
priceProperty: string,
exitLevels: string,
qty: string
];
}
/**
* An API object representing leverage info for an order.
*/
@@ -17160,6 +17227,11 @@ export interface OrderRule {
* This information is not sufficient to place an order.
*/
export interface OrderTemplate extends OrderTemplateBase {
/**
* [Exit levels](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/trading-concepts/brackets#multiple-exit-levels) associated with the order template.
* Used when {@link BrokerConfigFlags.supportMultipleExitLevels} is enabled.
*/
exitLevels?: ExitLevelTemplate[];
}
export interface OrderTemplateBase {
/** Symbol identifier */
@@ -18586,6 +18658,11 @@ export interface PlacedOrderBase {
stopType?: StopType;
/** Take profit price (double). Available when Brackets are enabled */
takeProfit?: number;
/**
* [Exit levels](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/trading-concepts/brackets#multiple-exit-levels) associated with the placed order.
* Used when {@link BrokerConfigFlags.supportMultipleExitLevels} is enabled.
*/
exitLevels?: ExitLevel[];
/** Order duration */
duration?: OrderDuration;
/**
@@ -18691,6 +18768,11 @@ export interface PositionBase {
updateTime?: number;
/** Message describing the state of the position */
message?: OrderOrPositionMessage;
/**
* [Exit levels](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/trading-concepts/brackets#multiple-exit-levels) associated with the position.
* Used when {@link BrokerConfigFlags.supportMultipleExitLevels} is enabled.
*/
exitLevels?: ExitLevel[];
}
export interface PositionDialogOptions extends TradingDialogOptions {
}
@@ -18822,6 +18904,11 @@ export interface PreOrder extends OrderTemplateBase {
* It is set to `true`, if the order closes a position.
*/
isClose?: boolean;
/**
* [Exit levels](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/trading-concepts/brackets#multiple-exit-levels) associated with the order.
* Used when {@link BrokerConfigFlags.supportMultipleExitLevels} is enabled.
*/
exitLevels?: ExitLevel[];
}
/**
* Override properties for the Prediction drawing tool.
@@ -20255,6 +20342,13 @@ export interface SingleBrokerMetaInfo {
* Broker Configuration Flags
*/
configFlags: BrokerConfigFlags;
/**
* A traded group is a combination of elements that are drawn on the chart for single position or order.
*
* It represents a position or order along with its brackets, plus all the UI controlssuch as TP/SL buttons,
* various lines, and dotsthat indicate where the position's brackets are located and what is currently selected.
*/
tradedGroupConfig?: TradedGroupConfig;
/**
* Optional field. You can use it if you have custom fields in orders or positions that should be taken into account when showing notifications.
*
@@ -20502,6 +20596,7 @@ export interface StandardFormattersDependenciesMapping {
[StandardFormatterName.FormatPriceForexSup]: [
priceProperty: string
];
[StandardFormatterName.FormatExitLevels]: LevelsFormatterProperties[keyof LevelsFormatterProperties];
[StandardFormatterName.FormatPriceInCurrency]: [
priceProperty: string,
currencyProperty: string
@@ -20742,6 +20837,14 @@ export interface StudyBandBackgroundPreferences {
/** Whether the background area should be filled with the `backgroundColor` */
fillBackground: boolean;
}
export interface StudyBandDefaultStyle extends Omit<StudyBandStyle, "color"> {
/**
* Color.
*
* @example '#ffffff'.
*/
color: string | null;
}
/**
* A description of a study band.
*/
@@ -20845,6 +20948,16 @@ export interface StudyCandleWickColorerPlotInfo extends StudyPalettedPlotInfo, S
/** @inheritDoc */
readonly type: StudyPlotType.CandleWickColorer;
}
export interface StudyCharsPlotDefaultPreferences extends Omit<StudyCharsPlotPreferences, "color" | "textColor"> {
/**
* Color.
*/
color: string | null;
/**
* Text color.
*/
textColor: string | null;
}
/**
* A description of a study characters plot.
*/
@@ -20895,7 +21008,7 @@ export interface StudyDefaults {
/** Defaults for the bands background */
bandsBackground: StudyBandBackgroundPreferences;
/** Defaults for the bands */
bands: readonly Required<StudyBandStyle>[];
bands: readonly Required<StudyBandDefaultStyle>[];
/** Defaults for the filled area styles */
filledAreasStyle: MappedObject<StudyFilledAreaStyle>;
/** Defaults for the study inputs */
@@ -20905,9 +21018,9 @@ export interface StudyDefaults {
/** Default for the study precision */
precision: number | string;
/** Defaults for the study styles */
styles: MappedObject<StudyPlotPreferences>;
styles: MappedObject<StudyPlotDefaultPreferences>;
/** Defaults for the OHLC plots */
ohlcPlots: MappedObject<StudyOhlcPlotPreferences>;
ohlcPlots: MappedObject<StudyOhlcPlotDefaultPreferences>;
/** Defaults for the study graphics */
graphics: StudyGraphicsDefaults;
}
@@ -21043,7 +21156,7 @@ export interface StudyFilledAreaInfo {
*/
export interface StudyFilledAreaSolidColorStyle extends StudyFilledAreaStyleBase {
/** Solid Fill type */
fillType: undefined;
fillType?: undefined;
/**
* Color.
*
@@ -21139,6 +21252,12 @@ export interface StudyInputValueItem {
export interface StudyInputsSimple {
[inputId: string]: StudyInputValue;
}
export interface StudyLinePlotDefaultPreferences extends Omit<StudyLinePlotPreferences, "color"> {
/**
* Line color.
*/
color: string | null;
}
/**
* A description of a study line plot.
*/
@@ -21218,6 +21337,10 @@ export interface StudyOhlcPlotCandlesStylePreferences extends StudyOhlcPlotBaseS
/** Candle border color */
borderColor: string;
}
export interface StudyOhlcPlotDefaultPreferences extends Omit<StudyOhlcPlotPreferences, "color"> {
/** OHLC plot color */
color: string | null;
}
/**
* A description of an OHLC plot.
*/
@@ -26512,6 +26635,16 @@ export interface StudySessionInputInfo extends StudyInputBaseInfo {
/** Options for Input Titles */
readonly optionsTitles?: StudyInputOptionsTitles;
}
export interface StudyShapesPlotDefaultPreferences extends Omit<StudyShapesPlotPreferences, "color" | "textColor"> {
/**
* Color.
*/
color: string | null;
/**
* Text color.
*/
textColor: string | null;
}
/**
* A description of a study shapes plot.
*/
@@ -26586,7 +26719,7 @@ export interface StudyStyleInfoDefaults {
/**
* Default study bands style preferences.
*/
bands?: readonly StudyBandStyle[];
bands?: readonly StudyBandDefaultStyle[];
/**
* Default study filled areas style preferences.
*/
@@ -26598,11 +26731,11 @@ export interface StudyStyleInfoDefaults {
/**
* Default study styles.
*/
styles?: Record<string, StudyPlotPreferences | undefined>;
styles?: Record<string, StudyPlotDefaultPreferences | undefined>;
/**
* Default study OHLC plot style preferences.
*/
ohlcPlots?: Record<string, StudyOhlcPlotPreferences | undefined>;
ohlcPlots?: Record<string, StudyOhlcPlotDefaultPreferences | undefined>;
/**
* Default study graphics style preferences.
*/
@@ -27298,17 +27431,33 @@ export interface SymbolSpecificTradingOptions {
*/
warningMessage?: string;
/**
* Whether the integration supports the modification of existing position brackets.
* Whether existing position brackets modification is supported for a symbol.
*/
supportModifyPositionBrackets?: boolean;
/**
* Whether the integration supports the modification of existing order brackets.
* Whether existing order brackets modification is supported for a symbol.
*/
supportModifyOrderBrackets?: boolean;
/**
* Whether the risk controls and order info should be shown.
*/
supportRiskControlsAndInfo?: boolean;
/**
* Whether Stop Loss bracket is supported for a symbol.
*/
supportStopLoss?: boolean;
/**
* Whether Trailing Stop bracket is supported for a symbol.
*/
supportTrailingStop?: boolean;
/**
* Whether Guaranteed Stop bracket is supported for a symbol.
*/
supportGuaranteedStop?: boolean;
/**
* Whether crypto exchange order placement mode is supported for a symbol.
*/
supportCryptoExchange?: boolean;
}
export interface SymbolValueFormatterFormatOptions extends NumberFormatterFormatOptions {
/** Add plus sign to result string */
@@ -27548,7 +27697,7 @@ export interface TimePoint {
*/
export interface TimeScaleOptions {
/**
* Minimum allowed [bar spacing](https://www.tradingview.com/charting-library-docs/latest/getting_started/glossary#bar-spacing). Should be greater than 0.
* Minimum allowed [bar spacing](https://www.tradingview.com/charting-library-docs/latest/resources/glossary#bar-spacing). Should be greater than 0.
*
* ```javascript
* time_scale: {
@@ -27662,6 +27811,15 @@ export interface TradeContext {
/** Previous value */
last: number;
}
export interface TradedGroupConfig {
/**
* Enables the adaptive layout for trading buttons (TP/SL, P&L) on position and order lines.
* When `true` (default), these buttons are automatically hidden on narrow viewports to optimize the layout.
* When `false`, these buttons will always be visible, regardless of screen width.
* @default true
*/
supportAdaptiveLayout: boolean;
}
/**
* Represents the structure of {@link TradingTerminalWidgetOptions.trading_customization}.
*/
@@ -27701,6 +27859,10 @@ export interface TradingDialogOptions {
*
*/
customFields?: TradingDialogCustomField[];
/**
* Specifies the maximum number of [exit levels](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/trading-concepts/brackets#multiple-exit-levels) (brackets) that can be attached to a single parent order or position.
*/
maxExitLevelsCount?: number;
}
export interface TradingQuotes {
/** Trade */
@@ -27725,6 +27887,8 @@ export interface TradingQuotes {
isHardToBorrow?: boolean;
/** Whether quotes are can not be shorted */
isNotShortable?: boolean;
/** Last trade size */
lastSize?: number;
}
export interface TradingTerminalWidgetOptions extends Omit<ChartingLibraryWidgetOptions, "enabled_features" | "disabled_features" | "favorites"> {
/**
@@ -29684,7 +29848,7 @@ export type CustomTableFormatElementFunction<T extends TableFormatterInputValues
* Identifier for a custom timezone (string).
*/
export type CustomTimezoneId = Nominal<"CustomTimezoneId", string>;
export type CustomTimezones = "Africa/Cairo" | "Africa/Casablanca" | "Africa/Johannesburg" | "Africa/Lagos" | "Africa/Nairobi" | "Africa/Tunis" | "America/Anchorage" | "America/Argentina/Buenos_Aires" | "America/Bogota" | "America/Caracas" | "America/Chicago" | "America/El_Salvador" | "America/Juneau" | "America/Lima" | "America/Los_Angeles" | "America/Mexico_City" | "America/New_York" | "America/Phoenix" | "America/Santiago" | "America/Sao_Paulo" | "America/Toronto" | "America/Vancouver" | "Asia/Almaty" | "Asia/Ashkhabad" | "Asia/Bahrain" | "Asia/Bangkok" | "Asia/Chongqing" | "Asia/Colombo" | "Asia/Dhaka" | "Asia/Dubai" | "Asia/Ho_Chi_Minh" | "Asia/Hong_Kong" | "Asia/Jakarta" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Karachi" | "Asia/Kathmandu" | "Asia/Kolkata" | "Asia/Kuala_Lumpur" | "Asia/Kuwait" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Tehran" | "Asia/Tokyo" | "Asia/Yangon" | "Atlantic/Azores" | "Atlantic/Reykjavik" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Perth" | "Australia/Sydney" | "Europe/Amsterdam" | "Europe/Athens" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Helsinki" | "Europe/Istanbul" | "Europe/Lisbon" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Moscow" | "Europe/Oslo" | "Europe/Paris" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Warsaw" | "Europe/Zurich" | "Pacific/Auckland" | "Pacific/Chatham" | "Pacific/Fakaofo" | "Pacific/Honolulu" | "Pacific/Norfolk" | "US/Mountain";
export type CustomTimezones = "Africa/Cairo" | "Africa/Casablanca" | "Africa/Johannesburg" | "Africa/Lagos" | "Africa/Nairobi" | "Africa/Tunis" | "America/Anchorage" | "America/Argentina/Buenos_Aires" | "America/Bogota" | "America/Caracas" | "America/Chicago" | "America/El_Salvador" | "America/Halifax" | "America/Juneau" | "America/Lima" | "America/Los_Angeles" | "America/Mexico_City" | "America/New_York" | "America/Phoenix" | "America/Santiago" | "America/Sao_Paulo" | "America/Toronto" | "America/Vancouver" | "Asia/Almaty" | "Asia/Ashkhabad" | "Asia/Bahrain" | "Asia/Bangkok" | "Asia/Chongqing" | "Asia/Colombo" | "Asia/Dhaka" | "Asia/Dubai" | "Asia/Ho_Chi_Minh" | "Asia/Hong_Kong" | "Asia/Jakarta" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Karachi" | "Asia/Kathmandu" | "Asia/Kolkata" | "Asia/Kuala_Lumpur" | "Asia/Kuwait" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Tehran" | "Asia/Tokyo" | "Asia/Yangon" | "Atlantic/Azores" | "Atlantic/Reykjavik" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Perth" | "Australia/Sydney" | "Europe/Amsterdam" | "Europe/Athens" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Helsinki" | "Europe/Istanbul" | "Europe/Lisbon" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Moscow" | "Europe/Oslo" | "Europe/Paris" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Warsaw" | "Europe/Zurich" | "Pacific/Auckland" | "Pacific/Chatham" | "Pacific/Fakaofo" | "Pacific/Honolulu" | "Pacific/Norfolk" | "US/Mountain";
/**
* Custom translation function
* @param {string} originalText - original raw text taking into account pluralization rules
@@ -29974,6 +30138,7 @@ export type StudyMetaInfo = DeepWriteable<RawStudyMetaInformation> & {
};
export type StudyOhlcPlotPreferences = StudyOhlcPlotBarsStylePreferences | StudyOhlcPlotCandlesStylePreferences;
export type StudyOverrideValueType = string | number | boolean;
export type StudyPlotDefaultPreferences = StudyLinePlotDefaultPreferences | StudyShapesPlotDefaultPreferences | StudyCharsPlotDefaultPreferences | StudyArrowsPlotPreferences;
export type StudyPlotDisplayMode = Nominal<number, "StudyPlotDisplayTarget"> | StudyPlotDisplayTarget;
export type StudyPlotInfo = StudyPlotInformation;
/**
@@ -30145,6 +30310,16 @@ export type TradingTerminalFeatureset = ChartingLibraryFeatureset |
* @default true
*/
"show_symbol_logo_in_account_manager" |
/**
* Display the symbol's logo in the close position dialog. This requires that `show_symbol_logos` is enabled.
* @default true
*/
"show_symbol_logo_in_close_position_dialog" |
/**
* Display the symbol's logo in the cancel order dialog. This requires that `show_symbol_logos` is enabled.
* @default true
*/
"show_symbol_logo_in_cancel_order_dialog" |
/**
* Display UI (buttons and context menu options) for creating sections within the watchlist.
* @default true