diff --git a/apps/trading/components/chart-container/chart-container.tsx b/apps/trading/components/chart-container/chart-container.tsx
index 535f8e2b6..3f91b9589 100644
--- a/apps/trading/components/chart-container/chart-container.tsx
+++ b/apps/trading/components/chart-container/chart-container.tsx
@@ -25,12 +25,12 @@ export const ChartContainer = ({ marketId }: { marketId: string }) => {
overlays,
studies,
studySizes,
- tradingViewStudies,
setInterval,
setStudies,
setStudySizes,
setOverlays,
- setTradingViewStudies,
+ state,
+ setState,
} = useChartSettings();
const pennantChart = (
@@ -64,13 +64,13 @@ export const ChartContainer = ({ marketId }: { marketId: string }) => {
libraryHash={CHARTING_LIBRARY_HASH}
marketId={marketId}
interval={toTradingViewResolution(interval)}
- studies={tradingViewStudies}
onIntervalChange={(newInterval) => {
setInterval(fromTradingViewResolution(newInterval));
}}
- onAutoSaveNeeded={(data: { studies: string[] }) => {
- setTradingViewStudies(data.studies);
+ onAutoSaveNeeded={(data) => {
+ setState(data);
}}
+ state={state}
/>
);
}
diff --git a/apps/trading/components/chart-container/chart-menu.spec.tsx b/apps/trading/components/chart-container/chart-menu.spec.tsx
index ea844d731..49729adab 100644
--- a/apps/trading/components/chart-container/chart-menu.spec.tsx
+++ b/apps/trading/components/chart-container/chart-menu.spec.tsx
@@ -27,11 +27,11 @@ describe('ChartMenu', () => {
render();
- await userEvent.click(screen.getByRole('button', { name: 'Vega chart' }));
- expect(useChartSettingsStore.getState().chartlib).toEqual('pennant');
-
- await userEvent.click(screen.getByRole('button', { name: 'TradingView' }));
+ await userEvent.click(screen.getByTestId('chartlib-toggle-button'));
expect(useChartSettingsStore.getState().chartlib).toEqual('tradingview');
+
+ await userEvent.click(screen.getByTestId('chartlib-toggle-button'));
+ expect(useChartSettingsStore.getState().chartlib).toEqual('pennant');
});
describe('tradingview', () => {
diff --git a/apps/trading/components/chart-container/chart-menu.tsx b/apps/trading/components/chart-container/chart-menu.tsx
index bb0a4bb7b..15645ddba 100644
--- a/apps/trading/components/chart-container/chart-menu.tsx
+++ b/apps/trading/components/chart-container/chart-menu.tsx
@@ -68,6 +68,7 @@ export const ChartMenu = () => {
setChartlib(isPennant ? 'tradingview' : 'pennant');
}}
size="extra-small"
+ testId="chartlib-toggle-button"
>
{isPennant ? 'TradingView' : t('Vega chart')}
diff --git a/apps/trading/components/chart-container/use-chart-settings.ts b/apps/trading/components/chart-container/use-chart-settings.ts
index 0349faba7..1f827b5a2 100644
--- a/apps/trading/components/chart-container/use-chart-settings.ts
+++ b/apps/trading/components/chart-container/use-chart-settings.ts
@@ -9,6 +9,7 @@ type StudySizes = { [S in Study]?: number };
export type Chartlib = 'pennant' | 'tradingview';
interface StoredSettings {
+ state: object | undefined; // Don't see a better type provided from TradingView type definitions
chartlib: Chartlib;
// For interval we use the enum from @vegaprotocol/types, this is to make mapping between different
// chart types easier and more consistent
@@ -17,7 +18,6 @@ interface StoredSettings {
overlays: Overlay[];
studies: Study[];
studySizes: StudySizes;
- tradingViewStudies: string[];
}
export const STUDY_SIZE = 90;
@@ -30,13 +30,13 @@ const STUDY_ORDER: Study[] = [
];
export const DEFAULT_CHART_SETTINGS = {
- chartlib: 'tradingview' as const,
+ state: undefined,
+ chartlib: 'pennant' as const,
interval: Interval.INTERVAL_I15M,
type: ChartType.CANDLE,
overlays: [Overlay.MOVING_AVERAGE],
studies: [Study.MACD, Study.VOLUME],
studySizes: {},
- tradingViewStudies: ['Volume'],
};
export const useChartSettingsStore = create<
@@ -47,7 +47,7 @@ export const useChartSettingsStore = create<
setStudies: (studies?: Study[]) => void;
setStudySizes: (sizes: number[]) => void;
setChartlib: (lib: Chartlib) => void;
- setTradingViewStudies: (studies: string[]) => void;
+ setState: (state: object) => void;
}
>()(
persist(
@@ -95,10 +95,8 @@ export const useChartSettingsStore = create<
state.chartlib = lib;
});
},
- setTradingViewStudies: (studies: string[]) => {
- set((state) => {
- state.tradingViewStudies = studies;
- });
+ setState: (state) => {
+ set({ state });
},
})),
{
@@ -147,13 +145,13 @@ export const useChartSettings = () => {
overlays,
studies,
studySizes,
- tradingViewStudies: settings.tradingViewStudies,
setInterval: settings.setInterval,
setType: settings.setType,
setStudies: settings.setStudies,
setOverlays: settings.setOverlays,
setStudySizes: settings.setStudySizes,
setChartlib: settings.setChartlib,
- setTradingViewStudies: settings.setTradingViewStudies,
+ state: settings.state,
+ setState: settings.setState,
};
};
diff --git a/libs/trading-view/.eslintrc.json b/libs/trading-view/.eslintrc.json
index f3153d3b4..ef2c5d6a1 100644
--- a/libs/trading-view/.eslintrc.json
+++ b/libs/trading-view/.eslintrc.json
@@ -1,6 +1,6 @@
{
"extends": ["plugin:@nx/react", "../../.eslintrc.json"],
- "ignorePatterns": ["!**/*", "__generated__"],
+ "ignorePatterns": ["!**/*", "__generated__", "charting-library.d.ts"],
"overrides": [
{
"files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
diff --git a/libs/trading-view/src/charting-library.d.ts b/libs/trading-view/src/charting-library.d.ts
new file mode 100644
index 000000000..7d7a7b22f
--- /dev/null
+++ b/libs/trading-view/src/charting-library.d.ts
@@ -0,0 +1,19258 @@
+/**
+ * TradingView Advanced Charts
+ * @packageDocumentation
+ * @module Charting Library
+ */
+// Generated by dts-bundle-generator v7.0.0
+
+/* eslint-disable jsdoc/require-jsdoc */
+declare const dateFormatFunctions: {
+ readonly "dd MMM 'yy": (date: Date, local: boolean) => string;
+ readonly 'MMM dd, 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;
+ readonly 'yyyy-MM-dd': (date: Date, local: boolean) => string;
+ readonly 'yy-MM-dd': (date: Date, local: boolean) => string;
+ readonly 'yy/MM/dd': (date: Date, local: boolean) => string;
+ readonly 'yyyy/MM/dd': (date: Date, local: boolean) => string;
+ readonly 'dd-MM-yyyy': (date: Date, local: boolean) => string;
+ readonly 'dd-MM-yy': (date: Date, local: boolean) => string;
+ readonly 'dd/MM/yy': (date: Date, local: boolean) => string;
+ readonly 'dd/MM/yyyy': (date: Date, local: boolean) => string;
+ readonly 'MM/dd/yy': (date: Date, local: boolean) => string;
+ readonly 'MM/dd/yyyy': (date: Date, local: boolean) => string;
+};
+/* eslint-enable jsdoc/require-jsdoc */
+declare enum HHistDirection {
+ LeftToRight = 'left_to_right',
+ RightToLeft = 'right_to_left',
+}
+declare enum LineStudyPlotStyle {
+ /**
+ * Line plot style.
+ */
+ Line = 0,
+ /**
+ * Histogram plot style.
+ */
+ Histogram = 1,
+ /**
+ * Cross plot style.
+ */
+ Cross = 3,
+ /**
+ * Area plot style.
+ */
+ Area = 4,
+ /**
+ * Column plot style.
+ */
+ Columns = 5,
+ /**
+ * Circles plot style.
+ */
+ Circles = 6,
+ /**
+ * Line with breaks plot style.
+ */
+ LineWithBreaks = 7,
+ /**
+ * Area with breaks plot style.
+ */
+ AreaWithBreaks = 8,
+ /**
+ * Step line plot style.
+ */
+ StepLine = 9,
+ /**
+ * Step line with diamonds plot style.
+ */
+ StepLineWithDiamonds = 10,
+ /**
+ * Step line with breaks, like LineWithBreaks
+ */
+ StepLineWithBreaks = 11,
+}
+declare enum LineStyle {
+ /**
+ * Solid line style.
+ */
+ Solid = 0,
+ /**
+ * Dotted line style.
+ */
+ Dotted = 1,
+ /**
+ * Dashed line style.
+ */
+ Dashed = 2,
+}
+declare enum MarkLocation {
+ AboveBar = 'AboveBar',
+ BelowBar = 'BelowBar',
+ Top = 'Top',
+ Bottom = 'Bottom',
+ Right = 'Right',
+ Left = 'Left',
+ Absolute = 'Absolute',
+ AbsoluteUp = 'AbsoluteUp',
+ AbsoluteDown = 'AbsoluteDown',
+}
+declare enum OrderOrPositionMessageType {
+ Information = 'information',
+ Warning = 'warning',
+ Error = 'error',
+}
+declare enum PlotSymbolSize {
+ Auto = 'auto',
+ Tiny = 'tiny',
+ Small = 'small',
+ Normal = 'normal',
+ Large = 'large',
+ Huge = 'huge',
+}
+declare enum StopType {
+ StopLoss = 0,
+ TrailingStop = 1,
+}
+export declare const enum ActionId {
+ ChartAddIndicatorToAllCharts = 'Chart.AddIndicatorToAllCharts',
+ ChartAddSymbolToWatchList = 'Chart.AddSymbolToWatchList',
+ ChartApplyIndicatorsToAllCharts = 'Chart.ApplyIndicatorsToAllCharts',
+ ChartChangeTimeZone = 'Chart.ChangeTimeZone',
+ ChartClipboardCopyPrice = 'Chart.Clipboard.CopyPrice',
+ ChartClipboardCopyLineTools = 'Chart.Clipboard.CopyLineTools',
+ ChartClipboardCopySource = 'Chart.Clipboard.CopySource',
+ ChartClipboardPasteSource = 'Chart.Clipboard.PasteSource',
+ ChartCrosshairLockVerticalCursor = 'Chart.Crosshair.LockVerticalCursor',
+ ChartCrosshairPlusButtonDrawHorizontalLine = 'Chart.Crosshair.PlusButton.DrawHorizontalLine',
+ ChartCustomActionId = 'Chart.CustomActionId',
+ ChartDialogsShowChangeInterval = 'Chart.Dialogs.ShowChangeInterval',
+ ChartDialogsShowChangeSymbol = 'Chart.Dialogs.ShowChangeSymbol',
+ ChartDialogsShowCompareOrAddSymbol = 'Chart.Dialogs.ShowCompareOrAddSymbol',
+ ChartDialogsShowGeneralSettings = 'Chart.Dialogs.ShowGeneralSettings',
+ ChartDialogsShowGeneralSettingsLegendTab = 'Chart.Dialogs.ShowGeneralSettings.LegendTab',
+ ChartDialogsShowGeneralSettingsSymbolTab = 'Chart.Dialogs.ShowGeneralSettings.SymbolTab',
+ ChartDialogsShowGoToDate = 'Chart.Dialogs.ShowGoToDate',
+ ChartDialogsShowInsertIndicators = 'Chart.Dialogs.ShowInsertIndicators',
+ ChartDialogsShowSymbolInfo = 'Chart.Dialogs.ShowSymbolInfo',
+ ChartDrawingToolbarToggleVisibility = 'Chart.DrawingToolbar.ToggleVisibility',
+ ChartExternalActionId = 'Chart.ExternalActionId',
+ ChartFavoriteDrawingToolsToolbarHide = 'Chart.FavoriteDrawingToolsToolbar.Hide',
+ ChartIndicatorShowSettingsDialog = 'Chart.Indicator.ShowSettingsDialog',
+ ChartLegendToggleBarChangeValuesVisibility = 'Chart.Legend.ToggleBarChangeValuesVisibility',
+ ChartLegendTogglePriceSourceVisibility = 'Chart.Legend.TogglePriceSourceVisibility',
+ ChartLegendToggleIndicatorArgumentsVisibility = 'Chart.Legend.ToggleIndicatorArgumentsVisibility',
+ ChartLegendToggleIndicatorTitlesVisibility = 'Chart.Legend.ToggleIndicatorTitlesVisibility',
+ ChartLegendToggleIndicatorValuesVisibility = 'Chart.Legend.ToggleIndicatorValuesVisibility',
+ ChartLegendToggleOhlcValuesVisibility = 'Chart.Legend.ToggleOhlcValuesVisibility',
+ ChartLegendToggleOpenMarketStatusVisibility = 'Chart.Legend.ToggleOpenMarketStatusVisibility',
+ ChartLegendToggleSymbolVisibility = 'Chart.Legend.ToggleSymbolVisibility',
+ ChartLegendToggleVolumeVisibility = 'Chart.Legend.ToggleVolumeVisibility',
+ ChartLines = 'Chart.Lines',
+ ChartLinesToggleBidAskLinesVisibility = 'Chart.Lines.ToggleBidAskLinesVisibility',
+ ChartLinesToggleHighLowLinesVisibility = 'Chart.Lines.ToggleHighLowLinesVisibility',
+ ChartLinesToggleAverageLineVisibility = 'Chart.Lines.ToggleAverageLineVisibility',
+ ChartLinesToggleSeriesPrevCloseLineVisibility = 'Chart.Lines.ToggleSeriesPrevCloseLineVisibility',
+ ChartLinesToggleSeriesPriceLineVisibility = 'Chart.Lines.ToggleSeriesPriceLineVisibility',
+ ChartLineToolBarsPatternToggleFlipped = 'Chart.LineTool.BarsPattern.ToggleFlipped',
+ ChartLineToolBarsPatternToggleMirrored = 'Chart.LineTool.BarsPattern.ToggleMirrored',
+ ChartLineToolClone = 'Chart.LineTool.Clone',
+ ChartLineToolCreateLimitOrderFromState = 'Chart.LineTool.CreateLimitOrderFromState',
+ ChartLineToolElliotChangeDegreeProperty = 'Chart.LineTool.Elliot.ChangeDegreeProperty',
+ ChartLineToolNoSync = 'Chart.LineTool.NoSync',
+ ChartLineToolPitchforkChangeTypeToInside = 'Chart.LineTool.Pitchfork.ChangeTypeToInside',
+ ChartLineToolPitchforkChangeTypeToModifiedSchiff = 'Chart.LineTool.Pitchfork.ChangeTypeToModifiedSchiff',
+ ChartLineToolPitchforkChangeTypeToOriginal = 'Chart.LineTool.Pitchfork.ChangeTypeToOriginal',
+ ChartLineToolPitchforkChangeTypeToSchiff = 'Chart.LineTool.Pitchfork.ChangeTypeToSchiff',
+ ChartLineToolSyncInLayout = 'Chart.LineTool.SyncInLayout',
+ ChartLineToolTemplates = 'Chart.LineTool.Templates',
+ ChartLineToolTemplatesApply = 'Chart.LineTool.Templates.Apply',
+ ChartLineToolTemplatesApplyDefaults = 'Chart.LineTool.Templates.ApplyDefaults',
+ ChartLineToolTemplatesSaveAs = 'Chart.LineTool.Templates.SaveAs',
+ ChartLineToolToolbarChangeFontSizeProperty = 'Chart.LineTool.Toolbar.ChangeFontSizeProperty',
+ ChartLineToolToolbarChangeLineStyleToDashed = 'Chart.LineTool.Toolbar.ChangeLineStyleToDashed',
+ ChartLineToolToolbarChangeLineStyleToDotted = 'Chart.LineTool.Toolbar.ChangeLineStyleToDotted',
+ ChartLineToolToolbarChangeLineStyleToSolid = 'Chart.LineTool.Toolbar.ChangeLineStyleToSolid',
+ ChartMarksToggleVisibility = 'Chart.Marks.ToggleVisibility',
+ ChartMoveChartInLayout = 'Chart.MoveChartInLayout',
+ ChartMoveChartInLayoutBack = 'Chart.MoveChartInLayout.Back',
+ ChartMoveChartInLayoutForward = 'Chart.MoveChartInLayout.Forward',
+ ChartObjectTreeShow = 'Chart.ObjectTree.Show',
+ ChartDataWindowShow = 'Chart.DataWindow.Show',
+ ChartPaneControlsDeletePane = 'Chart.PaneControls.DeletePane',
+ ChartPaneControlsMaximizePane = 'Chart.PaneControls.MaximizePane',
+ ChartPaneControlsMinimizePane = 'Chart.PaneControls.MinimizePane',
+ ChartPaneControlsMovePaneDown = 'Chart.PaneControls.MovePaneDown',
+ ChartPaneControlsMovePaneUp = 'Chart.PaneControls.MovePaneUp',
+ ChartPaneControlsCollapsePane = 'Chart.PaneControls.CollapsePane',
+ ChartPaneControlsRestorePane = 'Chart.PaneControls.RestorePane',
+ ChartPriceScaleLabels = 'Chart.PriceScale.Labels',
+ ChartPriceScaleLabelsToggleBidAskLabelsVisibility = 'Chart.PriceScale.Labels.ToggleBidAskLabelsVisibility',
+ ChartPriceScaleLabelsToggleHighLowPriceLabelsVisibility = 'Chart.PriceScale.Labels.ToggleHighLowPriceLabelsVisibility',
+ ChartPriceScaleLabelsToggleAveragePriceLabelVisibility = 'Chart.PriceScale.Labels.ToggleAveragePriceLabelVisibility',
+ ChartPriceScaleLabelsToggleIndicatorsNameLabelsVisibility = 'Chart.PriceScale.Labels.ToggleIndicatorsNameLabelsVisibility',
+ ChartPriceScaleLabelsToggleIndicatorsValueLabelsVisibility = 'Chart.PriceScale.Labels.ToggleIndicatorsValueLabelsVisibility',
+ ChartPriceScaleLabelsToggleNoOverlappingLabelsVisibility = 'Chart.PriceScale.Labels.ToggleNoOverlappingLabelsVisibility',
+ ChartPriceScaleLabelsToggleSeriesLastValueVisibility = 'Chart.PriceScale.Labels.ToggleSeriesLastValueVisibility',
+ ChartPriceScaleLabelsToggleSymbolNameLabelsVisibility = 'Chart.PriceScale.Labels.ToggleSymbolNameLabelsVisibility',
+ ChartPriceScaleLabelsToggleSymbolPrevCloseValueVisibility = 'Chart.PriceScale.Labels.ToggleSymbolPrevCloseValueVisibility',
+ ChartPriceScaleMergeAllScales = 'Chart.PriceScale.MergeAllScales',
+ ChartPriceScaleMergeAllScalesToLeft = 'Chart.PriceScale.MergeAllScalesToLeft',
+ ChartPriceScaleMergeAllScalesToRight = 'Chart.PriceScale.MergeAllScalesToRight',
+ ChartPriceScaleMoveToLeft = 'Chart.PriceScale.MoveToLeft',
+ ChartPriceScaleMoveToRight = 'Chart.PriceScale.MoveToRight',
+ ChartPriceScaleReset = 'Chart.PriceScale.Reset',
+ ChartPriceScaleToggleAddOrderPlusButtonVisibility = 'Chart.PriceScale.ToggleAddOrderPlusButtonVisibility',
+ ChartPriceScaleToggleAutoScale = 'Chart.PriceScale.ToggleAutoScale',
+ ChartPriceScaleToggleAutoScaleSeriesOnly = 'Chart.PriceScale.ToggleAutoScaleSeriesOnly',
+ ChartPriceScaleToggleCountdownToBarCloseVisibility = 'Chart.PriceScale.ToggleCountdownToBarCloseVisibility',
+ ChartPriceScaleToggleIndexedTo100 = 'Chart.PriceScale.ToggleIndexedTo100',
+ ChartPriceScaleToggleInvertScale = 'Chart.PriceScale.ToggleInvertScale',
+ ChartPriceScaleToggleLogarithmic = 'Chart.PriceScale.ToggleLogarithmic',
+ ChartPriceScaleTogglePercentage = 'Chart.PriceScale.TogglePercentage',
+ ChartPriceScaleToggleRegular = 'Chart.PriceScale.ToggleRegular',
+ ChartRedo = 'Chart.Redo',
+ ChartRemoveAllIndicators = 'Chart.RemoveAllIndicators',
+ ChartRemoveAllIndicatorsAndLineTools = 'Chart.RemoveAllIndicatorsAndLineTools',
+ ChartRemoveAllLineTools = 'Chart.RemoveAllLineTools',
+ ChartScalesReset = 'Chart.Scales.Reset',
+ ChartScalesToggleLockPriceToBarRatio = 'Chart.Scales.ToggleLockPriceToBarRatio',
+ ChartScrollToLineTool = 'Chart.ScrollToLineTool',
+ ChartSelectedObjectHide = 'Chart.SelectedObject.Hide',
+ ChartSelectedObjectRemove = 'Chart.SelectedObject.Remove',
+ ChartSelectedObjectShow = 'Chart.SelectedObject.Show',
+ ChartSelectedObjectShowSettingsDialog = 'Chart.SelectedObject.ShowSettingsDialog',
+ ChartSelectedObjectToggleLocked = 'Chart.SelectedObject.ToggleLocked',
+ ChartSeriesPriceScaleToggleAutoScale = 'Chart.Series.PriceScale.ToggleAutoScale',
+ ChartSeriesPriceScaleToggleIndexedTo100 = 'Chart.Series.PriceScale.ToggleIndexedTo100',
+ ChartSeriesPriceScaleToggleInvertPriceScale = 'Chart.Series.PriceScale.ToggleInvertPriceScale',
+ ChartSeriesPriceScaleToggleLogarithmic = 'Chart.Series.PriceScale.ToggleLogarithmic',
+ ChartSeriesPriceScaleTogglePercentage = 'Chart.Series.PriceScale.TogglePercentage',
+ ChartSeriesPriceScaleToggleRegular = 'Chart.Series.PriceScale.ToggleRegular',
+ ChartSessionBreaksToggleVisibility = 'Chart.SessionBreaks.ToggleVisibility',
+ ChartSetSession = 'Chart.SetSession',
+ ChartSourceChangePriceScale = 'Chart.Source.ChangePriceScale',
+ ChartSourceMergeDown = 'Chart.Source.MergeDown',
+ ChartSourceMergeUp = 'Chart.Source.MergeUp',
+ ChartSourceMoveToNoScale = 'Chart.Source.MoveToNoScale',
+ ChartSourceMoveToOtherScale = 'Chart.Source.MoveToOtherScale',
+ ChartSourceMoveToPane = 'Chart.Source.MoveToPane',
+ ChartSourceUnmergeDown = 'Chart.Source.UnmergeDown',
+ ChartSourceUnmergeUp = 'Chart.Source.UnmergeUp',
+ ChartSourceVisualOrder = 'Chart.Source.VisualOrder',
+ ChartSourceVisualOrderBringForward = 'Chart.Source.VisualOrder.BringForward',
+ ChartSourceVisualOrderBringToFront = 'Chart.Source.VisualOrder.BringToFront',
+ ChartSourceVisualOrderSendBackward = 'Chart.Source.VisualOrder.SendBackward',
+ ChartSourceVisualOrderSendToBack = 'Chart.Source.VisualOrder.SendToBack',
+ ChartSourceResetInputPoints = 'Chart.Source.ResetInputPoints',
+ ChartTimeScaleReset = 'Chart.TimeScale.Reset',
+ ChartUndo = 'Chart.Undo',
+ ChartSourceIntervalsVisibility = 'Chart.Source.IntervalsVisibility',
+ ChartSourceIntervalsVisibilityCurrentAndAbove = 'Chart.Source.IntervalsVisibility.CurrentAndAbove',
+ ChartSourceIntervalsVisibilityCurrentAndBelow = 'Chart.Source.IntervalsVisibility.CurrentAndBelow',
+ ChartSourceIntervalsVisibilityOnlyCurrent = 'Chart.Source.IntervalsVisibility.Current',
+ ChartSourceIntervalsVisibilityAll = 'Chart.Source.IntervalsVisibility.All',
+ ObjectsTreeCreateGroup = 'ObjectsTree.CreateGroup',
+ ObjectsTreeRemoveItem = 'ObjectsTree.RemoveItem',
+ ObjectsTreeRenameItem = 'ObjectsTree.RenameItem',
+ ObjectsTreeToggleItemLocked = 'ObjectsTree.ToggleItemLocked',
+ ObjectsTreeToggleItemVisibility = 'ObjectsTree.ToggleItemVisibility',
+ TradingCancelOrder = 'Trading.CancelOrder',
+ TradingClosePosition = 'Trading.ClosePosition',
+ TradingCustomActionId = 'Trading.CustomActionId',
+ TradingDOMPlaceLimitOrder = 'Trading.DOMPlaceLimitOrder',
+ TradingDOMPlaceMarketOrder = 'Trading.DOMPlaceMarketOrder',
+ TradingDOMPlaceStopLimitOrder = 'Trading.DOMPlaceStopLimitOrder',
+ TradingDOMPlaceStopOrder = 'Trading.DOMPlaceStopOrder',
+ TradingEditOrder = 'Trading.EditOrder',
+ TradingModifyPosition = 'Trading.ModifyPosition',
+ TradingReversePosition = 'Trading.ReversePosition',
+ TradingSellBuyButtonsToggleVisibility = 'Trading.SellBuyButtonsToggleVisibility',
+ TradingTradeFromChart = 'Trading.TradeFromChart',
+ TradingNoOverlapMode = 'Trading.NoOverlapMode',
+ WatchlistAddSymbol = 'Watchlist.AddSymbol',
+ WatchlistAddSymbolToCompare = 'Watchlist.AddSymbolToCompare',
+ WatchlistAddSelectedSymbolsToCompare = 'Watchlist.AddSelectedSymbolsToCompare ',
+ WatchlistRenameSection = 'Watchlist.RenameSection',
+ WatchlistRemoveSection = 'Watchlist.RemoveSection',
+ WatchlistAddSymbolToSection = 'Watchlist.AddSymbolToSection',
+}
+export declare const enum ChartStyle {
+ Bar = 0,
+ Candle = 1,
+ Line = 2,
+ Area = 3,
+ Renko = 4,
+ Kagi = 5,
+ PnF = 6,
+ LineBreak = 7,
+ HeikinAshi = 8,
+ HollowCandle = 9,
+ Baseline = 10,
+ HiLo = 12,
+ Column = 13,
+ LineWithMarkers = 14,
+ Stepline = 15,
+ HLCArea = 16,
+}
+/**
+ * Mode to clear the marks on the chart.
+ */
+export declare const enum ClearMarksMode {
+ /** Will clear both bar marks AND timescale marks - default value */
+ All = 0,
+ /** Will only clear bar marks */
+ BarMarks = 1,
+ /** Will only clear timescale marks */
+ TimeScaleMarks = 2,
+}
+export declare const enum ConnectionStatus {
+ Connected = 1,
+ Connecting = 2,
+ Disconnected = 3,
+ Error = 4,
+}
+/**
+ * Filled area type.
+ */
+export declare const enum FilledAreaType {
+ /**
+ * Filled area type for plots.
+ */
+ TypePlots = 'plot_plot',
+ /**
+ * Filled area type for bands.
+ */
+ TypeHlines = 'hline_hline',
+}
+/**
+ * Market status for the symbol.
+ */
+export declare const enum MarketStatus {
+ Open = 'market',
+ Pre = 'pre_market',
+ Post = 'post_market',
+ Close = 'out_of_session',
+ Holiday = 'holiday',
+}
+export declare const enum MenuItemType {
+ Separator = 'separator',
+ Action = 'action',
+}
+export declare const enum NotificationType {
+ Error = 0,
+ Success = 1,
+}
+export declare const enum OhlcStudyPlotStyle {
+ OhlcBars = 'ohlc_bars',
+ OhlcCandles = 'ohlc_candles',
+}
+export declare const enum OrderStatus {
+ Canceled = 1,
+ Filled = 2,
+ Inactive = 3,
+ Placing = 4,
+ Rejected = 5,
+ Working = 6,
+}
+export declare const enum OrderStatusFilter {
+ All = 0,
+ Canceled = 1,
+ Filled = 2,
+ Inactive = 3,
+ Rejected = 5,
+ Working = 6,
+}
+export declare const enum OrderTicketFocusControl {
+ LimitPrice = 1,
+ StopPrice = 2,
+ TakeProfit = 3,
+ StopLoss = 4,
+ Quantity = 5,
+}
+export declare const enum OrderType {
+ Limit = 1,
+ Market = 2,
+ Stop = 3,
+ StopLimit = 4,
+}
+/**
+ * Plot line style
+ */
+export declare const enum OverrideLineStyle {
+ /**
+ * Solid line style.
+ */
+ Solid = 0,
+ /**
+ * Dotted line style.
+ */
+ Dotted = 1,
+ /**
+ * Dashed line style.
+ */
+ Dashed = 2,
+}
+/**
+ * Last value label mode.
+ */
+export declare const enum OverridePriceAxisLastValueMode {
+ /**
+ * Price and % value.
+ */
+ LastPriceAndPercentageValue = 0,
+ /**
+ * Value according to scale.
+ */
+ LastValueAccordingToScale = 1,
+}
+export declare const enum ParentType {
+ Order = 1,
+ Position = 2,
+ Trade = 3,
+}
+export declare const enum PriceScaleMode {
+ /** Normal mode of the price scale */
+ Normal = 0,
+ /** Logarithmic mode of the price scale */
+ Log = 1,
+ /** Percentage mode of the price scale */
+ Percentage = 2,
+ /** Indexed to 100 mode of the price scale */
+ IndexedTo100 = 3,
+}
+export declare const enum SeriesType {
+ Bars = 0,
+ Candles = 1,
+ Line = 2,
+ Area = 3,
+ HeikenAshi = 8,
+ HollowCandles = 9,
+ Baseline = 10,
+ HiLo = 12,
+ Column = 13,
+ LineWithMarkers = 14,
+ Stepline = 15,
+ HLCArea = 16,
+ Renko = 4,
+ Kagi = 5,
+ PointAndFigure = 6,
+ LineBreak = 7,
+}
+export declare const enum Side {
+ Buy = 1,
+ Sell = -1,
+}
+export declare const enum StandardFormatterName {
+ Date = 'date',
+ DateOrDateTime = 'dateOrDateTime',
+ Default = 'default',
+ Fixed = 'fixed',
+ FixedInCurrency = 'fixedInCurrency',
+ VariablePrecision = 'variablePrecision',
+ FormatQuantity = 'formatQuantity',
+ FormatPrice = 'formatPrice',
+ FormatPriceForexSup = 'formatPriceForexSup',
+ IntegerSeparated = 'integerSeparated',
+ LocalDate = 'localDate',
+ LocalDateOrDateTime = 'localDateOrDateTime',
+ Percentage = 'percentage',
+ Pips = 'pips',
+ Profit = 'profit',
+ ProfitInInstrumentCurrency = 'profitInInstrumentCurrency',
+ Side = 'side',
+ PositionSide = 'positionSide',
+ Status = 'status',
+ Symbol = 'symbol',
+ Text = 'text',
+ Type = 'type',
+ MarginPercent = 'marginPercent',
+ Empty = 'empty',
+}
+export declare const enum StudyInputType {
+ Integer = 'integer',
+ Float = 'float',
+ Price = 'price',
+ Bool = 'bool',
+ Text = 'text',
+ Symbol = 'symbol',
+ Session = 'session',
+ Source = 'source',
+ Resolution = 'resolution',
+ Time = 'time',
+ BarTime = 'bar_time',
+ Color = 'color',
+ Textarea = 'text_area',
+}
+export declare const enum StudyPlotDisplayTarget {
+ None = 0,
+ Pane = 1,
+ DataWindow = 2,
+ PriceScale = 4,
+ StatusLine = 8,
+ All = 15,
+}
+export declare const enum StudyPlotType {
+ Line = 'line',
+ Colorer = 'colorer',
+ BarColorer = 'bar_colorer',
+ BgColorer = 'bg_colorer',
+ TextColorer = 'text_colorer',
+ OhlcColorer = 'ohlc_colorer',
+ CandleWickColorer = 'wick_colorer',
+ CandleBorderColorer = 'border_colorer',
+ UpColorer = 'up_colorer',
+ DownColorer = 'down_colorer',
+ Shapes = 'shapes',
+ Chars = 'chars',
+ Arrows = 'arrows',
+ Data = 'data',
+ DataOffset = 'dataoffset',
+ OhlcOpen = 'ohlc_open',
+ OhlcHigh = 'ohlc_high',
+ OhlcLow = 'ohlc_low',
+ OhlcClose = 'ohlc_close',
+}
+export declare const enum StudyTargetPriceScale {
+ Right = 0,
+ Left = 1,
+ NoScale = 2,
+}
+export declare const enum TimeFrameType {
+ PeriodBack = 'period-back',
+ TimeRange = 'time-range',
+}
+export declare const enum TimeHoursFormat {
+ TwentyFourHours = '24-hours',
+ TwelveHours = '12-hours',
+}
+export declare const enum VisibilityType {
+ AlwaysOn = 'alwaysOn',
+ VisibleOnMouseOver = 'visibleOnMouseOver',
+ AlwaysOff = 'alwaysOff',
+}
+export declare const widget: ChartingLibraryWidgetConstructor;
+/**
+ * Returns a build version string. For example "CL v23.012 (internal id e0d59dc3 @ 2022-08-23T06:07:00.808Z)".
+ *
+ * @returns The build version string.
+ */
+export declare function version(): string;
+/**
+ * This is the generic type useful for declaring a nominal type,
+ * which does not structurally matches with the base type and
+ * the other types declared over the same base type
+ *
+ * Usage:
+ * @example
+ * type Index = Nominal;
+ * // let i: Index = 42; // this fails to compile
+ * let i: Index = 42 as Index; // OK
+ * @example
+ * type TagName = Nominal;
+ */
+export declare type Nominal = T & {
+ /* eslint-disable-next-line jsdoc/require-jsdoc */ [Symbol.species]: Name;
+};
+/**
+ * Override properties for the Abcd drawing tool.
+ */
+export interface AbcdLineToolOverrides {
+ /** Default value: `false` */
+ 'linetoolabcd.bold': boolean;
+ /** Default value: `#089981` */
+ 'linetoolabcd.color': string;
+ /** Default value: `12` */
+ 'linetoolabcd.fontsize': number;
+ /** Default value: `false` */
+ 'linetoolabcd.italic': boolean;
+ /** Default value: `2` */
+ 'linetoolabcd.linewidth': number;
+ /** Default value: `#ffffff` */
+ 'linetoolabcd.textcolor': string;
+}
+/**
+ * Defines a whitelist / blacklist of studies or drawing tools.
+ */
+export interface AccessList {
+ /**
+ * List type.
+ * Supported values are:
+ * `black` (all listed items should be disabled),
+ * `white` (only the listed items should be enabled).
+ */
+ type: 'black' | 'white';
+ /** Array of items which should be considered part of the access list */
+ tools: AccessListItem[];
+}
+export interface AccessListItem {
+ /**
+ * Name of the study / drawing tool.
+ * Use the same name as seen in the UI for drawings,
+ * and use the same names as in the pop-ups for indicators.
+ */
+ name: string;
+ /**
+ * Whether this study should be visible but look as if it's disabled.
+ * If the study is grayed out and user clicks it, then the `onGrayedObjectClicked` function is called.
+ */
+ grayed?: boolean;
+}
+/** Column description for an account manager table */
+export interface AccountManagerColumnBase<
+ TFormatterName extends StandardFormatterName | FormatterName
+> {
+ /** Column title. It will be displayed in the table's header row. */
+ label: string;
+ /**
+ * Horizontal alignment of the cell value. The default value is `left`.
+ *
+ * | alignment | description |
+ * |--------------|----------------|
+ * | left | It aligns the cell value to the left |
+ * | right | It aligns the cell value to the right |
+ */
+ alignment?: CellAlignment;
+ /** Column id. Unique identifier of column. */
+ id: string;
+ /**
+ * Name of the formatter to be used for data formatting. It can be one of two types - `StandardFormatterName` or `FormatterName`. If `formatter` is not set, then the value is displayed as is.
+ * Formatter can be a default or a custom one.
+ *
+ * Default formatter names are listed in `StandardFormatterName` enumerator. If you want to use a custom formatter, you must typecast its name to `FormatterName` to confirm your confidence that you are using the correct name.
+ *
+ * Here is the list of default formatters:
+ *
+ * | name | description |
+ * | ---- | ----------- |
+ * | `StandardFormatterName.Date` | Displays the date or time. |
+ * | `StandardFormatterName.DateOrDateTime` | Displays the date or date and time. This formatter accepts an `{dateOrDateTime: number, hasTime: boolean}` object. If `hasTime` is set to `true` then the date and time are displayed. Otherwise only the date is displayed.|
+ * | `StandardFormatterName.Fixed` | Displays a number with 2 decimal places. |
+ * | `StandardFormatterName.FixedInCurrency` | Displays a number with 2 decimal places and adds currency. |
+ * | `StandardFormatterName.FormatPrice` | Displays symbol's price. |
+ * | `StandardFormatterName.FormatQuantity` | Displays an integer or floating point quantity, separates thousands groups with a space. |
+ * | `StandardFormatterName.FormatPriceForexSup` | The same as `formatPrice`, but it makes the last character of the price superscripted. It works only if instrument type is set to `forex`.|
+ * | `StandardFormatterName.LocalDate` | Displays the local date or time. |
+ * | `StandardFormatterName.LocalDateOrDateTime` | The same as `StandardFormatterName.DateOrDateTime`, but it displays time in the local timezone. |
+ * | `StandardFormatterName.Pips` | Displays a number with 1 decimal place. |
+ * | `StandardFormatterName.Profit` | Displays profit in account currency. It also adds the `+` sign, separates thousands and changes the cell text color to red or green. |
+ * | `StandardFormatterName.ProfitInInstrumentCurrency` | Displays profit in instrument currency. It also adds the `+` sign, separates thousands and changes the cell text color to red or green. |
+ * | `StandardFormatterName.Side` | It is used to display the side: Sell or Buy. |
+ * | `StandardFormatterName.PositionSide` | It is used to display the position side: Short or Long. |
+ * | `StandardFormatterName.Status` | It is used to format the `status`. |
+ * | `StandardFormatterName.Symbol` | It is used for a symbol field. It displays `brokerSymbol`, but when you click on a symbol the chart changes according to the `symbol` field. |
+ * | `StandardFormatterName.Text` | Displays a text value. |
+ * | `StandardFormatterName.Type` | It is used to display the type of order: Limit/Stop/StopLimit/Market. |
+ * | `StandardFormatterName.VariablePrecision` | Displays a number with variable precision. |
+ */
+ formatter?: TFormatterName;
+ /**
+ * `dataFields` is an array with data object fields that is used to get the data to display in a column.
+ *
+ * The displayed value in the column will only change if one of the corresponding data object values change.
+ *
+ * If the `formatter` is not set, the displayed values will be space-separated in the column.
+ *
+ * If a `formatter` is specified, it will only get the specified values.
+ *
+ * Specify an empty array as the `dataFields` and the formatter will receive the entire data object.
+ *
+ * **Example**
+ * Example
+ *
+ * - If you have column with `dataFields` set as `['avgPrice', 'qty']`, then displayed value will update only if `avgPrice` or `qty` values of the data object have been changed.
+ * - If you have column with `dataFields` set as `[]`, then displayed value will update if some data object values have been changed.
+ */
+ dataFields: TFormatterName extends StandardFormatterName
+ ? StandardFormattersDependenciesMapping[TFormatterName]
+ : string[];
+ /**
+ * Data object key that is used for data sorting
+ *
+ * If `sortProp` is not provided, then the first element of the `dataFields` array will be used. If the `dataFields` array is empty, then column sorting will be unavailable.
+ */
+ sortProp?: string;
+ /** When set to `true` will prevent column sorting. */
+ notSortable?: boolean;
+ /** Tooltip string for the column. */
+ help?: string;
+ /**
+ * `highlightDiff` can be set with `StandardFormatterName.FormatPrice` and `StandardFormatterName.FormatPriceForexSup` formatters to highlight the changes of the field. If set to `true` then custom formatters will also get previous values.
+ */
+ highlightDiff?: boolean;
+ /** When set to `true` will prevent the column from hiding. */
+ notHideable?: boolean;
+ /** When set to `true` will hide the column by default */
+ hideByDefault?: boolean;
+ /** Key of the row object that is used to get the tooltip to display when hovering over a cell.
+ * The tooltip property refers to an object whose keys are property names and
+ * values are the corresponding tooltips.
+ */
+ tooltipProperty?: string;
+ /** If set to `true`, the first character of every word in the sentence in the column
+ * will be capitalized. The default value is `true`.
+ */
+ isCapitalize?: boolean;
+ /** When set to `true` any zero values will be hidden. Default is `true` */
+ showZeroValues?: boolean;
+}
+export interface AccountManagerInfo {
+ /** Name of the broker */
+ accountTitle: string;
+ /** Custom fields which will always be displayed above the pages. */
+ summary: AccountManagerSummaryField[];
+ /**
+ * Optional array to define custom formatters.
+ * Each description is an object with the following fields:
+ *
+ * 1. `name`: FormatterName
+ * - Unique name of a formatter.
+ *
+ * 1. `formatText`: [TableFormatTextFunction](#tableformattextfunction)
+ * -Function that is used for formatting of a cell value to `string`. Required because used to generate exported data.
+ *
+ * 1. `formatElement`: [CustomTableFormatElementFunction](#customtableformatelementfunction) | undefined
+ * - Optional function that is used for formatting of a cell value to `string` or `HTMLElement`.
+ *
+ * If the `formatElement` function is provided, then only it will be used to format the displayed values, otherwise
+ * `formatText` will be used. If you need to only display `string` values it is better to use only `formatText` for performance reasons.
+ *
+ * **Example**
+ * ```ts
+ * {
+ * name: 'closeButton' as FormatterName, // Typecast to FormatterName. Use constant in real code
+ * formatText: () => '', // Returns an empty string because we don't need to display this in the exported data
+ * formatElement: ({ values: [id] }: TableFormatterInputs<[id: string]>) => {
+ * const button = document.createElement('button');
+ *
+ * button.innerText = 'Close';
+ *
+ * button.addEventListener('click', () => {
+ * event.stopPropagation();
+ *
+ * closePosition(id);
+ * });
+ *
+ * return button;
+ * },
+ * }
+ * ```
+ */
+ customFormatters?: CustomTableElementFormatter[];
+ /** Columns description that you want to be displayed on the Orders page.
+ * You can display any field of an {@link Order}
+ * or add your own fields to an order object and display them.
+ */
+ orderColumns: OrderTableColumn[];
+ /** Optional sorting of the orders table. */
+ orderColumnsSorting?: SortingParameters;
+ /** History page will be displayed if it exists. All orders from previous sessions will be shown in the History. */
+ historyColumns?: AccountManagerColumn[];
+ /** Optional sorting of the history table. */
+ historyColumnsSorting?: SortingParameters;
+ /**
+ * You can display any field of a {@link Position}
+ * or add your own fields to a position object and display them.
+ */
+ positionColumns?: AccountManagerColumn[];
+ /**
+ * You can display any field of a {@link Trade}
+ * or add your own fields to a trade object and display them.
+ */
+ tradeColumns?: AccountManagerColumn[];
+ /** You can add new tabs in the Account Manager by using `pages`. Each tab is a set of tables. */
+ pages: AccountManagerPage[];
+ /** Optional list of statuses to be used in the orders filter. Default list is used if it hasn't been set. */
+ possibleOrderStatuses?: OrderStatus[];
+ /** Margin used */
+ marginUsed?: IWatchedValue;
+ /**
+ * Optional function to create a custom context menu.
+ * @param contextMenuEvent - MouseEvent or TouchEvent object passed by a browser
+ * @param activePageActions - array of `ActionMetaInfo` items for the current page
+ * @returns `Promise` that is resolved with an array of `ActionMetaInfo`
+ */
+ contextMenuActions?(
+ contextMenuEvent: MouseEvent | TouchEvent,
+ activePageActions: ActionMetaInfo[]
+ ): Promise;
+}
+/** A description of an additional Account Manager tab. */
+export interface AccountManagerPage {
+ /** Unique identifier of a page */
+ id: string;
+ /** Page title. It is the tab name. */
+ title: string;
+ /** It is possible to display one or more tables in this tab. */
+ tables: AccountManagerTable[];
+}
+/** Custom field that will always be shown above the pages of the Account manager */
+export interface AccountManagerSummaryField {
+ /** Text to display for the summary field */
+ text: string;
+ /** A WatchedValue object that can be used to read the state of field. */
+ wValue: IWatchedValueReadonly;
+ /**
+ * Name of the formatter to be used for data formatting. If `formatter` is not
+ * set the value is displayed as is. Formatter can be a default or a custom one.
+ */
+ formatter?: StandardFormatterName;
+ /** Optional parameter which can be set to display the field by default. */
+ isDefault?: boolean;
+}
+/**
+ * Account Summary table meta-info
+ * **NOTE**: make sure that you have a unique string `id` field in each row to identify it.
+ */
+export interface AccountManagerTable {
+ /** Unique identifier of a table. */
+ id: string;
+ /** Optional title of a table. */
+ title?: string;
+ /** Table columns */
+ columns: AccountManagerColumn[];
+ /** Optional sorting of the table. If set, then the table will be sorted by these parameters, if the user has not enabled sorting by a specific column. */
+ initialSorting?: SortingParameters;
+ /** This delegate is used to watch the data changes and update the table.
+ * Pass new account manager data row by row to the `fire` method of the delegate.
+ */
+ changeDelegate: ISubscription<(data: {}) => void>;
+ /** Option flags for the table. */
+ flags?: AccountManagerTableFlags;
+ /**
+ * This function is used to request table data. It should return Promise (or Deferred) and resolve it with an array of data rows.
+ *
+ * Each row is an object. Keys of this object are column names with the corresponding values.
+ *
+ * There is a predefined field `isTotalRow` which can be used to mark a row that should be at the bottom of the table.
+ * @param paginationLastId - Last pagination id
+ */
+ getData(paginationLastId?: string | number): Promise<{}[]>;
+}
+/** Boolean options for the account manager table */
+export interface AccountManagerTableFlags {
+ /** Does the table support pagination */
+ supportPagination?: boolean;
+}
+export interface ActionDescription {
+ /** Displayed text for action */
+ text?: '-' | string;
+ /** Is a menu separator */
+ separator?: boolean;
+ /** Keyboard shortcut for the action. Displayed as hint text. */
+ shortcut?: string;
+ /** Tooltip text to be displayed when hovering over the action item. */
+ tooltip?: string;
+ /** Value of the checkbox. */
+ checked?: boolean;
+ /** Getter to retrieve the current checkbox value. */
+ checkedStateSource?: () => boolean;
+ /** Whether menu action represents a checkbox state. Set it to true if you need a checkbox. */
+ checkable?: boolean;
+ /** Whether the action is enabled. Set to false to disabled the action. */
+ enabled?: boolean;
+ /** External link (url) which will be opened upon clicking the menu item. */
+ externalLink?: boolean;
+ /**
+ * A string of SVG icon for an action. A string should be a string representation of SVG (not a path/URL).
+ */
+ icon?: string;
+}
+/** Menu action which provides a callback function to be executed. Action is executed when user clicks the item. */
+export interface ActionDescriptionWithCallback extends ActionDescription {
+ /** Action to be executed when user clicks the menu item. */
+ action: (a?: ActionDescription) => void;
+}
+export interface ActionOptions
+ extends Partial>,
+ Pick {
+ /**
+ * A function which will be called when an action should be executed (e.g. when a user clicks on the item).
+ */
+ onExecute?: OnActionExecuteHandler;
+}
+export interface ActionState {
+ /**
+ * Human-readable, non-unique ID of an action item. Similar to {@link label}, but language-agnostic.
+ */
+ actionId: ActionId;
+ /** Is active */
+ active: boolean;
+ /**
+ * Text title of an action
+ */
+ label: string;
+ /**
+ * Whether an action is disabled or not (disabled actions are usually cannot be executed and displayed grayed out)
+ */
+ disabled: boolean;
+ /**
+ * Sub-items of an action
+ */
+ subItems: IActionVariant[];
+ /**
+ * Whether an action should have a checkbox next to it.
+ */
+ checkable: boolean;
+ /**
+ * If {@link checkable} is `true` then whether current state is checked or not.
+ */
+ checked: boolean;
+ /**
+ * A hint of an action.
+ */
+ hint?: string;
+ /**
+ * A string of SVG icon for an action. A string should be a string representation of SVG (not a path/URL).
+ */
+ icon?: string;
+ /**
+ * If {@link checkable} is `true` then an icon to be used when {@link checked} is `true`.
+ */
+ iconChecked?: string;
+ /**
+ * Whether an action is still in loading state (it means that it's data is not ready yet).
+ * Usually in this case a spinner/loader will be displayed instead of this action.
+ */
+ loading: boolean;
+ /**
+ * A string that represents a shortcut hint for this action.
+ */
+ shortcutHint?: string;
+}
+export interface ActionsFactory {
+ /**
+ * Creates an action with provided options.
+ */
+ createAction: (options: ActionOptions) => IUpdatableAction;
+ /**
+ * Creates an action that will wait for a promise to get its options.
+ * In terms of GUI until a promise is resolved the loader/spinner will be displayed.
+ */
+ createAsyncAction: (loader: () => Promise) => IUpdatableAction;
+ /**
+ * Creates a separator item.
+ */
+ createSeparator: () => ISeparator;
+}
+/**
+ * custom symbol info fields to be shown in the Symbol Info dialog
+ */
+export interface AdditionalSymbolInfoField {
+ /** the name of the new symbol info */
+ title: string;
+ /** used to look up a property from the symbol info returned from the chart's datafeed */
+ propertyName: string;
+}
+/**
+ * Override properties for the Anchoredvwap drawing tool.
+ */
+export interface AnchoredvwapLineToolOverrides {
+ /** Default value: `hlc3` */
+ 'linetoolanchoredvwap.inputs.source': string;
+ /** Default value: `0` */
+ 'linetoolanchoredvwap.inputs.start_time': number;
+ /** Default value: `default` */
+ 'linetoolanchoredvwap.precision': string;
+ /** Default value: `#1e88e5` */
+ 'linetoolanchoredvwap.styles.VWAP.color': string;
+ /** Default value: `15` */
+ 'linetoolanchoredvwap.styles.VWAP.display': number;
+ /** Default value: `0` */
+ 'linetoolanchoredvwap.styles.VWAP.linestyle': number;
+ /** Default value: `1` */
+ 'linetoolanchoredvwap.styles.VWAP.linewidth': number;
+ /** Default value: `0` */
+ 'linetoolanchoredvwap.styles.VWAP.plottype': number;
+ /** Default value: `false` */
+ 'linetoolanchoredvwap.styles.VWAP.trackPrice': boolean;
+ /** Default value: `0` */
+ 'linetoolanchoredvwap.styles.VWAP.transparency': number;
+}
+/**
+ * Override properties for the Arc drawing tool.
+ */
+export interface ArcLineToolOverrides {
+ /** Default value: `rgba(233, 30, 99, 0.2)` */
+ 'linetoolarc.backgroundColor': string;
+ /** Default value: `#e91e63` */
+ 'linetoolarc.color': string;
+ /** Default value: `true` */
+ 'linetoolarc.fillBackground': boolean;
+ /** Default value: `2` */
+ 'linetoolarc.linewidth': number;
+ /** Default value: `80` */
+ 'linetoolarc.transparency': number;
+}
+export interface AreaStylePreferences {
+ /** Top color */
+ color1: string;
+ /** Bottom color */
+ color2: string;
+ /** Line Color */
+ linecolor: string;
+ /** Line Style {@link LineStyle} */
+ linestyle: number;
+ /** Line width */
+ linewidth: number;
+ /**
+ * Transparency. Range [0..100]
+ * `0` - fully opaque,
+ * `100` - fully transparent.
+ *
+ * **Note**: Rather use `rgba` color string for setting transparency.
+ */
+ transparency: number;
+}
+/**
+ * Override properties for the Arrow drawing tool.
+ */
+export interface ArrowLineToolOverrides {
+ /** Default value: `false` */
+ 'linetoolarrow.alwaysShowStats': boolean;
+ /** Default value: `false` */
+ 'linetoolarrow.bold': boolean;
+ /** Default value: `false` */
+ 'linetoolarrow.extendLeft': boolean;
+ /** Default value: `false` */
+ 'linetoolarrow.extendRight': boolean;
+ /** Default value: `14` */
+ 'linetoolarrow.fontsize': number;
+ /** Default value: `center` */
+ 'linetoolarrow.horzLabelsAlign': string;
+ /** Default value: `false` */
+ 'linetoolarrow.italic': boolean;
+ /** Default value: `0` */
+ 'linetoolarrow.leftEnd': number;
+ /** Default value: `#2962FF` */
+ 'linetoolarrow.linecolor': string;
+ /** Default value: `0` */
+ 'linetoolarrow.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolarrow.linewidth': number;
+ /** Default value: `1` */
+ 'linetoolarrow.rightEnd': number;
+ /** Default value: `false` */
+ 'linetoolarrow.showAngle': boolean;
+ /** Default value: `false` */
+ 'linetoolarrow.showBarsRange': boolean;
+ /** Default value: `false` */
+ 'linetoolarrow.showDateTimeRange': boolean;
+ /** Default value: `false` */
+ 'linetoolarrow.showDistance': boolean;
+ /** Default value: `false` */
+ 'linetoolarrow.showLabel': boolean;
+ /** Default value: `false` */
+ 'linetoolarrow.showMiddlePoint': boolean;
+ /** Default value: `false` */
+ 'linetoolarrow.showPercentPriceRange': boolean;
+ /** Default value: `false` */
+ 'linetoolarrow.showPipsPriceRange': boolean;
+ /** Default value: `false` */
+ 'linetoolarrow.showPriceLabels': boolean;
+ /** Default value: `false` */
+ 'linetoolarrow.showPriceRange': boolean;
+ /** Default value: `2` */
+ 'linetoolarrow.statsPosition': number;
+ /** Default value: `#2962FF` */
+ 'linetoolarrow.textcolor': string;
+ /** Default value: `bottom` */
+ 'linetoolarrow.vertLabelsAlign': string;
+}
+/**
+ * Override properties for the Arrowmarkdown drawing tool.
+ */
+export interface ArrowmarkdownLineToolOverrides {
+ /** Default value: `#CC2F3C` */
+ 'linetoolarrowmarkdown.arrowColor': string;
+ /** Default value: `false` */
+ 'linetoolarrowmarkdown.bold': boolean;
+ /** Default value: `#CC2F3C` */
+ 'linetoolarrowmarkdown.color': string;
+ /** Default value: `14` */
+ 'linetoolarrowmarkdown.fontsize': number;
+ /** Default value: `false` */
+ 'linetoolarrowmarkdown.italic': boolean;
+ /** Default value: `true` */
+ 'linetoolarrowmarkdown.showLabel': boolean;
+}
+/**
+ * Override properties for the Arrowmarker drawing tool.
+ */
+export interface ArrowmarkerLineToolOverrides {
+ /** Default value: `#1E53E5` */
+ 'linetoolarrowmarker.backgroundColor': string;
+ /** Default value: `true` */
+ 'linetoolarrowmarker.bold': boolean;
+ /** Default value: `16` */
+ 'linetoolarrowmarker.fontsize': number;
+ /** Default value: `false` */
+ 'linetoolarrowmarker.italic': boolean;
+ /** Default value: `true` */
+ 'linetoolarrowmarker.showLabel': boolean;
+ /** Default value: `#1E53E5` */
+ 'linetoolarrowmarker.textColor': string;
+}
+/**
+ * Override properties for the Arrowmarkleft drawing tool.
+ */
+export interface ArrowmarkleftLineToolOverrides {
+ /** Default value: `#2962FF` */
+ 'linetoolarrowmarkleft.arrowColor': string;
+ /** Default value: `false` */
+ 'linetoolarrowmarkleft.bold': boolean;
+ /** Default value: `#2962FF` */
+ 'linetoolarrowmarkleft.color': string;
+ /** Default value: `14` */
+ 'linetoolarrowmarkleft.fontsize': number;
+ /** Default value: `false` */
+ 'linetoolarrowmarkleft.italic': boolean;
+ /** Default value: `true` */
+ 'linetoolarrowmarkleft.showLabel': boolean;
+}
+/**
+ * Override properties for the Arrowmarkright drawing tool.
+ */
+export interface ArrowmarkrightLineToolOverrides {
+ /** Default value: `#2962FF` */
+ 'linetoolarrowmarkright.arrowColor': string;
+ /** Default value: `false` */
+ 'linetoolarrowmarkright.bold': boolean;
+ /** Default value: `#2962FF` */
+ 'linetoolarrowmarkright.color': string;
+ /** Default value: `14` */
+ 'linetoolarrowmarkright.fontsize': number;
+ /** Default value: `false` */
+ 'linetoolarrowmarkright.italic': boolean;
+ /** Default value: `true` */
+ 'linetoolarrowmarkright.showLabel': boolean;
+}
+/**
+ * Override properties for the Arrowmarkup drawing tool.
+ */
+export interface ArrowmarkupLineToolOverrides {
+ /** Default value: `#089981` */
+ 'linetoolarrowmarkup.arrowColor': string;
+ /** Default value: `false` */
+ 'linetoolarrowmarkup.bold': boolean;
+ /** Default value: `#089981` */
+ 'linetoolarrowmarkup.color': string;
+ /** Default value: `14` */
+ 'linetoolarrowmarkup.fontsize': number;
+ /** Default value: `false` */
+ 'linetoolarrowmarkup.italic': boolean;
+ /** Default value: `true` */
+ 'linetoolarrowmarkup.showLabel': boolean;
+}
+export interface AvailableZOrderOperations {
+ /** 'Bring Forward' is possible */
+ bringForwardEnabled: boolean;
+ /** 'Bring to Front' is possible */
+ bringToFrontEnabled: boolean;
+ /** 'Send Backward' is possible */
+ sendBackwardEnabled: boolean;
+ /** 'Send to Back' is possible */
+ sendToBackEnabled: boolean;
+}
+/**
+ * Override properties for the Balloon drawing tool.
+ */
+export interface BalloonLineToolOverrides {
+ /** Default value: `rgba(156, 39, 176, 0.7)` */
+ 'linetoolballoon.backgroundColor': string;
+ /** Default value: `rgba(156, 39, 176, 0)` */
+ 'linetoolballoon.borderColor': string;
+ /** Default value: `#ffffff` */
+ 'linetoolballoon.color': string;
+ /** Default value: `14` */
+ 'linetoolballoon.fontsize': number;
+ /** Default value: `30` */
+ 'linetoolballoon.transparency': number;
+}
+/**
+ * Bar data point
+ */
+export interface Bar {
+ /** Bar time.
+ * Amount of **milliseconds** since Unix epoch start in **UTC** timezone.
+ * `time` for daily, weekly, and monthly bars is expected to be a trading day (not session start day) at 00:00 UTC.
+ * The library adjusts time according to `session` from {@link LibrarySymbolInfo}.
+ */
+ time: number;
+ /** Opening price */
+ open: number;
+ /** High price */
+ high: number;
+ /** Low price */
+ low: number;
+ /** Closing price */
+ close: number;
+ /** Trading Volume */
+ volume?: number;
+}
+export interface BarStylePreferences {
+ /** Up bar color */
+ upColor: string;
+ /** Down bar color */
+ downColor: string;
+ /** Bar color determined by previous close value */
+ barColorsOnPrevClose: boolean;
+ /** Whether to draw opening value for bar */
+ dontDrawOpen: boolean;
+ /** Draw thin bars. Default - `true` */
+ thinBars: boolean;
+}
+/**
+ * Override properties for the Barspattern drawing tool.
+ */
+export interface BarspatternLineToolOverrides {
+ /** Default value: `#2962FF` */
+ 'linetoolbarspattern.color': string;
+ /** Default value: `false` */
+ 'linetoolbarspattern.flipped': boolean;
+ /** Default value: `false` */
+ 'linetoolbarspattern.mirrored': boolean;
+ /** Default value: `0` */
+ 'linetoolbarspattern.mode': number;
+}
+export interface BaseInputFieldValidatorResult {
+ /** Is the base input value valid */
+ valid: boolean;
+}
+export interface BaselineStylePreferences {
+ /** Top fill color of positive area */
+ topFillColor1: string;
+ /** Bottom fill color of positive area */
+ topFillColor2: string;
+ /** Top fill color of negative area */
+ bottomFillColor1: string;
+ /** Bottom fill color of negative area */
+ bottomFillColor2: string;
+ /** Positive area line color */
+ topLineColor: string;
+ /** Negative area line color */
+ bottomLineColor: string;
+ /** Baseline line color */
+ baselineColor: string;
+ /** Positive area line width */
+ topLineWidth: number;
+ /** Negative area line width */
+ bottomLineWidth: number;
+ /**
+ * Transparency. Range [0..100]
+ * `0` - fully opaque,
+ * `100` - fully transparent.
+ *
+ * **Note**: Rather use `rgba` color string for setting transparency.
+ */
+ transparency: number;
+ /** Baseline level percentage */
+ baseLevelPercentage: number;
+}
+/**
+ * Override properties for the Beziercubic drawing tool.
+ */
+export interface BeziercubicLineToolOverrides {
+ /** Default value: `rgba(103, 58, 183, 0.2)` */
+ 'linetoolbeziercubic.backgroundColor': string;
+ /** Default value: `false` */
+ 'linetoolbeziercubic.extendLeft': boolean;
+ /** Default value: `false` */
+ 'linetoolbeziercubic.extendRight': boolean;
+ /** Default value: `false` */
+ 'linetoolbeziercubic.fillBackground': boolean;
+ /** Default value: `0` */
+ 'linetoolbeziercubic.leftEnd': number;
+ /** Default value: `#673ab7` */
+ 'linetoolbeziercubic.linecolor': string;
+ /** Default value: `0` */
+ 'linetoolbeziercubic.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolbeziercubic.linewidth': number;
+ /** Default value: `0` */
+ 'linetoolbeziercubic.rightEnd': number;
+ /** Default value: `80` */
+ 'linetoolbeziercubic.transparency': number;
+}
+/**
+ * Override properties for the Bezierquadro drawing tool.
+ */
+export interface BezierquadroLineToolOverrides {
+ /** Default value: `rgba(41, 98, 255, 0.2)` */
+ 'linetoolbezierquadro.backgroundColor': string;
+ /** Default value: `false` */
+ 'linetoolbezierquadro.extendLeft': boolean;
+ /** Default value: `false` */
+ 'linetoolbezierquadro.extendRight': boolean;
+ /** Default value: `false` */
+ 'linetoolbezierquadro.fillBackground': boolean;
+ /** Default value: `0` */
+ 'linetoolbezierquadro.leftEnd': number;
+ /** Default value: `#2962FF` */
+ 'linetoolbezierquadro.linecolor': string;
+ /** Default value: `0` */
+ 'linetoolbezierquadro.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolbezierquadro.linewidth': number;
+ /** Default value: `0` */
+ 'linetoolbezierquadro.rightEnd': number;
+ /** Default value: `50` */
+ 'linetoolbezierquadro.transparency': number;
+}
+export interface BracketOrder extends BracketOrderBase, CustomFields {}
+export interface BracketOrderBase extends PlacedOrderBase {
+ /** If order is a bracket then this should contain base order/position id. */
+ parentId: string;
+ /** Type of the bracket's parent */
+ parentType: ParentType;
+}
+export interface Brackets {
+ /** Stop loss */
+ stopLoss?: number;
+ /** Take Profit */
+ takeProfit?: number;
+ /** Trailing Stop Pips */
+ trailingStopPips?: number;
+}
+export interface BrokerConfigFlags {
+ /**
+ * Display broker symbol name in the symbol search. You may usually want to disable it if broker symbols are the same or you are using internal numbers as broker symbol names.
+ * @default true
+ */
+ supportDisplayBrokerNameInSymbolSearch?: boolean;
+ /**
+ * This flag can be used to change "Amount" to "Quantity" in Order Ticket.
+ * @default false
+ */
+ showQuantityInsteadOfAmount?: boolean;
+ /**
+ * Broker supports brackets (take profit and stop loss) for orders.
+ * @default false
+ */
+ supportOrderBrackets?: boolean;
+ /**
+ * Broker supports trailing stop orders.
+ * If this flag is set to `true`, then the chart displays trailing stop orders and a user can place a trailing stop order using Order Ticket.
+ * @default false
+ */
+ supportTrailingStop?: boolean;
+ /**
+ * Broker supports positions.
+ * If it is set to `false`, the Positions tab in the Account Manager will be hidden.
+ * @default true
+ */
+ supportPositions?: boolean;
+ /**
+ * Broker supports brackets (take profit and stop loss orders) for positions.
+ * If this flag is set to `true` the Chart will display an Edit button for positions and add `Edit position...` to the context menu of a position.
+ * @default false
+ */
+ supportPositionBrackets?: boolean;
+ /**
+ * Broker supports brackets for trades (take profit and stop loss orders).
+ * If this flag is set to `true` the Chart will display an Edit button for trades (individual positions) and add `Edit position...` to the context menu of a trade.
+ * @default false
+ */
+ supportTradeBrackets?: boolean;
+ /**
+ * Broker supports individual positions (trades).
+ * If it is set to `true`, there will be two tabs in the Account Manager - Individual Positions and Net Positions.
+ * @default false
+ */
+ supportTrades?: boolean;
+ /**
+ * Broker supports closing of a position.
+ * If it is not supported by broker, Chart will have the close button, but it will place a closing order.
+ * @default false
+ */
+ supportClosePosition?: boolean;
+ /**
+ * Individual positions (trades) can be closed.
+ * @default false
+ */
+ supportCloseTrade?: boolean;
+ /**
+ * Using this flag you can disable existing order's price modification.
+ * @default true
+ */
+ supportModifyOrderPrice?: boolean;
+ /**
+ * Using this flag you can disable existing order's quantity modification.
+ * @default true
+ */
+ supportEditAmount?: boolean;
+ /**
+ * Using this flag you can disable existing order's brackets modification. If you set it to `false`,
+ * additional fields will be disabled in Order Ticket on the chart,
+ * and 'Modify' button will be hidden from the chart and in the Account Manager.
+ * @default true
+ */
+ supportModifyBrackets?: boolean;
+ /**
+ * Level2 data is used for DOM widget. `subscribeDepth` and `unsubscribeDepth` should be implemented.
+ * @default false
+ */
+ supportLevel2Data?: boolean;
+ /**
+ * Does broker support Depth of Market.
+ * @default false
+ */
+ supportDOM?: boolean;
+ /**
+ * Supporting multiposition prevents creating the default implementation for a reversing position.
+ * @default false
+ */
+ supportMultiposition?: boolean;
+ /**
+ * Broker provides PL for a position. If the broker calculates profit/loss by itself it should call `plUpdate` as soon as PL is changed.
+ * Otherwise Chart will calculate PL as a difference between the current trade and an average price of the position.
+ * @default true
+ */
+ supportPLUpdate?: boolean;
+ /**
+ * Broker supports reversing of a position.
+ * If it is not supported by broker, the reverse position button will be hidden.
+ * @default false
+ */
+ supportReversePosition?: boolean;
+ /**
+ * Broker natively supports reversing of a position.
+ * If it is not natively supported by broker, Chart will place a reversing order.
+ * @default false
+ */
+ supportNativeReversePosition?: boolean;
+ /**
+ * This flag adds market orders type to Order Ticket.
+ * @default true
+ */
+ supportMarketOrders?: boolean;
+ /**
+ * This flag adds limit orders type to Order Ticket.
+ * @default true
+ */
+ supportLimitOrders?: boolean;
+ /**
+ * This flag adds stop orders type to Order Ticket.
+ * @default true
+ */
+ supportStopOrders?: boolean;
+ /**
+ * This flag adds stop-limit orders type to Order Ticket.
+ * @default false
+ */
+ supportStopLimitOrders?: boolean;
+ /**
+ * Does broker support demo live switcher.
+ * @default true
+ */
+ supportDemoLiveSwitcher?: boolean;
+ /**
+ * Using this flag you can disable brackets for market orders.
+ * @default true
+ */
+ supportMarketBrackets?: boolean;
+ /**
+ * Broker supports symbol search
+ * @default false
+ */
+ supportSymbolSearch?: boolean;
+ /**
+ * Using this flag you can enable modification of the duration of the existing order.
+ * @default false
+ */
+ supportModifyDuration?: boolean;
+ /**
+ * Broker supports modifying trailing stop orders.
+ * @default true
+ */
+ supportModifyTrailingStop?: boolean;
+ /**
+ * Broker supports margin.
+ * If the broker supports margin it should call `marginAvailableUpdate` ({@link IBrokerConnectionAdapterHost.marginAvailableUpdate}) when the Trading Platform subscribes using `subscribeMarginAvailable` ({@link IBrokerWithoutRealtime.subscribeMarginAvailable}).
+ * @default false
+ */
+ supportMargin?: boolean;
+ /**
+ * Calculate Profit / Loss using last value.
+ * @default false
+ */
+ calculatePLUsingLast?: boolean;
+ /**
+ * Broker provides the estimated commission, fees, margin and other order information before placing the order without actually placing it.
+ * @default false
+ */
+ supportPlaceOrderPreview?: boolean;
+ /**
+ * Broker provides the estimated commission, fees, margin and other order information before modifying the order without actually modifying it.
+ * @default false
+ */
+ supportModifyOrderPreview?: boolean;
+ /**
+ * Broker supports leverage. If the flag is set to `true`, broker will calculate leverage using `leverageInfo` ({@link IBrokerWithoutRealtime.leverageinfo}) method.
+ * @default false
+ */
+ supportLeverage?: boolean;
+ /**
+ * Broker supports leverage button. If the flag is set to `true`, a leverage input field will appear in Order Ticket. Click on the input field will activate a dedicated Leverage Dialog.
+ * @default true
+ */
+ supportLeverageButton?: boolean;
+ /**
+ * Broker supports orders history. If it is set to `true`, there will be an additional tab in the Account Manager - Orders History.
+ * The `ordersHistory` method should be implemented. It should return a list of orders with the `filled`, `cancelled` and `rejected` statuses from previous trade sessions.
+ * @default false
+ */
+ supportOrdersHistory?: boolean;
+ /**
+ * Using this flag you can disable adding brackets to the existing order.
+ * @default true
+ */
+ supportAddBracketsToExistingOrder?: boolean;
+ /**
+ * Used for crypto currencies only. Allows to get crypto balances for an account. Balances are displayed as the first table of the Account Summary tab.
+ * @default false
+ */
+ supportBalances?: boolean;
+ /**
+ * Closing a position cancels its brackets.
+ * @default false
+ */
+ closePositionCancelsOrders?: boolean;
+ /**
+ * `Stop Loss` and `Take Profit` are added or removed only together.
+ * @default false
+ */
+ supportOnlyPairPositionBrackets?: boolean;
+ /**
+ * Whether the account is used to exchange(trade) crypto currencies.
+ * This flag switches Order Ticket to the Crypto Exchange mode. It adds second currency quantity control, currency labels etc.
+ * @default false
+ */
+ supportCryptoExchangeOrderTicket?: boolean;
+ /**
+ * With this flag you can show a checkbox to disable the confirmation dialog display
+ * @default false
+ */
+ supportConfirmations?: boolean;
+ /**
+ * Using this flag you can display PL in instrument currency.
+ * @default false
+ */
+ positionPLInInstrumentCurrency?: boolean;
+ /**
+ * Does broker support partial position closing
+ * @default false
+ */
+ supportPartialClosePosition?: boolean;
+ /**
+ * Does broker support partial trade closing
+ * @default false
+ */
+ supportPartialCloseTrade?: boolean;
+ /**
+ * Cancelling a bracket (take profit or stop loss) cancels its pair.
+ * @default false
+ */
+ supportCancellingBothBracketsOnly?: boolean;
+ /**
+ * Does broker support crypto brackets
+ * @default false
+ */
+ supportCryptoBrackets?: boolean;
+ /**
+ * Using this flag you can show/hide the `Notifications log` tab in the account manager.
+ * @default true
+ */
+ showNotificationsLog?: boolean;
+ /**
+ * Whether stop orders should behave like Market-if-touched in both directions.
+ * Enabling this flag prevents the check of stop price direction from the stop limit Order Ticket.
+ * @default false
+ */
+ supportStopOrdersInBothDirections?: boolean;
+ /**
+ * Enabling this flag prevents the check of stop price direction from the stop limit Order Ticket.
+ */
+ supportStopLimitOrdersInBothDirections?: boolean;
+ /**
+ * Broker supports executions.
+ * If this flag is set to `true` the Chart will display executions.
+ * @default false
+ */
+ supportExecutions?: boolean;
+ /**
+ * Does broker support modifying order type
+ * @default false
+ */
+ supportModifyOrderType?: boolean;
+ /**
+ * Trading account requires closing of trades in FIFO order.
+ * @default false
+ */
+ requiresFIFOCloseTrades?: boolean;
+}
+export interface BrokerCustomUI {
+ /**
+ * Shows standard Order Ticket to create or modify an order and executes handler if Buy/Sell/Modify is pressed.
+ * @param {OrderTemplate|Order} order - order to be placed or modified
+ * @param {OrderTicketFocusControl} [focus] - Control to focus on when dialog is opened
+ */
+ showOrderDialog?: (
+ order: OrderTemplate | Order,
+ focus?: OrderTicketFocusControl
+ ) => Promise;
+ /**
+ * Shows the Position Dialog
+ * @param {Position|Trade} position - position to be placed or modified
+ * @param {Brackets} brackets - brackets for the position
+ * @param {OrderTicketFocusControl} [focus] - Control to focus on when dialog is opened
+ */
+ showPositionDialog?: (
+ position: Position | Trade,
+ brackets: Brackets,
+ focus?: OrderTicketFocusControl
+ ) => Promise;
+ /**
+ * Shows a confirmation dialog and executes handler if YES/OK is pressed.
+ * @param {Order} order - order to be cancelled
+ */
+ showCancelOrderDialog?: (order: Order) => Promise;
+ /**
+ * Shows the Close Position Dialog.
+ * @param {Position} position - position to be closed
+ */
+ showClosePositionDialog?: (position: Position) => Promise;
+}
+/**
+ * Override properties for the Brush drawing tool.
+ */
+export interface BrushLineToolOverrides {
+ /** Default value: `#00bcd4` */
+ 'linetoolbrush.backgroundColor': string;
+ /** Default value: `false` */
+ 'linetoolbrush.fillBackground': boolean;
+ /** Default value: `0` */
+ 'linetoolbrush.leftEnd': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolbrush.linecolor': string;
+ /** Default value: `0` */
+ 'linetoolbrush.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolbrush.linewidth': number;
+ /** Default value: `0` */
+ 'linetoolbrush.rightEnd': number;
+ /** Default value: `5` */
+ 'linetoolbrush.smooth': number;
+ /** Default value: `50` */
+ 'linetoolbrush.transparency': number;
+}
+/**
+ * Override properties for the Callout drawing tool.
+ */
+export interface CalloutLineToolOverrides {
+ /** Default value: `rgba(0, 151, 167, 0.7)` */
+ 'linetoolcallout.backgroundColor': string;
+ /** Default value: `false` */
+ 'linetoolcallout.bold': boolean;
+ /** Default value: `#0097A7` */
+ 'linetoolcallout.bordercolor': string;
+ /** Default value: `#ffffff` */
+ 'linetoolcallout.color': string;
+ /** Default value: `14` */
+ 'linetoolcallout.fontsize': number;
+ /** Default value: `false` */
+ 'linetoolcallout.italic': boolean;
+ /** Default value: `2` */
+ 'linetoolcallout.linewidth': number;
+ /** Default value: `50` */
+ 'linetoolcallout.transparency': number;
+ /** Default value: `false` */
+ 'linetoolcallout.wordWrap': boolean;
+ /** 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;
+ /** Whether to draw the candle wick */
+ drawWick: boolean;
+ /** Whether to draw the candle body border */
+ drawBorder: boolean;
+ /** Whether to draw the candle body */
+ drawBody: boolean;
+ /** Candle border color */
+ borderColor: string;
+ /** Up candle border color */
+ borderUpColor: string;
+ /** Down candle border color */
+ borderDownColor: string;
+ /** Candle wick color */
+ wickColor: string;
+ /** Up candle wick color */
+ wickUpColor: string;
+ /** Down candle wick color */
+ wickDownColor: string;
+ /** Bar color determined by previous close value */
+ barColorsOnPrevClose: boolean;
+}
+export interface ChangeAccountSolution {
+ /** id of a sub-account suitable for trading the symbol */
+ changeAccount: AccountId;
+}
+export interface ChangeSymbolSolution {
+ /** the symbol suitable for trading with current sub-account */
+ changeSymbol: string;
+}
+export interface ChangeThemeOptions {
+ /** Disable undo for the theme change */
+ disableUndo: boolean;
+}
+/**
+ * Saved chart data
+ */
+export interface ChartData {
+ /** unique ID of the chart (may be `undefined` if it wasn't saved before) */
+ id: string | undefined;
+ /** name of the chart */
+ name: string;
+ /** symbol of the chart */
+ symbol: string;
+ /** resolution of the chart */
+ resolution: ResolutionString;
+ /** content of the chart */
+ content: string;
+}
+/**
+ * Meta information about a saved chart
+ */
+export interface ChartMetaInfo {
+ /** unique ID of the chart. */
+ id: number;
+ /** name of the chart */
+ name: string;
+ /** symbol of the chart */
+ symbol: string;
+ /** resolution of the chart */
+ resolution: ResolutionString;
+ /** UNIX time when the chart was last modified */
+ timestamp: number;
+}
+/**
+ * Property overrides that can be used with {@link IChartingLibraryWidget.applyOverrides}.
+ */
+export interface ChartPropertiesOverrides extends StudyOverrides {
+ /**
+ * A timezone ID. The default value depends on the locale.
+ */
+ timezone: TimezoneId;
+ /**
+ * A price scale selection strategy. Determines where price scales should be placed: on the left, on the right, or spread evenly (auto).
+ *
+ * @default 'auto'
+ */
+ priceScaleSelectionStrategyName: 'left' | 'right' | 'auto';
+ /**
+ * Pane background type. In the dark theme, the default value is 'gradient'.
+ *
+ * @default 'solid'
+ */
+ 'paneProperties.backgroundType': ColorTypes;
+ /**
+ * Pane background color.
+ *
+ * @default '#ffffff'
+ */
+ 'paneProperties.background': string;
+ /**
+ * Pane background gradient start color.
+ *
+ * @default '#ffffff'
+ */
+ 'paneProperties.backgroundGradientStartColor': string;
+ /**
+ * Pane background gradient end color.
+ *
+ * @default '#ffffff'
+ */
+ 'paneProperties.backgroundGradientEndColor': string;
+ /**
+ * Pane vertical grid color.
+ *
+ * @default 'rgba(42, 46, 57, 0.06)'
+ */
+ 'paneProperties.vertGridProperties.color': string;
+ /**
+ * Pane vertical grid line style.
+ *
+ * @default LineStyle.Solid
+ */
+ 'paneProperties.vertGridProperties.style': OverrideLineStyle;
+ /**
+ * Pane horizontal grid color.
+ *
+ * @default 'rgba(42, 46, 57, 0.06)'
+ */
+ 'paneProperties.horzGridProperties.color': string;
+ /**
+ * Pane horizontal grid line style.
+ *
+ * @default LineStyle.Solid
+ */
+ 'paneProperties.horzGridProperties.style': OverrideLineStyle;
+ /**
+ * Crosshair color.
+ *
+ * @default '#9598A1'
+ */
+ 'crossHairProperties.color': string;
+ /**
+ * Crosshair style.
+ *
+ * @default LineStyle.Dashed
+ */
+ 'crossHairProperties.style': OverrideLineStyle;
+ /**
+ * Crosshair transparency.
+ *
+ * @default 0
+ */
+ 'crossHairProperties.transparency': number;
+ /**
+ * Crosshair width.
+ *
+ * @default 1
+ */
+ 'crossHairProperties.width': number;
+ /**
+ * Pane auto scaling top margin percentage.
+ *
+ * @default 10
+ */
+ 'paneProperties.topMargin': number;
+ /**
+ * Pane auto scaling bottom margin percentage.
+ *
+ * @default 8
+ */
+ 'paneProperties.bottomMargin': number;
+ /**
+ * Pane separator color.
+ *
+ * @default '#E0E3EB'
+ */
+ 'paneProperties.separatorColor': string;
+ /**
+ * Study legend input values visibility.
+ *
+ * @default true
+ */
+ 'paneProperties.legendProperties.showStudyArguments': boolean;
+ /**
+ * Study legend title visibility.
+ *
+ * @default true
+ */
+ 'paneProperties.legendProperties.showStudyTitles': boolean;
+ /**
+ * Toggle the visibility for all studies legend values.
+ *
+ * @default true
+ */
+ 'paneProperties.legendProperties.showStudyValues': boolean;
+ /**
+ * Series legend title visibility.
+ *
+ * @default true
+ */
+ 'paneProperties.legendProperties.showSeriesTitle': boolean;
+ /**
+ * Study legend OHLC values visibility.
+ *
+ * @default true
+ */
+ 'paneProperties.legendProperties.showSeriesOHLC': boolean;
+ /**
+ * Series legend change value visibility.
+ *
+ * @default true
+ */
+ 'paneProperties.legendProperties.showBarChange': boolean;
+ /**
+ * Series legend volume value visibility.
+ *
+ * @default false
+ */
+ 'paneProperties.legendProperties.showVolume': boolean;
+ /**
+ * Legend background visibility.
+ *
+ * @default true
+ */
+ 'paneProperties.legendProperties.showBackground': boolean;
+ /**
+ * Legend background transparency percentage.
+ *
+ * @default 50
+ */
+ 'paneProperties.legendProperties.backgroundTransparency': number;
+ /**
+ * Scales (axis) border line color.
+ *
+ * @default 'rgba(42, 46, 57, 0)'
+ */
+ 'scalesProperties.lineColor': string;
+ /**
+ * Scales (axis) text color.
+ *
+ * @default '#131722'
+ */
+ 'scalesProperties.textColor': string;
+ /**
+ * Scales (axis) font size.
+ *
+ * @default 12
+ */
+ 'scalesProperties.fontSize': number;
+ /**
+ * Series last value label visibility.
+ *
+ * @default true
+ */
+ 'scalesProperties.showSeriesLastValue': boolean;
+ /**
+ * Series last value label display mode.
+ *
+ * @default PriceAxisLastValueMode.LastValueAccordingToScale
+ */
+ 'scalesProperties.seriesLastValueMode': OverridePriceAxisLastValueMode;
+ /**
+ * Study label value label visibility.
+ *
+ * @default true
+ */
+ 'scalesProperties.showStudyLastValue': boolean;
+ /**
+ * Symbol name label visibility.
+ *
+ * @default false
+ */
+ 'scalesProperties.showSymbolLabels': boolean;
+ /**
+ * Study plot labels visibility.
+ *
+ * @default false
+ */
+ 'scalesProperties.showStudyPlotLabels': boolean;
+ /**
+ * Bid/ask labels visibility.
+ *
+ * @default false
+ */
+ 'scalesProperties.showBidAskLabels': boolean;
+ /**
+ * Pre/post market price labels visibility.
+ *
+ * @default true
+ */
+ 'scalesProperties.showPrePostMarketPriceLabel': boolean;
+ /**
+ * Sets the highlight color of the scales when adding a drawing.
+ *
+ * @default 'rgba(41, 98, 255, 0.25)'
+ */
+ 'scalesProperties.axisHighlightColor': string;
+ /**
+ * Scales (axis) highlight label background color.
+ *
+ * @default '#2962FF'
+ */
+ 'scalesProperties.axisLineToolLabelBackgroundColorCommon': string;
+ /**
+ * Scales (axis) background label active background color.
+ *
+ * @default '#143EB3'
+ */
+ 'scalesProperties.axisLineToolLabelBackgroundColorActive': string;
+ /**
+ * Price scale crosshair label visibility.
+ *
+ * @default true
+ */
+ 'scalesProperties.showPriceScaleCrosshairLabel': boolean;
+ /**
+ * Time scale crosshair label visibility.
+ *
+ * @default true
+ */
+ 'scalesProperties.showTimeScaleCrosshairLabel': boolean;
+ /**
+ * Crosshair label light theme background color.
+ *
+ * @default '#131722'
+ */
+ 'scalesProperties.crosshairLabelBgColorLight': string;
+ /**
+ * Crosshair label dark theme background color.
+ *
+ * @default '#363A45'
+ */
+ 'scalesProperties.crosshairLabelBgColorDark': string;
+ /**
+ * Main series chart style.
+ *
+ * @default ChartStyle.Candle
+ */
+ 'mainSeriesProperties.style': ChartStyle;
+ /**
+ * Main series bar countdown visibility.
+ *
+ * @default false
+ */
+ 'mainSeriesProperties.showCountdown': boolean;
+ /**
+ * Main series bid & ask visibility
+ *
+ * @default false
+ */
+ 'mainSeriesProperties.bidAsk.visible': boolean;
+ /**
+ * Style of the line for bid & ask
+ *
+ * @default LineStyle.Dotted
+ */
+ 'mainSeriesProperties.bidAsk.lineStyle': OverrideLineStyle;
+ /**
+ * Width of the line for bid & ask
+ *
+ * @default 1
+ */
+ 'mainSeriesProperties.bidAsk.lineWidth': number;
+ /**
+ * Color line for the bid
+ *
+ * @default '#2962FF'
+ */
+ 'mainSeriesProperties.bidAsk.bidLineColor': string;
+ /**
+ * Color line for the ask
+ *
+ * @default '#F7525F'
+ */
+ 'mainSeriesProperties.bidAsk.askLineColor': string;
+ /**
+ * High/low price lines visibility.
+ *
+ * @default false
+ */
+ 'mainSeriesProperties.highLowAvgPrice.highLowPriceLinesVisible': boolean;
+ /**
+ * High/low price lines label visibility.
+ *
+ * @default false
+ */
+ 'mainSeriesProperties.highLowAvgPrice.highLowPriceLabelsVisible': boolean;
+ /**
+ * Average close price lines visibility.
+ *
+ * @default false
+ */
+ 'mainSeriesProperties.highLowAvgPrice.averageClosePriceLineVisible': boolean;
+ /**
+ * Average close price lines label visibility.
+ *
+ * @default false
+ */
+ 'mainSeriesProperties.highLowAvgPrice.averageClosePriceLabelVisible': boolean;
+ /**
+ * High/low price lines color.
+ *
+ * @default ""
+ */
+ 'mainSeriesProperties.highLowAvgPrice.highLowPriceLinesColor': string;
+ /**
+ *
+ * High/low price lines width.
+ *
+ * @default 1
+ */
+ 'mainSeriesProperties.highLowAvgPrice.highLowPriceLinesWidth': number;
+ /**
+ *
+ * Average close price lines color.
+ *
+ * @default ""
+ */
+ 'mainSeriesProperties.highLowAvgPrice.averagePriceLineColor': string;
+ /**
+ *
+ * Average close price lines width.
+ *
+ * @default 1
+ */
+ 'mainSeriesProperties.highLowAvgPrice.averagePriceLineWidth': number;
+ /**
+ * Main series visibility.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.visible': boolean;
+ /**
+ * Sessions to display on the chart. Use `'extended'` to include pre- and post-market subsessions. See the [Extended Sessions](https://www.tradingview.com/charting-library-docs/latest/connecting_data/Extended-Sessions) guide for more info.
+ *
+ * @default 'regular'
+ */
+ 'mainSeriesProperties.sessionId': 'regular' | 'extended';
+ /**
+ * Main series price line visibility.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.showPriceLine': boolean;
+ /**
+ *
+ * Main series price line width.
+ *
+ * @default 1
+ */
+ 'mainSeriesProperties.priceLineWidth': number;
+ /**
+ * Main series price line color.
+ *
+ * @default ""
+ */
+ 'mainSeriesProperties.priceLineColor': string;
+ /**
+ * Main series previous close price line visibility.
+ *
+ * @default false
+ */
+ 'mainSeriesProperties.showPrevClosePriceLine': boolean;
+ /**
+ * Main series previous close price line width.
+ *
+ * @default 1
+ */
+ 'mainSeriesProperties.prevClosePriceLineWidth': number;
+ /**
+ * Main series previous close price line color.
+ *
+ * @default "#555555"
+ */
+ 'mainSeriesProperties.prevClosePriceLineColor': string;
+ /**
+ * Main series minimum tick behaviour.
+ *
+ * @default "default"
+ *
+ * @example
+ *
+ * ```javascript
+ * // reset minTick to default
+ * tvWidget.applyOverrides({ 'mainSeriesProperties.minTick': 'default' });
+ *
+ * // Set main series minTick to { priceScale: 10000, minMove: 1, frac: false }
+ * tvWidget.applyOverrides({ 'mainSeriesProperties.minTick': '10000,1,false' });
+ *
+ * // Set default minTick for overlay studies to { priceScale: 10000, minMove: 1, frac: false }
+ * tvWidget.applyStudiesOverrides({ 'overlay.minTick': '10000,1,false' });
+ * ```
+ */
+ 'mainSeriesProperties.minTick': string;
+ /**
+ * Main series legend exchange visibility.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.statusViewStyle.showExchange': boolean;
+ /**
+ * Main series legend interval visibility.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.statusViewStyle.showInterval': boolean;
+ /**
+ * Main series legend text style.
+ *
+ * @default "description"
+ */
+ 'mainSeriesProperties.statusViewStyle.symbolTextSource': SeriesStatusViewSymbolTextSource;
+ /**
+ * Main series candle style up color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.candleStyle.upColor': string;
+ /**
+ * Main series candle style down color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.candleStyle.downColor': string;
+ /**
+ * Main series candle style wick visibility.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.candleStyle.drawWick': boolean;
+ /**
+ * Main series candle style border visibility.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.candleStyle.drawBorder': boolean;
+ /**
+ *
+ * Main series candle style border color.
+ *
+ * @default "#378658"
+ */
+ 'mainSeriesProperties.candleStyle.borderColor': string;
+ /**
+ *
+ * Main series candle style border up color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.candleStyle.borderUpColor': string;
+ /**
+ * Main series candle style border down color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.candleStyle.borderDownColor': string;
+ /**
+ * Main series candle style wick color.
+ *
+ * @default "#737375"
+ */
+ 'mainSeriesProperties.candleStyle.wickColor': string;
+ /**
+ * Main series candle style wick up color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.candleStyle.wickUpColor': string;
+ /**
+ * Main series candle style wick down color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.candleStyle.wickDownColor': string;
+ /**
+ *
+ * Main series candle style color on previous close behaviour.
+ *
+ * @default false
+ */
+ 'mainSeriesProperties.candleStyle.barColorsOnPrevClose': boolean;
+ /**
+ * Main series candle style body visibility.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.candleStyle.drawBody': boolean;
+ /**
+ * Main series hollow candle style up color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.hollowCandleStyle.upColor': string;
+ /**
+ * Main series hollow candle style down color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.hollowCandleStyle.downColor': string;
+ /**
+ * Main series hollow candle style wick visibility.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.hollowCandleStyle.drawWick': boolean;
+ /**
+ * Main series hollow candle style border visibility.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.hollowCandleStyle.drawBorder': boolean;
+ /**
+ * Main series hollow candle style border color.
+ *
+ * @default "#378658"
+ */
+ 'mainSeriesProperties.hollowCandleStyle.borderColor': string;
+ /**
+ * Main series hollow candle style border up color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.hollowCandleStyle.borderUpColor': string;
+ /**
+ * Main series hollow candle style down color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.hollowCandleStyle.borderDownColor': string;
+ /**
+ * Main series hollow candle style wick color.
+ *
+ * @default "#737375"
+ */
+ 'mainSeriesProperties.hollowCandleStyle.wickColor': string;
+ /**
+ * Main series hollow candle style wick up color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.hollowCandleStyle.wickUpColor': string;
+ /**
+ * Main series hollow candle style wick down color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.hollowCandleStyle.wickDownColor': string;
+ /**
+ * Main series hollow candle style body visibility.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.hollowCandleStyle.drawBody': boolean;
+ /**
+ * Main series Heikin Ashi style up color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.haStyle.upColor': string;
+ /**
+ * Main series Heikin Ashi style down color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.haStyle.downColor': string;
+ /**
+ * Main series Heikin Ashi style wick visibility.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.haStyle.drawWick': boolean;
+ /**
+ * Main series Heikin Ashi style border visibility.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.haStyle.drawBorder': boolean;
+ /**
+ * Main series Heikin Ashi style border color.
+ *
+ * @default "#378658"
+ */
+ 'mainSeriesProperties.haStyle.borderColor': string;
+ /**
+ * Main series Heikin Ashi style border up color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.haStyle.borderUpColor': string;
+ /**
+ * Main series Heikin Ashi style border down color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.haStyle.borderDownColor': string;
+ /**
+ * Main series Heikin Ashi style wick color.
+ *
+ * @default "#737375"
+ */
+ 'mainSeriesProperties.haStyle.wickColor': string;
+ /**
+ * Main series Heikin Ashi style wick up color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.haStyle.wickUpColor': string;
+ /**
+ * Main series Heikin Ashi style wick down color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.haStyle.wickDownColor': string;
+ /**
+ * Main series Heikin Ashi style color on previous close behaviour.
+ *
+ * @default false
+ */
+ 'mainSeriesProperties.haStyle.barColorsOnPrevClose': boolean;
+ /**
+ * Main series Heikin Ashi style body visibility.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.haStyle.drawBody': boolean;
+ /**
+ * Main series bar style up color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.barStyle.upColor': string;
+ /**
+ * Main series bar style down color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.barStyle.downColor': string;
+ /**
+ * Main series bar style color on previous close behaviour.
+ *
+ * @default false
+ */
+ 'mainSeriesProperties.barStyle.barColorsOnPrevClose': boolean;
+ /**
+ * Main series bar style don't draw open behaviour.
+ *
+ * @default false
+ */
+ 'mainSeriesProperties.barStyle.dontDrawOpen': boolean;
+ /**
+ * Main series bar style thin bars behaviour.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.barStyle.thinBars': boolean;
+ /**
+ * Main series High-low style color.
+ *
+ * @default "#2962FF"
+ */
+ 'mainSeriesProperties.hiloStyle.color': string;
+ /**
+ * Main series High-low style border visibility.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.hiloStyle.showBorders': boolean;
+ /**
+ * Main series High-low style border color.
+ *
+ * @default "#2962FF"
+ */
+ 'mainSeriesProperties.hiloStyle.borderColor': string;
+ /**
+ * Main series High-low style label visibility.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.hiloStyle.showLabels': boolean;
+ /**
+ * Main series High-low style label color.
+ *
+ * @default "#2962FF"
+ */
+ 'mainSeriesProperties.hiloStyle.labelColor': string;
+ /**
+ * Main series column style up color.
+ *
+ * @default "rgba(8, 153, 129, 0.5)"
+ */
+ 'mainSeriesProperties.columnStyle.upColor': string;
+ /**
+ * Main series column style down color.
+ *
+ * @default "rgba(242, 54, 69, 0.5)"
+ */
+ 'mainSeriesProperties.columnStyle.downColor': string;
+ /**
+ * Main series column style color on previous close behaviour.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.columnStyle.barColorsOnPrevClose': boolean;
+ /**
+ * Main series column style price source.
+ *
+ * @default "close"
+ */
+ 'mainSeriesProperties.columnStyle.priceSource': PriceSource;
+ /**
+ * Main series line style color.
+ *
+ * @default "#2962FF"
+ */
+ 'mainSeriesProperties.lineStyle.color': string;
+ /**
+ * Main series line style line style.
+ *
+ * @default LineStyle.Solid
+ */
+ 'mainSeriesProperties.lineStyle.linestyle': OverrideLineStyle;
+ /**
+ * Main series line style line width.
+ *
+ * @default 2
+ */
+ 'mainSeriesProperties.lineStyle.linewidth': number;
+ /**
+ * Main series line style price source.
+ *
+ * @default "close"
+ */
+ 'mainSeriesProperties.lineStyle.priceSource': PriceSource;
+ /**
+ * Main series area style color1.
+ *
+ * @default "rgba(41, 98, 255, 0.28)"
+ */
+ 'mainSeriesProperties.areaStyle.color1': string;
+ /**
+ * Main series area style color2.
+ *
+ * @default "#2962FF"
+ */
+ 'mainSeriesProperties.areaStyle.color2': string;
+ /**
+ * Main series area style line color.
+ *
+ * @default "#2962FF"
+ */
+ 'mainSeriesProperties.areaStyle.linecolor': string;
+ /**
+ * Main series area style line style.
+ *
+ * @default LineStyle.Solid
+ */
+ 'mainSeriesProperties.areaStyle.linestyle': OverrideLineStyle;
+ /**
+ * Main series area style line width.
+ *
+ * @default 2
+ */
+ 'mainSeriesProperties.areaStyle.linewidth': number;
+ /**
+ * Main series area style price source.
+ *
+ * @default "close"
+ */
+ 'mainSeriesProperties.areaStyle.priceSource': PriceSource;
+ /**
+ * Main series area style transparency.
+ *
+ * @default 100
+ */
+ 'mainSeriesProperties.areaStyle.transparency': number;
+ /**
+ * Main series hlc area style close line color.
+ *
+ * @default "#868993"
+ */
+ 'mainSeriesProperties.hlcAreaStyle.closeLineColor': string;
+ /**
+ * Main series hlc area style close line style.
+ *
+ * @default LineStyle.Solid
+ */
+ 'mainSeriesProperties.hlcAreaStyle.closeLineStyle': OverrideLineStyle;
+ /**
+ * Main series hlc area style close line width.
+ *
+ * @default 2
+ */
+ 'mainSeriesProperties.hlcAreaStyle.closeLineWidth': number;
+ /**
+ * Main series hlc area style close low fill color.
+ *
+ * @default "rgba(242, 54, 69, 0.2)"
+ */
+ 'mainSeriesProperties.hlcAreaStyle.closeLowFillColor': string;
+ /**
+ * Main series hlc area style high close fill color.
+ *
+ * @default "rgba(8, 153, 129, 0.2)"
+ */
+ 'mainSeriesProperties.hlcAreaStyle.highCloseFillColor': string;
+ /**
+ * Main series hlc area style high line color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.hlcAreaStyle.highLineColor': string;
+ /**
+ * Main series hlc area style high line style.
+ *
+ * @default LineStyle.Solid
+ */
+ 'mainSeriesProperties.hlcAreaStyle.highLineStyle': OverrideLineStyle;
+ /**
+ * Main series hlc area style high line width.
+ *
+ * @default 2
+ */
+ 'mainSeriesProperties.hlcAreaStyle.highLineWidth': number;
+ /**
+ * Main series hlc area style low line color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.hlcAreaStyle.lowLineColor': string;
+ /**
+ * Main series hlc area style low line style.
+ *
+ * @default LineStyle.Solid
+ */
+ 'mainSeriesProperties.hlcAreaStyle.lowLineStyle': OverrideLineStyle;
+ /**
+ * Main series hlc area style low line width.
+ *
+ * @default 2
+ */
+ 'mainSeriesProperties.hlcAreaStyle.lowLineWidth': number;
+ /**
+ * Main series price axis percentage mode.
+ *
+ * @default false
+ */
+ 'mainSeriesProperties.priceAxisProperties.percentage': boolean;
+ /**
+ * Main series price axis indexed to 100 mode.
+ *
+ * @default false
+ */
+ 'mainSeriesProperties.priceAxisProperties.indexedTo100': boolean;
+ /**
+ * Main series price axis log mode.
+ *
+ * @default false
+ */
+ 'mainSeriesProperties.priceAxisProperties.log': boolean;
+ /**
+ * Main series price axis inverted mode.
+ *
+ * @default false
+ */
+ 'mainSeriesProperties.priceAxisProperties.isInverted': boolean;
+ /**
+ * Main series price axis label alignment behaviour.
+ *
+ * @default true
+ */
+ 'mainSeriesProperties.priceAxisProperties.alignLabels': boolean;
+ /**
+ * Main series Renko style up color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.renkoStyle.upColor': string;
+ /**
+ * Main series Renko style down color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.renkoStyle.downColor': string;
+ /**
+ * Main series Renko style border up color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.renkoStyle.borderUpColor': string;
+ /**
+ * Main series Renko style border down color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.renkoStyle.borderDownColor': string;
+ /**
+ * Main series Renko style up projection color.
+ *
+ * @default "#a9dcc3"
+ */
+ 'mainSeriesProperties.renkoStyle.upColorProjection': string;
+ /**
+ * Main series Renko style down projection color.
+ *
+ * @default "#f5a6ae"
+ */
+ 'mainSeriesProperties.renkoStyle.downColorProjection': string;
+ /**
+ * Main series Renko style up projection border color.
+ *
+ * @default "#a9dcc3"
+ */
+ 'mainSeriesProperties.renkoStyle.borderUpColorProjection': string;
+ /**
+ * Main series Renko style down projection border color.
+ *
+ * @default "#f5a6ae"
+ */
+ 'mainSeriesProperties.renkoStyle.borderDownColorProjection': string;
+ /**
+ * Main series Renko style wick up color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.renkoStyle.wickUpColor': string;
+ /**
+ * Main series Renko style wick down color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.renkoStyle.wickDownColor': string;
+ /**
+ * Main series Line Break style up color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.pbStyle.upColor': string;
+ /**
+ * Main series Line Break style down color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.pbStyle.downColor': string;
+ /**
+ * Main series Line Break style border up color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.pbStyle.borderUpColor': string;
+ /**
+ * Main series Line Break style border down color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.pbStyle.borderDownColor': string;
+ /**
+ * Main series Line Break style up projection color.
+ *
+ * @default "#a9dcc3"
+ */
+ 'mainSeriesProperties.pbStyle.upColorProjection': string;
+ /**
+ * Main series Line Break style down projection color.
+ *
+ * @default "#f5a6ae"
+ */
+ 'mainSeriesProperties.pbStyle.downColorProjection': string;
+ /**
+ * Main series Line Break style up projection color.
+ *
+ * @default "#a9dcc3"
+ */
+ 'mainSeriesProperties.pbStyle.borderUpColorProjection': string;
+ /**
+ * Main series Line Break style down projection color.
+ *
+ * @default "#f5a6ae"
+ */
+ 'mainSeriesProperties.pbStyle.borderDownColorProjection': string;
+ /**
+ * Main series Kagi style up color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.kagiStyle.upColor': string;
+ /**
+ * Main series Kagi style down color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.kagiStyle.downColor': string;
+ /**
+ * Main series Kagi style up projection color.
+ *
+ * @default "#a9dcc3"
+ */
+ 'mainSeriesProperties.kagiStyle.upColorProjection': string;
+ /**
+ * Main series Kagi style down projection color.
+ *
+ * @default "#f5a6ae"
+ */
+ 'mainSeriesProperties.kagiStyle.downColorProjection': string;
+ /**
+ * Main series Point & Figure style up color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.pnfStyle.upColor': string;
+ /**
+ * Main series Point & Figure style down color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.pnfStyle.downColor': string;
+ /**
+ * Main series Point & Figure style up projection color.
+ *
+ * @default "#a9dcc3"
+ */
+ 'mainSeriesProperties.pnfStyle.upColorProjection': string;
+ /**
+ * Main series Point & Figure style down projection color.
+ *
+ * @default "#f5a6ae"
+ */
+ 'mainSeriesProperties.pnfStyle.downColorProjection': string;
+ /**
+ * Main series Baseline style baseline color.
+ *
+ * @default "#758696"
+ */
+ 'mainSeriesProperties.baselineStyle.baselineColor': string;
+ /**
+ * Main series Baseline style top fill color1.
+ *
+ * @default "rgba(8, 153, 129, 0.28)"
+ */
+ 'mainSeriesProperties.baselineStyle.topFillColor1': string;
+ /**
+ * Main series Baseline style top fill color2.
+ *
+ * @default "rgba(8, 153, 129, 0.05)"
+ */
+ 'mainSeriesProperties.baselineStyle.topFillColor2': string;
+ /**
+ * Main series Baseline style bottom fill color1.
+ *
+ * @default "rgba(242, 54, 69, 0.05)"
+ */
+ 'mainSeriesProperties.baselineStyle.bottomFillColor1': string;
+ /**
+ * Main series Baseline style bottom fill color2.
+ *
+ * @default "rgba(242, 54, 69, 0.28)"
+ */
+ 'mainSeriesProperties.baselineStyle.bottomFillColor2': string;
+ /**
+ * Main series Baseline style top line color.
+ *
+ * @default "#089981"
+ */
+ 'mainSeriesProperties.baselineStyle.topLineColor': string;
+ /**
+ * Main series Baseline style bottom line color.
+ *
+ * @default "#F23645"
+ */
+ 'mainSeriesProperties.baselineStyle.bottomLineColor': string;
+ /**
+ * Main series Baseline style top line width.
+ *
+ * @default 2
+ */
+ 'mainSeriesProperties.baselineStyle.topLineWidth': number;
+ /**
+ * Main series Baseline style bottom line width.
+ *
+ * @default 2
+ */
+ 'mainSeriesProperties.baselineStyle.bottomLineWidth': number;
+ /**
+ * Main series Baseline style price source.
+ *
+ * @default "close"
+ */
+ 'mainSeriesProperties.baselineStyle.priceSource': PriceSource;
+ /**
+ * Main series Baseline style transparency.
+ *
+ * @default 50
+ */
+ 'mainSeriesProperties.baselineStyle.transparency': number;
+ /**
+ * Main series Baseline style base level percentage.
+ *
+ * @default 50
+ */
+ 'mainSeriesProperties.baselineStyle.baseLevelPercentage': number;
+ /**
+ * Main series Line With Markers style Line Color.
+ *
+ * @default '#2962FF'
+ */
+ 'mainSeriesProperties.lineWithMarkersStyle.color': string;
+ /**
+ * Main series Line With Markers style Line style.
+ *
+ * @default LineStyle.Solid
+ */
+ 'mainSeriesProperties.lineWithMarkersStyle.linestyle': OverrideLineStyle;
+ /**
+ * Main series Line With Markers style Line width.
+ *
+ * @default 2
+ */
+ 'mainSeriesProperties.lineWithMarkersStyle.linewidth': number;
+ /**
+ * Main series Line With Markers style Price Source.
+ *
+ * @default 'close'
+ */
+ 'mainSeriesProperties.lineWithMarkersStyle.priceSource': string;
+}
+/**
+ * A chart template.
+ */
+export interface ChartTemplate {
+ /**
+ * The template content.
+ */
+ content?: ChartTemplateContent;
+}
+/**
+ * Chart template content. The properties of the chart that are saved/loaded when the library saves/loads a chart template.
+ */
+export interface ChartTemplateContent {
+ [key: string]: any;
+ /**
+ * Chart properties (for example color, etc).
+ */
+ chartProperties?: {
+ /**
+ * Chart pane properties.
+ */
+ paneProperties: any;
+ /**
+ * Chart scales properties.
+ */
+ scalesProperties: any;
+ };
+ /**
+ * Series properties (for example chart style, etc).
+ */
+ mainSourceProperties?: any;
+ /**
+ * The version of the chart template.
+ */
+ version?: number;
+}
+export interface ChartingLibraryWidgetConstructor {
+ /**
+ * Constructor for the Advanced Charts Widget
+ * @param {ChartingLibraryWidgetOptions|TradingTerminalWidgetOptions} options - Constructor options
+ */
+ new (
+ options: ChartingLibraryWidgetOptions | TradingTerminalWidgetOptions
+ ): IChartingLibraryWidget;
+}
+export interface ChartingLibraryWidgetOptions {
+ /**
+ * The `container` can either be a reference to an attribute of a DOM element inside which the iframe with the chart will be placed or the `HTMLElement` itself.
+ *
+ * ```javascript
+ * container: "tv_chart_container",
+ * ```
+ *
+ * or
+ *
+ * ```javascript
+ * container: document.getElementById("tv_chart_container"),
+ * ```
+ */
+ container: HTMLElement | string;
+ /**
+ * JavaScript object that implements the datafeed interface ({@link IBasicDataFeed}) to supply the chart with data. See [Connecting Data](https://www.tradingview.com/charting-library-docs/latest/connecting_data/connecting_data.md) for more information on the JS API.
+ *
+ * ```javascript
+ * datafeed: new Datafeeds.UDFCompatibleDatafeed("https://demo_feed.tradingview.com")
+ * ```
+ */
+ datafeed: IBasicDataFeed | (IBasicDataFeed & IDatafeedQuotesApi);
+ /**
+ * The default interval for the chart.
+ *
+ * Example:
+ * ```javascript
+ * interval: '1D',
+ * ```
+ */
+ interval: ResolutionString;
+ /**
+ * The default symbol for the chart.
+ *
+ * Example:
+ * ```javascript
+ * symbol: 'AAPL',
+ * ```
+ */
+ symbol?: string;
+ /**
+ * A threshold delay in seconds that is used to reduce the number of `onAutoSaveNeeded` calls.
+ *
+ * ```javascript
+ * auto_save_delay: 5,
+ * ```
+ */
+ auto_save_delay?: number;
+ /**
+ * Boolean value showing whether the chart should use all the available space in the container and resize when the container itself is resized.
+ * @default false
+ *
+ * ```javascript
+ * autosize: true,
+ * ```
+ */
+ autosize?: boolean;
+ /**
+ * Setting this property to `true` will make the chart write detailed API logs into the browser console.
+ * Alternatively, you can use the `charting_library_debug_mode` featureset to enable it, or use the `setDebugMode` widget method ({@link IChartingLibraryWidget.setDebugMode}) .
+ *
+ * ```javascript
+ * debug: true,
+ * ```
+ */
+ debug?: boolean;
+ /**
+ * The array containing names of features that should be disabled by default. `Feature` means part of the functionality of the chart (part of the UI/UX). Supported features are listed [here](https://www.tradingview.com/charting-library-docs/latest/customization/Featuresets.md).
+ *
+ * Example:
+ * ```javascript
+ * disabled_features: ["header_widget", "left_toolbar"],
+ * ```
+ */
+ disabled_features?: ChartingLibraryFeatureset[];
+ /**
+ * You can hide some drawings from the toolbar or add custom restrictions for applying them to the chart.
+ *
+ * This property has the same structure as the `studies_access` argument. Use the same names as you see in the UI.
+ *
+ * **Remark**: There is a special case for font-based drawings. Use the "Font Icons" name for them.
+ * Those drawings cannot be enabled or disabled separately - the entire group will have to be either enabled or disabled.
+ *
+ * @example
+ * ```javascript
+ * drawings_access: {
+ * type: 'black',
+ * tools: [
+ * {
+ * name: 'Trend Line',
+ * grayed: true
+ * },
+ * ]
+ * },
+ * ```
+ */
+ drawings_access?: AccessList;
+ /**
+ * The array containing names of features that should be enabled by default. `Feature` means part of the functionality of the chart (part of the UI/UX). Supported features are listed [here](https://www.tradingview.com/charting-library-docs/latest/customization/Featuresets.md).
+ *
+ * Example:
+ * ```javascript
+ * enabled_features: ["move_logo_to_main_pane"],
+ * ```
+ */
+ enabled_features?: ChartingLibraryFeatureset[];
+ /**
+ * Boolean value showing whether the chart should use all the available space in the window.
+ * @default false
+ *
+ * ```javascript
+ * fullscreen: true,
+ * ```
+ */
+ fullscreen?: boolean;
+ /**
+ * A path to a `static` folder.
+ *
+ * ```javascript
+ * 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.md).
+ */
+ library_path?: string;
+ /**
+ * Locale to be used by the library. See [Localization](https://www.tradingview.com/charting-library-docs/latest/core_concepts/Localization.md) section for details.
+ *
+ * ```javascript
+ * locale: 'en',
+ * ```
+ */
+ locale: LanguageCode;
+ /**
+ * The object containing formatting options for numbers. The only possible option is `decimal_sign` currently.
+ *
+ * ```javascript
+ * numeric_formatting: { decimal_sign: "," },
+ * ```
+ */
+ numeric_formatting?: NumericFormattingParams;
+ /**
+ * JS object containing saved chart content.
+ * Use this parameter when creating the widget if you have a saved chart already.
+ * If you want to load the chart content when the chart is initialized then use `load()` method ({@link IChartingLibraryWidget.load}) of the widget.
+ */
+ saved_data?: object;
+ /**
+ * JS object containing saved chart content meta info.
+ */
+ saved_data_meta_info?: SavedStateMetaInfo;
+ /**
+ * You can hide some studies from the toolbar or add custom restrictions for applying them to the chart.
+ *
+ * @example
+ * ```javascript
+ * studies_access: {
+ * type: "black" | "white",
+ * tools: [
+ * {
+ * name: "",
+ * grayed: true
+ * },
+ * < ... >
+ * ]
+ * }
+ * ```
+ */
+ studies_access?: AccessList;
+ /**
+ * Maximum amount of studies allowed at one time within the layout. Minimum value is 2.
+ *
+ * ```javascript
+ * study_count_limit: 5,
+ * ```
+ */
+ study_count_limit?: number;
+ /**
+ * A threshold delay in milliseconds that is used to reduce the number of search requests when the user enters the symbol name in the [Symbol Search](https://www.tradingview.com/charting-library-docs/latest/ui_elements/Symbol-Search.md).
+ *
+ * ```javascript
+ * symbol_search_request_delay: 1000,
+ * ```
+ */
+ symbol_search_request_delay?: number;
+ /**
+ * Sets the default timeframe of the chart.
+ *
+ * The timeframe can be relative to the current date, or a range.
+ *
+ * A relative timeframe is a number with a letter D for days and M for months:
+ *
+ * ```javascript
+ * timeframe: '3M',
+ * ```
+ *
+ * A range is an object with to and from properties. The to and from properties should be UNIX timestamps:
+ *
+ * ```javascript
+ * timeframe: { from: 1640995200, to: 1643673600 } // from 2022-01-01 to 2022-02-01
+ * ```
+ *
+ * **Note**:
+ * When using a range the chart will still request data up to the current date. This is to enable scrolling forward in time once the chart has loaded.
+ */
+ timeframe?: TimeframeOption;
+ /**
+ * Default timezone of the chart. The time on the timescale is displayed according to this timezone.
+ * See the [list of supported timezones](https://www.tradingview.com/charting-library-docs/latest/connecting_data/Symbology#timezone) for available values. Set it to `exchange` to use the exchange timezone. Use the {@link ChartingLibraryWidgetOptions.overrides} section if you wish to override the default value.
+ *
+ * ```javascript
+ * timezone: "America/New_York",
+ * ```
+ */
+ timezone?: 'exchange' | Timezone;
+ /**
+ * Background color of the toolbars.
+ *
+ * ```javascript
+ * toolbar_bg: '#f4f7f9',
+ * ```
+ */
+ toolbar_bg?: string;
+ /**
+ * The desired width of a widget. Please make sure that there is enough space for the widget to be displayed correctly.
+ *
+ * ```javascript
+ * width: 300,
+ * ```
+ *
+ * **Remark**: If you want the chart to use all the available space use the `fullscreen` parameter instead of setting it to '100%'.
+ */
+ width?: number;
+ /**
+ * The desired height of a widget. Please make sure that there is enough space for the widget to be displayed correctly.
+ *
+ * ```javascript
+ * height: 600,
+ * ```
+ *
+ * **Remark**: If you want the chart to use all the available space use the `fullscreen` parameter instead of setting it to '100%'.
+ */
+ height?: number;
+ /**
+ * Set the storage url endpoint for use with the high-level saving / loading charts API.
+ * See more details [here](https://www.tradingview.com/charting-library-docs/latest/saving_loading/).
+ *
+ * ```javascript
+ * charts_storage_url: 'http://storage.yourserver.com',
+ * ```
+ */
+ charts_storage_url?: string;
+ /**
+ * A version of your backend. Supported values are: `"1.0"` | `"1.1"`. Study Templates are supported starting from version `"1.1"`.
+ *
+ * ```javascript
+ * charts_storage_api_version: "1.1",
+ * ```
+ */
+ charts_storage_api_version?: AvailableSaveloadVersions;
+ /**
+ * Set the client ID for the high-level saving / loading charts API.
+ * See more details [here](https://www.tradingview.com/charting-library-docs/latest/saving_loading/).
+ *
+ * ```javascript
+ * client_id: 'yourserver.com',
+ * ```
+ */
+ client_id?: string;
+ /**
+ * Set the user ID for the high-level saving / loading charts API.
+ * See more details [here](https://www.tradingview.com/charting-library-docs/latest/saving_loading/).
+ *
+ * ```javascript
+ * user_id: 'public_user_id',
+ * ```
+ */
+ user_id?: string;
+ /**
+ * Set this parameter to `true` if you want the library to load the last saved chart for a user (you should implement [save/load](https://www.tradingview.com/charting-library-docs/latest/saving_loading/saving_loading.md) first to make it work).
+ *
+ * ```javascript
+ * load_last_chart: true,
+ * ```
+ */
+ load_last_chart?: boolean;
+ /**
+ * Use this option to customize the style or inputs of the indicators.
+ * You can also customize the styles and inputs of the `Compare` series using this argument.
+ * Refer to [Indicator Overrides](https://www.tradingview.com/charting-library-docs/latest/customization/overrides/Studies-Overrides.md#specify-default-properties) for more information.
+ * Overrides for built-in indicators are listed in {@link StudyOverrides}.
+ *
+ * ```javascript
+ * studies_overrides: {
+ * "volume.volume.color.0": "#00FFFF",
+ * },
+ * ```
+ */
+ studies_overrides?: StudyOverrides;
+ /**
+ * @deprecated
+ * Alias for {@link ChartingLibraryWidgetOptions.custom_formatters}
+ */
+ customFormatters?: CustomFormatters;
+ /**
+ * Custom formatters for adjusting the display format of price, date, and time values.
+ *
+ * Example:
+ *
+ * ```javascript
+ * custom_formatters: {
+ * timeFormatter: {
+ * format: (date) => {
+ * const _format_str = '%h:%m';
+ * return _format_str
+ * .replace('%h', date.getUTCHours(), 2)
+ * .replace('%m', date.getUTCMinutes(), 2)
+ * .replace('%s', date.getUTCSeconds(), 2);
+ * }
+ * },
+ * dateFormatter: {
+ * format: (date) => {
+ * return date.getUTCFullYear() + '/' + (date.getUTCMonth() + 1) + '/' + date.getUTCDate();
+ * }
+ * },
+ * tickMarkFormatter: (date, tickMarkType) => {
+ * switch (tickMarkType) {
+ * case 'Year':
+ * return 'Y' + date.getUTCFullYear();
+ *
+ * case 'Month':
+ * return 'M' + (date.getUTCMonth() + 1);
+ *
+ * case 'DayOfMonth':
+ * return 'D' + date.getUTCDate();
+ *
+ * case 'Time':
+ * return 'T' + date.getUTCHours() + ':' + date.getUTCMinutes();
+ *
+ * case 'TimeWithSeconds':
+ * return 'S' + date.getUTCHours() + ':' + date.getUTCMinutes() + ':' + date.getUTCSeconds();
+ * }
+ *
+ * throw new Error('unhandled tick mark type ' + tickMarkType);
+ * },
+ * priceFormatterFactory: (symbolInfo, minTick) => {
+ * if (symbolInfo?.fractional || minTick !== 'default' && minTick.split(',')[2] === 'true') {
+ * return {
+ * format: (price, signPositive) => {
+ * // return the appropriate format
+ * },
+ * };
+ * }
+ * return null; // this is to use default formatter;
+ * },
+ * studyFormatterFactory: (format, symbolInfo) => {
+ * if (format.type === 'price') {
+ * const numberFormat = new Intl.NumberFormat('en-US', { notation: 'scientific' });
+ * return {
+ * format: (value) => numberFormat.format(value)
+ * };
+ * }
+ *
+ * if (format.type === 'volume') {
+ * return {
+ * format: (value) => (value / 1e9).toPrecision(format?.precision || 2) + 'B'
+ * };
+ * }
+ *
+ * if (format.type === 'percent') {
+ * return {
+ * format: (value) => `${value.toPrecision(format?.precision || 4)} percent`
+ * };
+ * }
+ *
+ * return null; // this is to use default formatter;
+ * },
+ * }
+ * ```
+ *
+ * **Remark**: `tickMarkFormatter` must display the UTC date, and not the date corresponding to your local timezone.
+ */
+ custom_formatters?: CustomFormatters;
+ /**
+ * Override values for the default widget properties
+ * You can override most of the properties (which also may be edited by user through UI)
+ * using `overrides` parameter of Widget constructor. `overrides` is supposed to be an object.
+ * The keys of this object are the names of overridden properties.
+ * The values of these keys are the new values of the properties.
+ *
+ * Example:
+ * ```javascript
+ * overrides: {
+ * "mainSeriesProperties.style": 2
+ * }
+ * ```
+ * This code will change the default series style to "line".
+ * All customizable properties are listed in [separate article](https://www.tradingview.com/charting-library-docs/latest/customization/overrides/Overrides.md).
+ */
+ overrides?: Partial;
+ /**
+ * This URL is used to send a POST request with binary chart snapshots when a user presses the snapshot button.
+ * This POST request contains `multipart/form-data` with the field `preparedImage` that represents binary data of the snapshot image in `image/png` format.
+ *
+ * This endpoint should return the full URL of the saved image in the the response.
+ *
+ * ```javascript
+ * snapshot_url: "https://myserver.com/snapshot",
+ * ```
+ */
+ snapshot_url?: string;
+ /**
+ * List of visible time frames that can be selected at the bottom of the chart. See [Time frame toolbar](https://www.tradingview.com/charting-library-docs/latest/ui_elements/Time-Scale.md#time-frame-toolbar) for more information. Time frame is an object containing the following properties:
+ *
+ * Example:
+ *
+ * ```javascript
+ * time_frames: [
+ * { text: "50y", resolution: "6M", description: "50 Years" },
+ * { text: "3y", resolution: "1W", description: "3 Years", title: "3yr" },
+ * { text: "8m", resolution: "1D", description: "8 Month" },
+ * { text: "3d", resolution: "5", description: "3 Days" },
+ * { text: "1000y", resolution: "1W", description: "All", title: "All" },
+ * ]
+ * ```
+ */
+ time_frames?: TimeFrameItem[];
+ /**
+ * Adds your custom CSS to the chart. `url` should be an absolute or relative path to the `static` folder.
+ *
+ * ```javascript
+ * custom_css_url: 'css/style.css',
+ * ```
+ */
+ custom_css_url?: string;
+ /**
+ * Changes the font family used on the chart including the [time scale](https://www.tradingview.com/charting-library-docs/latest/ui_elements/Time-Scale.md), [price scale](https://www.tradingview.com/charting-library-docs/latest/ui_elements/Price-Scale.md), and chart's pane.
+ * 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.md) 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.md) as follows:
+ *
+ * ```javascript
+ * custom_font_family: "'Inconsolata', monospace",
+ * ```
+ *
+ * The `custom_font_family` value should have the same format as the `font-family` property in CSS.
+ * To use a font that is not available by default on your system, you should first add this font to your [custom CSS](#custom_css_url).
+ * For example, the code sample below imports a Google font into your custom CSS:
+ *
+ * ```css
+ * @import url('https://fonts.googleapis.com/css2?family=Inconsolata:wght@500&display=swap');
+ * ```
+ *
+ */
+ custom_font_family?: string;
+ /**
+ * Items that should be marked as favorite by default. This option requires that the usage of localstorage is disabled (see [featuresets](https://www.tradingview.com/charting-library-docs/latest/customization/Featuresets) to know more).
+ * The `favorites` property is supposed to be an object. The following properties are supported:
+ *
+ * ```javascript
+ * favorites: {
+ * intervals: ["1D", "3D", "3W", "W", "M"],
+ * indicators: ["Awesome Oscillator", "Bollinger Bands"],
+ * drawingTools: ['LineToolBrush', 'LineToolCallout', 'LineToolCircle'],
+ * chartTypes: ['Area', 'Candles'],
+ * },
+ * ```
+ *
+ * If you want to allow users to add/remove items from favorites, you should enable/disable the [`items_favoriting`](https://www.tradingview.com/charting-library-docs/latest/customization/Featuresets.md#items_favoriting) featureset.
+ *
+ */
+ favorites?: Favorites;
+ /**
+ * An object containing the save/load functions.
+ * It is used to implement a custom save/load algorithm.
+ * Please see details and an example on [Saving and Loading Charts page](https://www.tradingview.com/charting-library-docs/latest/saving_loading/saving_loading.md#api-handlers).
+ */
+ save_load_adapter?: IExternalSaveLoadAdapter;
+ /**
+ * Customization of the loading spinner. Value is an object with the following possible keys:
+ *
+ * * `backgroundColor`
+ * * `foregroundColor`
+ *
+ * Example:
+ *
+ * ```javascript
+ * loading_screen: { backgroundColor: "#000000" }
+ * ```
+ */
+ loading_screen?: LoadingScreenOptions;
+ /**
+ * An object that contains set/remove functions. Use it to save chart settings to your preferred storage (including server-side).
+ *
+ * Example:
+ * ```javascript
+ * settings_adapter: {
+ * initialSettings: { ... },
+ * setValue: function(key, value) { ... },
+ * removeValue: function(key) { ... },
+ * }
+ * ```
+ */
+ settings_adapter?: ISettingsAdapter;
+ /**
+ * Set predefined custom theme color for the chart. Supported values are: `"light"` | `"dark"`.
+ *
+ * ```javascript
+ * theme: "light",
+ * ```
+ */
+ theme?: ThemeName;
+ /**
+ * an array of custom compare symbols for the Compare window.
+ *
+ * Example:
+ * ```javascript
+ * compare_symbols: [
+ * { symbol: 'DAL', title: 'Delta Air Lines' },
+ * { symbol: 'VZ', title: 'Verizon' },
+ * ...
+ * ];
+ * ```
+ */
+ compare_symbols?: CompareSymbol[];
+ /**
+ * Function that returns a Promise object with an array of your custom indicators.
+ *
+ * `PineJS` variable will be passed as the first argument of this function and can be used inside your indicators to access internal helper functions.
+ *
+ * See more details [here](https://www.tradingview.com/charting-library-docs/latest/custom_studies/).
+ *
+ * ```javascript
+ * custom_indicators_getter: function(PineJS) {
+ * return Promise.resolve([
+ * // *** your indicator object, created from the template ***
+ * ]);
+ * },
+ * ```
+ */
+ custom_indicators_getter?: (
+ PineJS: PineJS
+ ) => Promise;
+ /**
+ * An optional field containing an array of custom symbol info fields to be shown in the Symbol Info dialog.
+ *
+ * See [Symbology](https://www.tradingview.com/charting-library-docs/latest/connecting_data/Symbology) for more information about symbol info.
+ *
+ * ```javascript
+ * additional_symbol_info_fields: [
+ * { title: 'Ticker', propertyName: 'ticker' }
+ * ]
+ * ```
+ */
+ additional_symbol_info_fields?: AdditionalSymbolInfoField[];
+ /**
+ * An additional optional field to change the look and feel of buttons on the top toolbar.
+ *
+ * By default (if option is omitted) header will be in adaptive mode (fullsize if the window width allows and icons on smaller windows).
+ *
+ * Example:
+ * ```javascript
+ * header_widget_buttons_mode: 'fullsize',
+ * ```
+ */
+ header_widget_buttons_mode?: HeaderWidgetButtonsMode;
+ /**
+ * You could use this object to override context menu. You can also change the menu on the fly using the {@link IChartingLibraryWidget.onContextMenu} method.
+ */
+ context_menu?: ContextMenuOptions;
+ /**
+ * An additional optional field to add more bars on screen.
+ *
+ * Example:
+ * ```javascript
+ * time_scale: {
+ * min_bar_spacing: 10,
+ * }
+ * ```
+ */
+ time_scale?: TimeScaleOptions;
+ /**
+ * Use this property to set your own translation function. `key` and `options` will be passed to the function.
+ *
+ * You can use this function to provide custom translations for some strings.
+ *
+ * The function should return either a string with a new translation or `null` to fallback to the default translation.
+ *
+ * For example, if you want to rename "Trend Line" shape to "Line Shape", then you can do something like this:
+ *
+ * ```javascript
+ * custom_translate_function: (key, options, isTranslated) => {
+ * if (key === 'Trend Line') {
+ * // patch the title of trend line
+ * return 'Line Shape';
+ * }
+ *
+ * return null;
+ * }
+ * ```
+ */
+ custom_translate_function?: CustomTranslateFunction;
+ /**
+ * Use this property to set a function to override the symbol input from the [Symbol Search](https://www.tradingview.com/charting-library-docs/latest/ui_elements/Symbol-Search.md).
+ *
+ * For example, you may want to get additional input from the user before deciding which symbol should be resolved.
+ *
+ * The function should take two parameters: a `string` of input from the Symbol Search and a optional search result item. It should return a `Promise` that resolves with a symbol ticker and a human-friendly symbol name.
+ *
+ * **NOTE:** This override is not called when adding a symbol to the watchlist.
+ *
+ * ```typescript
+ * {
+ * // `SearchSymbolResultItem` is the same interface as for items returned to the Datafeed's searchSymbols result callback.
+ * symbol_search_complete: (symbol: string, searchResultItem?: SearchSymbolResultItem) => {
+ * return new Promise((resolve) => {
+ * let symbol = getNewSymbol(symbol, searchResultItem);
+ * let name = getHumanFriendlyName(symbol, searchResultItem)
+ * resolve({ symbol: symbol, name: name });
+ * });
+ * }
+ * }
+ * ```
+ */
+ symbol_search_complete?: SymbolSearchCompleteOverrideFunction;
+ /**
+ * The object that contains new values for values saved to the settings.
+ * These overrides will replace any matching values from the settings, regardless of where the settings are loaded from (i.e. local storage or a custom settings adapter).
+ * The object is similar to the [overrides](#overrides) object.
+ *
+ * [overrides](#overrides) will not affect values that have been saved to settings so this option can be used instead.
+ *
+ * ```javascript
+ * settings_overrides: {
+ * "linetooltrendline.linecolor": "blue"
+ * }
+ * ```
+ */
+ settings_overrides?: Overrides;
+ /**
+ * List of custom timezones.
+ *
+ * Please see the [timezones](https://www.tradingview.com/charting-library-docs/latest/ui_elements/timezones) documentation for more details.
+ */
+ custom_timezones?: CustomAliasedTimezone[];
+}
+export interface CheckboxFieldMetaInfo extends CustomFieldMetaInfoBase {
+ /** @inheritDoc */
+ inputType: 'Checkbox';
+ /** @inheritDoc */
+ value: boolean;
+ /** Does the field support modification */
+ supportModify?: boolean;
+ /** Help message for the field */
+ help?: string;
+}
+/**
+ * Override properties for the Circle drawing tool.
+ */
+export interface CircleLineToolOverrides {
+ /** Default value: `rgba(255, 152, 0, 0.2)` */
+ 'linetoolcircle.backgroundColor': string;
+ /** Default value: `false` */
+ 'linetoolcircle.bold': boolean;
+ /** Default value: `#FF9800` */
+ 'linetoolcircle.color': string;
+ /** Default value: `true` */
+ 'linetoolcircle.fillBackground': boolean;
+ /** Default value: `14` */
+ 'linetoolcircle.fontSize': number;
+ /** Default value: `false` */
+ 'linetoolcircle.italic': boolean;
+ /** Default value: `2` */
+ 'linetoolcircle.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolcircle.showLabel': boolean;
+ /** Default value: `#FF9800` */
+ 'linetoolcircle.textColor': string;
+}
+export interface ClientSnapshotOptions {
+ /** Background color */
+ backgroundColor: string;
+ /** Border color */
+ borderColor: string;
+ /** Font */
+ font: string;
+ /** Size of font */
+ fontSize: number;
+ /** Legend Mode. */
+ legendMode: LegendMode;
+ /** Hide resolution */
+ hideResolution: boolean;
+}
+export interface ColumnStylePreferences {
+ /** Up column color */
+ upColor: string;
+ /** Down column color */
+ downColor: string;
+ /** Color column based on previous close */
+ barColorsOnPrevClose: boolean;
+}
+/**
+ * Override properties for the Comment drawing tool.
+ */
+export interface CommentLineToolOverrides {
+ /** Default value: `#2962FF` */
+ 'linetoolcomment.backgroundColor': string;
+ /** Default value: `#2962FF` */
+ 'linetoolcomment.borderColor': string;
+ /** Default value: `#ffffff` */
+ 'linetoolcomment.color': string;
+ /** Default value: `16` */
+ 'linetoolcomment.fontsize': number;
+ /** Default value: `0` */
+ 'linetoolcomment.transparency': number;
+}
+/**
+ * Defines a custom compare symbol for the Compare dialog window
+ */
+export interface CompareSymbol {
+ /** symbol identifier */
+ symbol: string;
+ /** the name of instrument that will be displayed near the corresponding checkbox */
+ title: string;
+}
+export interface ContextMenuItem {
+ /** Position of the context menu item */
+ position: 'top' | 'bottom';
+ /** Text content for the context menu item */
+ text: string;
+ /** Callback event when menu item is clicked */
+ click: EmptyCallback;
+}
+export interface ContextMenuOptions {
+ /**
+ * Provide this function if you want to change the set of actions being displayed in the context menu.
+ *
+ * You can filter out, add yours and re-order items.
+ *
+ * The library will call your function each time it wants to display a context menu and will provide a list of items to display.
+ * This function should return an array of items to display.
+ *
+ * Example:
+ *
+ * ```js
+ * context_menu: {
+ * items_processor: function(items, actionsFactory, params) {
+ * console.log(`Menu name is: ${params.menuName}`);
+ * const newItem = actionsFactory.createAction({
+ * actionId: 'hello-world',
+ * label: 'Say Hello',
+ * onExecute: function() {
+ * alert('Hello World');
+ * },
+ * });
+ * items.unshift(newItem);
+ * return Promise.resolve(items);
+ * },
+ * },
+ * ```
+ */
+ items_processor?: ContextMenuItemsProcessor;
+ /**
+ * **Note:** This API is experimental and might be changed significantly in the future releases.
+ * By providing this function you could override the default renderer for context menu.
+ */
+ renderer_factory?: ContextMenuRendererFactory;
+}
+export interface ContextMenuPosition {
+ /** X (horizontal) coordinate (in pixels) at which the mouse event occurred, relative to the left edge of the applications viewport. */
+ clientX: number;
+ /** Y (vertical) coordinate (in pixels) at which the mouse event occurred, relative to the left edge of the applications viewport. */
+ clientY: number;
+ /** Touch positions */
+ touches?: readonly {
+ /** X (horizontal) coordinate (in pixels) at which the touch event occurred, relative to the left edge of the applications viewport. */
+ clientX: number;
+ /** Y (vertical) coordinate (in pixels) at which the touch event occurred, relative to the left edge of the applications viewport. */
+ clientY: number;
+ }[];
+ /**
+ * Tells what side of the context menu widget should be used to "attach" to a provided x coordinate.
+ * If the value is `undefined`, then you may treat it based on whether it is rtl or not (e.g. `'right'` for rtl and `'left'` otherwise).
+ * The value `'auto'` behaves as `undefined` but additionally checks if there is enough space to place the menu and if it's not then the result value is inverted.
+ */
+ attachToXBy?: 'left' | 'right' | 'auto';
+ /**
+ * Tells what side of the context menu widget should be used to "attach" to a provided y coordinate:
+ * - `'auto'` means similar to `'top'` but the menu could be expanded above the coordinate if needed (if there is no enough space to place it below)
+ * - `'auto-strict'` means `'top'` if the whole menu fits the space below the coordinate and `'bottom'` otherwise (see {@link box})
+ * - `'top'` means that the menu should be placed to the bottom of y coordinate (the menu should be attached by its bottom to y coordinate)
+ * - `'bottom'` means that the menu should be placed above y coordinate (the menu should be attached by its top to y coordinate)
+ *
+ * You may treat `undefined` as `'auto'`.
+ */
+ attachToYBy?: 'auto' | 'auto-strict' | 'top' | 'bottom';
+ /**
+ * The optional structure that helps to more accurate calculate a position of the menu (see {@link attachToYBy}).
+ */
+ box?: {
+ /** menu x coordinate */
+ x: number;
+ /** menu y coordinate */
+ y: number;
+ /** menu width */
+ w: number;
+ /** menu height */
+ h: number;
+ /** x coordinate overlaps */
+ overlapX?: boolean;
+ };
+ /**
+ * Additional horizontal margin.
+ */
+ marginX?: number;
+ /**
+ * Additional vertical margin.
+ */
+ marginY?: number;
+}
+/**
+ * Options for creating an anchored drawing.
+ */
+export interface CreateAnchoredShapeOptions
+ extends CreateShapeOptionsBase {
+ /**
+ * A drawing to create;
+ */
+ shape: 'anchored_text' | 'anchored_note';
+}
+export interface CreateContextMenuParams {
+ /** name of the menu */
+ menuName: string;
+ /**
+ * Additional details for the context menu.
+ * `type` field can be one of the following: `series`, `study`, `shape`, or `groupOfShapes`
+ */
+ detail?:
+ | {
+ /** series type */
+ type: 'series';
+ /** id */
+ id: string;
+ }
+ | {
+ /** study type */
+ type: 'study';
+ /** id */
+ id: string | null;
+ }
+ | {
+ /** shape type */
+ type: 'shape';
+ /** id */
+ id: number | string | null;
+ }
+ | {
+ /** groupOfShapes type */
+ type: 'groupOfShapes';
+ /** id */
+ id: string | null;
+ }
+ | {
+ /** Trading position */
+ type: 'position';
+ /** id */
+ id: string | null;
+ }
+ | {
+ /** Trading order */
+ type: 'order';
+ /** id */
+ id: string | null;
+ };
+}
+export interface CreateHTMLButtonOptions {
+ /**
+ * Alignment for the button.
+ * @default 'left'
+ */
+ align: 'left' | 'right';
+ /**
+ * A placeholder HTMLElement will be created.
+ */
+ useTradingViewStyle: false;
+}
+/**
+ * Options for creating a multipoint drawing.
+ */
+export interface CreateMultipointShapeOptions
+ extends CreateShapeOptionsBase {
+ /**
+ * A drawing to create.
+ */
+ shape?: Exclude<
+ SupportedLineTools,
+ 'cursor' | 'dot' | 'arrow_cursor' | 'eraser' | 'measure' | 'zoom'
+ >;
+}
+/**
+ * Options for creating a drawing.
+ */
+export interface CreateShapeOptions
+ extends CreateShapeOptionsBase {
+ /**
+ * A drawing to create.
+ */
+ shape?:
+ | 'arrow_up'
+ | 'arrow_down'
+ | 'flag'
+ | 'vertical_line'
+ | 'horizontal_line'
+ | 'long_position'
+ | 'short_position'
+ | 'icon'
+ | 'emoji'
+ | 'sticker'
+ | 'anchored_text'
+ | 'anchored_note';
+ /**
+ * An optional study ID to be attached to the owner study.
+ * It does not mean that both the owner and all possible associated IDs will behave in tandem.
+ * Their behavior will be independent.
+ */
+ ownerStudyId?: EntityId;
+}
+/**
+ * Options for creating a drawing.
+ */
+export interface CreateShapeOptionsBase {
+ /** Text for drawing */
+ text?: string;
+ /** Should drawing be locked */
+ lock?: boolean;
+ /**
+ * Disable/enable selecting the drawing.
+ */
+ disableSelection?: boolean;
+ /**
+ * Disable/enable saving the drawing.
+ */
+ disableSave?: boolean;
+ /**
+ * Disable/enable undoing the creation of the drawing.
+ */
+ disableUndo?: boolean;
+ /**
+ * Drawing properties overrides.
+ */
+ overrides?: TOverrides;
+ /**
+ * Create the drawing in front of all other drawings, or behind all other drawings.
+ */
+ zOrder?: 'top' | 'bottom';
+ /**
+ * Enable/disable showing the drawing in the objects tree.
+ */
+ showInObjectsTree?: boolean;
+ /**
+ * An entity ID that can be used to associate the drawing with a study.
+ */
+ ownerStudyId?: EntityId;
+ /**
+ * Enable/disable filling the drawing with color (if the drawing supports filling).
+ */
+ filled?: boolean;
+ /**
+ * Specify an icon to render - Only icons listed [here](https://www.tradingview.com/charting-library-docs/latest/customization/overrides/Shapes-and-Overrides) are supported
+ */
+ icon?: number;
+}
+/**
+ * Options for creating a study.
+ */
+export interface CreateStudyOptions {
+ /** if it is `true` then the study limit dialog will be shown if the limit is exceeded. */
+ checkLimit?: boolean;
+ /**
+ * Price scale
+ */
+ priceScale?: StudyPriceScale;
+ /** Allow the currency to be changed */
+ allowChangeCurrency?: boolean;
+ /** Allow the unit to be changed */
+ allowChangeUnit?: boolean;
+ /** prevents adding of the action to the undo stack */
+ disableUndo?: boolean;
+}
+/**
+ * Options for creating a study template.
+ */
+export interface CreateStudyTemplateOptions {
+ /**
+ * An optional boolean flag to include the symbol in the saved state.
+ */
+ saveSymbol?: boolean;
+ /**
+ * An optional boolean flag to include the interval in the saved state.
+ */
+ saveInterval?: boolean;
+}
+export interface CreateTradingViewStyledButtonOptions {
+ /**
+ * Alignment for the button.
+ * @default 'left'
+ */
+ align: 'left' | 'right';
+ /**
+ * A button with the built-in styles will be created in the header.
+ */
+ useTradingViewStyle: true;
+ /**
+ * The text shown on the button.
+ */
+ text: string;
+ /**
+ * The text shown on hovering the button.
+ */
+ title?: string;
+ /**
+ * A function called when the button is clicked.
+ */
+ onClick?: () => void;
+}
+/**
+ * Crosshair move event information.
+ */
+export interface CrossHairMovedEventParams {
+ /**
+ * The time coordinate of the crosshair.
+ */
+ time: number;
+ /**
+ * The price coordinate of the crosshair.
+ */
+ price: number;
+ /**
+ * Series and study values at the crosshair position. The object keys are study or series IDs, and the object value are study or series values.
+ * The ID for the main series will always be the string `'_seriesId'`.
+ */
+ entityValues?: Record;
+ /**
+ * X coordinate of the crosshair relative to the left edge of the element containing the library.
+ */
+ offsetX?: number;
+ /**
+ * Y coordinate of the crosshair relative to the top edge of the element containing the library.
+ */
+ offsetY?: number;
+}
+/**
+ * Data source (a series or a study) values for a crosshair position.
+ */
+export interface CrossHairMovedEventSource {
+ /**
+ * `true` if the source is hovered by the crosshair `false` otherwise.
+ */
+ isHovered: boolean;
+ /**
+ * The title of the source. Matches the title shown in the data window.
+ */
+ title: string;
+ /**
+ * The values of the source. Matches the values shown in the data window.
+ */
+ values: CrossHairMovedEventSourceValue[];
+}
+export interface CrossHairMovedEventSourceValue {
+ /**
+ * Value title. E.g. 'open', 'high', 'change', etc. Matches the title shown in the data window.
+ */
+ title: string;
+ /**
+ * The value formatted as a string. Matches the value shown in the data window.
+ */
+ value: string;
+}
+/**
+ * Override properties for the Crossline drawing tool.
+ */
+export interface CrosslineLineToolOverrides {
+ /** Default value: `#2962FF` */
+ 'linetoolcrossline.linecolor': string;
+ /** Default value: `0` */
+ 'linetoolcrossline.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolcrossline.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolcrossline.showPrice': boolean;
+ /** Default value: `true` */
+ 'linetoolcrossline.showTime': boolean;
+}
+export interface CryptoBalance {
+ /** Symbol */
+ symbol: string;
+ /** Total balance */
+ total: number;
+ /** Available balance */
+ available: number;
+ /** Reserved balance */
+ reserved?: number;
+ /** Balance value */
+ value?: number;
+ /** Balance value's currency */
+ valueCurrency?: string;
+ /** Long name of Crypto */
+ longName?: string;
+ /** Bitcoin value of balance */
+ btcValue?: number;
+}
+export interface CurrencyInfo {
+ /**
+ * Currently selected currency for the price scale.
+ */
+ selectedCurrency: PriceScaleSelectedCurrency;
+ /**
+ * Available currencies for the price scale provided by the datafeed.
+ */
+ currencies: string[];
+}
+export interface CurrencyItem {
+ /** Unique ID */
+ id: string;
+ /** Currency code. @example `USD` */
+ code: string;
+ /** URL to an image of the currency. SVG logos are preferable, but please make sure that the provided image fits nicely in the currency select control (for raster images the expected size is 24x24px). */
+ logoUrl?: string;
+ /** Description for the currency */
+ description?: string;
+}
+export interface CustomAliasedTimezone extends CustomTimezoneInfo {
+ /**
+ * Id for the custom timezone.
+ */
+ id: CustomTimezoneId;
+}
+export interface CustomComboBoxItem {
+ /** Combo box item text */
+ text: string;
+ /** Combo box item value */
+ value: string;
+}
+export interface CustomComboBoxMetaInfo extends CustomInputFieldMetaInfo {
+ /** @inheritDoc */
+ inputType: 'ComboBox';
+ /** Items for the combo box input field */
+ items: CustomComboBoxItem[];
+}
+export interface CustomFieldMetaInfoBase {
+ /** Type of the input field */
+ inputType: string;
+ /** Input field ID */
+ id: string;
+ /** Title for the input field */
+ title: string;
+ /** Value of the field */
+ value?: any;
+ /** Should the input field value be saved to settings */
+ saveToSettings?: boolean;
+}
+/**
+ * Custom fields to be added to an object.
+ */
+export interface CustomFields {
+ /** Custom field */
+ [key: string]: any;
+}
+/** */
+export interface CustomFormatter {
+ /** Formats date and time */
+ format(date: Date): string;
+ /** Converts date and time to local timezone. */
+ formatLocal(date: Date): string;
+}
+/**
+ * Formatters used to adjust the displayed format of the date and time values.
+ */
+export interface CustomFormatters {
+ /** Used to format the time displayed in the bottom toolbar (timezone) */
+ timeFormatter: CustomFormatter;
+ /** Used to format the date displayed over the timescale when hover over a chart */
+ dateFormatter: CustomFormatter;
+ /**
+ * Used to format date displayed in the time axis
+ * **Remark**: `tickMarkFormatter` must display the UTC date, and not the date corresponding to your local timezone.
+ */
+ tickMarkFormatter?: (date: Date, tickMarkType: TickMarkType) => string;
+ /** Used to format the number displayed in the price axis */
+ priceFormatterFactory?: SeriesFormatterFactory;
+ /**
+ * Used to format the numbers displayed within a custom study.
+ */
+ studyFormatterFactory?: CustomStudyFormatterFactory;
+}
+export interface CustomIndicator {
+ /** Your study name, it will be used internally by the library */
+ readonly name: string;
+ /**
+ * The metainfo field is designed to contain the main info about the custom study.
+ *
+ * See [Custom Studies Metainfo](https://www.tradingview.com/charting-library-docs/latest/custom_studies/metainfo/metainfo.md) for more information
+ */
+ readonly metainfo: StudyMetaInfo;
+ /**
+ * The Custom Study Constructor is a Function Constructor in terms of ES5.
+ * The library creates an instance of a custom study by applying operator new to the constructor.
+ * The library expects the constructor to create an instance of the study with one mandatory method - `main()` and one optional method - `init()`.
+ * Once the study is created the library calls init (if exists) and main sequentially with empty context to collect information about all vars.
+ *
+ * See [Custom Studies Constructor](https://www.tradingview.com/charting-library-docs/latest/custom_studies/Custom-Studies-Constructor.md) for more information.
+ */
+ readonly constructor:
+ | LibraryPineStudyConstructor
+ | ((this: LibraryPineStudy) => void);
+}
+export interface CustomInputFieldMetaInfo extends CustomFieldMetaInfoBase {
+ /** Prevent modification */
+ preventModify?: boolean;
+ /** Placeholder string for the field */
+ placeHolder?: string;
+ /** Validator function for the field */
+ validator?: InputFieldValidator;
+ /** Additional custom information */
+ customInfo?: any;
+}
+/**
+ * An object that contains the results of broker specific user inputs (for example a digital signature).
+ */
+export interface CustomInputFieldsValues {
+ [fieldId: string]: TextWithCheckboxValue | boolean | string | any;
+}
+/**
+ * Action link to be displayed at the end of the section for the
+ * status item in the pop-up tooltip.
+ */
+export interface CustomStatusDropDownAction {
+ /**
+ * Text to be displayed as the link
+ */
+ text: string;
+ /**
+ * Tooltip text to be displayed when the user hovers over
+ * the action link.
+ */
+ tooltip?: string;
+ /**
+ * Callback function to be executed when the user clicks
+ * on the action.
+ */
+ onClick: () => void;
+}
+/**
+ * Specifies the content to be displayed within a section of
+ * the pop-up tooltip which is displayed when a user clicks on
+ * the symbol status items.
+ *
+ * The pop-up tooltip should be used to display additional
+ * information related to the status item.
+ */
+export interface CustomStatusDropDownContent {
+ /**
+ * Title to be displayed next to the icon for this section
+ * of the pop-up tooltip.
+ */
+ title: string;
+ /**
+ * Color to be used for the icon and title. If unspecified
+ * then the color from the status item will be used.
+ */
+ color?: string;
+ /**
+ * Icon to be displayed next to the title for this section
+ * of the pop-up tooltip. If unspecified then the icon from
+ * the status item will be used.
+ */
+ icon?: string;
+ /**
+ * Content to the displayed within this section of the
+ * pop-up tooltip.
+ *
+ * **It is essential to protect the content you provide
+ * against cross-site scripting (XSS) attacks, as these
+ * strings will be interpreted as HTML markup.**
+ */
+ content: string[];
+ /**
+ * Optional action link to be displayed at the bottom of
+ * the status section.
+ */
+ action?: CustomStatusDropDownAction;
+}
+/**
+ * Study format description used in custom study formatters.
+ */
+export interface CustomStudyFormatterFormat {
+ /**
+ * The format of the plot.
+ */
+ type: 'price' | 'volume' | 'percent';
+ /**
+ * The format precision.
+ */
+ precision?: number;
+}
+export interface CustomTableElementFormatter<
+ T extends TableFormatterInputValues = TableFormatterInputValues
+> {
+ /** Custom formatter name */
+ name: FormatterName;
+ /** Formatter to generate HTML element */
+ formatElement?: CustomTableFormatElementFunction;
+ /** Formatter to generate text. Return an empty string if you don't need to display this */
+ formatText: TableFormatTextFunction;
+ /** Allow usage of priceFormatter */
+ isPriceFormatterNeeded?: boolean;
+}
+export interface CustomTimezoneInfo {
+ /**
+ * Timezone identifier ({@link TimezoneId}) to which this custom
+ * timezone should be mapped to. This must be a timezone supported
+ * by library.
+ *
+ * Additionally, you can specify a `Etc/GMT` timezone id.
+ * In order to conform with the POSIX style, those zone names
+ * beginning with "Etc/GMT" have their sign reversed from the
+ * standard ISO 8601 convention. In the "Etc" area, zones west
+ * of GMT have a positive sign and those east have a negative
+ * sign in their name (e.g "Etc/GMT-14" is 14 hours ahead of GMT).
+ */
+ alias: TimezoneId | GmtTimezoneId;
+ /**
+ * Display name for the timezone
+ */
+ title: string;
+}
+/**
+ * Additional translation options
+ */
+export interface CustomTranslateOptions {
+ /** Plural/s of the phrase */
+ plural?: string | string[];
+ /** Count of the phrase */
+ count?: number;
+ /** Context of the phrase */
+ context?: string;
+ /** Replacements object */
+ replace?: Record;
+}
+/**
+ * Override properties for the Cypherpattern drawing tool.
+ */
+export interface CypherpatternLineToolOverrides {
+ /** Default value: `#2962FF` */
+ 'linetoolcypherpattern.backgroundColor': string;
+ /** Default value: `false` */
+ 'linetoolcypherpattern.bold': boolean;
+ /** Default value: `#2962FF` */
+ 'linetoolcypherpattern.color': string;
+ /** Default value: `true` */
+ 'linetoolcypherpattern.fillBackground': boolean;
+ /** Default value: `12` */
+ 'linetoolcypherpattern.fontsize': number;
+ /** Default value: `false` */
+ 'linetoolcypherpattern.italic': boolean;
+ /** Default value: `2` */
+ 'linetoolcypherpattern.linewidth': number;
+ /** Default value: `#ffffff` */
+ 'linetoolcypherpattern.textcolor': string;
+ /** Default value: `85` */
+ 'linetoolcypherpattern.transparency': number;
+}
+/**
+ * Depth of Market (Order Book) Data
+ */
+export interface DOMData {
+ /**
+ * Whether the Depth of Market data is a snapshot (has the full set of depth data).
+ * - If `true` then the data contains the full set of depth data.
+ * - If `false` then data only contains updated levels.
+ */
+ snapshot: boolean;
+ /** Ask order levels (must be sorted by `price` in ascending order) */
+ asks: DOMLevel[];
+ /** Bid order levels (must be sorted by `price` in ascending order) */
+ bids: DOMLevel[];
+}
+/**
+ * Depth of Market Level
+ */
+export interface DOMLevel {
+ /** Price for DOM level */
+ price: number;
+ /** Volume for DOM level */
+ volume: number;
+}
+/**
+ * Datafeed configuration data.
+ * Pass the resulting array of properties as a parameter to {@link OnReadyCallback} of the [`onReady`](https://www.tradingview.com/charting-library-docs/latest/connecting_data/Datafeed-API#onready) method.
+ */
+export interface DatafeedConfiguration {
+ /**
+ * List of exchange descriptors.
+ * An empty array leads to an absence of the exchanges filter in the Symbol Search list.
+ * Use `value=''` if you wish to include all exchanges.
+ */
+ exchanges?: Exchange[];
+ /**
+ * List of supported resolutions. Resolution string format is described here: {@link ResolutionString}
+ * Setting this property to `undefined` or an empty array will result in the resolution widget
+ * displaying the content.
+ *
+ * @example
+ * `["1", "15", "240", "D", "6M"]` will give you "1 minute, 15 minutes, 4 hours, 1 day, 6 months" in resolution widget.
+ */
+ supported_resolutions?: ResolutionString[];
+ /**
+ * Supported unit groups. Each group can have several unit objects.
+ *
+ * @example
+ * ```javascript
+ * {
+ * weight: [
+ * { id: 'kg', name: 'kg', description: 'Kilograms' },
+ * { id: 'lb', name: 'lb', description: 'Pounds'},
+ * ]
+ * }
+ * ```
+ */
+ units?: Record;
+ /**
+ * Supported currencies for currency conversion.
+ *
+ * When a currency code is supplied as a string then the library will automatically convert it to `{ id: value, code: value }` object.
+ *
+ * @example `["USD", "EUR", "GBP"]`
+ * @example `[{ id: "USD", code: "USD", description: "$" }, { id: "EUR", code: "EUR", description: "€" }]`
+ */
+ currency_codes?: (string | CurrencyItem)[];
+ /** Does the datafeed supports marks on bars (`true`), or not (`false | undefined`). */
+ supports_marks?: boolean;
+ /** Set this one to `true` if your datafeed provides server time (unix time). It is used to adjust Countdown on the Price scale. */
+ supports_time?: boolean;
+ /** Does the datafeed supports marks on the timescale (`true`), or not (`false | undefined`). */
+ supports_timescale_marks?: boolean;
+ /**
+ * List of filter descriptors.
+ *
+ * Setting this property to `undefined` or an empty array leads to the absence of filter types in Symbol Search list. Use `value = ''` if you wish to include all filter types.
+ * `value` within the descriptor will be passed as `symbolType` argument to {@link IDatafeedChartApi.searchSymbols}
+ */
+ symbols_types?: DatafeedSymbolType[];
+ /**
+ * Set it if you want to group symbols in the [Symbol Search](https://www.tradingview.com/charting-library-docs/latest/ui_elements/Symbol-Search.md).
+ * Represents an object where keys are symbol types {@link SymbolType} and values are regular expressions (each regular expression should divide an instrument name into 2 parts: a root and an expiration).
+ *
+ * Sample:
+ * ```
+ * {
+ * "futures": `/^(.+)([12]!|[FGHJKMNQUVXZ]\d{1,2})$/`,
+ * "stock": `/^(.+)([12]!|[FGHJKMNQUVXZ]\d{1,2})$/`,
+ * }
+ * ```
+ * It will be applied to the instruments with futures and stock as a type.
+ * Refer to [Symbol grouping](https://www.tradingview.com/charting-library-docs/latest/ui_elements/Symbol-Search.md#symbol-grouping) for more information.
+ */
+ symbols_grouping?: Record;
+}
+/** Symbol Quote Data Value */
+export interface DatafeedQuoteValues {
+ /** Price change (usually counts as an open price on a particular day) */
+ ch?: number;
+ /** Price change percentage */
+ chp?: number;
+ /** Short name for the symbol */
+ short_name?: string;
+ /** The name of the exchange */
+ exchange?: string;
+ /** A short description of the symbol */
+ description?: string;
+ /** Last traded price */
+ lp?: number;
+ /** Ask price */
+ ask?: number;
+ /** Bid price */
+ bid?: number;
+ /** Spread (difference between the ask and bid prices) */
+ spread?: number;
+ /** Today's opening price */
+ open_price?: number;
+ /** Today's high price */
+ high_price?: number;
+ /** Today's low price */
+ low_price?: number;
+ /** Yesterday's closing price */
+ prev_close_price?: number;
+ /** Today's trading volume */
+ volume?: number;
+ /** Original name */
+ original_name?: string;
+ [valueName: string]: string | number | string[] | number[] | undefined;
+}
+export interface DatafeedSymbolType {
+ /** Name of the symbol type */
+ name: string;
+ /** Value to be passed as the `symbolType` argument to `searchSymbols` */
+ value: string;
+}
+export interface DefaultContextMenuActionsParams {}
+export interface DefaultDropdownActionsParams {
+ /** Show trading properties */
+ tradingProperties?: boolean;
+ /** Restore confirmations */
+ restoreConfirmations?: boolean;
+}
+export interface DialogParams {
+ /** Dialog title */
+ title: string;
+ /** Dialog content */
+ body: string;
+ /** Callback */
+ callback: CallbackType;
+}
+/**
+ * Override properties for the Disjointangle drawing tool.
+ */
+export interface DisjointangleLineToolOverrides {
+ /** Default value: `rgba(8, 153, 129, 0.2)` */
+ 'linetooldisjointangle.backgroundColor': string;
+ /** Default value: `false` */
+ 'linetooldisjointangle.bold': boolean;
+ /** Default value: `false` */
+ 'linetooldisjointangle.extendLeft': boolean;
+ /** Default value: `false` */
+ 'linetooldisjointangle.extendRight': boolean;
+ /** Default value: `true` */
+ 'linetooldisjointangle.fillBackground': boolean;
+ /** Default value: `12` */
+ 'linetooldisjointangle.fontsize': number;
+ /** Default value: `false` */
+ 'linetooldisjointangle.italic': boolean;
+ /** Default value: `false` */
+ 'linetooldisjointangle.labelBold': boolean;
+ /** Default value: `14` */
+ 'linetooldisjointangle.labelFontSize': number;
+ /** Default value: `left` */
+ 'linetooldisjointangle.labelHorzAlign': string;
+ /** Default value: `false` */
+ 'linetooldisjointangle.labelItalic': boolean;
+ /** Default value: `#089981` */
+ 'linetooldisjointangle.labelTextColor': string;
+ /** Default value: `bottom` */
+ 'linetooldisjointangle.labelVertAlign': string;
+ /** Default value: `false` */
+ 'linetooldisjointangle.labelVisible': boolean;
+ /** Default value: `0` */
+ 'linetooldisjointangle.leftEnd': number;
+ /** Default value: `#089981` */
+ 'linetooldisjointangle.linecolor': string;
+ /** Default value: `0` */
+ 'linetooldisjointangle.linestyle': number;
+ /** Default value: `2` */
+ 'linetooldisjointangle.linewidth': number;
+ /** Default value: `0` */
+ 'linetooldisjointangle.rightEnd': number;
+ /** Default value: `false` */
+ 'linetooldisjointangle.showBarsRange': boolean;
+ /** Default value: `false` */
+ 'linetooldisjointangle.showDateTimeRange': boolean;
+ /** Default value: `false` */
+ 'linetooldisjointangle.showPriceRange': boolean;
+ /** Default value: `false` */
+ 'linetooldisjointangle.showPrices': boolean;
+ /** Default value: `#089981` */
+ 'linetooldisjointangle.textcolor': string;
+ /** Default value: `20` */
+ 'linetooldisjointangle.transparency': number;
+}
+/** Item within a dropdown menu */
+export interface DropdownItem {
+ /** Title of the menu item */
+ title: string;
+ /** Callback for when the item is selected by the user */
+ onSelect: () => void;
+}
+/** Parameters for configuring a dropdown menu */
+export interface DropdownParams {
+ /** Title for the dropdown menu */
+ title: string;
+ /** Menu items */
+ items: DropdownItem[];
+ /** Dropdown menu tooltip */
+ tooltip?: string;
+ /** Icons for the dropdown menu. (SVG mark-up) */
+ icon?: string;
+ /** Alignment of the dropdown menu */
+ align?: 'right' | 'left';
+}
+export interface EditObjectDialogEventParams {
+ /** Dialog type */
+ objectType: EditObjectDialogObjectType;
+ /** Title of the object described within the dialog */
+ scriptTitle: string;
+}
+/**
+ * Override properties for the Elliottcorrection drawing tool.
+ */
+export interface ElliottcorrectionLineToolOverrides {
+ /** Default value: `#3d85c6` */
+ 'linetoolelliottcorrection.color': string;
+ /** Default value: `7` */
+ 'linetoolelliottcorrection.degree': number;
+ /** Default value: `2` */
+ 'linetoolelliottcorrection.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolelliottcorrection.showWave': boolean;
+}
+/**
+ * Override properties for the Elliottdoublecombo drawing tool.
+ */
+export interface ElliottdoublecomboLineToolOverrides {
+ /** Default value: `#6aa84f` */
+ 'linetoolelliottdoublecombo.color': string;
+ /** Default value: `7` */
+ 'linetoolelliottdoublecombo.degree': number;
+ /** Default value: `2` */
+ 'linetoolelliottdoublecombo.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolelliottdoublecombo.showWave': boolean;
+}
+/**
+ * Override properties for the Elliottimpulse drawing tool.
+ */
+export interface ElliottimpulseLineToolOverrides {
+ /** Default value: `#3d85c6` */
+ 'linetoolelliottimpulse.color': string;
+ /** Default value: `7` */
+ 'linetoolelliottimpulse.degree': number;
+ /** Default value: `2` */
+ 'linetoolelliottimpulse.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolelliottimpulse.showWave': boolean;
+}
+/**
+ * Override properties for the Elliotttriangle drawing tool.
+ */
+export interface ElliotttriangleLineToolOverrides {
+ /** Default value: `#FF9800` */
+ 'linetoolelliotttriangle.color': string;
+ /** Default value: `7` */
+ 'linetoolelliotttriangle.degree': number;
+ /** Default value: `2` */
+ 'linetoolelliotttriangle.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolelliotttriangle.showWave': boolean;
+}
+/**
+ * Override properties for the Elliotttriplecombo drawing tool.
+ */
+export interface ElliotttriplecomboLineToolOverrides {
+ /** Default value: `#6aa84f` */
+ 'linetoolelliotttriplecombo.color': string;
+ /** Default value: `7` */
+ 'linetoolelliotttriplecombo.degree': number;
+ /** Default value: `2` */
+ 'linetoolelliotttriplecombo.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolelliotttriplecombo.showWave': boolean;
+}
+/**
+ * Override properties for the Ellipse drawing tool.
+ */
+export interface EllipseLineToolOverrides {
+ /** Default value: `rgba(242, 54, 69, 0.2)` */
+ 'linetoolellipse.backgroundColor': string;
+ /** Default value: `false` */
+ 'linetoolellipse.bold': boolean;
+ /** Default value: `#F23645` */
+ 'linetoolellipse.color': string;
+ /** Default value: `true` */
+ 'linetoolellipse.fillBackground': boolean;
+ /** Default value: `14` */
+ 'linetoolellipse.fontSize': number;
+ /** Default value: `false` */
+ 'linetoolellipse.italic': boolean;
+ /** Default value: `2` */
+ 'linetoolellipse.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolellipse.showLabel': boolean;
+ /** Default value: `#F23645` */
+ 'linetoolellipse.textColor': string;
+ /** Default value: `50` */
+ 'linetoolellipse.transparency': number;
+}
+/**
+ * Override properties for the Emoji drawing tool.
+ */
+export interface EmojiLineToolOverrides {
+ /** Default value: `1.5707963267948966` */
+ 'linetoolemoji.angle': number;
+ /** Default value: `😀` */
+ 'linetoolemoji.emoji': string;
+ /** Default value: `40` */
+ 'linetoolemoji.size': number;
+}
+export interface EmojiOptions {
+ /** Emoji */
+ emoji: string;
+}
+export interface EntityInfo {
+ /** Entity id (string) */
+ id: EntityId;
+ /** Name of entity */
+ name: string;
+}
+export interface ErrorFormatterParseResult extends FormatterParseResult {
+ /** Optional message when there's an error while parsing */
+ error?: string;
+ /** @inheritDoc */
+ res: false;
+}
+/** Exchange Description */
+export interface Exchange {
+ /** Value to be passed as the `exchange` argument to `searchSymbols` */
+ value: string;
+ /** Name of the exchange */
+ name: string;
+ /** Description of the exchange */
+ desc: string;
+}
+/**
+ * Describes a single execution.
+ * Execution is when a buy or sell order is completed for a financial instrument.
+ */
+export interface Execution extends CustomFields {
+ /** Symbol name */
+ symbol: string;
+ /** Execution price */
+ price: number;
+ /** Execution Quantity */
+ qty: number;
+ /** Execution Side */
+ side: Side;
+ /** Time (unix timestamp in milliseconds) */
+ time: number;
+ /** Commission amount for executed trade */
+ commission?: number;
+ /** Net amount for executed trade */
+ netAmount?: number;
+}
+/**
+ * Override properties for the Execution drawing tool.
+ */
+export interface ExecutionLineToolOverrides {
+ /** Default value: `#4094e8` */
+ 'linetoolexecution.arrowBuyColor': string;
+ /** Default value: `8` */
+ 'linetoolexecution.arrowHeight': number;
+ /** Default value: `#e75656` */
+ 'linetoolexecution.arrowSellColor': string;
+ /** Default value: `1` */
+ 'linetoolexecution.arrowSpacing': number;
+ /** Default value: `buy` */
+ 'linetoolexecution.direction': string;
+ /** Default value: `false` */
+ 'linetoolexecution.fontBold': boolean;
+ /** Default value: `Verdana` */
+ 'linetoolexecution.fontFamily': string;
+ /** Default value: `false` */
+ 'linetoolexecution.fontItalic': boolean;
+ /** Default value: `10` */
+ 'linetoolexecution.fontSize': number;
+ /** Default value: `` */
+ 'linetoolexecution.text': string;
+ /** Default value: `#000000` */
+ 'linetoolexecution.textColor': string;
+ /** Default value: `0` */
+ 'linetoolexecution.textTransparency': number;
+ /** Default value: `` */
+ 'linetoolexecution.tooltip': string;
+}
+export interface ExportDataOptions {
+ /**
+ * Optional timestamp of the first exported bar.
+ */
+ from?: number;
+ /**
+ * Optional timestamp of the last exported bar.
+ */
+ to?: number;
+ /**
+ * If true then each exported data item will include a time value.
+ *
+ * @default true
+ */
+ includeTime?: boolean;
+ /**
+ * If true then each exported data item will include a user time value.
+ * User time is the time that user sees on the chart.
+ * This time depends on the selected time zone and resolution.
+ *
+ * @default false
+ */
+ includeUserTime?: boolean;
+ /**
+ * If true then the exported data will include open, high, low, close values from the main series.
+ *
+ * @default true
+ */
+ includeSeries?: boolean;
+ /**
+ * If true then the exported data will include formatted value as displayed to the user.
+ *
+ * @default false
+ */
+ includeDisplayedValues?: boolean;
+ /**
+ * If true then each exported data item will include a value for the specified studies.
+ */
+ includedStudies: readonly string[] | 'all';
+ /**
+ * Include study data that has a positive offset from the main series data. That is study data that is "to the right of" the last main series data point.
+ */
+ includeOffsetStudyValues?: boolean;
+}
+/**
+ * Export data from the chart
+ */
+export interface ExportedData {
+ /** An array of {@link FieldDescriptor} */
+ schema: FieldDescriptor[];
+ /** Array of the same length as `schema` that represents the associated field's item */
+ data: Float64Array[];
+ /** Array of strings that represents the display value of the associated field element */
+ displayedData: string[][];
+}
+/**
+ * Override properties for the Extended drawing tool.
+ */
+export interface ExtendedLineToolOverrides {
+ /** Default value: `false` */
+ 'linetoolextended.alwaysShowStats': boolean;
+ /** Default value: `false` */
+ 'linetoolextended.bold': boolean;
+ /** Default value: `true` */
+ 'linetoolextended.extendLeft': boolean;
+ /** Default value: `true` */
+ 'linetoolextended.extendRight': boolean;
+ /** Default value: `14` */
+ 'linetoolextended.fontsize': number;
+ /** Default value: `center` */
+ 'linetoolextended.horzLabelsAlign': string;
+ /** Default value: `false` */
+ 'linetoolextended.italic': boolean;
+ /** Default value: `0` */
+ 'linetoolextended.leftEnd': number;
+ /** Default value: `#2962FF` */
+ 'linetoolextended.linecolor': string;
+ /** Default value: `0` */
+ 'linetoolextended.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolextended.linewidth': number;
+ /** Default value: `0` */
+ 'linetoolextended.rightEnd': number;
+ /** Default value: `false` */
+ 'linetoolextended.showAngle': boolean;
+ /** Default value: `false` */
+ 'linetoolextended.showBarsRange': boolean;
+ /** Default value: `false` */
+ 'linetoolextended.showDateTimeRange': boolean;
+ /** Default value: `false` */
+ 'linetoolextended.showDistance': boolean;
+ /** Default value: `false` */
+ 'linetoolextended.showLabel': boolean;
+ /** Default value: `false` */
+ 'linetoolextended.showMiddlePoint': boolean;
+ /** Default value: `false` */
+ 'linetoolextended.showPercentPriceRange': boolean;
+ /** Default value: `false` */
+ 'linetoolextended.showPipsPriceRange': boolean;
+ /** Default value: `false` */
+ 'linetoolextended.showPriceLabels': boolean;
+ /** Default value: `false` */
+ 'linetoolextended.showPriceRange': boolean;
+ /** Default value: `2` */
+ 'linetoolextended.statsPosition': number;
+ /** Default value: `#2962FF` */
+ 'linetoolextended.textcolor': string;
+ /** Default value: `bottom` */
+ 'linetoolextended.vertLabelsAlign': string;
+}
+/**
+ * Favorites which can be defined within the Widget Constructor options (see {@link ChartingLibraryWidgetOptions.favorites}).
+ */
+export interface Favorites {
+ /**
+ * An array of time intervals that are marked as favorite.
+ *
+ * Example: `["D", "2D"]`
+ */
+ intervals?: ResolutionString[];
+ /**
+ * An array of indicator titles that are marked as favorite.
+ * The names of indicators are identical to the `title` property of the indicator. For built-in indicators
+ * this will match the chart UI in the English version.
+ *
+ * Example: `["Awesome Oscillator", "Bollinger Bands"]`.
+ */
+ indicators?: string[];
+ /**
+ * An array of chart types that are marked as favorite.
+ * The names of chart types are listed within the {@link ChartTypeFavorites} or {@link TradingTerminalChartTypeFavorites} type.
+ *
+ * Example: `["Area", "Candles"]`.
+ */
+ chartTypes?: TChartTypeFavorites[];
+ /**
+ * An array of drawing tool identifiers that should be marked as favorite. These will only
+ * be applied if there aren't existing favorites.
+ *
+ * Example: ['LineToolBrush', 'LineToolCallout', 'LineToolCircle']
+ */
+ drawingTools?: DrawingToolIdentifier[];
+}
+/**
+ * Override properties for the Fibchannel drawing tool.
+ */
+export interface FibchannelLineToolOverrides {
+ /** Default value: `false` */
+ 'linetoolfibchannel.coeffsAsPercents': boolean;
+ /** Default value: `false` */
+ 'linetoolfibchannel.extendLeft': boolean;
+ /** Default value: `false` */
+ 'linetoolfibchannel.extendRight': boolean;
+ /** Default value: `true` */
+ 'linetoolfibchannel.fillBackground': boolean;
+ /** Default value: `left` */
+ 'linetoolfibchannel.horzLabelsAlign': string;
+ /** Default value: `12` */
+ 'linetoolfibchannel.labelFontSize': number;
+ /** Default value: `0` */
+ 'linetoolfibchannel.level1.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolfibchannel.level1.color': string;
+ /** Default value: `true` */
+ 'linetoolfibchannel.level1.visible': boolean;
+ /** Default value: `3.618` */
+ 'linetoolfibchannel.level10.coeff': number;
+ /** Default value: `#9c27b0` */
+ 'linetoolfibchannel.level10.color': string;
+ /** Default value: `true` */
+ 'linetoolfibchannel.level10.visible': boolean;
+ /** Default value: `4.236` */
+ 'linetoolfibchannel.level11.coeff': number;
+ /** Default value: `#e91e63` */
+ 'linetoolfibchannel.level11.color': string;
+ /** Default value: `true` */
+ 'linetoolfibchannel.level11.visible': boolean;
+ /** Default value: `1.272` */
+ 'linetoolfibchannel.level12.coeff': number;
+ /** Default value: `#FF9800` */
+ 'linetoolfibchannel.level12.color': string;
+ /** Default value: `false` */
+ 'linetoolfibchannel.level12.visible': boolean;
+ /** Default value: `1.414` */
+ 'linetoolfibchannel.level13.coeff': number;
+ /** Default value: `#F23645` */
+ 'linetoolfibchannel.level13.color': string;
+ /** Default value: `false` */
+ 'linetoolfibchannel.level13.visible': boolean;
+ /** Default value: `2.272` */
+ 'linetoolfibchannel.level14.coeff': number;
+ /** Default value: `#FF9800` */
+ 'linetoolfibchannel.level14.color': string;
+ /** Default value: `false` */
+ 'linetoolfibchannel.level14.visible': boolean;
+ /** Default value: `2.414` */
+ 'linetoolfibchannel.level15.coeff': number;
+ /** Default value: `#4caf50` */
+ 'linetoolfibchannel.level15.color': string;
+ /** Default value: `false` */
+ 'linetoolfibchannel.level15.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolfibchannel.level16.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolfibchannel.level16.color': string;
+ /** Default value: `false` */
+ 'linetoolfibchannel.level16.visible': boolean;
+ /** Default value: `3` */
+ 'linetoolfibchannel.level17.coeff': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolfibchannel.level17.color': string;
+ /** Default value: `false` */
+ 'linetoolfibchannel.level17.visible': boolean;
+ /** Default value: `3.272` */
+ 'linetoolfibchannel.level18.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolfibchannel.level18.color': string;
+ /** Default value: `false` */
+ 'linetoolfibchannel.level18.visible': boolean;
+ /** Default value: `3.414` */
+ 'linetoolfibchannel.level19.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibchannel.level19.color': string;
+ /** Default value: `false` */
+ 'linetoolfibchannel.level19.visible': boolean;
+ /** Default value: `0.236` */
+ 'linetoolfibchannel.level2.coeff': number;
+ /** Default value: `#F23645` */
+ 'linetoolfibchannel.level2.color': string;
+ /** Default value: `true` */
+ 'linetoolfibchannel.level2.visible': boolean;
+ /** Default value: `4` */
+ 'linetoolfibchannel.level20.coeff': number;
+ /** Default value: `#F23645` */
+ 'linetoolfibchannel.level20.color': string;
+ /** Default value: `false` */
+ 'linetoolfibchannel.level20.visible': boolean;
+ /** Default value: `4.272` */
+ 'linetoolfibchannel.level21.coeff': number;
+ /** Default value: `#9c27b0` */
+ 'linetoolfibchannel.level21.color': string;
+ /** Default value: `false` */
+ 'linetoolfibchannel.level21.visible': boolean;
+ /** Default value: `4.414` */
+ 'linetoolfibchannel.level22.coeff': number;
+ /** Default value: `#e91e63` */
+ 'linetoolfibchannel.level22.color': string;
+ /** Default value: `false` */
+ 'linetoolfibchannel.level22.visible': boolean;
+ /** Default value: `4.618` */
+ 'linetoolfibchannel.level23.coeff': number;
+ /** Default value: `#FF9800` */
+ 'linetoolfibchannel.level23.color': string;
+ /** Default value: `false` */
+ 'linetoolfibchannel.level23.visible': boolean;
+ /** Default value: `4.764` */
+ 'linetoolfibchannel.level24.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolfibchannel.level24.color': string;
+ /** Default value: `false` */
+ 'linetoolfibchannel.level24.visible': boolean;
+ /** Default value: `0.382` */
+ 'linetoolfibchannel.level3.coeff': number;
+ /** Default value: `#FF9800` */
+ 'linetoolfibchannel.level3.color': string;
+ /** Default value: `true` */
+ 'linetoolfibchannel.level3.visible': boolean;
+ /** Default value: `0.5` */
+ 'linetoolfibchannel.level4.coeff': number;
+ /** Default value: `#4caf50` */
+ 'linetoolfibchannel.level4.color': string;
+ /** Default value: `true` */
+ 'linetoolfibchannel.level4.visible': boolean;
+ /** Default value: `0.618` */
+ 'linetoolfibchannel.level5.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolfibchannel.level5.color': string;
+ /** Default value: `true` */
+ 'linetoolfibchannel.level5.visible': boolean;
+ /** Default value: `0.786` */
+ 'linetoolfibchannel.level6.coeff': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolfibchannel.level6.color': string;
+ /** Default value: `true` */
+ 'linetoolfibchannel.level6.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolfibchannel.level7.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolfibchannel.level7.color': string;
+ /** Default value: `true` */
+ 'linetoolfibchannel.level7.visible': boolean;
+ /** Default value: `1.618` */
+ 'linetoolfibchannel.level8.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibchannel.level8.color': string;
+ /** Default value: `true` */
+ 'linetoolfibchannel.level8.visible': boolean;
+ /** Default value: `2.618` */
+ 'linetoolfibchannel.level9.coeff': number;
+ /** Default value: `#F23645` */
+ 'linetoolfibchannel.level9.color': string;
+ /** Default value: `true` */
+ 'linetoolfibchannel.level9.visible': boolean;
+ /** Default value: `0` */
+ 'linetoolfibchannel.levelsStyle.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibchannel.levelsStyle.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibchannel.showCoeffs': boolean;
+ /** Default value: `true` */
+ 'linetoolfibchannel.showPrices': boolean;
+ /** Default value: `80` */
+ 'linetoolfibchannel.transparency': number;
+ /** Default value: `middle` */
+ 'linetoolfibchannel.vertLabelsAlign': string;
+}
+/**
+ * Override properties for the Fibcircles drawing tool.
+ */
+export interface FibcirclesLineToolOverrides {
+ /** Default value: `false` */
+ 'linetoolfibcircles.coeffsAsPercents': boolean;
+ /** Default value: `true` */
+ 'linetoolfibcircles.fillBackground': boolean;
+ /** Default value: `0.236` */
+ 'linetoolfibcircles.level1.coeff': number;
+ /** Default value: `#F23645` */
+ 'linetoolfibcircles.level1.color': string;
+ /** Default value: `0` */
+ 'linetoolfibcircles.level1.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibcircles.level1.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibcircles.level1.visible': boolean;
+ /** Default value: `4.236` */
+ 'linetoolfibcircles.level10.coeff': number;
+ /** Default value: `#e91e63` */
+ 'linetoolfibcircles.level10.color': string;
+ /** Default value: `0` */
+ 'linetoolfibcircles.level10.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibcircles.level10.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibcircles.level10.visible': boolean;
+ /** Default value: `4.618` */
+ 'linetoolfibcircles.level11.coeff': number;
+ /** Default value: `#F23645` */
+ 'linetoolfibcircles.level11.color': string;
+ /** Default value: `0` */
+ 'linetoolfibcircles.level11.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibcircles.level11.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibcircles.level11.visible': boolean;
+ /** Default value: `0.382` */
+ 'linetoolfibcircles.level2.coeff': number;
+ /** Default value: `#FF9800` */
+ 'linetoolfibcircles.level2.color': string;
+ /** Default value: `0` */
+ 'linetoolfibcircles.level2.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibcircles.level2.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibcircles.level2.visible': boolean;
+ /** Default value: `0.5` */
+ 'linetoolfibcircles.level3.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolfibcircles.level3.color': string;
+ /** Default value: `0` */
+ 'linetoolfibcircles.level3.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibcircles.level3.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibcircles.level3.visible': boolean;
+ /** Default value: `0.618` */
+ 'linetoolfibcircles.level4.coeff': number;
+ /** Default value: `#4caf50` */
+ 'linetoolfibcircles.level4.color': string;
+ /** Default value: `0` */
+ 'linetoolfibcircles.level4.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibcircles.level4.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibcircles.level4.visible': boolean;
+ /** Default value: `0.786` */
+ 'linetoolfibcircles.level5.coeff': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolfibcircles.level5.color': string;
+ /** Default value: `0` */
+ 'linetoolfibcircles.level5.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibcircles.level5.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibcircles.level5.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolfibcircles.level6.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolfibcircles.level6.color': string;
+ /** Default value: `0` */
+ 'linetoolfibcircles.level6.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibcircles.level6.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibcircles.level6.visible': boolean;
+ /** Default value: `1.618` */
+ 'linetoolfibcircles.level7.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibcircles.level7.color': string;
+ /** Default value: `0` */
+ 'linetoolfibcircles.level7.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibcircles.level7.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibcircles.level7.visible': boolean;
+ /** Default value: `2.618` */
+ 'linetoolfibcircles.level8.coeff': number;
+ /** Default value: `#e91e63` */
+ 'linetoolfibcircles.level8.color': string;
+ /** Default value: `0` */
+ 'linetoolfibcircles.level8.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibcircles.level8.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibcircles.level8.visible': boolean;
+ /** Default value: `3.618` */
+ 'linetoolfibcircles.level9.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibcircles.level9.color': string;
+ /** Default value: `0` */
+ 'linetoolfibcircles.level9.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibcircles.level9.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibcircles.level9.visible': boolean;
+ /** Default value: `true` */
+ 'linetoolfibcircles.showCoeffs': boolean;
+ /** Default value: `80` */
+ 'linetoolfibcircles.transparency': number;
+ /** Default value: `#787B86` */
+ 'linetoolfibcircles.trendline.color': string;
+ /** Default value: `2` */
+ 'linetoolfibcircles.trendline.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibcircles.trendline.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibcircles.trendline.visible': boolean;
+}
+/**
+ * Override properties for the Fibretracement drawing tool.
+ */
+export interface FibretracementLineToolOverrides {
+ /** Default value: `false` */
+ 'linetoolfibretracement.coeffsAsPercents': boolean;
+ /** Default value: `false` */
+ 'linetoolfibretracement.extendLines': boolean;
+ /** Default value: `false` */
+ 'linetoolfibretracement.extendLinesLeft': boolean;
+ /** Default value: `false` */
+ 'linetoolfibretracement.fibLevelsBasedOnLogScale': boolean;
+ /** Default value: `true` */
+ 'linetoolfibretracement.fillBackground': boolean;
+ /** Default value: `left` */
+ 'linetoolfibretracement.horzLabelsAlign': string;
+ /** Default value: `12` */
+ 'linetoolfibretracement.labelFontSize': number;
+ /** Default value: `0` */
+ 'linetoolfibretracement.level1.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolfibretracement.level1.color': string;
+ /** Default value: `true` */
+ 'linetoolfibretracement.level1.visible': boolean;
+ /** Default value: `3.618` */
+ 'linetoolfibretracement.level10.coeff': number;
+ /** Default value: `#9c27b0` */
+ 'linetoolfibretracement.level10.color': string;
+ /** Default value: `true` */
+ 'linetoolfibretracement.level10.visible': boolean;
+ /** Default value: `4.236` */
+ 'linetoolfibretracement.level11.coeff': number;
+ /** Default value: `#e91e63` */
+ 'linetoolfibretracement.level11.color': string;
+ /** Default value: `true` */
+ 'linetoolfibretracement.level11.visible': boolean;
+ /** Default value: `1.272` */
+ 'linetoolfibretracement.level12.coeff': number;
+ /** Default value: `#FF9800` */
+ 'linetoolfibretracement.level12.color': string;
+ /** Default value: `false` */
+ 'linetoolfibretracement.level12.visible': boolean;
+ /** Default value: `1.414` */
+ 'linetoolfibretracement.level13.coeff': number;
+ /** Default value: `#F23645` */
+ 'linetoolfibretracement.level13.color': string;
+ /** Default value: `false` */
+ 'linetoolfibretracement.level13.visible': boolean;
+ /** Default value: `2.272` */
+ 'linetoolfibretracement.level14.coeff': number;
+ /** Default value: `#FF9800` */
+ 'linetoolfibretracement.level14.color': string;
+ /** Default value: `false` */
+ 'linetoolfibretracement.level14.visible': boolean;
+ /** Default value: `2.414` */
+ 'linetoolfibretracement.level15.coeff': number;
+ /** Default value: `#4caf50` */
+ 'linetoolfibretracement.level15.color': string;
+ /** Default value: `false` */
+ 'linetoolfibretracement.level15.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolfibretracement.level16.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolfibretracement.level16.color': string;
+ /** Default value: `false` */
+ 'linetoolfibretracement.level16.visible': boolean;
+ /** Default value: `3` */
+ 'linetoolfibretracement.level17.coeff': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolfibretracement.level17.color': string;
+ /** Default value: `false` */
+ 'linetoolfibretracement.level17.visible': boolean;
+ /** Default value: `3.272` */
+ 'linetoolfibretracement.level18.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolfibretracement.level18.color': string;
+ /** Default value: `false` */
+ 'linetoolfibretracement.level18.visible': boolean;
+ /** Default value: `3.414` */
+ 'linetoolfibretracement.level19.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibretracement.level19.color': string;
+ /** Default value: `false` */
+ 'linetoolfibretracement.level19.visible': boolean;
+ /** Default value: `0.236` */
+ 'linetoolfibretracement.level2.coeff': number;
+ /** Default value: `#F23645` */
+ 'linetoolfibretracement.level2.color': string;
+ /** Default value: `true` */
+ 'linetoolfibretracement.level2.visible': boolean;
+ /** Default value: `4` */
+ 'linetoolfibretracement.level20.coeff': number;
+ /** Default value: `#F23645` */
+ 'linetoolfibretracement.level20.color': string;
+ /** Default value: `false` */
+ 'linetoolfibretracement.level20.visible': boolean;
+ /** Default value: `4.272` */
+ 'linetoolfibretracement.level21.coeff': number;
+ /** Default value: `#9c27b0` */
+ 'linetoolfibretracement.level21.color': string;
+ /** Default value: `false` */
+ 'linetoolfibretracement.level21.visible': boolean;
+ /** Default value: `4.414` */
+ 'linetoolfibretracement.level22.coeff': number;
+ /** Default value: `#e91e63` */
+ 'linetoolfibretracement.level22.color': string;
+ /** Default value: `false` */
+ 'linetoolfibretracement.level22.visible': boolean;
+ /** Default value: `4.618` */
+ 'linetoolfibretracement.level23.coeff': number;
+ /** Default value: `#FF9800` */
+ 'linetoolfibretracement.level23.color': string;
+ /** Default value: `false` */
+ 'linetoolfibretracement.level23.visible': boolean;
+ /** Default value: `4.764` */
+ 'linetoolfibretracement.level24.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolfibretracement.level24.color': string;
+ /** Default value: `false` */
+ 'linetoolfibretracement.level24.visible': boolean;
+ /** Default value: `0.382` */
+ 'linetoolfibretracement.level3.coeff': number;
+ /** Default value: `#FF9800` */
+ 'linetoolfibretracement.level3.color': string;
+ /** Default value: `true` */
+ 'linetoolfibretracement.level3.visible': boolean;
+ /** Default value: `0.5` */
+ 'linetoolfibretracement.level4.coeff': number;
+ /** Default value: `#4caf50` */
+ 'linetoolfibretracement.level4.color': string;
+ /** Default value: `true` */
+ 'linetoolfibretracement.level4.visible': boolean;
+ /** Default value: `0.618` */
+ 'linetoolfibretracement.level5.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolfibretracement.level5.color': string;
+ /** Default value: `true` */
+ 'linetoolfibretracement.level5.visible': boolean;
+ /** Default value: `0.786` */
+ 'linetoolfibretracement.level6.coeff': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolfibretracement.level6.color': string;
+ /** Default value: `true` */
+ 'linetoolfibretracement.level6.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolfibretracement.level7.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolfibretracement.level7.color': string;
+ /** Default value: `true` */
+ 'linetoolfibretracement.level7.visible': boolean;
+ /** Default value: `1.618` */
+ 'linetoolfibretracement.level8.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibretracement.level8.color': string;
+ /** Default value: `true` */
+ 'linetoolfibretracement.level8.visible': boolean;
+ /** Default value: `2.618` */
+ 'linetoolfibretracement.level9.coeff': number;
+ /** Default value: `#F23645` */
+ 'linetoolfibretracement.level9.color': string;
+ /** Default value: `true` */
+ 'linetoolfibretracement.level9.visible': boolean;
+ /** Default value: `0` */
+ 'linetoolfibretracement.levelsStyle.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibretracement.levelsStyle.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolfibretracement.reverse': boolean;
+ /** Default value: `true` */
+ 'linetoolfibretracement.showCoeffs': boolean;
+ /** Default value: `true` */
+ 'linetoolfibretracement.showPrices': boolean;
+ /** Default value: `80` */
+ 'linetoolfibretracement.transparency': number;
+ /** Default value: `#787B86` */
+ 'linetoolfibretracement.trendline.color': string;
+ /** Default value: `2` */
+ 'linetoolfibretracement.trendline.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibretracement.trendline.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibretracement.trendline.visible': boolean;
+ /** Default value: `bottom` */
+ 'linetoolfibretracement.vertLabelsAlign': string;
+}
+/**
+ * Override properties for the Fibspeedresistancearcs drawing tool.
+ */
+export interface FibspeedresistancearcsLineToolOverrides {
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancearcs.fillBackground': boolean;
+ /** Default value: `false` */
+ 'linetoolfibspeedresistancearcs.fullCircles': boolean;
+ /** Default value: `0.236` */
+ 'linetoolfibspeedresistancearcs.level1.coeff': number;
+ /** Default value: `#F23645` */
+ 'linetoolfibspeedresistancearcs.level1.color': string;
+ /** Default value: `0` */
+ 'linetoolfibspeedresistancearcs.level1.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibspeedresistancearcs.level1.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancearcs.level1.visible': boolean;
+ /** Default value: `4.236` */
+ 'linetoolfibspeedresistancearcs.level10.coeff': number;
+ /** Default value: `#e91e63` */
+ 'linetoolfibspeedresistancearcs.level10.color': string;
+ /** Default value: `0` */
+ 'linetoolfibspeedresistancearcs.level10.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibspeedresistancearcs.level10.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancearcs.level10.visible': boolean;
+ /** Default value: `4.618` */
+ 'linetoolfibspeedresistancearcs.level11.coeff': number;
+ /** Default value: `#F23645` */
+ 'linetoolfibspeedresistancearcs.level11.color': string;
+ /** Default value: `0` */
+ 'linetoolfibspeedresistancearcs.level11.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibspeedresistancearcs.level11.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancearcs.level11.visible': boolean;
+ /** Default value: `0.382` */
+ 'linetoolfibspeedresistancearcs.level2.coeff': number;
+ /** Default value: `#FF9800` */
+ 'linetoolfibspeedresistancearcs.level2.color': string;
+ /** Default value: `0` */
+ 'linetoolfibspeedresistancearcs.level2.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibspeedresistancearcs.level2.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancearcs.level2.visible': boolean;
+ /** Default value: `0.5` */
+ 'linetoolfibspeedresistancearcs.level3.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolfibspeedresistancearcs.level3.color': string;
+ /** Default value: `0` */
+ 'linetoolfibspeedresistancearcs.level3.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibspeedresistancearcs.level3.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancearcs.level3.visible': boolean;
+ /** Default value: `0.618` */
+ 'linetoolfibspeedresistancearcs.level4.coeff': number;
+ /** Default value: `#4caf50` */
+ 'linetoolfibspeedresistancearcs.level4.color': string;
+ /** Default value: `0` */
+ 'linetoolfibspeedresistancearcs.level4.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibspeedresistancearcs.level4.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancearcs.level4.visible': boolean;
+ /** Default value: `0.786` */
+ 'linetoolfibspeedresistancearcs.level5.coeff': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolfibspeedresistancearcs.level5.color': string;
+ /** Default value: `0` */
+ 'linetoolfibspeedresistancearcs.level5.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibspeedresistancearcs.level5.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancearcs.level5.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolfibspeedresistancearcs.level6.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolfibspeedresistancearcs.level6.color': string;
+ /** Default value: `0` */
+ 'linetoolfibspeedresistancearcs.level6.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibspeedresistancearcs.level6.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancearcs.level6.visible': boolean;
+ /** Default value: `1.618` */
+ 'linetoolfibspeedresistancearcs.level7.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibspeedresistancearcs.level7.color': string;
+ /** Default value: `0` */
+ 'linetoolfibspeedresistancearcs.level7.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibspeedresistancearcs.level7.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancearcs.level7.visible': boolean;
+ /** Default value: `2.618` */
+ 'linetoolfibspeedresistancearcs.level8.coeff': number;
+ /** Default value: `#e91e63` */
+ 'linetoolfibspeedresistancearcs.level8.color': string;
+ /** Default value: `0` */
+ 'linetoolfibspeedresistancearcs.level8.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibspeedresistancearcs.level8.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancearcs.level8.visible': boolean;
+ /** Default value: `3.618` */
+ 'linetoolfibspeedresistancearcs.level9.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibspeedresistancearcs.level9.color': string;
+ /** Default value: `0` */
+ 'linetoolfibspeedresistancearcs.level9.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibspeedresistancearcs.level9.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancearcs.level9.visible': boolean;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancearcs.showCoeffs': boolean;
+ /** Default value: `80` */
+ 'linetoolfibspeedresistancearcs.transparency': number;
+ /** Default value: `#787B86` */
+ 'linetoolfibspeedresistancearcs.trendline.color': string;
+ /** Default value: `2` */
+ 'linetoolfibspeedresistancearcs.trendline.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibspeedresistancearcs.trendline.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancearcs.trendline.visible': boolean;
+}
+/**
+ * Override properties for the Fibspeedresistancefan drawing tool.
+ */
+export interface FibspeedresistancefanLineToolOverrides {
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.fillBackground': boolean;
+ /** Default value: `rgba(21, 56, 153, 0.8)` */
+ 'linetoolfibspeedresistancefan.grid.color': string;
+ /** Default value: `0` */
+ 'linetoolfibspeedresistancefan.grid.linestyle': number;
+ /** Default value: `1` */
+ 'linetoolfibspeedresistancefan.grid.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.grid.visible': boolean;
+ /** Default value: `0` */
+ 'linetoolfibspeedresistancefan.hlevel1.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolfibspeedresistancefan.hlevel1.color': string;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.hlevel1.visible': boolean;
+ /** Default value: `0.25` */
+ 'linetoolfibspeedresistancefan.hlevel2.coeff': number;
+ /** Default value: `#FF9800` */
+ 'linetoolfibspeedresistancefan.hlevel2.color': string;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.hlevel2.visible': boolean;
+ /** Default value: `0.382` */
+ 'linetoolfibspeedresistancefan.hlevel3.coeff': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolfibspeedresistancefan.hlevel3.color': string;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.hlevel3.visible': boolean;
+ /** Default value: `0.5` */
+ 'linetoolfibspeedresistancefan.hlevel4.coeff': number;
+ /** Default value: `#4caf50` */
+ 'linetoolfibspeedresistancefan.hlevel4.color': string;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.hlevel4.visible': boolean;
+ /** Default value: `0.618` */
+ 'linetoolfibspeedresistancefan.hlevel5.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolfibspeedresistancefan.hlevel5.color': string;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.hlevel5.visible': boolean;
+ /** Default value: `0.75` */
+ 'linetoolfibspeedresistancefan.hlevel6.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibspeedresistancefan.hlevel6.color': string;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.hlevel6.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolfibspeedresistancefan.hlevel7.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolfibspeedresistancefan.hlevel7.color': string;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.hlevel7.visible': boolean;
+ /** Default value: `0` */
+ 'linetoolfibspeedresistancefan.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibspeedresistancefan.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolfibspeedresistancefan.reverse': boolean;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.showBottomLabels': boolean;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.showLeftLabels': boolean;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.showRightLabels': boolean;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.showTopLabels': boolean;
+ /** Default value: `80` */
+ 'linetoolfibspeedresistancefan.transparency': number;
+ /** Default value: `0` */
+ 'linetoolfibspeedresistancefan.vlevel1.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolfibspeedresistancefan.vlevel1.color': string;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.vlevel1.visible': boolean;
+ /** Default value: `0.25` */
+ 'linetoolfibspeedresistancefan.vlevel2.coeff': number;
+ /** Default value: `#FF9800` */
+ 'linetoolfibspeedresistancefan.vlevel2.color': string;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.vlevel2.visible': boolean;
+ /** Default value: `0.382` */
+ 'linetoolfibspeedresistancefan.vlevel3.coeff': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolfibspeedresistancefan.vlevel3.color': string;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.vlevel3.visible': boolean;
+ /** Default value: `0.5` */
+ 'linetoolfibspeedresistancefan.vlevel4.coeff': number;
+ /** Default value: `#4caf50` */
+ 'linetoolfibspeedresistancefan.vlevel4.color': string;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.vlevel4.visible': boolean;
+ /** Default value: `0.618` */
+ 'linetoolfibspeedresistancefan.vlevel5.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolfibspeedresistancefan.vlevel5.color': string;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.vlevel5.visible': boolean;
+ /** Default value: `0.75` */
+ 'linetoolfibspeedresistancefan.vlevel6.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibspeedresistancefan.vlevel6.color': string;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.vlevel6.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolfibspeedresistancefan.vlevel7.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolfibspeedresistancefan.vlevel7.color': string;
+ /** Default value: `true` */
+ 'linetoolfibspeedresistancefan.vlevel7.visible': boolean;
+}
+/**
+ * Override properties for the Fibtimezone drawing tool.
+ */
+export interface FibtimezoneLineToolOverrides {
+ /** Default value: `#808080` */
+ 'linetoolfibtimezone.baselinecolor': string;
+ /** Default value: `false` */
+ 'linetoolfibtimezone.fillBackground': boolean;
+ /** Default value: `right` */
+ 'linetoolfibtimezone.horzLabelsAlign': string;
+ /** Default value: `0` */
+ 'linetoolfibtimezone.level1.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolfibtimezone.level1.color': string;
+ /** Default value: `0` */
+ 'linetoolfibtimezone.level1.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibtimezone.level1.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibtimezone.level1.visible': boolean;
+ /** Default value: `55` */
+ 'linetoolfibtimezone.level10.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibtimezone.level10.color': string;
+ /** Default value: `0` */
+ 'linetoolfibtimezone.level10.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibtimezone.level10.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibtimezone.level10.visible': boolean;
+ /** Default value: `89` */
+ 'linetoolfibtimezone.level11.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibtimezone.level11.color': string;
+ /** Default value: `0` */
+ 'linetoolfibtimezone.level11.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibtimezone.level11.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibtimezone.level11.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolfibtimezone.level2.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibtimezone.level2.color': string;
+ /** Default value: `0` */
+ 'linetoolfibtimezone.level2.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibtimezone.level2.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibtimezone.level2.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolfibtimezone.level3.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibtimezone.level3.color': string;
+ /** Default value: `0` */
+ 'linetoolfibtimezone.level3.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibtimezone.level3.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibtimezone.level3.visible': boolean;
+ /** Default value: `3` */
+ 'linetoolfibtimezone.level4.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibtimezone.level4.color': string;
+ /** Default value: `0` */
+ 'linetoolfibtimezone.level4.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibtimezone.level4.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibtimezone.level4.visible': boolean;
+ /** Default value: `5` */
+ 'linetoolfibtimezone.level5.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibtimezone.level5.color': string;
+ /** Default value: `0` */
+ 'linetoolfibtimezone.level5.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibtimezone.level5.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibtimezone.level5.visible': boolean;
+ /** Default value: `8` */
+ 'linetoolfibtimezone.level6.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibtimezone.level6.color': string;
+ /** Default value: `0` */
+ 'linetoolfibtimezone.level6.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibtimezone.level6.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibtimezone.level6.visible': boolean;
+ /** Default value: `13` */
+ 'linetoolfibtimezone.level7.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibtimezone.level7.color': string;
+ /** Default value: `0` */
+ 'linetoolfibtimezone.level7.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibtimezone.level7.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibtimezone.level7.visible': boolean;
+ /** Default value: `21` */
+ 'linetoolfibtimezone.level8.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibtimezone.level8.color': string;
+ /** Default value: `0` */
+ 'linetoolfibtimezone.level8.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibtimezone.level8.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibtimezone.level8.visible': boolean;
+ /** Default value: `34` */
+ 'linetoolfibtimezone.level9.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibtimezone.level9.color': string;
+ /** Default value: `0` */
+ 'linetoolfibtimezone.level9.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibtimezone.level9.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibtimezone.level9.visible': boolean;
+ /** Default value: `#0055db` */
+ 'linetoolfibtimezone.linecolor': string;
+ /** Default value: `0` */
+ 'linetoolfibtimezone.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibtimezone.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibtimezone.showLabels': boolean;
+ /** Default value: `80` */
+ 'linetoolfibtimezone.transparency': number;
+ /** Default value: `#808080` */
+ 'linetoolfibtimezone.trendline.color': string;
+ /** Default value: `2` */
+ 'linetoolfibtimezone.trendline.linestyle': number;
+ /** Default value: `1` */
+ 'linetoolfibtimezone.trendline.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibtimezone.trendline.visible': boolean;
+ /** Default value: `bottom` */
+ 'linetoolfibtimezone.vertLabelsAlign': string;
+}
+/**
+ * Override properties for the Fibwedge drawing tool.
+ */
+export interface FibwedgeLineToolOverrides {
+ /** Default value: `true` */
+ 'linetoolfibwedge.fillBackground': boolean;
+ /** Default value: `0.236` */
+ 'linetoolfibwedge.level1.coeff': number;
+ /** Default value: `#F23645` */
+ 'linetoolfibwedge.level1.color': string;
+ /** Default value: `0` */
+ 'linetoolfibwedge.level1.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibwedge.level1.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibwedge.level1.visible': boolean;
+ /** Default value: `4.236` */
+ 'linetoolfibwedge.level10.coeff': number;
+ /** Default value: `#e91e63` */
+ 'linetoolfibwedge.level10.color': string;
+ /** Default value: `0` */
+ 'linetoolfibwedge.level10.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibwedge.level10.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolfibwedge.level10.visible': boolean;
+ /** Default value: `4.618` */
+ 'linetoolfibwedge.level11.coeff': number;
+ /** Default value: `#e91e63` */
+ 'linetoolfibwedge.level11.color': string;
+ /** Default value: `0` */
+ 'linetoolfibwedge.level11.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibwedge.level11.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolfibwedge.level11.visible': boolean;
+ /** Default value: `0.382` */
+ 'linetoolfibwedge.level2.coeff': number;
+ /** Default value: `#FF9800` */
+ 'linetoolfibwedge.level2.color': string;
+ /** Default value: `0` */
+ 'linetoolfibwedge.level2.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibwedge.level2.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibwedge.level2.visible': boolean;
+ /** Default value: `0.5` */
+ 'linetoolfibwedge.level3.coeff': number;
+ /** Default value: `#4caf50` */
+ 'linetoolfibwedge.level3.color': string;
+ /** Default value: `0` */
+ 'linetoolfibwedge.level3.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibwedge.level3.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibwedge.level3.visible': boolean;
+ /** Default value: `0.618` */
+ 'linetoolfibwedge.level4.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolfibwedge.level4.color': string;
+ /** Default value: `0` */
+ 'linetoolfibwedge.level4.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibwedge.level4.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibwedge.level4.visible': boolean;
+ /** Default value: `0.786` */
+ 'linetoolfibwedge.level5.coeff': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolfibwedge.level5.color': string;
+ /** Default value: `0` */
+ 'linetoolfibwedge.level5.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibwedge.level5.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibwedge.level5.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolfibwedge.level6.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolfibwedge.level6.color': string;
+ /** Default value: `0` */
+ 'linetoolfibwedge.level6.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibwedge.level6.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibwedge.level6.visible': boolean;
+ /** Default value: `1.618` */
+ 'linetoolfibwedge.level7.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolfibwedge.level7.color': string;
+ /** Default value: `0` */
+ 'linetoolfibwedge.level7.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibwedge.level7.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolfibwedge.level7.visible': boolean;
+ /** Default value: `2.618` */
+ 'linetoolfibwedge.level8.coeff': number;
+ /** Default value: `#F23645` */
+ 'linetoolfibwedge.level8.color': string;
+ /** Default value: `0` */
+ 'linetoolfibwedge.level8.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibwedge.level8.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolfibwedge.level8.visible': boolean;
+ /** Default value: `3.618` */
+ 'linetoolfibwedge.level9.coeff': number;
+ /** Default value: `#673ab7` */
+ 'linetoolfibwedge.level9.color': string;
+ /** Default value: `0` */
+ 'linetoolfibwedge.level9.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibwedge.level9.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolfibwedge.level9.visible': boolean;
+ /** Default value: `true` */
+ 'linetoolfibwedge.showCoeffs': boolean;
+ /** Default value: `80` */
+ 'linetoolfibwedge.transparency': number;
+ /** Default value: `#808080` */
+ 'linetoolfibwedge.trendline.color': string;
+ /** Default value: `0` */
+ 'linetoolfibwedge.trendline.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolfibwedge.trendline.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolfibwedge.trendline.visible': boolean;
+}
+/**
+ * Override properties for the Fivepointspattern drawing tool.
+ */
+export interface FivepointspatternLineToolOverrides {
+ /** Default value: `#2962FF` */
+ 'linetool5pointspattern.backgroundColor': string;
+ /** Default value: `false` */
+ 'linetool5pointspattern.bold': boolean;
+ /** Default value: `#2962FF` */
+ 'linetool5pointspattern.color': string;
+ /** Default value: `true` */
+ 'linetool5pointspattern.fillBackground': boolean;
+ /** Default value: `12` */
+ 'linetool5pointspattern.fontsize': number;
+ /** Default value: `false` */
+ 'linetool5pointspattern.italic': boolean;
+ /** Default value: `2` */
+ 'linetool5pointspattern.linewidth': number;
+ /** Default value: `#ffffff` */
+ 'linetool5pointspattern.textcolor': string;
+ /** Default value: `85` */
+ 'linetool5pointspattern.transparency': number;
+}
+/**
+ * Override properties for the Flagmark drawing tool.
+ */
+export interface FlagmarkLineToolOverrides {
+ /** Default value: `#2962FF` */
+ 'linetoolflagmark.flagColor': string;
+}
+/**
+ * Override properties for the Flatbottom drawing tool.
+ */
+export interface FlatbottomLineToolOverrides {
+ /** Default value: `rgba(255, 152, 0, 0.2)` */
+ 'linetoolflatbottom.backgroundColor': string;
+ /** Default value: `false` */
+ 'linetoolflatbottom.bold': boolean;
+ /** Default value: `false` */
+ 'linetoolflatbottom.extendLeft': boolean;
+ /** Default value: `false` */
+ 'linetoolflatbottom.extendRight': boolean;
+ /** Default value: `true` */
+ 'linetoolflatbottom.fillBackground': boolean;
+ /** Default value: `12` */
+ 'linetoolflatbottom.fontsize': number;
+ /** Default value: `false` */
+ 'linetoolflatbottom.italic': boolean;
+ /** Default value: `false` */
+ 'linetoolflatbottom.labelBold': boolean;
+ /** Default value: `14` */
+ 'linetoolflatbottom.labelFontSize': number;
+ /** Default value: `left` */
+ 'linetoolflatbottom.labelHorzAlign': string;
+ /** Default value: `false` */
+ 'linetoolflatbottom.labelItalic': boolean;
+ /** Default value: `#FF9800` */
+ 'linetoolflatbottom.labelTextColor': string;
+ /** Default value: `bottom` */
+ 'linetoolflatbottom.labelVertAlign': string;
+ /** Default value: `false` */
+ 'linetoolflatbottom.labelVisible': boolean;
+ /** Default value: `0` */
+ 'linetoolflatbottom.leftEnd': number;
+ /** Default value: `#FF9800` */
+ 'linetoolflatbottom.linecolor': string;
+ /** Default value: `0` */
+ 'linetoolflatbottom.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolflatbottom.linewidth': number;
+ /** Default value: `0` */
+ 'linetoolflatbottom.rightEnd': number;
+ /** Default value: `false` */
+ 'linetoolflatbottom.showBarsRange': boolean;
+ /** Default value: `false` */
+ 'linetoolflatbottom.showDateTimeRange': boolean;
+ /** Default value: `false` */
+ 'linetoolflatbottom.showPriceRange': boolean;
+ /** Default value: `false` */
+ 'linetoolflatbottom.showPrices': boolean;
+ /** Default value: `#FF9800` */
+ 'linetoolflatbottom.textcolor': string;
+ /** Default value: `20` */
+ 'linetoolflatbottom.transparency': number;
+}
+export interface FormatterParseResult {
+ /** Returns if the formatter support parsing */
+ res: boolean;
+}
+/**
+ * Override properties for the Ganncomplex drawing tool.
+ */
+export interface GanncomplexLineToolOverrides {
+ /** Default value: `#FF9800` */
+ 'linetoolganncomplex.arcs.0.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.arcs.0.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.arcs.0.width': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.arcs.0.x': number;
+ /** Default value: `0` */
+ 'linetoolganncomplex.arcs.0.y': number;
+ /** Default value: `#FF9800` */
+ 'linetoolganncomplex.arcs.1.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.arcs.1.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.arcs.1.width': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.arcs.1.x': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.arcs.1.y': number;
+ /** Default value: `#2962FF` */
+ 'linetoolganncomplex.arcs.10.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.arcs.10.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.arcs.10.width': number;
+ /** Default value: `5` */
+ 'linetoolganncomplex.arcs.10.x': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.arcs.10.y': number;
+ /** Default value: `#FF9800` */
+ 'linetoolganncomplex.arcs.2.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.arcs.2.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.arcs.2.width': number;
+ /** Default value: `1.5` */
+ 'linetoolganncomplex.arcs.2.x': number;
+ /** Default value: `0` */
+ 'linetoolganncomplex.arcs.2.y': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolganncomplex.arcs.3.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.arcs.3.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.arcs.3.width': number;
+ /** Default value: `2` */
+ 'linetoolganncomplex.arcs.3.x': number;
+ /** Default value: `0` */
+ 'linetoolganncomplex.arcs.3.y': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolganncomplex.arcs.4.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.arcs.4.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.arcs.4.width': number;
+ /** Default value: `2` */
+ 'linetoolganncomplex.arcs.4.x': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.arcs.4.y': number;
+ /** Default value: `#4caf50` */
+ 'linetoolganncomplex.arcs.5.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.arcs.5.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.arcs.5.width': number;
+ /** Default value: `3` */
+ 'linetoolganncomplex.arcs.5.x': number;
+ /** Default value: `0` */
+ 'linetoolganncomplex.arcs.5.y': number;
+ /** Default value: `#4caf50` */
+ 'linetoolganncomplex.arcs.6.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.arcs.6.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.arcs.6.width': number;
+ /** Default value: `3` */
+ 'linetoolganncomplex.arcs.6.x': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.arcs.6.y': number;
+ /** Default value: `#089981` */
+ 'linetoolganncomplex.arcs.7.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.arcs.7.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.arcs.7.width': number;
+ /** Default value: `4` */
+ 'linetoolganncomplex.arcs.7.x': number;
+ /** Default value: `0` */
+ 'linetoolganncomplex.arcs.7.y': number;
+ /** Default value: `#089981` */
+ 'linetoolganncomplex.arcs.8.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.arcs.8.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.arcs.8.width': number;
+ /** Default value: `4` */
+ 'linetoolganncomplex.arcs.8.x': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.arcs.8.y': number;
+ /** Default value: `#2962FF` */
+ 'linetoolganncomplex.arcs.9.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.arcs.9.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.arcs.9.width': number;
+ /** Default value: `5` */
+ 'linetoolganncomplex.arcs.9.x': number;
+ /** Default value: `0` */
+ 'linetoolganncomplex.arcs.9.y': number;
+ /** Default value: `true` */
+ 'linetoolganncomplex.arcsBackground.fillBackground': boolean;
+ /** Default value: `80` */
+ 'linetoolganncomplex.arcsBackground.transparency': number;
+ /** Default value: `#B39DDB` */
+ 'linetoolganncomplex.fanlines.0.color': string;
+ /** Default value: `false` */
+ 'linetoolganncomplex.fanlines.0.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.fanlines.0.width': number;
+ /** Default value: `8` */
+ 'linetoolganncomplex.fanlines.0.x': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.fanlines.0.y': number;
+ /** Default value: `#F23645` */
+ 'linetoolganncomplex.fanlines.1.color': string;
+ /** Default value: `false` */
+ 'linetoolganncomplex.fanlines.1.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.fanlines.1.width': number;
+ /** Default value: `5` */
+ 'linetoolganncomplex.fanlines.1.x': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.fanlines.1.y': number;
+ /** Default value: `#B39DDB` */
+ 'linetoolganncomplex.fanlines.10.color': string;
+ /** Default value: `false` */
+ 'linetoolganncomplex.fanlines.10.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.fanlines.10.width': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.fanlines.10.x': number;
+ /** Default value: `8` */
+ 'linetoolganncomplex.fanlines.10.y': number;
+ /** Default value: `#787B86` */
+ 'linetoolganncomplex.fanlines.2.color': string;
+ /** Default value: `false` */
+ 'linetoolganncomplex.fanlines.2.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.fanlines.2.width': number;
+ /** Default value: `4` */
+ 'linetoolganncomplex.fanlines.2.x': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.fanlines.2.y': number;
+ /** Default value: `#FF9800` */
+ 'linetoolganncomplex.fanlines.3.color': string;
+ /** Default value: `false` */
+ 'linetoolganncomplex.fanlines.3.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.fanlines.3.width': number;
+ /** Default value: `3` */
+ 'linetoolganncomplex.fanlines.3.x': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.fanlines.3.y': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolganncomplex.fanlines.4.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.fanlines.4.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.fanlines.4.width': number;
+ /** Default value: `2` */
+ 'linetoolganncomplex.fanlines.4.x': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.fanlines.4.y': number;
+ /** Default value: `#4caf50` */
+ 'linetoolganncomplex.fanlines.5.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.fanlines.5.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.fanlines.5.width': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.fanlines.5.x': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.fanlines.5.y': number;
+ /** Default value: `#089981` */
+ 'linetoolganncomplex.fanlines.6.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.fanlines.6.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.fanlines.6.width': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.fanlines.6.x': number;
+ /** Default value: `2` */
+ 'linetoolganncomplex.fanlines.6.y': number;
+ /** Default value: `#089981` */
+ 'linetoolganncomplex.fanlines.7.color': string;
+ /** Default value: `false` */
+ 'linetoolganncomplex.fanlines.7.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.fanlines.7.width': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.fanlines.7.x': number;
+ /** Default value: `3` */
+ 'linetoolganncomplex.fanlines.7.y': number;
+ /** Default value: `#2962FF` */
+ 'linetoolganncomplex.fanlines.8.color': string;
+ /** Default value: `false` */
+ 'linetoolganncomplex.fanlines.8.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.fanlines.8.width': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.fanlines.8.x': number;
+ /** Default value: `4` */
+ 'linetoolganncomplex.fanlines.8.y': number;
+ /** Default value: `#9575cd` */
+ 'linetoolganncomplex.fanlines.9.color': string;
+ /** Default value: `false` */
+ 'linetoolganncomplex.fanlines.9.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.fanlines.9.width': number;
+ /** Default value: `1` */
+ 'linetoolganncomplex.fanlines.9.x': number;
+ /** Default value: `5` */
+ 'linetoolganncomplex.fanlines.9.y': number;
+ /** Default value: `false` */
+ 'linetoolganncomplex.fillBackground': boolean;
+ /** Default value: `false` */
+ 'linetoolganncomplex.labelsStyle.bold': boolean;
+ /** Default value: `12` */
+ 'linetoolganncomplex.labelsStyle.fontSize': number;
+ /** Default value: `false` */
+ 'linetoolganncomplex.labelsStyle.italic': boolean;
+ /** Default value: `#787B86` */
+ 'linetoolganncomplex.levels.0.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.levels.0.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.levels.0.width': number;
+ /** Default value: `#FF9800` */
+ 'linetoolganncomplex.levels.1.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.levels.1.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.levels.1.width': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolganncomplex.levels.2.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.levels.2.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.levels.2.width': number;
+ /** Default value: `#4caf50` */
+ 'linetoolganncomplex.levels.3.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.levels.3.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.levels.3.width': number;
+ /** Default value: `#089981` */
+ 'linetoolganncomplex.levels.4.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.levels.4.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.levels.4.width': number;
+ /** Default value: `#787B86` */
+ 'linetoolganncomplex.levels.5.color': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.levels.5.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolganncomplex.levels.5.width': number;
+ /** Default value: `false` */
+ 'linetoolganncomplex.reverse': boolean;
+ /** Default value: `` */
+ 'linetoolganncomplex.scaleRatio': string;
+ /** Default value: `true` */
+ 'linetoolganncomplex.showLabels': boolean;
+}
+/**
+ * Override properties for the Gannfan drawing tool.
+ */
+export interface GannfanLineToolOverrides {
+ /** Default value: `true` */
+ 'linetoolgannfan.fillBackground': boolean;
+ /** Default value: `1` */
+ 'linetoolgannfan.level1.coeff1': number;
+ /** Default value: `8` */
+ 'linetoolgannfan.level1.coeff2': number;
+ /** Default value: `#FF9800` */
+ 'linetoolgannfan.level1.color': string;
+ /** Default value: `0` */
+ 'linetoolgannfan.level1.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolgannfan.level1.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolgannfan.level1.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolgannfan.level2.coeff1': number;
+ /** Default value: `4` */
+ 'linetoolgannfan.level2.coeff2': number;
+ /** Default value: `#089981` */
+ 'linetoolgannfan.level2.color': string;
+ /** Default value: `0` */
+ 'linetoolgannfan.level2.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolgannfan.level2.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolgannfan.level2.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolgannfan.level3.coeff1': number;
+ /** Default value: `3` */
+ 'linetoolgannfan.level3.coeff2': number;
+ /** Default value: `#4caf50` */
+ 'linetoolgannfan.level3.color': string;
+ /** Default value: `0` */
+ 'linetoolgannfan.level3.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolgannfan.level3.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolgannfan.level3.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolgannfan.level4.coeff1': number;
+ /** Default value: `2` */
+ 'linetoolgannfan.level4.coeff2': number;
+ /** Default value: `#089981` */
+ 'linetoolgannfan.level4.color': string;
+ /** Default value: `0` */
+ 'linetoolgannfan.level4.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolgannfan.level4.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolgannfan.level4.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolgannfan.level5.coeff1': number;
+ /** Default value: `1` */
+ 'linetoolgannfan.level5.coeff2': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolgannfan.level5.color': string;
+ /** Default value: `0` */
+ 'linetoolgannfan.level5.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolgannfan.level5.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolgannfan.level5.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfan.level6.coeff1': number;
+ /** Default value: `1` */
+ 'linetoolgannfan.level6.coeff2': number;
+ /** Default value: `#2962FF` */
+ 'linetoolgannfan.level6.color': string;
+ /** Default value: `0` */
+ 'linetoolgannfan.level6.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolgannfan.level6.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolgannfan.level6.visible': boolean;
+ /** Default value: `3` */
+ 'linetoolgannfan.level7.coeff1': number;
+ /** Default value: `1` */
+ 'linetoolgannfan.level7.coeff2': number;
+ /** Default value: `#9c27b0` */
+ 'linetoolgannfan.level7.color': string;
+ /** Default value: `0` */
+ 'linetoolgannfan.level7.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolgannfan.level7.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolgannfan.level7.visible': boolean;
+ /** Default value: `4` */
+ 'linetoolgannfan.level8.coeff1': number;
+ /** Default value: `1` */
+ 'linetoolgannfan.level8.coeff2': number;
+ /** Default value: `#e91e63` */
+ 'linetoolgannfan.level8.color': string;
+ /** Default value: `0` */
+ 'linetoolgannfan.level8.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolgannfan.level8.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolgannfan.level8.visible': boolean;
+ /** Default value: `8` */
+ 'linetoolgannfan.level9.coeff1': number;
+ /** Default value: `1` */
+ 'linetoolgannfan.level9.coeff2': number;
+ /** Default value: `#F23645` */
+ 'linetoolgannfan.level9.color': string;
+ /** Default value: `0` */
+ 'linetoolgannfan.level9.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolgannfan.level9.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolgannfan.level9.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfan.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolgannfan.showLabels': boolean;
+ /** Default value: `80` */
+ 'linetoolgannfan.transparency': number;
+}
+/**
+ * Override properties for the Gannfixed drawing tool.
+ */
+export interface GannfixedLineToolOverrides {
+ /** Default value: `#FF9800` */
+ 'linetoolgannfixed.arcs.0.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.arcs.0.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.arcs.0.width': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.arcs.0.x': number;
+ /** Default value: `0` */
+ 'linetoolgannfixed.arcs.0.y': number;
+ /** Default value: `#FF9800` */
+ 'linetoolgannfixed.arcs.1.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.arcs.1.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.arcs.1.width': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.arcs.1.x': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.arcs.1.y': number;
+ /** Default value: `#2962FF` */
+ 'linetoolgannfixed.arcs.10.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.arcs.10.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.arcs.10.width': number;
+ /** Default value: `5` */
+ 'linetoolgannfixed.arcs.10.x': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.arcs.10.y': number;
+ /** Default value: `#FF9800` */
+ 'linetoolgannfixed.arcs.2.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.arcs.2.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.arcs.2.width': number;
+ /** Default value: `1.5` */
+ 'linetoolgannfixed.arcs.2.x': number;
+ /** Default value: `0` */
+ 'linetoolgannfixed.arcs.2.y': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolgannfixed.arcs.3.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.arcs.3.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.arcs.3.width': number;
+ /** Default value: `2` */
+ 'linetoolgannfixed.arcs.3.x': number;
+ /** Default value: `0` */
+ 'linetoolgannfixed.arcs.3.y': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolgannfixed.arcs.4.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.arcs.4.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.arcs.4.width': number;
+ /** Default value: `2` */
+ 'linetoolgannfixed.arcs.4.x': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.arcs.4.y': number;
+ /** Default value: `#4caf50` */
+ 'linetoolgannfixed.arcs.5.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.arcs.5.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.arcs.5.width': number;
+ /** Default value: `3` */
+ 'linetoolgannfixed.arcs.5.x': number;
+ /** Default value: `0` */
+ 'linetoolgannfixed.arcs.5.y': number;
+ /** Default value: `#4caf50` */
+ 'linetoolgannfixed.arcs.6.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.arcs.6.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.arcs.6.width': number;
+ /** Default value: `3` */
+ 'linetoolgannfixed.arcs.6.x': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.arcs.6.y': number;
+ /** Default value: `#089981` */
+ 'linetoolgannfixed.arcs.7.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.arcs.7.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.arcs.7.width': number;
+ /** Default value: `4` */
+ 'linetoolgannfixed.arcs.7.x': number;
+ /** Default value: `0` */
+ 'linetoolgannfixed.arcs.7.y': number;
+ /** Default value: `#089981` */
+ 'linetoolgannfixed.arcs.8.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.arcs.8.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.arcs.8.width': number;
+ /** Default value: `4` */
+ 'linetoolgannfixed.arcs.8.x': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.arcs.8.y': number;
+ /** Default value: `#2962FF` */
+ 'linetoolgannfixed.arcs.9.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.arcs.9.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.arcs.9.width': number;
+ /** Default value: `5` */
+ 'linetoolgannfixed.arcs.9.x': number;
+ /** Default value: `0` */
+ 'linetoolgannfixed.arcs.9.y': number;
+ /** Default value: `true` */
+ 'linetoolgannfixed.arcsBackground.fillBackground': boolean;
+ /** Default value: `80` */
+ 'linetoolgannfixed.arcsBackground.transparency': number;
+ /** Default value: `#B39DDB` */
+ 'linetoolgannfixed.fanlines.0.color': string;
+ /** Default value: `false` */
+ 'linetoolgannfixed.fanlines.0.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.fanlines.0.width': number;
+ /** Default value: `8` */
+ 'linetoolgannfixed.fanlines.0.x': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.fanlines.0.y': number;
+ /** Default value: `#F23645` */
+ 'linetoolgannfixed.fanlines.1.color': string;
+ /** Default value: `false` */
+ 'linetoolgannfixed.fanlines.1.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.fanlines.1.width': number;
+ /** Default value: `5` */
+ 'linetoolgannfixed.fanlines.1.x': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.fanlines.1.y': number;
+ /** Default value: `#B39DDB` */
+ 'linetoolgannfixed.fanlines.10.color': string;
+ /** Default value: `false` */
+ 'linetoolgannfixed.fanlines.10.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.fanlines.10.width': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.fanlines.10.x': number;
+ /** Default value: `8` */
+ 'linetoolgannfixed.fanlines.10.y': number;
+ /** Default value: `#787B86` */
+ 'linetoolgannfixed.fanlines.2.color': string;
+ /** Default value: `false` */
+ 'linetoolgannfixed.fanlines.2.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.fanlines.2.width': number;
+ /** Default value: `4` */
+ 'linetoolgannfixed.fanlines.2.x': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.fanlines.2.y': number;
+ /** Default value: `#FF9800` */
+ 'linetoolgannfixed.fanlines.3.color': string;
+ /** Default value: `false` */
+ 'linetoolgannfixed.fanlines.3.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.fanlines.3.width': number;
+ /** Default value: `3` */
+ 'linetoolgannfixed.fanlines.3.x': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.fanlines.3.y': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolgannfixed.fanlines.4.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.fanlines.4.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.fanlines.4.width': number;
+ /** Default value: `2` */
+ 'linetoolgannfixed.fanlines.4.x': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.fanlines.4.y': number;
+ /** Default value: `#4caf50` */
+ 'linetoolgannfixed.fanlines.5.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.fanlines.5.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.fanlines.5.width': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.fanlines.5.x': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.fanlines.5.y': number;
+ /** Default value: `#089981` */
+ 'linetoolgannfixed.fanlines.6.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.fanlines.6.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.fanlines.6.width': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.fanlines.6.x': number;
+ /** Default value: `2` */
+ 'linetoolgannfixed.fanlines.6.y': number;
+ /** Default value: `#089981` */
+ 'linetoolgannfixed.fanlines.7.color': string;
+ /** Default value: `false` */
+ 'linetoolgannfixed.fanlines.7.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.fanlines.7.width': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.fanlines.7.x': number;
+ /** Default value: `3` */
+ 'linetoolgannfixed.fanlines.7.y': number;
+ /** Default value: `#2962FF` */
+ 'linetoolgannfixed.fanlines.8.color': string;
+ /** Default value: `false` */
+ 'linetoolgannfixed.fanlines.8.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.fanlines.8.width': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.fanlines.8.x': number;
+ /** Default value: `4` */
+ 'linetoolgannfixed.fanlines.8.y': number;
+ /** Default value: `#9575cd` */
+ 'linetoolgannfixed.fanlines.9.color': string;
+ /** Default value: `false` */
+ 'linetoolgannfixed.fanlines.9.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.fanlines.9.width': number;
+ /** Default value: `1` */
+ 'linetoolgannfixed.fanlines.9.x': number;
+ /** Default value: `5` */
+ 'linetoolgannfixed.fanlines.9.y': number;
+ /** Default value: `false` */
+ 'linetoolgannfixed.fillBackground': boolean;
+ /** Default value: `#787B86` */
+ 'linetoolgannfixed.levels.0.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.levels.0.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.levels.0.width': number;
+ /** Default value: `#FF9800` */
+ 'linetoolgannfixed.levels.1.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.levels.1.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.levels.1.width': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolgannfixed.levels.2.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.levels.2.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.levels.2.width': number;
+ /** Default value: `#4caf50` */
+ 'linetoolgannfixed.levels.3.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.levels.3.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.levels.3.width': number;
+ /** Default value: `#089981` */
+ 'linetoolgannfixed.levels.4.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.levels.4.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.levels.4.width': number;
+ /** Default value: `#787B86` */
+ 'linetoolgannfixed.levels.5.color': string;
+ /** Default value: `true` */
+ 'linetoolgannfixed.levels.5.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolgannfixed.levels.5.width': number;
+ /** Default value: `false` */
+ 'linetoolgannfixed.reverse': boolean;
+}
+/**
+ * Override properties for the Gannsquare drawing tool.
+ */
+export interface GannsquareLineToolOverrides {
+ /** Default value: `rgba(21, 56, 153, 0.8)` */
+ 'linetoolgannsquare.color': string;
+ /** Default value: `#9598A1` */
+ 'linetoolgannsquare.fans.color': string;
+ /** Default value: `false` */
+ 'linetoolgannsquare.fans.visible': boolean;
+ /** Default value: `true` */
+ 'linetoolgannsquare.fillHorzBackground': boolean;
+ /** Default value: `true` */
+ 'linetoolgannsquare.fillVertBackground': boolean;
+ /** Default value: `0` */
+ 'linetoolgannsquare.hlevel1.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolgannsquare.hlevel1.color': string;
+ /** Default value: `true` */
+ 'linetoolgannsquare.hlevel1.visible': boolean;
+ /** Default value: `0.25` */
+ 'linetoolgannsquare.hlevel2.coeff': number;
+ /** Default value: `#FF9800` */
+ 'linetoolgannsquare.hlevel2.color': string;
+ /** Default value: `true` */
+ 'linetoolgannsquare.hlevel2.visible': boolean;
+ /** Default value: `0.382` */
+ 'linetoolgannsquare.hlevel3.coeff': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolgannsquare.hlevel3.color': string;
+ /** Default value: `true` */
+ 'linetoolgannsquare.hlevel3.visible': boolean;
+ /** Default value: `0.5` */
+ 'linetoolgannsquare.hlevel4.coeff': number;
+ /** Default value: `#4caf50` */
+ 'linetoolgannsquare.hlevel4.color': string;
+ /** Default value: `true` */
+ 'linetoolgannsquare.hlevel4.visible': boolean;
+ /** Default value: `0.618` */
+ 'linetoolgannsquare.hlevel5.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolgannsquare.hlevel5.color': string;
+ /** Default value: `true` */
+ 'linetoolgannsquare.hlevel5.visible': boolean;
+ /** Default value: `0.75` */
+ 'linetoolgannsquare.hlevel6.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolgannsquare.hlevel6.color': string;
+ /** Default value: `true` */
+ 'linetoolgannsquare.hlevel6.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolgannsquare.hlevel7.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolgannsquare.hlevel7.color': string;
+ /** Default value: `true` */
+ 'linetoolgannsquare.hlevel7.visible': boolean;
+ /** Default value: `80` */
+ 'linetoolgannsquare.horzTransparency': number;
+ /** Default value: `0` */
+ 'linetoolgannsquare.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolgannsquare.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolgannsquare.reverse': boolean;
+ /** Default value: `true` */
+ 'linetoolgannsquare.showBottomLabels': boolean;
+ /** Default value: `true` */
+ 'linetoolgannsquare.showLeftLabels': boolean;
+ /** Default value: `true` */
+ 'linetoolgannsquare.showRightLabels': boolean;
+ /** Default value: `true` */
+ 'linetoolgannsquare.showTopLabels': boolean;
+ /** Default value: `80` */
+ 'linetoolgannsquare.vertTransparency': number;
+ /** Default value: `0` */
+ 'linetoolgannsquare.vlevel1.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolgannsquare.vlevel1.color': string;
+ /** Default value: `true` */
+ 'linetoolgannsquare.vlevel1.visible': boolean;
+ /** Default value: `0.25` */
+ 'linetoolgannsquare.vlevel2.coeff': number;
+ /** Default value: `#FF9800` */
+ 'linetoolgannsquare.vlevel2.color': string;
+ /** Default value: `true` */
+ 'linetoolgannsquare.vlevel2.visible': boolean;
+ /** Default value: `0.382` */
+ 'linetoolgannsquare.vlevel3.coeff': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolgannsquare.vlevel3.color': string;
+ /** Default value: `true` */
+ 'linetoolgannsquare.vlevel3.visible': boolean;
+ /** Default value: `0.5` */
+ 'linetoolgannsquare.vlevel4.coeff': number;
+ /** Default value: `#4caf50` */
+ 'linetoolgannsquare.vlevel4.color': string;
+ /** Default value: `true` */
+ 'linetoolgannsquare.vlevel4.visible': boolean;
+ /** Default value: `0.618` */
+ 'linetoolgannsquare.vlevel5.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolgannsquare.vlevel5.color': string;
+ /** Default value: `true` */
+ 'linetoolgannsquare.vlevel5.visible': boolean;
+ /** Default value: `0.75` */
+ 'linetoolgannsquare.vlevel6.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolgannsquare.vlevel6.color': string;
+ /** Default value: `true` */
+ 'linetoolgannsquare.vlevel6.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolgannsquare.vlevel7.coeff': number;
+ /** Default value: `#787B86` */
+ 'linetoolgannsquare.vlevel7.color': string;
+ /** Default value: `true` */
+ 'linetoolgannsquare.vlevel7.visible': boolean;
+}
+export interface GetNewsResponse {
+ /** Title */
+ title?: string;
+ /** Retrieved news items */
+ newsItems: NewsItem[];
+}
+/**
+ * Override properties for the Ghostfeed drawing tool.
+ */
+export interface GhostfeedLineToolOverrides {
+ /** Default value: `20` */
+ 'linetoolghostfeed.averageHL': number;
+ /** Default value: `#378658` */
+ 'linetoolghostfeed.candleStyle.borderColor': string;
+ /** Default value: `#F23645` */
+ 'linetoolghostfeed.candleStyle.borderDownColor': string;
+ /** Default value: `#089981` */
+ 'linetoolghostfeed.candleStyle.borderUpColor': string;
+ /** Default value: `#FAA1A4` */
+ 'linetoolghostfeed.candleStyle.downColor': string;
+ /** Default value: `true` */
+ 'linetoolghostfeed.candleStyle.drawBorder': boolean;
+ /** Default value: `true` */
+ 'linetoolghostfeed.candleStyle.drawWick': boolean;
+ /** Default value: `#ACE5DC` */
+ 'linetoolghostfeed.candleStyle.upColor': string;
+ /** Default value: `#787B86` */
+ 'linetoolghostfeed.candleStyle.wickColor': string;
+ /** Default value: `50` */
+ 'linetoolghostfeed.transparency': number;
+ /** Default value: `50` */
+ 'linetoolghostfeed.variance': number;
+}
+export interface GrayedObject {
+ /** Type for grayed object */
+ type: 'drawing' | 'study';
+ /** Name of grayed object */
+ name: string;
+}
+/** Histogram Preferences */
+export interface HHistPreferences {
+ /**
+ * Colors for the histogram up and down bars.
+ * Example:
+ * ```js
+ * colors: ['#1592e6', '#fbc123']
+ * ```
+ */
+ colors: string[];
+ /** Transparency values for the histogram */
+ transparencies: number[];
+ /** Should the histogram be visible */
+ visible: boolean;
+ /** Percentage width of the chart for which the histogram should occupy */
+ percentWidth: number;
+ /** Should the values be shown */
+ showValues: boolean;
+ /** Color for values shown */
+ valuesColor: string;
+ /**
+ * Direction of the histogram.
+ * Whether the histogram will be shown on the left or right edge of the chart
+ */
+ direction: HHistDirection;
+}
+export interface HLCAreaStylePreferences {
+ /** High line color */
+ highLineColor: string;
+ /** High line style */
+ highLineStyle: number;
+ /** High line width */
+ highLineWidth: number;
+ /** Low line color */
+ lowLineColor: string;
+ /** Low line style */
+ lowLineStyle: number;
+ /** Low line width */
+ lowLineWidth: number;
+ /** Close line color */
+ closeLineColor: string;
+ /** Close line style */
+ closeLineStyle: number;
+ /** Close line width */
+ closeLineWidth: number;
+ /** Fill color of area between high and close lines */
+ highCloseFillColor: string;
+ /** Fill color of area between close and low lines */
+ closeLowFillColor: string;
+}
+/**
+ * Override properties for the Headandshoulders drawing tool.
+ */
+export interface HeadandshouldersLineToolOverrides {
+ /** Default value: `#089981` */
+ 'linetoolheadandshoulders.backgroundColor': string;
+ /** Default value: `false` */
+ 'linetoolheadandshoulders.bold': boolean;
+ /** Default value: `#089981` */
+ 'linetoolheadandshoulders.color': string;
+ /** Default value: `true` */
+ 'linetoolheadandshoulders.fillBackground': boolean;
+ /** Default value: `12` */
+ 'linetoolheadandshoulders.fontsize': number;
+ /** Default value: `false` */
+ 'linetoolheadandshoulders.italic': boolean;
+ /** Default value: `2` */
+ 'linetoolheadandshoulders.linewidth': number;
+ /** Default value: `#ffffff` */
+ 'linetoolheadandshoulders.textcolor': string;
+ /** Default value: `85` */
+ 'linetoolheadandshoulders.transparency': number;
+}
+export interface HeikinAshiStylePreferences {
+ /** Body color for an up candle */
+ upColor: string;
+ /** Body color for down candle */
+ downColor: string;
+ /** Whether to draw the candle wick */
+ drawWick: boolean;
+ /** Whether to draw the candle border */
+ drawBorder: boolean;
+ /** Whether to draw the candle body */
+ drawBody: boolean;
+ /** Candle border color */
+ borderColor: string;
+ /** Up candle border color */
+ borderUpColor: string;
+ /** Down candle border color */
+ borderDownColor: string;
+ /** Candle wick color */
+ wickColor: string;
+ /** Up candle wick color */
+ wickUpColor: string;
+ /** Down candle wick color */
+ wickDownColor: string;
+ /** Show real last price */
+ showRealLastPrice: boolean;
+ /** Color bars based on previous close value */
+ barColorsOnPrevClose: boolean;
+}
+export interface HiLoStylePreferences {
+ /** Color for Hi Lo chart */
+ color: string;
+ /** Show borders. Default - `false` */
+ showBorders: boolean;
+ /** Border Color */
+ borderColor: string;
+ /** Show Labels. Default - `false` */
+ showLabels: boolean;
+ /** Label color */
+ labelColor: string;
+ /** Draw body. Default - `true` */
+ drawBody: boolean;
+}
+/**
+ * Override properties for the Highlighter drawing tool.
+ */
+export interface HighlighterLineToolOverrides {
+ /** Default value: `rgba(242, 54, 69, 0.2)` */
+ 'linetoolhighlighter.linecolor': string;
+ /** Default value: `5` */
+ 'linetoolhighlighter.smooth': number;
+ /** Default value: `80` */
+ 'linetoolhighlighter.transparency': number;
+}
+/**
+ * Information passed to `onHistoryCallback` for getBars.
+ */
+export interface HistoryMetadata {
+ /**
+ * Optional value indicating to the library that there is no more data on the server.
+ */
+ noData?: boolean;
+ /**
+ * Time of the next bar if there is no data in the requested period.
+ * It should be set if the requested period represents a gap in the data. Hence there is available data prior to the requested period.
+ */
+ nextTime?: number | null;
+}
+export interface HollowCandleStylePreferences {
+ /** Body color for an up candle */
+ upColor: string;
+ /** Body color for a down candle */
+ downColor: string;
+ /** Whether to draw the candle wick */
+ drawWick: boolean;
+ /** Whether to draw the candle body border */
+ drawBorder: boolean;
+ /** Whether to draw the candle body */
+ drawBody: boolean;
+ /** Candle border color */
+ borderColor: string;
+ /** Up candle border color */
+ borderUpColor: string;
+ /** Down candle border color */
+ borderDownColor: string;
+ /** Candle wick color */
+ wickColor: string;
+ /** Up candle wick color */
+ wickUpColor: string;
+ /** Down candle wick color */
+ wickDownColor: string;
+}
+/**
+ * Horizontal Line Preferences
+ */
+export interface HorizLinePreferences {
+ /** Is visible if set to `true` */
+ visible: boolean;
+ /** Width of the horizontal line */
+ width: number;
+ /** Color of the horizontal line */
+ color: string;
+ /** Line style */
+ style: LineStyle;
+ /** Show price if set to `true` */
+ showPrice?: boolean;
+}
+
+/**
+ * Override properties for the Horzline drawing tool.
+ */
+export interface HorzlineLineToolOverrides {
+ /** Default value: `false` */
+ 'linetoolhorzline.bold': boolean;
+ /** Default value: `12` */
+ 'linetoolhorzline.fontsize': number;
+ /** Default value: `center` */
+ 'linetoolhorzline.horzLabelsAlign': string;
+ /** Default value: `false` */
+ 'linetoolhorzline.italic': boolean;
+ /** Default value: `#2962FF` */
+ 'linetoolhorzline.linecolor': string;
+ /** Default value: `0` */
+ 'linetoolhorzline.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolhorzline.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolhorzline.showLabel': boolean;
+ /** Default value: `true` */
+ 'linetoolhorzline.showPrice': boolean;
+ /** Default value: `#2962FF` */
+ 'linetoolhorzline.textcolor': string;
+ /** Default value: `top` */
+ 'linetoolhorzline.vertLabelsAlign': string;
+}
+/**
+ * Override properties for the Horzray drawing tool.
+ */
+export interface HorzrayLineToolOverrides {
+ /** Default value: `false` */
+ 'linetoolhorzray.bold': boolean;
+ /** Default value: `12` */
+ 'linetoolhorzray.fontsize': number;
+ /** Default value: `center` */
+ 'linetoolhorzray.horzLabelsAlign': string;
+ /** Default value: `false` */
+ 'linetoolhorzray.italic': boolean;
+ /** Default value: `#2962FF` */
+ 'linetoolhorzray.linecolor': string;
+ /** Default value: `0` */
+ 'linetoolhorzray.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolhorzray.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolhorzray.showLabel': boolean;
+ /** Default value: `true` */
+ 'linetoolhorzray.showPrice': boolean;
+ /** Default value: `#2962FF` */
+ 'linetoolhorzray.textcolor': string;
+ /** Default value: `top` */
+ 'linetoolhorzray.vertLabelsAlign': string;
+}
+export interface IAction extends IMenuItem {
+ /** @inheritDoc */
+ readonly type: MenuItemType.Action;
+ /**
+ * A method which will be called when an action should be executed (e.g. when a user clicks on the item)
+ */
+ execute(): void;
+ /**
+ * @returns Returns a state object of the action.
+ */
+ getState(): Readonly;
+ /**
+ * @returns A subscription for an event when an action is updated.
+ */
+ onUpdate(): ISubscription;
+}
+export interface IBoxedValue extends IBoxedValueReadOnly {
+ /**
+ * Set boxed value
+ * @param {T} value - value to be set
+ */
+ setValue(value: T): void;
+}
+export interface IBoxedValueReadOnly {
+ /** Value */
+ value(): T;
+}
+export interface IBrokerCommon {
+ /**
+ * Chart can have a sub-menu `Trading` in the context menu. This method should return an array of {@link ActionMetaInfo} elements, each of them representing one context menu item.
+ * @param {TradeContext} context - context object passed by a browser
+ * @param {DefaultContextMenuActionsParams} options? - default options for the context menu action parameters
+ */
+ chartContextMenuActions(
+ context: TradeContext,
+ options?: DefaultContextMenuActionsParams
+ ): Promise;
+ /**
+ * This function is required for the Floating Trading Panel.
+ * The ability to trade via the panel depends on the result of this function: `true` or `false`.
+ * You don't need to implement this method if all symbols can be traded.
+ *
+ * If you want to show a custom message with the reason why the symbol cannot be traded then you can return an object `IsTradableResult`.
+ * @param {string} symbol - symbol identifier
+ */
+ isTradable(symbol: string): Promise;
+ /**
+ * Connection status for the Broker API.
+ *
+ * You don't need to return values other than `1` (`Connected`) typically since the broker is already connected when you create the widget.
+ * You can use it if you want to display a spinner in the bottom panel while the data is being loaded.
+ */
+ connectionStatus(): ConnectionStatus;
+ /**
+ * Called by Trading Platform to request orders
+ */
+ orders(): Promise;
+ /**
+ * This method is called by the Trading Platform to request orders history.
+ * It is expected that returned orders will have a final status (`rejected`, `filled`, `cancelled`).
+ *
+ * This method is optional. If you don't support orders history, please set `supportOrdersHistory` flag to `false`.
+ */
+ ordersHistory?(): Promise;
+ /**
+ * Called by Trading Platform to request positions
+ */
+ positions?(): Promise;
+ /**
+ * Called by Trading Platform to request trades
+ */
+ trades?(): Promise;
+ /**
+ * Called by Trading Platform to request executions for the specified symbol
+ * @param {string} symbol - symbol identifier
+ */
+ executions(symbol: string): Promise;
+ /**
+ * Called by the internal Order dialog, DOM panel, and floating trading panel to get symbol information.
+ * @param {string} symbol - symbol identifier
+ */
+ symbolInfo(symbol: string): Promise;
+ /**
+ * This function should return the information that will be used to build an Account manager.
+ */
+ accountManagerInfo(): AccountManagerInfo;
+ /**
+ * Provide a custom price formatter for the specified symbol.
+ * @param {string} symbol - symbol identifier
+ * @param {boolean} alignToMinMove - align formatted number to the minimum movement amount of the symbol
+ */
+ formatter?(
+ symbol: string,
+ alignToMinMove: boolean
+ ): Promise;
+ /**
+ * Provide a custom spread formatter for the specified symbol.
+ * @param {string} symbol - symbol identifier
+ */
+ spreadFormatter?(symbol: string): Promise;
+ /**
+ * Provide a custom quantity formatter for the specified symbol.
+ * @param {string} symbol - symbol identifier
+ */
+ quantityFormatter?(symbol: string): Promise;
+ /**
+ * Implement this method if you use the standard Order dialog and want to customize it.
+ *
+ * Use the `symbol` parameter to return customization options for a particular symbol.
+ * @param {string} symbol - symbol identifier
+ */
+ getOrderDialogOptions?(
+ symbol: string
+ ): Promise;
+ /**
+ * Implement this method if you want to customize the position dialog.
+ */
+ getPositionDialogOptions?(): PositionDialogOptions | undefined;
+}
+export interface IBrokerConnectionAdapterFactory {
+ /** Creates a Delegate object */
+ createDelegate(): IDelegate;
+ /** Creates a WatchedValue object */
+ createWatchedValue(value?: T): IWatchedValue;
+ /**
+ * Creates a price formatter.
+ * @param priceScale - Defines the number of decimal places. It is `10^number-of-decimal-places`. If a price is displayed as `1.01`, `pricescale` is `100`; If it is displayed as `1.005`, `pricescale` is `1000`.
+ * @param minMove - The amount of price precision steps for 1 tick. For example, since the tick size for U.S. equities is `0.01`, `minmov` is 1. But the price of the E-mini S&P futures contract moves upward or downward by `0.25` increments, so the `minmov` is `25`.
+ * @param fractional - For common prices, is `false` or it can be skipped. For more information on fractional prices, refer to [Fractional format](https://www.tradingview.com/charting-library-docs/latest/connecting_data/Symbology.md#fractional-format).
+ * @param minMove2 - For common prices, is `0` or it can be skipped.
+ * @param variableMinTick - For common prices, is `string` (for example, `0.01 10 0.02 25 0.05`) or it can be skipped. For more information, refer to [Variable tick size](https://www.tradingview.com/charting-library-docs/latest/connecting_data/Symbology.md#variable-tick-size).
+ */
+ createPriceFormatter(
+ priceScale?: number,
+ minMove?: number,
+ fractional?: boolean,
+ minMove2?: number,
+ variableMinTick?: string
+ ): IPriceFormatter;
+}
+/**
+ * The Trading Host is an API for interaction between the Broker API and the library code related to trading.
+ * Its main purpose is to receive information from your backend server where trading logic is implemented and provide updates to the library.
+ * Refer to the [Core trading concepts](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/trading-concepts.md) article for more information.
+ */
+export interface IBrokerConnectionAdapterHost {
+ /** Broker Connection Adapter Factory object */
+ factory: IBrokerConnectionAdapterFactory;
+ /**
+ * Generates and returns the default value formatter for the symbol
+ * @param {string} symbol - symbol identifier
+ * @param {boolean} alignToMinMove - whether the formatted number should be aligned to minimum movement for the symbol
+ */
+ defaultFormatter(
+ symbol: string,
+ alignToMinMove: boolean
+ ): Promise;
+ /**
+ * Generates and returns a number formatter with the desired decimal places
+ * @param {number} [decimalPlaces] - decimal places
+ */
+ numericFormatter(decimalPlaces: number): Promise;
+ /**
+ * Generates and returns a quantity formatter with the desired decimal places
+ * @param {number} [decimalPlaces] - decimal places
+ */
+ quantityFormatter(decimalPlaces?: number): Promise;
+ /**
+ * Provides default buy/sell, show properties actions to be returned as a default by {@link IBrokerCommon.chartContextMenuActions}.
+ * @param {TradeContext} context - trade context
+ * @param {DefaultContextMenuActionsParams} [params] - optional parameters
+ */
+ defaultContextMenuActions(
+ context: TradeContext,
+ params?: DefaultContextMenuActionsParams
+ ): Promise;
+ /**
+ * Provides default dropdown list of actions. You can use default actions in {@link IBrokerConnectionAdapterHost.setButtonDropdownActions}
+ * @param {Partial} [options] - options for the dropdown menu actions
+ */
+ defaultDropdownMenuActions(
+ options?: Partial
+ ): ActionMetaInfo[];
+ /** Returns whether the buy/sell buttons are visible or not. */
+ sellBuyButtonsVisibility(): IWatchedValue | null;
+ /** Returns whether DOM Panel is visible or not. */
+ domPanelVisibility(): IWatchedValue | null;
+ /** Returns whether the order panel is visible or not. */
+ orderPanelVisibility(): IWatchedValue | null;
+ /** Returns if orders can be sent to the broker without showing the order ticket. */
+ silentOrdersPlacement(): IWatchedValue;
+ /**
+ * Patch changes into the current broker configuration
+ * @param {Partial} config - partial configuration changes to apply
+ */
+ patchConfig(config: Partial): void;
+ /**
+ * Set expiration durations
+ * @param {OrderDurationMetaInfo[]} durations - Expiration options for orders
+ */
+ setDurations(durations: OrderDurationMetaInfo[]): void;
+ /**
+ * Call this method to notify the chart that it needs to update information after an order is added or changed.
+ * @param {Order} order - order which was added or changed
+ */
+ orderUpdate(order: Order): void;
+ /**
+ * Call this method when an order is not changed, but the fields that you added to the order object to display in the Account Manager have changed.
+ * It should be used only if you want to display custom fields in the Account Manager.
+ * @param {string} id - order id
+ * @param {Partial} orderChanges - changes made to the order object
+ */
+ orderPartialUpdate(id: string, orderChanges: Partial): void;
+ /**
+ * Call this method when a position is added or changed.
+ * @param {Position} position - position which was added or changed
+ * @param {boolean} [isHistoryUpdate] - whether the change is a history update
+ */
+ positionUpdate(position: Position, isHistoryUpdate?: boolean): void;
+ /**
+ * Call this method when a position is not changed, but the fields that you added to the position object to display in the Account Manager have changed.
+ * It should be used only if you want to display custom fields in the Account Manager.
+ * @param {string} id - id of the position
+ * @param {Partial} positionChanges - changes to the position object
+ */
+ positionPartialUpdate(id: string, positionChanges: Partial): void;
+ /**
+ * Call this method when a trade is added or changed.
+ * @param {Trade} trade - updated trade
+ * @param {boolean} [isHistoryUpdate] - whether the change is a history update
+ */
+ tradeUpdate(trade: Trade, isHistoryUpdate?: boolean): void;
+ /**
+ * Call this method when a trade has not changed, but fields that you added to the trade object to display in the Account Manager have changed.
+ * @param {string} id - id of the updated trade
+ * @param {Partial} tradeChanges - changes to the trade object
+ */
+ tradePartialUpdate(id: string, tradeChanges: Partial): void;
+ /**
+ * Call this method when an execution is added.
+ * @param {Execution} execution - execution which was added
+ */
+ executionUpdate(execution: Execution): void;
+ /**
+ * Call this method when user account has been changed synchronously. The terminal will re-request all displayed information.
+ */
+ currentAccountUpdate(): void;
+ /**
+ * Trading quote realtime update
+ * @param {string} symbol - symbol identifier
+ * @param {TradingQuotes} data - realtime updated data for the symbol quotes
+ */
+ realtimeUpdate(symbol: string, data: TradingQuotes): void;
+ /**
+ * Call this method when a broker connection has received a PL update. This method should be used when `supportPLUpdate` flag is set in `configFlags`.
+ * @param {string} positionId - id of the position
+ * @param {number} pl - updated profit / loss value
+ */
+ plUpdate(positionId: string, pl: number): void;
+ /**
+ * Call this method when a broker connection has a `pipValue` update.
+ * The library subscribes to `pipValue` updates using {@link IBrokerWithoutRealtime.subscribePipValue}.
+ * @param {string} symbol - symbol with updated pip values
+ * @param {PipValues} pipValues - updated pip values
+ */
+ pipValueUpdate(symbol: string, pipValues: PipValues): void;
+ /**
+ * Call this method when a broker connection has received a trade PL update.
+ * @param {string} tradeId - id of the trade
+ * @param {number} pl - updated profit / loss for the trade
+ */
+ tradePLUpdate(tradeId: string, pl: number): void;
+ /**
+ * Call this method when a broker connection has received an equity update. This method is required by the standard Order Dialog to calculate risks.
+ * @param {number} equity - updated equity
+ */
+ equityUpdate(equity: number): void;
+ /**
+ * Call this method when a broker connection has received a margin available update.
+ * This method is required by the standard Order Dialog to display the margin meter.
+ * This method should be used when `supportMargin` flag is set in `configFlags`.
+ * The Trading Platform subscribes to margin available updates using {@link IBrokerWithoutRealtime.subscribeMarginAvailable}.
+ * @param {number} marginAvailable - updated available margin
+ */
+ marginAvailableUpdate(marginAvailable: number): void;
+ /**
+ * Call this method when a broker connection has received a balance update.
+ * This method is required by the crypto Order Dialog.
+ * It should be implemented when `supportBalances` flag is set in `configFlags`.
+ * @param {string} symbol - symbol id
+ * @param {CryptoBalance} balance - updated crypto balance
+ */
+ cryptoBalanceUpdate(symbol: string, balance: CryptoBalance): void;
+ /**
+ * Update the Depth of Market for the specified symbol
+ * @param {string} symbol - symbol identifier
+ * @param {DOMData} equity - Depth of market data
+ */
+ domUpdate(symbol: string, equity: DOMData): void;
+ /**
+ * Sets the quantity for a given symbol.
+ * @param {string} symbol - symbol
+ * @param {number} quantity - quantity to update
+ */
+ setQty(symbol: string, quantity: number): void;
+ /**
+ * Returns the quantity for a given symbol.
+ * @param {string} symbol - symbol
+ * @return {Promise} - quantity for the given symbol
+ */
+ getQty(symbol: string): Promise;
+ /**
+ * Adds a callback to be executed whenever there's a change of quantity for a given symbol.
+ *
+ * It's the user's responsibility to manage the unsubscription of any added listener
+ *
+ * @param {string} symbol - symbol to which the callback will be linked to
+ * @param {SuggestedQtyChangedListener} listener - callback
+ */
+ subscribeSuggestedQtyChange(
+ symbol: string,
+ listener: SuggestedQtyChangedListener
+ ): void;
+ /**
+ * Remove a previously added callback from the list.
+ * @param {string} symbol - symbol to remove the callback from
+ * @param {SuggestedQtyChangedListener} listener - callback to be removed
+ */
+ unsubscribeSuggestedQtyChange(
+ symbol: string,
+ listener: SuggestedQtyChangedListener
+ ): void;
+ /**
+ * Shows the order dialog
+ * @param {T extends PreOrder} order - order to show in the dialog
+ * @param {OrderTicketFocusControl} focus? - input control to focus on when dialog is opened
+ */
+ showOrderDialog?(
+ order: T,
+ focus?: OrderTicketFocusControl
+ ): Promise;
+ /**
+ * Shows notification message
+ * @param {string} title - notification title
+ * @param {string} text - notification content
+ * @param {NotificationType} notificationType? - type of notification (default: NotificationType.Error)
+ */
+ showNotification(
+ title: string,
+ text: string,
+ notificationType?: NotificationType
+ ): void;
+ /**
+ * Shows the cancel order dialog for specified order
+ * @param {string} orderId - id of order to potentially cancel
+ * @param {()=>Promise} handler - cancel order confirmation handler (called when order should be cancelled)
+ */
+ showCancelOrderDialog(
+ orderId: string,
+ handler: () => Promise
+ ): Promise;
+ /**
+ * Shows the cancel order dialog for multiple orders
+ * @param {string} symbol - symbol for which to cancel orders
+ * @param {Side} side - side of the order
+ * @param {number} qty - quantity of the order
+ * @param {()=>Promise} handler - cancel orders confirmation handler (called when orders should be cancelled)
+ */
+ showCancelMultipleOrdersDialog(
+ symbol: string,
+ side: Side,
+ qty: number,
+ handler: () => Promise
+ ): Promise;
+ /**
+ * Shows the cancel brackets dialog
+ * @param {string} orderId - id of order
+ * @param {()=>Promise} handler - cancel brackets confirmation handler (called when brackets should be cancelled)
+ */
+ showCancelBracketsDialog(
+ orderId: string,
+ handler: () => Promise
+ ): Promise;
+ /**
+ * Shows the cancel brackets dialog for multiple brackets
+ * @param {string} orderId - id of order
+ * @param {()=>Promise} handler - cancel brackets confirmation handler (called when brackets should be cancelled)
+ */
+ showCancelMultipleBracketsDialog(
+ orderId: string,
+ handler: () => Promise
+ ): Promise;
+ /**
+ * Shows reverse position dialog
+ * @param {string} position - position to be reversed
+ * @param {()=>Promise} handler - reverse position confirmation handler (called when the position should be reversed)
+ */
+ showReversePositionDialog(
+ position: string,
+ handler: () => Promise
+ ): Promise;
+ /**
+ * Shows the position brackets dialog
+ * @param {Position|Trade} position - position or trade
+ * @param {Brackets} brackets - brackets for the position or trade
+ * @param {OrderTicketFocusControl} focus - input control to focus on when dialog is opened
+ */
+ showPositionBracketsDialog(
+ position: Position | Trade,
+ brackets: Brackets,
+ focus: OrderTicketFocusControl
+ ): Promise;
+ /**
+ * Bottom Trading Panel has a button with a list of dropdown items. This method can be used to replace existing items.
+ * @param {ActionMetaInfo[]} descriptions - Descriptions for the dropdown items.
+ */
+ setButtonDropdownActions(descriptions: ActionMetaInfo[]): void;
+ /**
+ * Activate bottom widget
+ */
+ activateBottomWidget(): Promise;
+ /**
+ * Shows trading properties
+ */
+ showTradingProperties(): void;
+ /**
+ * Returns symbol `minTick`.
+ * @param {string} symbol - symbol identifier
+ */
+ getSymbolMinTick(symbol: string): Promise;
+ /**
+ * Displays a message dialog to a user.
+ * @param {string} title - title of the message dialog
+ * @param {string} text - message
+ * @param {boolean} textHasHTML? - whether message text contains HTML
+ */
+ showMessageDialog(title: string, text: string, textHasHTML?: boolean): void;
+ /**
+ * Displays a confirmation dialog to a user and returns a Promise to the result.
+ * @param {string} title - title of the confirmation dialog
+ * @param {string|string[]} content - content for the dialog
+ * @param {string} [mainButtonText] - text for the main button (`true` result)
+ * @param {string} [cancelButtonText] - text for the cancel button (`false` result)
+ * @param {boolean} [showDisableConfirmationsCheckbox] - show disable confirmations checkbox within the dialog
+ */
+ showConfirmDialog(
+ title: string,
+ content: string | string[],
+ mainButtonText?: string,
+ cancelButtonText?: string,
+ showDisableConfirmationsCheckbox?: boolean
+ ): Promise;
+ /**
+ * Displays a simple confirmation dialog to a user and returns a Promise to the result.
+ * @param {string} title - title of the confirmation dialog
+ * @param {string|string[]} content - content for the dialog
+ * @param {string} [mainButtonText] - text for the main button (`true` result)
+ * @param {string} [cancelButtonText] - text for the cancel button (`false` result)
+ * @param {boolean} [showDisableConfirmationsCheckbox] - show disable confirmations checkbox within the dialog
+ */
+ showSimpleConfirmDialog(
+ title: string,
+ content: string | string[],
+ mainButtonText?: string,
+ cancelButtonText?: string,
+ showDisableConfirmationsCheckbox?: boolean
+ ): Promise;
+}
+export interface IBrokerTerminal extends IBrokerWithoutRealtime {
+ /**
+ * Library is requesting that realtime updates should be supplied for this symbol.
+ * @param {string} symbol - symbol identifier
+ */
+ subscribeRealtime(symbol: string): void;
+ /**
+ * Library is notifying that realtime updates are no longer required for this symbol.
+ * @param {string} symbol - symbol identifier
+ */
+ unsubscribeRealtime(symbol: string): void;
+}
+/**
+ * The Broker API is a key component that enables trading.
+ * Its main purpose is to connect TradingView charts with your trading logic.
+ * Refer to the [Core trading concepts](https://www.tradingview.com/charting-library-docs/latest/trading_terminal/trading-concepts.md) article for more information.
+ */
+export interface IBrokerWithoutRealtime extends IBrokerCommon {
+ /**
+ * Library is requesting that realtime DOM (Depth of Market) updates should be supplied for this symbol
+ * @param {string} symbol - symbol identifier
+ */
+ subscribeDOM?(symbol: string): void;
+ /**
+ * Library is notifying that realtime DOM (Depth of Market) updates are no longer required for this symbol.
+ * @param {string} symbol - symbol identifier
+ */
+ unsubscribeDOM?(symbol: string): void;
+ /**
+ * Method is called when a user wants to place an order. Order is pre-filled with partial or complete information. This function returns an object with the order id.
+ * @param {PreOrder} order - order information
+ * @param {string} [confirmId] - is passed if `supportPlaceOrderPreview` configuration flag is on.
+ * @returns PlaceOrderResult, which should include an `orderId`
+ */
+ placeOrder(order: PreOrder, confirmId?: string): Promise;
+ /**
+ * Returns estimated commission, fees, margin and other information for the order without it actually being placed.
+ * The method is called if `supportPlaceOrderPreview` configuration flag is on.
+ * @param {PreOrder} order - order information
+ */
+ previewOrder?(order: PreOrder): Promise;
+ /**
+ * Method is called when a user wants to modify an existing order.
+ * @param {Order} order - order information
+ * @param {string} [confirmId] - is passed if `supportPlaceOrderPreview` configuration flag is on.
+ */
+ modifyOrder(order: Order, confirmId?: string): Promise;
+ /**
+ * This method is called to cancel a single order with the given `id`.
+ * @param {string} orderId - id for the order to cancel
+ */
+ cancelOrder(orderId: string): Promise;
+ /**
+ * This method is called to cancel multiple orders for a `symbol` and `side`.
+ *
+ * `ordersIds` parameter should contain the list of order ids to be cancelled.
+ * @param {string} symbol - symbol identifier
+ * @param {Side|undefined} side - order side
+ * @param {string[]} ordersIds - ids already collected by `symbol` and `side`
+ */
+ cancelOrders(
+ symbol: string,
+ side: Side | undefined,
+ ordersIds: string[]
+ ): Promise;
+ /**
+ * This method is called if `supportNativeReversePosition` configuration flag is on. It allows to reverse the position by id.
+ * @param {string} positionId - position
+ */
+ reversePosition?(positionId: string): Promise;
+ /**
+ * This method is called if `supportClosePosition` configuration flag is on. It allows to close the position by id.
+ * @param {string} positionId - position id
+ * @param {number} [amount] - The amount is specified if `supportPartialClosePosition` is `true` and the user wants to close only part of the position.
+ */
+ closePosition?(positionId: string, amount?: number): Promise;
+ /**
+ * This method is called if `supportCloseTrade` configuration flag is on. It allows to close the trade by id.
+ * @param {string} tradeId - trade id
+ * @param {number} [amount] - The amount is specified if `supportPartialCloseTrade` is `true` and the user wants to close only part of the trade.
+ */
+ closeTrade?(tradeId: string, amount?: number): Promise;
+ /**
+ * This method is called if `supportPositionBrackets` configuration flag is on. It shows a dialog that enables `take profit` and `stop loss` editing.
+ * @param {string} positionId - is an ID of an existing position to be modified
+ * @param {Brackets} brackets - new Brackets to be set for the position
+ * @param {CustomInputFieldsValues} [customFields] - custom fields to display in the dialog
+ */
+ editPositionBrackets?(
+ positionId: string,
+ brackets: Brackets,
+ customFields?: CustomInputFieldsValues
+ ): Promise;
+ /**
+ * This method is called if `supportTradeBrackets` configuration flag is on. It displays a dialog that enables take profit and stop loss editing.
+ * @param {string} tradeId - ID of existing trade to be modified
+ * @param {Brackets} brackets - new Brackets to be set for the trade
+ */
+ editTradeBrackets?(tradeId: string, brackets: Brackets): Promise;
+ /**
+ * This method is called to receive leverageInfo from the broker.
+ * @param {LeverageInfoParams} leverageInfoParams - information about the specific symbol to provide leverage info for
+ */
+ leverageInfo?(leverageInfoParams: LeverageInfoParams): Promise;
+ /**
+ * This method is called to send user's leverage value to the broker. The value should be verified and corrected on the broker's side if required, and sent back in the response.
+ * @param {LeverageSetParams} leverageSetParams - `leverageSetParams` is an object similar to {@link leverageInfoParams}, but contains an additional `leverage: number` field, which holds the leverage value set by the user.
+ */
+ setLeverage?(
+ leverageSetParams: LeverageSetParams
+ ): Promise;
+ /**
+ * This method is called to receive {@link LeveragePreviewResult} object which holds messages about the leverage value set by the user.
+ * @param {LeverageSetParams} leverageSetParams - `leverageSetParams` is an object similar to {@link leverageInfoParams}, but contains an additional `leverage: number` field, which holds the leverage value set by the user.
+ */
+ previewLeverage?(
+ leverageSetParams: LeverageSetParams
+ ): Promise;
+ /**
+ * The method should be implemented if you use the standard Order dialog and support stop loss. Equity is used to calculate Risk in Percent.
+ *
+ * Once this method is called the broker should provide equity (Balance + P/L) updates via {@link IBrokerConnectionAdapterHost.equityUpdate} method.
+ */
+ subscribeEquity?(): void;
+ /**
+ * The method should be implemented if you use the standard Order dialog and want to show the margin meter.
+ *
+ * Once this method is called the broker should provide margin available updates via {@link IBrokerConnectionAdapterHost.marginAvailableUpdate} method.
+ * @param {string} symbol - symbol identifier
+ */
+ subscribeMarginAvailable?(symbol: string): void;
+ /**
+ * The method should be implemented if you use a standard Order dialog.
+ * `pipValues` is displayed in the Order info and it is used to calculate the Trade Value and risks.
+ * If this method is not implemented then `pipValue` from the `symbolInfo` is used in the order panel/dialog.
+ *
+ * Once this method is called the broker should provide `pipValue` updates via {@link IBrokerConnectionAdapterHost.pipValueUpdate} method.
+ * @param {string} symbol - symbol identifier
+ */
+ subscribePipValue?(symbol: string): void;
+ /**
+ * The method should be implemented if you use a standard Order dialog and implement `subscribePipValue`.
+ *
+ * Once this method is called the broker should stop providing `pipValue` updates.
+ * @param {string} symbol - symbol identifier
+ */
+ unsubscribePipValue?(symbol: string): void;
+ /**
+ * The method should be implemented if you use the standard Order dialog want to show the margin meter.
+ *
+ * Once this method is called the broker should stop providing margin available updates.
+ * @param {string} symbol - symbol identifier
+ */
+ unsubscribeMarginAvailable?(symbol: string): void;
+ /**
+ * The method should be implemented if you use the standard Order dialog and support stop loss.
+ *
+ * Once this method is called the broker should stop providing equity updates.
+ */
+ unsubscribeEquity?(): void;
+}
+/**
+ * The main chart API.
+ *
+ * This interface can be retrieved by using the following widget ({@link IChartingLibraryWidget}) methods:
+ * - `chart` ({@link IChartingLibraryWidget.chart})
+ * - `activeChart` ({@link IChartingLibraryWidget.activeChart})
+ */
+export interface IChartWidgetApi {
+ /**
+ * Get a subscription object for new data being loaded for the chart.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().onDataLoaded().subscribe(
+ * null,
+ * () => console.log('New history bars are loaded'),
+ * true
+ * );
+ * ```
+ * @returns A subscription object for new data loaded for the chart.
+ */
+ onDataLoaded(): ISubscription<() => void>;
+ /**
+ * Get a subscription object for the chart symbol changing.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().onSymbolChanged().subscribe(null, () => console.log('The symbol is changed'));
+ * ```
+ * @returns A subscription object for when a symbol is resolved (ie changing resolution, timeframe, currency, etc.)
+ */
+ onSymbolChanged(): ISubscription<() => 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.md#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.md#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.
+ *
+ * **Examples**
+ *
+ * The following code sample specifies a time frame value:
+ *
+ * ```javascript
+ * widget.activeChart().onIntervalChanged().subscribe(null, (interval, timeframeObj) =>
+ * timeframeObj.timeframe = {
+ * value: "12M",
+ * type: "period-back"
+ * });
+ * ```
+ *
+ * The following code sample specifies a certain date range:
+ *
+ * ```javascript
+ * widget.activeChart().onIntervalChanged().subscribe(null, (interval, timeframeObj) =>
+ * timeframeObj.timeframe = {
+ * from: new Date('2015-01-01').getTime() / 1000,
+ * to: new Date('2017-01-01').getTime() / 1000,
+ * type: "time-range"
+ * });
+ * ```
+ * @returns A subscription object for the chart interval (resolution) changing.
+ */
+ onIntervalChanged(): ISubscription<
+ (
+ interval: ResolutionString,
+ timeFrameParameters: {
+ timeframe?: TimeFrameValue;
+ }
+ ) => void
+ >;
+ /**
+ * Get a subscription object for the chart's visible range changing.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().onVisibleRangeChanged().subscribe(
+ * null,
+ * ({ from, to }) => console.log(from, to)
+ * );
+ * ```
+ * @returns A subscription object for the chart's visible range changing.
+ */
+ onVisibleRangeChanged(): ISubscription<(range: VisibleTimeRange) => void>;
+ /**
+ * Get a subscription object for the chart type changing.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().onChartTypeChanged().subscribe(
+ * null,
+ * (chartType) => console.log('The type of chart is changed')
+ * );
+ * ```
+ * @returns A subscription object for the chart type changing.
+ */
+ onChartTypeChanged(): ISubscription<(chartType: SeriesType) => void>;
+ /**
+ * Provide a callback function that will be called when chart data is loaded.
+ * If chart data is already loaded when this method is called, the callback is called immediately.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().dataReady(() => {
+ * // ...
+ * }
+ * ```
+ *
+ * @param callback A callback function called when chart data is loaded.
+ */
+ dataReady(callback: () => void): boolean;
+ /**
+ * Get a subscription object for the crosshair moving over the chart.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().crossHairMoved().subscribe(
+ * null,
+ * ({ time, price }) => console.log(time, price)
+ * );
+ * ```
+ * @returns A subscription object for the crosshair moving over the chart.
+ */
+ crossHairMoved(): ISubscription<(params: CrossHairMovedEventParams) => void>;
+ /**
+ * Get a subscription object for the ID of the study or series hovered by the crosshair.
+ *
+ * @returns A subscription object for the ID of the study or series hovered by the crosshair. Subscribers will be called with `null` if there is no study or series hovered.
+ */
+ onHoveredSourceChanged(): ISubscription<(sourceId: EntityId) => void>;
+ /**
+ * Scroll and/or scale the chart so a time range is visible.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().setVisibleRange(
+ * { from: 1420156800, to: 1451433600 },
+ * { percentRightMargin: 20 }
+ * ).then(() => console.log('New visible range is applied'));
+ * ```
+ * @param range A range that will be made visible.
+ * @param options Optional object of options for the new visible range.
+ * @returns A promise that is resolved when the range has been set.
+ */
+ setVisibleRange(
+ range: SetVisibleTimeRange,
+ options?: SetVisibleRangeOptions
+ ): Promise;
+ /**
+ * Change the chart's symbol.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().setSymbol('IBM');
+ * ```
+ * Note: if you are attempting to change multiple charts (multi-chart layouts) at the same time with
+ * multiple `setSymbol` calls then you should set `doNotActivateChart` option to `true`.
+ *
+ * @param symbol A symbol.
+ * @param options Optional object of options for the new symbol or optional callback that is called when the data for the new symbol has loaded.
+ */
+ setSymbol(symbol: string, options?: SetSymbolOptions | (() => void)): void;
+ /**
+ * Change the chart's interval (resolution).
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().setResolution('2M');
+ * ```
+ * Note: if you are attempting to change multiple charts (multi-chart layouts) at the same time with
+ * multiple `setResolution` calls then you should set `doNotActivateChart` option to `true`.
+ *
+ * @param resolution A resolution.
+ * @param options Optional object of options for the new resolution or optional callback that is called when the data for the new resolution has loaded.
+ */
+ setResolution(
+ resolution: ResolutionString,
+ options?: SetResolutionOptions | (() => void)
+ ): void;
+ /**
+ * Change the chart's type.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().setChartType(12); // Specifies the High-low type
+ * ```
+ *
+ * @param type A chart type.
+ * @param callback An optional callback function. Called when the chart type has changed and data has loaded.
+ */
+ setChartType(type: SeriesType, callback?: () => void): void;
+ /**
+ * Force the chart to re-request data.
+ * Before calling this function the `onResetCacheNeededCallback` callback from {@link IDatafeedChartApi.subscribeBars} should be called.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().resetData();
+ * ```
+ *
+ */
+ resetData(): void;
+ /**
+ * Execute an action.
+ *
+ * **Example**
+ * ```javascript
+ * // ...
+ * widget.activeChart().executeActionById("undo");
+ * // ...
+ * widget.activeChart().executeActionById("drawingToolbarAction"); // Hides or shows the drawing toolbar
+ * // ...
+ * ```
+ *
+ * @param actionId An action ID.
+ */
+ executeActionById(actionId: ChartActionId): void;
+ /**
+ * Get the state of a checkable action.
+ *
+ * **Example**
+ * ```javascript
+ * if (widget.activeChart().getCheckableActionState("drawingToolbarAction")) {
+ * // ...
+ * };
+ * ```
+ *
+ * @param actionId An action ID.
+ * @returns `true` if the action is checked, `false` otherwise.
+ */
+ getCheckableActionState(actionId: ChartActionId): boolean;
+ /**
+ * Force the chart to re-request all bar marks and timescale marks.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().refreshMarks();
+ * ```
+ *
+ */
+ refreshMarks(): void;
+ /**
+ * Remove marks from the chart.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().clearMarks();
+ * ```
+ *
+ * @param marksToClear type of marks to clear. If nothing is specified both bar & timescale marks will be removed.
+ */
+ clearMarks(marksToClear?: ClearMarksMode): void;
+ /**
+ * Get an array of IDs and name for all drawings on the chart.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().getAllShapes().forEach(({ name }) => console.log(name));
+ * ```
+ *
+ * @returns An array of drawing information.
+ */
+ getAllShapes(): EntityInfo[];
+ /**
+ * Get an array of IDs and names for all studies on the chart.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().getAllStudies().forEach(({ name }) => console.log(name));
+ * ```
+ *
+ * @returns An array of study information.
+ */
+ getAllStudies(): EntityInfo[];
+ /**
+ * Get the chart's price to bar ratio.
+ *
+ * **Example**
+ * ```javascript
+ * console.log(widget.activeChart().getPriceToBarRatio());
+ * ```
+ *
+ * @returns The ratio or `null` if no ratio is defined.
+ */
+ getPriceToBarRatio(): number | null;
+ /**
+ * Set the chart's price to bar ratio.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().setPriceToBarRatio(0.4567, { disableUndo: true });
+ * ```
+ *
+ * @param ratio The new price to bar ratio.
+ * @param options Optional undo options.
+ */
+ setPriceToBarRatio(ratio: number, options?: UndoOptions): void;
+ /**
+ * Get the locked/unlocked state of the chart's price to bar ratio.
+ *
+ * **Example**
+ * ```javascript
+ * console.log(widget.activeChart().isPriceToBarRatioLocked());
+ * ```
+ *
+ */
+ isPriceToBarRatioLocked(): boolean;
+ /**
+ * Lock or unlock the chart's price to bar ratio.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().setPriceToBarRatioLocked(true, { disableUndo: false });
+ * ```
+ *
+ * @param value `true` to lock, `false` to unlock.
+ * @param options Optional undo options.
+ */
+ setPriceToBarRatioLocked(value: boolean, options?: UndoOptions): void;
+ /**
+ * Get an array of the heigh of all panes.
+ *
+ * **Example**
+ * ```javascript
+ * console.log(widget.activeChart().getAllPanesHeight());
+ * ```
+ *
+ * @returns An array of heights.
+ */
+ getAllPanesHeight(): number[];
+ /**
+ * Set the height for each pane in the order provided.
+ *
+ * **Example**
+ * ```javascript
+ * console.log(widget.activeChart().setAllPanesHeight([250, 400, 200]));
+ * ```
+ *
+ * @param heights An array of heights.
+ */
+ setAllPanesHeight(heights: readonly number[]): void;
+ /**
+ * Maximize to its full size currently selected chart.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().maximizeChart();
+ * ```
+ */
+ maximizeChart(): void;
+ /**
+ * Check if the chart is maximized or not.
+ *
+ * @returns `true` if maximized, `false` otherwise.
+ */
+ isMaximized(): boolean;
+ /**
+ * Restore to its initial size currently selected chart.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().restoreChart();
+ * ```
+ */
+ restoreChart(): void;
+ /**
+ * Get an object with operations available for the specified set of entities.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().availableZOrderOperations([id]);
+ * ```
+ *
+ * @param sources An array of entity IDs.
+ */
+ availableZOrderOperations(
+ sources: readonly EntityId[]
+ ): AvailableZOrderOperations;
+ /**
+ * Move the group to the bottom of the Z-order.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().sendToBack([id]);
+ * ```
+ *
+ * @param sources An array of source IDs.
+ */
+ sendToBack(entities: readonly EntityId[]): void;
+ /**
+ * Move the sources to the top of the Z-order.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().bringToFront([id]);
+ * ```
+ *
+ * @param sources An array of source IDs.
+ */
+ bringToFront(sources: readonly EntityId[]): void;
+ /**
+ * Move the sources one level up in the Z-order.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().bringForward([id]);
+ * ```
+ *
+ * @param sources An array of source IDs.
+ */
+ bringForward(sources: readonly EntityId[]): void;
+ /**
+ * Move the sources one level down in the Z-order.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().sendBackward([id]);
+ * ```
+ *
+ * @param sources An array of source IDs.
+ */
+ sendBackward(sources: readonly EntityId[]): void;
+ /**
+ * Adds an indicator or a symbol for comparison to the chart.
+ * For more information, refer to the [Indicators](https://www.tradingview.com/charting-library-docs/latest/ui_elements/indicators/indicators.md) article.
+ *
+ * @param {string} name - name of an indicator as shown in the `Indicators` widget
+ * @param {boolean} [forceOverlay] - forces the Charting Library to place the created indicator on the main pane
+ * @param {boolean} [lock] - whether a user will be able to remove/change/hide the indicator or not
+ * @param {Record(
+ name: string,
+ forceOverlay?: boolean,
+ lock?: boolean,
+ inputs?: Record,
+ overrides?: TOverrides,
+ options?: CreateStudyOptions
+ ): Promise;
+ /**
+ * Get a study by ID.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().getStudyById(id).setVisible(false);
+ * ```
+ *
+ * @param entityId The study ID.
+ * @returns An API object for interacting with the study.
+ */
+ getStudyById(entityId: EntityId): IStudyApi;
+ /**
+ * Get the main series.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().getSeries().setVisible(false);
+ * ```
+ *
+ * @returns An API object for interacting with the main series.
+ */
+ getSeries(): ISeriesApi;
+ /**
+ * Create a new single point drawing.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().createShape({ time: 1514764800 }, { shape: 'vertical_line' });
+ * ```
+ *
+ * @param point A point. The location of the new drawing.
+ * @param options An options object for the new drawing.
+ * @returns The ID of the new drawing if it was created successfully, or null otherwise.
+ */
+ createShape(
+ point: ShapePoint,
+ options: CreateShapeOptions
+ ): EntityId | null;
+ /**
+ * Create a new multi point drawing.
+ *
+ * **Example**
+ * ```javascript
+ * const from = Date.now() / 1000 - 500 * 24 * 3600; // 500 days ago
+ * const to = Date.now() / 1000;
+ * widget.activeChart().createMultipointShape(
+ * [{ time: from, price: 150 }, { time: to, price: 150 }],
+ * {
+ * shape: "trend_line",
+ * lock: true,
+ * disableSelection: true,
+ * disableSave: true,
+ * disableUndo: true,
+ * text: "text",
+ * }
+ * );
+ * ```
+ *
+ * @param points An array of points that define the drawing.
+ * @param options An options object for the new drawing.
+ * @returns The ID of the new drawing if it was created successfully, or null otherwise.
+ */
+ createMultipointShape(
+ points: ShapePoint[],
+ options: CreateMultipointShapeOptions
+ ): EntityId | null;
+ /**
+ * Create a new anchored drawing. Anchored drawings maintain their position when the chart's visible range changes.
+ *
+ * **Example**
+ * ```javascript
+ * widget.createAnchoredShape({ x: 0.1, y: 0.9 }, { shape: 'anchored_text', text: 'Hello, charts!', overrides: { color: 'green' }});
+ * ```
+ *
+ * @param position Percent-based x and y position of the new drawing, relative to the top left of the chart.
+ * @param options An options object for the new drawing.
+ */
+ createAnchoredShape(
+ position: PositionPercents,
+ options: CreateAnchoredShapeOptions
+ ): EntityId | null;
+ /**
+ * Get a drawing by ID.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().getShapeById(id).bringToFront();
+ * ```
+ *
+ * @param entityId A drawing ID.
+ * @returns An API object for interacting with the drawing.
+ */
+ getShapeById(entityId: EntityId): ILineDataSourceApi;
+ /**
+ * Remove an entity (e.g. drawing or study) from the chart.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().removeEntity(id);
+ * ```
+ *
+ * @param entityId The ID of the entity.
+ * @param options Optional undo options.
+ */
+ removeEntity(entityId: EntityId, options?: UndoOptions): void;
+ /**
+ * Remove all drawings from the chart.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().removeAllShapes();
+ * ```
+ *
+ */
+ removeAllShapes(): void;
+ /**
+ * Remove all studies from the chart.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().removeAllStudies();
+ * ```
+ *
+ */
+ removeAllStudies(): void;
+ /**
+ * Get an API object for interacting with the selection.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().selection().clear();
+ * ```
+ *
+ */
+ selection(): ISelectionApi;
+ /**
+ * Show the properties dialog for a study or drawing.
+ *
+ * **Example**
+ * ```javascript
+ * const chart = widget.activeChart();
+ * chart.showPropertiesDialog(chart.getAllShapes()[0].id);`
+ * ```
+ *
+ * @param studyId An ID of the study or drawing.
+ */
+ showPropertiesDialog(studyId: EntityId): void;
+ /**
+ * Save the current study template to a object.
+ *
+ * **Example**
+ * ```javascript
+ * const options = { saveSymbol: true, saveInterval: true };
+ * const template = widget.activeChart().createStudyTemplate(options);
+ * ```
+ *
+ * @param options An object of study template options.
+ * @returns A study template object.
+ */
+ createStudyTemplate(options: CreateStudyTemplateOptions): object;
+ /**
+ * Apply a study template to the chart.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().applyStudyTemplate(template);
+ * ```
+ *
+ * @param template A study template object.
+ */
+ applyStudyTemplate(template: object): void;
+ /**
+ * Create a new trading order on the chart.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().createOrderLine()
+ * .setTooltip("Additional order information")
+ * .setModifyTooltip("Modify order")
+ * .setCancelTooltip("Cancel order")
+ * .onMove(function() {
+ * this.setText("onMove called");
+ * })
+ * .onModify("onModify called", function(text) {
+ * this.setText(text);
+ * })
+ * .onCancel("onCancel called", function(text) {
+ * this.setText(text);
+ * })
+ * .setText("STOP: 73.5 (5,64%)")
+ * .setQuantity("2");
+ * ```
+ *
+ * @param options Optional undo options.
+ * @returns An API object for interacting with the order.
+ */
+ createOrderLine(options?: UndoOptions): IOrderLineAdapter;
+ /**
+ * Creates a new trading position on the chart.
+ *
+ * **Example**
+ * ```javascript
+ * widget.chart().createPositionLine()
+ * .onModify(function() {
+ * this.setText("onModify called");
+ * })
+ * .onReverse("onReverse called", function(text) {
+ * this.setText(text);
+ * })
+ * .onClose("onClose called", function(text) {
+ * this.setText(text);
+ * })
+ * .setText("PROFIT: 71.1 (3.31%)")
+ * .setTooltip("Additional position information")
+ * .setProtectTooltip("Protect position")
+ * .setCloseTooltip("Close position")
+ * .setReverseTooltip("Reverse position")
+ * .setQuantity("8.235")
+ * .setPrice(160)
+ * .setExtendLeft(false)
+ * .setLineStyle(0)
+ * .setLineLength(25);
+ * ```
+ *
+ * @param options Optional undo options.
+ * @returns An API object for interacting with the position.
+ */
+ createPositionLine(options?: UndoOptions): IPositionLineAdapter;
+ /**
+ * Creates a new trade execution on the chart.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().createExecutionShape()
+ * .setText("@1,320.75 Limit Buy 1")
+ * .setTooltip("@1,320.75 Limit Buy 1")
+ * .setTextColor("rgba(0,255,0,0.5)")
+ * .setArrowColor("#0F0")
+ * .setDirection("buy")
+ * .setTime(widget.activeChart().getVisibleRange().from)
+ * .setPrice(160);
+ * ```
+ *
+ * @param options Optional undo options.
+ * @returns An API object for interacting with the execution.
+ */
+ createExecutionShape(options?: UndoOptions): IExecutionLineAdapter;
+ /**
+ * Get the name of the current symbol.
+ *
+ * **Example**
+ * ```javascript
+ * console.log(widget.activeChart().symbol());
+ * ```
+ *
+ */
+ symbol(): string;
+ /**
+ * Get an extended information object for the current symbol.
+ *
+ * **Example**
+ * ```javascript
+ * console.log(widget.activeChart().symbolExt().full_name);
+ * ```
+ *
+ */
+ symbolExt(): SymbolExt | null;
+ /**
+ * Get the current resolution (interval).
+ *
+ * **Example**
+ * ```javascript
+ * console.log(widget.activeChart().resolution());
+ * ```
+ *
+ */
+ resolution(): ResolutionString;
+ /**
+ * Get the current visible time range.
+ *
+ * **Example**
+ * ```javascript
+ * console.log(widget.activeChart().getVisibleRange());
+ * ```
+ *
+ */
+ getVisibleRange(): VisibleTimeRange;
+ /**
+ * Returns the object with 'format' function that you can use to format the prices.
+ *
+ * ```javascript
+ * widget.activeChart().priceFormatter().format(123);
+ * ```
+ */
+ priceFormatter(): INumberFormatter;
+ /**
+ * Returns the main series style type.
+ *
+ * ```javascript
+ * console.log(widget.activeChart().chartType());
+ * ```
+ */
+ chartType(): SeriesType;
+ /**
+ * Get an API object for interacting with the chart timezone.
+ */
+ getTimezoneApi(): ITimezoneApi;
+ /**
+ * Get an array of API objects for interacting with the chart panes.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().getPanes()[1].moveTo(0);
+ * ```
+ *
+ */
+ getPanes(): IPaneApi[];
+ /**
+ * Export the current data from the chart.
+ *
+ * **Example**
+ * ```javascript
+ * // Exports series' data only
+ * widget.activeChart().exportData({ includeTime: false, includedStudies: [] });
+ * // Exports series' data with times
+ * widget.activeChart().exportData({ includedStudies: [] });
+ * // Exports series' data with with user time
+ * widget.activeChart().exportData({ includeTime: false, includeUserTime: true, includedStudies: [] });
+ * // Exports data for the indicator which ID is STUDY_ID
+ * widget.activeChart().exportData({ includeTime: false, includeSeries: false, includedStudies: ['STUDY_ID'] });
+ * // Exports all available data from the chart
+ * widget.activeChart().exportData({ includeUserTime: true });
+ * // Exports series' data before 2018-01-01
+ * widget.activeChart().exportData({ includeTime: false, to: Date.UTC(2018, 0, 1) / 1000 });
+ * // Exports series' data after 2018-01-01
+ * widget.activeChart().exportData({ includeTime: false, from: Date.UTC(2018, 0, 1) / 1000 });
+ * // Exports series' data in the range between 2018-01-01 and 2018-02-01
+ * widget.activeChart().exportData({ includeTime: false, from: Date.UTC(2018, 0, 1) / 1000, to: Date.UTC(2018, 1, 1) / 1000 });
+ * // Exports all displayed data on the chart
+ * widget.activeChart().exportData({ includeDisplayedValues: true });
+ * ```
+ *
+ * @param options Optional object of options to control the exported data.
+ * @returns A promise that resolves with the exported data.
+ */
+ exportData(options?: Partial): Promise;
+ /**
+ * Check if the chart can be zoomed out using the {@link zoomOut} method.
+ *
+ * **Example**
+ * ```javascript
+ * if(widget.activeChart().canZoomOut()) {
+ * widget.activeChart().zoomOut();
+ * };
+ * ```
+ *
+ * @returns `true` if the chart can be zoomed out.
+ */
+ canZoomOut(): boolean;
+ /**
+ * Zoom out. The method has the same effect as clicking on the "Zoom out" button.
+ */
+ zoomOut(): void;
+ /**
+ * Enable or disable zooming of the chart.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().setZoomEnabled(false);
+ * ```
+ *
+ * @param enabled `true` to enable zooming, `false` to disable.
+ */
+ setZoomEnabled(enabled: boolean): void;
+ /**
+ * Enable or disable scrolling of the chart.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().setScrollEnabled(false);
+ * ```
+ *
+ * @param enabled `true` to enable scrolling, `false` to disable.
+ */
+ setScrollEnabled(enabled: boolean): void;
+ /**
+ * Get an API object for interacting with groups of drawings.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().shapesGroupController().createGroupFromSelection();
+ * ```
+ *
+ */
+ shapesGroupController(): IShapesGroupControllerApi;
+ /**
+ * Get the bar time to the end of the period
+ * @param {number} unixTime - date timestamp
+ */
+ barTimeToEndOfPeriod(unixTime: number): number;
+ /**
+ * Get the end of period to bar time
+ * @param {number} unixTime - date timestamp
+ */
+ endOfPeriodToBarTime(unixTime: number): number;
+ /**
+ * Get an API object for interacting with the timescale.
+ *
+ * **Example**
+ * ```javascript
+ * var time = widget.activeChart().getTimeScale().coordinateToTime(100);
+ * ```
+ *
+ */
+ getTimeScale(): ITimeScaleApi;
+ /**
+ * Check if bar selection mode is active or not.
+ *
+ * **Example**
+ * ```javascript
+ * var isRequested = widget.activeChart().isSelectBarRequested();
+ * ```
+ *
+ * @returns `true` if active, `false` otherwise.
+ */
+ isSelectBarRequested(): boolean;
+ /**
+ * Switch the chart to bar selection mode.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().requestSelectBar()
+ * .then(function(time) {
+ * console.log('user selects bar with time', time);
+ * })
+ * .catch(function() {
+ * console.log('bar selection was rejected');
+ * });
+ * ```
+ *
+ * @returns A promise that resolves to the timestamp of a bar selected by the user. Rejects if the bar selection was already requested or is cancelled.
+ */
+ requestSelectBar(): Promise;
+ /**
+ * Cancel any active bar selection requests.
+ *
+ * **Example**
+ * ```javascript
+ * widget.activeChart().cancelSelectBar();
+ * ```
+ *
+ */
+ cancelSelectBar(): void;
+ /**
+ * Load and apply a chart template.
+ *
+ * @param templateName The name of the template to load.
+ */
+ loadChartTemplate(templateName: string): Promise;
+ /**
+ * Get a readonly watched value that can be used to read/subscribe to the state of the chart's market status.
+ */
+ marketStatus(): IWatchedValueReadonly;
+ /**
+ * Set the time frame for this chart.
+ *
+ * **Note:** This action will set this chart as active in a multi-chart layout.
+ *
+ * **Example**
+ * To apply the '1Y' timeframe:
+ * ```js
+ * tvWidget.setTimeFrame({
+ * val: { type: 'period-back', value: '12M' },
+ * res: '1W',
+ * });
+ * ```
+ *
+ * @param timeFrame Object specifying the range and resolution to be applied
+ */
+ setTimeFrame(timeFrame: RangeOptions): void;
+}
+/**
+ * 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.md) article.
+ */
+export interface IChartingLibraryWidget {
+ /**
+ * A promise that resolves if and when the header is ready to be used.
+ */
+ headerReady(): Promise;
+ /**
+ * The library will call `callback` when the chart is ready to be used.
+ *
+ * @param callback A function that will be called when the chart is ready to be used.
+ */
+ onChartReady(callback: EmptyCallback): void;
+ /**
+ * The library will call `callback` when a greyed-out drawing tool or study is clicked.
+ *
+ * @param callback A function that will be called when a greyed-out drawing tool or study is clicked.
+ */
+ onGrayedObjectClicked(callback: (obj: GrayedObject) => void): void;
+ /**
+ * The library will call `callback` when the `shortCut` keys are input.
+ *
+ * Use a string separated by '+' for shortcuts using an alphabet character (A to Z) with optional modifiers (ctrl, shift, alt).
+ * Use a number for shortcuts using non-alphabet character without modifiers.
+ * If you don't know the key code you need you can use resources like [keycode.info](https://keycode.info), or [MDN](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode) to check.
+ * Use an array of literal key codes and modifier strings for shortcuts using non-alphabet characters with optional modifier strings.
+ *
+ * @param shortCut A number, a string, or an array of number and string.
+ * @param callback A function that will be called when the `shortCut` keys are input.
+ * @example
+ * ```javascript
+ * widget.onShortcut("alt+q", function() {
+ * widget.chart().executeActionById("symbolSearch");
+ * });
+ *
+ * // F1
+ * widget.onShortcut(112, function() {
+ * widget.chart().executeActionById("symbolSearch");
+ * });
+ *
+ * // ctrl+shift+\
+ * widget.onShortcut(['ctrl', 'shift', 220], function() {
+ * widget.chart().executeActionById("symbolSearch");
+ * });
+ * ```
+ */
+ onShortcut(
+ shortCut: string | number | (string | number)[],
+ callback: EmptyCallback
+ ): void;
+ /**
+ * Subscribe to library events.
+ *
+ * @param event A event to subscribe to.
+ * @param callback A callback that will be called when the event happens.
+ */
+ subscribe(
+ event: EventName,
+ callback: SubscribeEventsMap[EventName]
+ ): void;
+ /**
+ * Unsubscribe from library events.
+ *
+ * @param event A event to unsubscribe from.
+ * @param callback A callback to unsubscribe. Must be the same reference as a callback passed to {@link subscribe}.
+ */
+ unsubscribe(
+ event: EventName,
+ callback: SubscribeEventsMap[EventName]
+ ): void;
+ /**
+ * Get an API instance that can be used to interact with a chart.
+ *
+ * @param index Zero based index of the chart.
+ * @returns An API instance.
+ */
+ chart(index?: number): IChartWidgetApi;
+ /**
+ * Get the configured locale of the widget. For example `en`, `zh`, `ru`.
+ *
+ * @returns A code representing the locale of the widget.
+ */
+ getLanguage(): LanguageCode;
+ /**
+ * Set the symbol and resolution of the active chart.
+ * @param symbol A symbol to load.
+ * @param interval A interval (resolution) to load.
+ * @param callback A callback. Called when the symbol's data has finished loading.
+ */
+ setSymbol(
+ symbol: string,
+ interval: ResolutionString,
+ callback: EmptyCallback
+ ): void;
+ /**
+ * Remove the widget and all its data from the page. The widget cannot be interacted with after it has been removed.
+ */
+ remove(): void;
+ /**
+ * Close all open context menus, pop-ups or dialogs.
+ */
+ closePopupsAndDialogs(): void;
+ /**
+ * Select an icon. It's the same as clicking on the corresponding button in the left toolbar.
+ *
+ * @param linetool An icon drawing tool.
+ * @param options An optional object with options.
+ */
+ selectLineTool(linetool: 'icon', options?: IconOptions): void;
+ /**
+ * Select a drawing or a cursor. It's the same as clicking on the corresponding button in the left toolbar.
+ *
+ * @param linetool A drawing or cursor to select (excluding 'icon')
+ */
+ selectLineTool(linetool: Omit<'icon', SupportedLineTools>): void;
+ /**
+ * Select the Icon line tool. It's the same as clicking on the corresponding button in the left toolbar.
+ *
+ * @param linetool Icon line tool.
+ * @param options An optional object with options. Currently only used for the 'icon' drawing.
+ */
+ selectLineTool(linetool: 'icon', options?: IconOptions): void;
+ /**
+ * Select the Emoji line tool. It's the same as clicking on the corresponding button in the left toolbar.
+ *
+ * @param linetool Emoji line tool.
+ * @param options Options for the Emoji line tool
+ */
+ selectLineTool(linetool: 'emoji', options?: EmojiOptions): void;
+ /**
+ * Select a drawing, icon, or a cursor. It's the same as clicking on the corresponding button in the left toolbar.
+ *
+ * @param linetool A drawing or cursor to select.
+ * @param options An optional object with options.
+ */
+ selectLineTool(
+ linetool: SupportedLineTools,
+ options?: IconOptions | EmojiOptions
+ ): void;
+ /**
+ * Get the currently selected drawing or cursor.
+ *
+ * @returns An identifier for drawing or cursor.
+ */
+ selectedLineTool(): SupportedLineTools;
+ /**
+ * Saves the chart state to a object. This method is part of the low-level save/load API.
+ *
+ * @param callback A function called with the chart state as the first argument.
+ */
+ save(callback: (state: object) => void): void;
+ /**
+ * Loads the chart state from a object. This method is part of the low-level save/load API.
+ *
+ * @param state A chart state object to load.
+ * @param extendedData A optional object of information about the saved state.
+ */
+ load(state: object, extendedData?: SavedStateMetaInfo): void;
+ /**
+ * Get a list of chart descriptions saved to the server for the current user.
+ *
+ * @param callback A function called with an array of saved chart information as the first argument.
+ */
+ getSavedCharts(callback: (chartRecords: SaveLoadChartRecord[]) => void): void;
+ /**
+ * Load a saved chart from the server.
+ *
+ * @param chartRecord A chart information object (returned by {@link getSavedCharts}).
+ */
+ loadChartFromServer(chartRecord: SaveLoadChartRecord): void;
+ /**
+ * Save the current chart to the server.
+ *
+ * @param onComplete An optional callback function called when the chart is successfully saved.
+ * @param onFail An optional callback function called when the chart fails to save.
+ * @param options An optional object of options for saving the chart.
+ */
+ saveChartToServer(
+ onComplete?: EmptyCallback,
+ onFail?: EmptyCallback,
+ options?: SaveChartToServerOptions
+ ): void;
+ /**
+ * Remove a saved chart from the server.
+ *
+ * @param chartId A chart ID from a {@link SaveLoadChartRecord} (returned by {@link getSavedCharts}).
+ * @param onCompleteCallback A callback function called when the chart is successfully saved.
+ */
+ removeChartFromServer(
+ chartId: string,
+ onCompleteCallback: EmptyCallback
+ ): void;
+ /**
+ * The widget will call the callback function each time the widget wants to display a context menu.
+ * See also {@link ChartingLibraryWidgetOptions.context_menu}.
+ *
+ * **Example**
+ * ```javascript
+ * widget.onChartReady(function() {
+ * widget.onContextMenu(function(unixtime, price) {
+ * return [{
+ * position: "top",
+ * text: "First top menu item, time: " + unixtime + ", price: " + price,
+ * click: function() { alert("First clicked."); }
+ * },
+ * { text: "-", position: "top" }, // Adds a separator between buttons
+ * { text: "-Paste" }, // Removes the existing item from the menu
+ * {
+ * position: "top",
+ * text: "Second top menu item 2",
+ * click: function() { alert("Second clicked."); }
+ * }, {
+ * position: "bottom",
+ * text: "Bottom menu item",
+ * click: function() { alert("Third clicked."); }
+ * }];
+ * });
+ * });
+ * ```
+ *
+ * @param callback A function called with the time and price of the location on the chart that triggered the context menu.
+ * The array of objects returned will add or remove items from the context menu.
+ */
+ onContextMenu(
+ callback: (unixTime: number, price: number) => ContextMenuItem[]
+ ): void;
+ /**
+ * Create a button in the top toolbar. This should be called after {@link headerReady} has resolved.
+ *
+ * **Example**
+ * ```javascript
+ * widget.headerReady().then(function() {
+ * var button = widget.createButton();
+ * button.setAttribute('title', 'My custom button tooltip');
+ * button.addEventListener('click', function() { alert("My custom button pressed!"); });
+ * button.textContent = 'My custom button caption';
+ * });
+ * ```
+ *
+ * @param options A optional object of options for the button.
+ * @returns A `HTMLElement` you can customize.
+ */
+ createButton(options?: CreateHTMLButtonOptions): HTMLElement;
+ /**
+ * Create a button in the top toolbar. This should be called after {@link headerReady} has resolved.
+ * If the `title` option is provided then the title text will be shown in a tooltip on hover.
+ * If the `onClick` option is provided then the button will be clickable.
+ * @param options A optional object of options for the button.
+ */
+ createButton(options?: CreateTradingViewStyledButtonOptions): void;
+ /**
+ * Create a button in the top toolbar. This should be called after {@link headerReady} has resolved.
+ * @param options A optional object of options for the button.
+ * @returns A `HTMLElement` if the `useTradingViewStyle` option if `false`. `undefined` if `useTradingViewStyle` is `true`.
+ */
+ createButton(options?: CreateButtonOptions): HTMLElement | undefined;
+ /**
+ * Add a custom dropdown menu to the top toolbar.
+ *
+ * **Example**
+ * ```javascript
+ * widget.createDropdown(
+ * {
+ * title: 'dropdown',
+ * tooltip: 'tooltip for this dropdown',
+ * items: [
+ * {
+ * title: 'item#1',
+ * onSelect: () => {console.log('1');},
+ * },
+ * {
+ * title: 'item#2',
+ * onSelect: () => {widget.setSymbol('IBM', '1D');},
+ * },
+ * {
+ * title: 'item#3',
+ * onSelect: () => {
+ * widget.activeChart().createStudy(
+ * 'MACD',
+ * false,
+ * false,
+ * {
+ * in_0: 14,
+ * in_1: 30,
+ * in_3: 'close',
+ * in_2: 9
+ * }
+ * );
+ * },
+ * }
+ * ],
+ * icon: ``,
+ * }
+ * ).then(myDropdownApi => {
+ * // Use myDropdownApi if you need to update the dropdown:
+ * // myDropdownApi.applyOptions({
+ * // title: 'a new title!'
+ * // });
+ *
+ * // Or remove the dropdown:
+ * // myDropdownApi.remove();
+ * });
+ * ```
+ * @param {DropdownParams} params
+ */
+ createDropdown(params: DropdownParams): Promise;
+ /**
+ * Show a dialog with custom title and text along with an "OK" buttons.
+ * @param params A object of options for the created dialog.
+ */
+ showNoticeDialog(params: DialogParams<() => void>): void;
+ /**
+ * Show a dialog with custom title and text along with "OK" and "CANCEL" buttons.
+ *
+ * @param params A object of options for the created dialog.
+ */
+ showConfirmDialog(params: DialogParams<(confirmed: boolean) => void>): void;
+ /**
+ * Show the "Load Chart Layout" dialog.
+ */
+ showLoadChartDialog(): void;
+ /**
+ * Show the "Copy Chart Layout" dialog.
+ */
+ showSaveAsChartDialog(): void;
+ /**
+ * Get the symbol and interval of the active chart.
+ */
+ symbolInterval(): SymbolIntervalResult;
+ /**
+ * Get the price formatter for the main series. You can use this to format prices as the char
+ */
+ mainSeriesPriceFormatter(): INumberFormatter;
+ /**
+ * Get an array of supported intervals (resolutions).
+ *
+ * @returns An array of supported intervals. E.g. `['1D', '5D', '1Y']`.
+ */
+ getIntervals(): string[];
+ /**
+ * Get an array of the names of all supported studies. These names can be used when calling {@link IChartWidgetApi.createStudy}.
+ *
+ * @returns An array of supported study names. E.g. `['Accumulation/Distribution', 'Accumulative Swing Index', 'Advance/Decline', ...]`.
+ */
+ getStudiesList(): string[];
+ /**
+ * Get an array of information about the inputs of a study.
+ *
+ * @param studyName The name of a study.
+ */
+ getStudyInputs(studyName: string): StudyInputInformation[];
+ /**
+ * Get information about the styles of a study.
+ *
+ * @param studyName The name of a study.
+ */
+ getStudyStyles(studyName: string): StudyStyleInfo;
+ /**
+ * Add a custom CSS file for the library to load.
+ *
+ * @param url A url to the custom CSS file. Should be absolute or relative to the `static` folder.
+ */
+ addCustomCSSFile(url: string): void;
+ /**
+ * Apply overrides to the chart without reloading. See also {@link ChartingLibraryWidgetOptions.overrides}.
+ *
+ * @param overrides An object of overrides to apply to the chart.
+ */
+ applyOverrides>(
+ overrides: TOverrides
+ ): void;
+ /**
+ * Apply overrides to indicator styles and inputs without reloading.
+ * Refer to [Indicator Overrides](https://www.tradingview.com/charting-library-docs/latest/customization/overrides/Studies-Overrides.md#change-default-properties-on-the-fly) for more information.
+ * Overrides for built-in indicators are listed in {@link StudyOverrides}.
+ *
+ * @param overrides An object of overrides to apply to the studies.
+ */
+ applyStudiesOverrides(overrides: object): void;
+ /**
+ * Trading Platform only. Get a promise that resolves with an API object for interacting with the widgetbar (right sidebar) watchlist.
+ *
+ * **Example**
+ * ```javascript
+ * const watchlistApi = await widget.watchList();
+ * const activeListId = watchlistApi.getActiveListId();
+ * const currentListItems = watchlistApi.getList(activeListId);
+ * // append new section and item to the current watchlist
+ * watchlistApi.updateList(activeListId, [...currentListItems, '###NEW SECTION', 'AMZN']);
+ * ```
+ *
+ * @returns An API object for interacting with the widgetbar (right sidebar) watchlist.
+ */
+ watchList(): Promise;
+ /**
+ * Trading Platform only. Get a promise that resolves with an API object for interacting with the widgetbar (right sidebar) news widget.
+ *
+ * @returns An API object for interacting with the widgetbar (right sidebar) widget.
+ */
+ news(): Promise;
+ /**
+ * Trading Platform only. Get a promise that resolves with an API object for interacting with the widgetbar (right sidebar).
+ *
+ * @returns An API object for interacting with the widgetbar (right sidebar).
+ */
+ widgetbar(): Promise;
+ /**
+ * Get an API object for interacting with the active chart.
+ *
+ * @returns An API object for interacting with the chart.
+ */
+ activeChart(): IChartWidgetApi;
+ /**
+ * Get the index of the active chart in the layout.
+ *
+ * @returns number.
+ */
+ activeChartIndex(): number;
+ /**
+ * Set which chart is currently active.
+ * It is recommended that this method is only used when linked to a user action
+ * which should change the active chart.
+ *
+ * Use {@link chartsCount} to determine the number of charts currently available.
+ * If an invalid index is supplied (less than zero, or greater than the number of charts minus 1)
+ * then this method will not change the active chart.
+ * @param index - index of chart to set as the active chart. Index is zero-based.
+ */
+ setActiveChart(index: number): void;
+ /**
+ * Get the number of charts in the current layout.
+ *
+ * @returns A count of the charts in the current layout.
+ */
+ chartsCount(): number;
+ /**
+ * Get the current chart layout type.
+ *
+ * @returns A string representation of the current layout type. E.g. `'2h'` for two charts split vertically.
+ */
+ layout(): LayoutType;
+ /**
+ * Set the current chart layout type.
+ *
+ * @params layout A string representation of the new layout type. E.g. `'2h'` for two charts split vertically.
+ */
+ setLayout(layout: LayoutType): void;
+ /**
+ * Get the name of the current chart layout. The return value will be `undefined` if the current layout has not been saved.
+ *
+ * @returns A string of the name of the current chart layout.
+ */
+ layoutName(): string;
+ /**
+ * Change the theme of the chart.
+ *
+ * @param themeName A theme name.
+ * @param options An optional object of options for the theme.
+ * @returns A promise that resolves when the theme has been changed.
+ */
+ changeTheme(
+ themeName: ThemeName,
+ options?: ChangeThemeOptions
+ ): Promise;
+ /**
+ * Get the current theme of the chart.
+ *
+ * **Example**
+ * ```javascript
+ * console.log(widget.getTheme());
+ * ```
+ *
+ * @returns A theme name. The name of the current theme.
+ */
+ getTheme(): ThemeName;
+ /**
+ * Create a snapshot of the chart and upload it to the server.
+ * When it is ready callback functions subscribed to the `'onScreenshotReady'` event using {@link subscribe} will be called.
+ * The URL of the snapshot will be passed as an argument to the callback function.
+ */
+ takeScreenshot(): void;
+ /**
+ * Create a snapshot of the chart and return it as a canvas.
+ *
+ * @param options An optional object that customizes the returned snapshot.
+ * @returns A promise containing a `HTMLCanvasElement` of the snapshot.
+ */
+ takeClientScreenshot(
+ options?: Partial
+ ): Promise;
+ /**
+ * Get a watched value that can be used to read/write/subscribe to the state of the "Lock All Drawing Tools" button.
+ *
+ * @returns A watched value of the state of the "Lock All Drawing Tools" button.
+ */
+ lockAllDrawingTools(): IWatchedValue;
+ /**
+ * Get a watched value that can be used to read/write/subscribe to the state of the "Hide All Drawing Tools" button.
+ *
+ * @returns A watched value of the state of the "Hide All Drawing Tools" button.
+ */
+ hideAllDrawingTools(): IWatchedValue;
+ /**
+ * Get a watched value that can be used to read/write/subscribe to the state of the magnet.
+ *
+ * @returns A watched value of the state of the magnet.
+ */
+ magnetEnabled(): IWatchedValue;
+ /**
+ * Get a watched value that can be used to read/write/subscribe to the state of the magnet mode.
+ *
+ * @returns A watched value of the state of the magnet mode.
+ */
+ magnetMode(): IWatchedValue;
+ /**
+ * Only available in Trading Platform. Get a watched value that can be used to read/write/subscribe to the state of the symbol sync between charts.
+ *
+ * **Example**
+ * ```javascript
+ * if (widget.symbolSync().value()) {
+ * // ...
+ * }
+ * ```
+ *
+ * @returns A watched value of the state of the symbol sync.
+ */
+ symbolSync(): IWatchedValue;
+ /**
+ * Only available in Trading Platform. Get a watched value that can be used to read/write/subscribe to the state of the interval sync between charts.
+ *
+ * **Example**
+ * ```javascript
+ * widget.intervalSync().setValue(true);
+ * ```
+ *
+ * @returns A watched value of the state of the interval sync.
+ */
+ intervalSync(): IWatchedValue;
+ /**
+ * Only available in Trading Platform. Get a watched value that can be used to read/write/subscribe to the state of the crosshair sync between charts.
+ *
+ * **Example**
+ * ```javascript
+ * widget.crosshairSync().setValue(true);
+ * ```
+ *
+ * @returns A watched value of the state of the crosshair sync.
+ */
+ crosshairSync(): IWatchedValue;
+ /**
+ * Only available in Trading Platform. Get a watched value that can be used to read/write/subscribe to the state of the time sync between charts.
+ *
+ * **Example**
+ * ```javascript
+ * widget.timeSync().setValue(true);
+ * ```
+ *
+ * @returns A watched value of the state of the time sync.
+ */
+ timeSync(): IWatchedValue;
+ /**
+ * Only available in Trading Platform. Get a watched value that can be used to read/write/subscribe to the state of the date range sync between charts.
+ *
+ * **Example**
+ * ```javascript
+ * widget.dateRangeSync().setValue(true);
+ * ```
+ *
+ * @returns A watched value of the state of the date range sync.
+ */
+ dateRangeSync(): IWatchedValue;
+ /**
+ * Set the chart into fullscreen mode (if it isn't already).
+ */
+ startFullscreen(): void;
+ /**
+ * Set the chart into non-fullscreen mode (if it isn't already).
+ */
+ exitFullscreen(): void;
+ /**
+ * Get the state of the undo/redo stack.
+ */
+ undoRedoState(): UndoRedoState;
+ /**
+ * Get a watched value that can be used to read/write/subscribe to the state of the navigation buttons.
+ *
+ * @returns A watched value of the state of the navigation buttons.
+ */
+ navigationButtonsVisibility(): IWatchedValue;
+ /**
+ * Get a watched value that can be used to read/write/subscribe to the state of the pane buttons.
+ *
+ * @returns A watched value of the state of the pane buttons.
+ */
+ paneButtonsVisibility(): IWatchedValue;
+ /**
+ * Get a watched value that can be used to read/write/subscribe to the state of the date format.
+ *
+ * @returns A watched value of the state of the date format.
+ */
+ dateFormat(): IWatchedValue;
+ /**
+ * Get a watched value that can be used to read/write/subscribe to the state of the timeHours format.
+ */
+ timeHoursFormat(): IWatchedValue;
+ /**
+ * Get a watched value that can be used to read/write/subscribe to the state of the currency and unit
+ * visibility setting on the price scale.
+ *
+ * @returns A watched value of the state of the currency and unit visibility option.
+ */
+ currencyAndUnitVisibility(): IWatchedValue;
+ /**
+ * Enable or disable debug mode.
+ *
+ * @param enabled A boolean flag. `true` to enable debug mode, `false` to disable.
+ */
+ setDebugMode(enabled: boolean): void;
+ /**
+ * Clears the undo & redo history.
+ *
+ * **Warning:** this should only be used in very specific cases where you have considered
+ * the UX implications. It is generally unexpected for the user that the undo
+ * history has been cleared.
+ *
+ * An example of an acceptable use-case would be reusing a chart when switching
+ * pages / tabs on a Single Page Application, and presenting it to the user as a
+ * new chart.
+ */
+ clearUndoHistory(): void;
+ /**
+ * This method returns a readonly WatchedValue ({@link IWatchedValueReadonly})
+ * object that can be used to read/watch the current supported chart types
+ * ({@link SeriesType}) for an active chart.
+ *
+ * The chart type is returned as a number.
+ * You can see which number corresponds to which chart type in the
+ * [Overrides](https://www.tradingview.com/charting-library-docs/latest/customization/overrides/)
+ * documentation for `mainSeriesProperties.style`.
+ */
+ supportedChartTypes(): IWatchedValueReadonly;
+ /**
+ * Get an API object for adjusting the watermarks present on the charts.
+ * This can only be accessed when the chart is ready to be used. ({@link onChartReady})
+ *
+ * @returns An API object for adjusting the watermark settings.
+ */
+ watermark(): IWatermarkApi;
+ /**
+ * Get an API object for creating, and adjusting, custom status items to
+ * be displayed within the legend for the main series of each chart.
+ *
+ * This can only be accessed when the chart has been created. ({@link headerReady})
+ *
+ * @returns An API object for controlling additional custom status items within the legend area.
+ */
+ customSymbolStatus(): ICustomSymbolStatusApi;
+ /**
+ * Sets the value for a CSS custom property.
+ *
+ * **Example:**
+ * ```js
+ * widget.setCSSCustomProperty('--my-theme-color', '#123AAA');
+ * ```
+ *
+ * @param customPropertyName A string representing the CSS custom property name. It is expected that the name should start with a double hyphen ('--').
+ * @param value A string containing the new property value.
+ */
+ setCSSCustomProperty(customPropertyName: string, value: string): void;
+ /**
+ * Returns the current value for a CSS custom property.
+ *
+ * **Example:**
+ * ```js
+ * const currentValue = widget.getCSSCustomPropertyValue('--my-theme-color');
+ * ```
+ *
+ * @param customPropertyName A string representing the CSS custom property name to be checked. It is expected that the name should start with a double hyphen ('--').
+ * @returns A string containing the value of the property. If not set, returns the empty string.
+ */
+ getCSSCustomPropertyValue(customPropertyName: string): string;
+}
+/**
+ * PineJS execution context.
+ */
+export interface IContext {
+ /**
+ * Symbol Instrument
+ */
+ symbol: ISymbolInstrument;
+ /**
+ * Load a new symbol for the custom indicator
+ * @param {string} tickerid - Symbol identifier
+ * @param {string} period - period for the new symbol
+ * @param {string} currencyCode? - Currency code
+ * @param {string} unitId? - Unit id
+ * @param {string} unitId? - Subsession id
+ */
+ new_sym(
+ tickerid: string,
+ period: string,
+ currencyCode?: string,
+ unitId?: string,
+ subsessionId?: string
+ ): ISymbolInstrument;
+ /**
+ * Switch context to the other symbol received through {@link IContext.new_sym}
+ * @param {number} i - the index of the symbol (`0` for the main series)
+ */
+ select_sym(i: number): void;
+ /**
+ * Creates an in-memory temporary storage with depth defined by the first call `new_var(value).get(n)`
+ * @param {number} value? - variable's value
+ */
+ new_var(value?: number): IPineSeries;
+ /**
+ * Creates an in-memory temporary storage with unlimited depth.
+ * @param {number} value? - variable's value
+ */
+ new_unlimited_var(value?: number): IPineSeries;
+ /**
+ * Creates a new context
+ */
+ new_ctx(): IContext;
+ /**
+ * Checks if symbol is the main symbol
+ * @param {ISymbolInstrument|undefined} symbol - symbol to check
+ * @returns `true` if symbol is the main symbol
+ */
+ is_main_symbol(symbol: ISymbolInstrument | undefined): boolean;
+}
+export interface IContextMenuRenderer {
+ /**
+ * Displays the menu at the position.
+ * @param pos Position to show context menu
+ */
+ show(pos: ContextMenuPosition): void;
+ /**
+ * hides the menu.
+ */
+ hide(): void;
+ /**
+ * @returns `true` when the menu is currently displayed.
+ */
+ isShown(): boolean;
+}
+/**
+ * Adapter API for reading and setting the state of a
+ * custom symbol status item.
+ *
+ * The 'set' methods return the same adapter so that you can
+ * chain multiple set functions together.
+ *
+ * **Example**
+ * ```js
+ * const adapter = widget.customSymbolStatus().symbol('ABC');
+ * adapter.setVisible(true).setColor('#336699').setTooltip('Custom Status')
+ * ```
+ */
+export interface ICustomSymbolStatusAdapter {
+ /**
+ * Get the current visibility of the status item.
+ * @returns the current visibility
+ */
+ getVisible(): boolean;
+ /**
+ * Set the visibility for the status item. @default false
+ *
+ * @param visible - visibility for the status item, where
+ * `true` makes the item visible.
+ * @returns the current symbol status adapter so you can
+ * chain 'set' functions together.
+ */
+ setVisible(visible: boolean): ICustomSymbolStatusAdapter;
+ /**
+ * Get the current icon for the status item.
+ * @returns the current icon SVG string
+ */
+ getIcon(): string | null;
+ /**
+ * Set the icon for the status item. @default blank
+ * The icon should be provided as an svg markup. It is
+ * recommended that the icon works well at small sizes.
+ *
+ * **Example**
+ * ```svg
+ *
+ * ```
+ *
+ * @param icon - svg markup string to be used as the icon, or `null` to display no icon
+ * @returns the current symbol status adapter so you can
+ * chain 'set' functions together.
+ */
+ setIcon(icon: string | null): ICustomSymbolStatusAdapter;
+ /**
+ * Get the current color of the status item.
+ * @returns the current color
+ */
+ getColor(): string;
+ /**
+ * Set the color for the status item. @default '#9598a1'
+ *
+ * @param color - color to be used for the status item.
+ * It is recommended that you test that the color works well
+ * for both light and dark themes.
+ * @returns the current symbol status adapter so you can
+ * chain 'set' functions together.
+ */
+ setColor(color: string): ICustomSymbolStatusAdapter;
+ /**
+ * Get the current tooltip text for the status item.
+ * @returns the current tooltip text
+ */
+ getTooltip(): string | null;
+ /**
+ * Set the text to be displayed within the tooltip displayed
+ * when hovering over the statuses for the symbol.
+ * @default ''
+ *
+ * @param tooltip - text to be displayed within the tooltip.
+ * @returns the current symbol status adapter so you can
+ * chain 'set' functions together.
+ */
+ setTooltip(tooltip: string | null): ICustomSymbolStatusAdapter;
+ /**
+ * Get the current content of the status item displayed within
+ * the pop-up tooltip.
+ * @returns the current pop-up content
+ */
+ getDropDownContent(): CustomStatusDropDownContent[] | null;
+ /**
+ * Set the content to be displayed within the pop-up which appears
+ * when the user clicks on the symbol statuses.
+ * @default null
+ *
+ * @param content - content to be displayed, set to `null` to display
+ * nothing. More than one section can be specified.
+ * @returns the current symbol status adapter so you can
+ * chain 'set' functions together.
+ */
+ setDropDownContent(
+ content: CustomStatusDropDownContent[] | null
+ ): ICustomSymbolStatusAdapter;
+}
+/**
+ * The custom symbol status API provides the ability to create (and adjust)
+ * additional status items to be displayed within the symbol status section
+ * of the main series legend. This section is typically used to show the
+ * market status (such as open or closed) but can additionally be used to
+ * display warnings related to the current symbol.
+ *
+ * This API allows custom status items to be added (which are tied to a
+ * specific symbol). You can customise the icon, color, tooltip, and content
+ * within the dropdown tooltip menu displayed when the user clicks on the
+ * icon.
+ *
+ * **Example**
+ * ```js
+ * widget
+ * .customSymbolStatus()
+ * .symbol('NASDAQNM:AAPL') // select the symbol
+ * .setVisible(true) // make the status visible
+ * .setColor('rgb(255, 40, 60)') // set the colour
+ * .setIcon(myCustomIconSvgString) // string for an svg icon, i.e. ''
+ * .setTooltip('Tooltip') // text to be displayed within the hover tooltip
+ * .setDropDownContent([ // content to be displayed within the large pop-up tooltip
+ * {
+ * title: 'Title', // title to be displayed within the pop-up
+ * color: 'rgb(255, 60, 70)', // optional, if you want it to be different to above
+ * content: [
+ * 'Explanation of status',
+ * '
',
+ * 'More details...',
+ * ],
+ * action: { // Optional action to be displayed
+ * text: 'Read more here',
+ * tooltip: 'opens in a new window',
+ * onClick: () => {
+ * window.open('https://www.tradingview.com/', '_blank');
+ * },
+ * },
+ * },
+ * ]);
+ * ```
+ */
+export interface ICustomSymbolStatusApi {
+ /**
+ * Get the custom symbol status adapter for a specific symbolId. The
+ * symbolId should exactly match the resolved symbolId. This id can
+ * be retrieved for a chart via the {@link IChartWidgetApi.symbol} method.
+ *
+ * @param symbolId - symbol id for which you would like to create / adjust
+ * the custom status
+ */
+ symbol(symbolId: string): ICustomSymbolStatusAdapter;
+ /**
+ * Hide all the custom status items. This is equivalent to using
+ * `setVisible(false)` on all of the current custom symbol status items.
+ */
+ hideAll(): void;
+}
+export interface IDatafeedChartApi {
+ /**
+ * The library calls this function to get marks for visible bars range.
+ * The library assumes that you will call `onDataCallback` only once per `getMarks` call.
+ *
+ * A few marks per bar are allowed (for now, the maximum is 10). The time of each mark must match the time of a bar. For example, if the bar times are `2023-01-01`, `2023-01-08`, and `2023-01-15`, then a mark cannot have the time `2023-01-05`.
+ *
+ * **Remark:** This function will be called only if you confirmed that your back-end is supporting marks ({@link DatafeedConfiguration.supports_marks}).
+ *
+ * @param symbolInfo A SymbolInfo object
+ * @param from Unix timestamp (leftmost visible bar)
+ * @param to Unix timestamp (rightmost visible bar)
+ * @param onDataCallback Callback function containing an array of marks
+ * @param resolution Resolution of the symbol
+ */
+ getMarks?(
+ symbolInfo: LibrarySymbolInfo,
+ from: number,
+ to: number,
+ onDataCallback: GetMarksCallback,
+ resolution: ResolutionString
+ ): void;
+ /**
+ * The library calls this function to get timescale marks for visible bars range.
+ * The library assumes that you will call `onDataCallback` only once per `getTimescaleMarks` call.
+ *
+ * **Remark:** This function will be called only if you confirmed that your back-end is supporting marks ({@link DatafeedConfiguration.supports_timescale_marks}).
+ *
+ * @param symbolInfo A SymbolInfo object
+ * @param from Unix timestamp (leftmost visible bar)
+ * @param to Unix timestamp (rightmost visible bar)
+ * @param onDataCallback Callback function containing an array of marks
+ * @param resolution Resolution of the symbol
+ */
+ getTimescaleMarks?(
+ symbolInfo: LibrarySymbolInfo,
+ from: number,
+ to: number,
+ onDataCallback: GetMarksCallback,
+ resolution: ResolutionString
+ ): void;
+ /**
+ * This function is called if configuration flag supports_time is set to true when chart needs to know the server time.
+ * The library expects callback to be called once.
+ * The time is provided without milliseconds. Example: `1445324591`. It is used to display Countdown on the price scale.
+ */
+ getServerTime?(callback: ServerTimeCallback): void;
+ /**
+ * Provides a list of symbols that match the user's search query.
+ *
+ * @param userInput Text entered by user in the symbol search field
+ * @param exchange The requested exchange. Empty value means no filter was specified
+ * @param symbolType Type of symbol. Empty value means no filter was specified
+ * @param onResult Callback function that returns an array of results ({@link SearchSymbolResultItem}) or empty array if no symbols found
+ */
+ searchSymbols(
+ userInput: string,
+ exchange: string,
+ symbolType: string,
+ onResult: SearchSymbolsCallback
+ ): void;
+ /**
+ * The library will call this function when it needs to get SymbolInfo by symbol name.
+ *
+ * @param symbolName Symbol name or `ticker`
+ * @param onResolve Callback function returning a SymbolInfo ({@link LibrarySymbolInfo})
+ * @param onError Callback function whose only argument is a text error message
+ * @param extension An optional object with additional parameters
+ */
+ resolveSymbol(
+ symbolName: string,
+ onResolve: ResolveCallback,
+ onError: ErrorCallback,
+ extension?: SymbolResolveExtension
+ ): void;
+ /**
+ * This function is called when the chart needs a history fragment defined by dates range.
+ *
+ * @param symbolInfo A SymbolInfo object
+ * @param resolution Resolution of the symbol
+ * @param periodParams An object used to pass specific requirements for getting bars
+ * @param onResult Callback function for historical data
+ * @param onError Callback function whose only argument is a text error message
+ */
+ getBars(
+ symbolInfo: LibrarySymbolInfo,
+ resolution: ResolutionString,
+ periodParams: PeriodParams,
+ onResult: HistoryCallback,
+ onError: ErrorCallback
+ ): void;
+ /**
+ * The library calls this function when it wants to receive real-time updates for a symbol.
+ * The library assumes that you will call the callback provided by the `onTick` parameter every time you want to update the most recent bar or to add a new one.
+ *
+ * @param symbolInfo A SymbolInfo object
+ * @param resolution Resolution of the symbol
+ * @param onTick Callback function returning a Bar object
+ * @param listenerGuid
+ * @param onResetCacheNeededCallback Function to be executed when bar data has changed
+ */
+ subscribeBars(
+ symbolInfo: LibrarySymbolInfo,
+ resolution: ResolutionString,
+ onTick: SubscribeBarsCallback,
+ listenerGuid: string,
+ onResetCacheNeededCallback: () => void
+ ): void;
+ /**
+ * The library calls this function when it doesn't want to receive updates anymore.
+ *
+ * @param listenerGuid id to unsubscribe from
+ */
+ unsubscribeBars(listenerGuid: string): void;
+ /**
+ * Trading Platform calls this function when it wants to receive real-time level 2 (DOM) for a symbol.
+ *
+ * @param symbol A SymbolInfo object
+ * @param callback Function returning an object to update Depth Of Market (DOM) data
+ * @returns A unique identifier that will be used to unsubscribe from the data
+ */
+ subscribeDepth?(symbol: string, callback: DOMCallback): string;
+ /**
+ * Trading Platform calls this function when it doesn't want to receive updates for this listener anymore.
+ *
+ * @param subscriberUID A string returned by `subscribeDepth`
+ */
+ unsubscribeDepth?(subscriberUID: string): void;
+ /**
+ * The library calls this function to get the resolution that will be used to calculate the Volume Profile Visible Range indicator.
+ *
+ * Usually you might want to implement this method to calculate the indicator more accurately.
+ * The implementation really depends on how much data you can transfer to the library and the depth of data in your data feed.
+ * **Remark:** If this function is not provided the library uses currentResolution.
+ *
+ * @param currentResolution Resolution of the symbol
+ * @param from Unix timestamp (leftmost visible bar)
+ * @param to Unix timestamp (rightmost visible bar)
+ * @param symbolInfo A Symbol object
+ * @returns A resolution
+ */
+ getVolumeProfileResolutionForPeriod?(
+ currentResolution: ResolutionString,
+ from: number,
+ to: number,
+ symbolInfo: LibrarySymbolInfo
+ ): ResolutionString;
+}
+/** Quotes datafeed API */
+export interface IDatafeedQuotesApi {
+ /**
+ * This function is called when the library needs quote data.
+ * The library assumes that `onDataCallback` is called once when all the requested data is received.
+ * @param {string[]} symbols - symbol names.
+ * @param {QuotesCallback} onDataCallback - callback to return the requested data.
+ * @param {QuotesErrorCallback} onErrorCallback - callback for responding with an error.
+ */
+ getQuotes(
+ symbols: string[],
+ onDataCallback: QuotesCallback,
+ onErrorCallback: QuotesErrorCallback
+ ): void;
+ /**
+ * Trading Platform calls this function when it wants to receive real-time quotes for a symbol.
+ * The library assumes that you will call `onRealtimeCallback` every time you want to update the quotes.
+ * @param {string[]} symbols - list of symbols that should be updated rarely (once per minute). These symbols are included in the watchlist but they are not visible at the moment.
+ * @param {string[]} fastSymbols - list of symbols that should be updated frequently (at least once every 10 seconds)
+ * @param {QuotesCallback} onRealtimeCallback - callback to send realtime quote data updates
+ * @param {string} listenerGUID - unique identifier of the listener
+ */
+ subscribeQuotes(
+ symbols: string[],
+ fastSymbols: string[],
+ onRealtimeCallback: QuotesCallback,
+ listenerGUID: string
+ ): void;
+ /**
+ * Trading Platform calls this function when it doesn't want to receive updates for this listener anymore.
+ * `listenerGUID` will be the same object that the Library passed to `subscribeQuotes` before.
+ * @param {string} listenerGUID - unique identifier of the listener
+ */
+ unsubscribeQuotes(listenerGUID: string): void;
+}
+export interface IDelegate
+ extends ISubscription {
+ /** Fire (Evoke) */
+ fire: TFunc;
+}
+/**
+ * # IDESTRØYÅBLE
+ * ```
+ * ┌────────────────┐
+ * │ ┏━━━━━┓ │
+ * │ ┃ ○ ○ ┃ │ ┏━━━━━┓ ┌╲╌╌╱╌┐
+ * │ ┃ ○ ○ ┃ x 1 │ ┃ ○ ○ ┃ destroy() ┊ ╲╱ ╵
+ * │ ┠─────┨ │ ┃ ○ ○ ┃ ╭───╯╲ ╷ ╱╲ ┊
+ * │ ┗━━━━━┛ │ ┠─────┨ ╰───╮╱ ├╱ ╌╲ ┤
+ * │ destroy() x 1 │ ┗━━━━━┛ └ ╌╌ ╌┘
+ * └────────────────┘
+ * ```
+ */
+export interface IDestroyable {
+ /** Clean up (destroy) any subscriptions, intervals, or other resources that this `IDestroyable` instance has. */
+ destroy(): void;
+}
+/** Dropdown menu API */
+export interface IDropdownApi {
+ /**
+ * Apply options to the dropdown menu.
+ * Note that this method does not affect the menu's alignment. To change the alignment, you should remove and recreate the menu as follows:
+ *
+ * ```javascript
+ * myCustomDropdownApi.remove();
+ * widget.createDropdown(optionsWithDifferentAlignment);
+ * ```
+ *
+ * @param {DropdownUpdateParams} options - Partial options for the dropdown menu
+ */
+ applyOptions(options: DropdownUpdateParams): void;
+ /**
+ * Remove the dropdown menu.
+ */
+ remove(): void;
+}
+/**
+ * An API object used to control execution lines.
+ */
+export interface IExecutionLineAdapter {
+ /**
+ * Remove the execution line. This API object cannot be used after this call.
+ */
+ remove(): void;
+ /**
+ * Get the price of the execution line.
+ */
+ getPrice(): number;
+ /**
+ * Set the price of the execution line.
+ *
+ * @param value The new price.
+ */
+ setPrice(value: number): this;
+ /**
+ * Get the time of the execution line.
+ */
+ getTime(): number;
+ /**
+ * Set the time of the execution line.
+ *
+ * @param value The new time.
+ */
+ setTime(value: number): this;
+ /**
+ * Get the direction of the execution line.
+ */
+ getDirection(): Direction;
+ /**
+ * Set the direction of the execution line.
+ *
+ * @param value The new direction.
+ */
+ setDirection(value: Direction): this;
+ /**
+ * Get the text of the execution line.
+ */
+ getText(): string;
+ /**
+ * Set the text of the execution line.
+ *
+ * @param value The new text.
+ */
+ setText(value: string): this;
+ /**
+ * Get the tooltip of the execution line.
+ */
+ getTooltip(): string;
+ /**
+ * Set the tooltip of the execution line.
+ *
+ * @param value The new tooltip.
+ */
+ setTooltip(value: string): this;
+ /**
+ * Get the arrow height of the execution line.
+ */
+ getArrowHeight(): number;
+ /**
+ * Set the arrow height of the execution line.
+ *
+ * @param value The new arrow height.
+ */
+ setArrowHeight(value: number): this;
+ /**
+ * Get the arrow spacing of the execution line.
+ */
+ getArrowSpacing(): number;
+ /**
+ * Set the arrow spacing of the execution line.
+ *
+ * @param value The new arrow spacing.
+ */
+ setArrowSpacing(value: number): this;
+ /**
+ * Get the font of the execution line.
+ */
+ getFont(): string;
+ /**
+ * Set the font of the execution line.
+ *
+ * @param value The new font.
+ */
+ setFont(value: string): this;
+ /**
+ * Get the text color of the execution line.
+ */
+ getTextColor(): string;
+ /**
+ * Set the text color of the execution line.
+ *
+ * @param value The new text color.
+ */
+ setTextColor(value: string): this;
+ /**
+ * Get the arrow color of the execution line.
+ */
+ getArrowColor(): string;
+ /**
+ * Set the arrow color of the execution line.
+ *
+ * @param value The new arrow color.
+ */
+ setArrowColor(value: string): this;
+}
+export interface IExternalDatafeed {
+ /**
+ * This call is intended to provide the object filled with the configuration data.
+ * The lib assumes that you will call the callback function and pass your datafeed {@link DatafeedConfiguration} as an argument.
+ *
+ * @param {OnReadyCallback} callback - callback to return your datafeed configuration ({@link DatafeedConfiguration}) to the library.
+ */
+ onReady(callback: OnReadyCallback): void;
+}
+export interface IExternalSaveLoadAdapter {
+ /**
+ * Get all saved charts.
+ * @returns Array of chart meta information
+ */
+ getAllCharts(): Promise;
+ /**
+ * Remove a chart.
+ * @param id - Unique ID of the chart (see {@link getAllCharts})
+ */
+ removeChart(id: T): Promise;
+ /**
+ * Save the chart
+ * @param {ChartData} chartData - Chart description data
+ * @returns unique ID of the chart
+ */
+ saveChart(chartData: ChartData): Promise;
+ /**
+ * Load the chart from the server
+ * @param {number} chartId - Unique ID of the chart to load (see {@link getAllCharts})
+ * @returns chart content contained in the `content` field when saving the chart ({@link ChartData})
+ */
+ getChartContent(chartId: number): Promise;
+ /**
+ * Get all saved study templates
+ * @returns Array of study template meta information
+ */
+ getAllStudyTemplates(): Promise;
+ /**
+ * Remove a study template
+ * @param {StudyTemplateMetaInfo} studyTemplateInfo
+ */
+ removeStudyTemplate(studyTemplateInfo: StudyTemplateMetaInfo): Promise;
+ /**
+ * Save a study template
+ * @param {StudyTemplateData} studyTemplateData - Study template data to save
+ */
+ saveStudyTemplate(studyTemplateData: StudyTemplateData): Promise;
+ /**
+ * load a study template from the server
+ * @param {StudyTemplateMetaInfo} studyTemplateInfo
+ * @returns Study template `content`
+ */
+ getStudyTemplateContent(
+ studyTemplateInfo: StudyTemplateMetaInfo
+ ): Promise;
+ /**
+ * Get names of all saved drawing templates
+ * @param {string} toolName - name of the drawing tool
+ * @returns names of saved drawing templates
+ */
+ getDrawingTemplates(toolName: string): Promise;
+ /**
+ * Load a drawing template from the server
+ * @param {string} toolName - name of the drawing tool
+ * @param {string} templateName - name of the template
+ * @returns content of the drawing template
+ */
+ loadDrawingTemplate(toolName: string, templateName: string): Promise;
+ /**
+ * Remove a drawing template
+ * @param {string} toolName - name of the drawing tool
+ * @param {string} templateName - name of the template
+ */
+ removeDrawingTemplate(toolName: string, templateName: string): Promise;
+ /**
+ * Save a drawing template
+ * @param {string} toolName - name of the drawing tool
+ * @param {string} templateName - name of the template
+ * @param {string} content - content of the drawing template
+ */
+ saveDrawingTemplate(
+ toolName: string,
+ templateName: string,
+ content: string
+ ): Promise;
+ /**
+ * Load a chart template from the server
+ *
+ * @param templateName The name of the template.
+ *
+ * @returns The chart template content.
+ */
+ getChartTemplateContent(templateName: string): Promise;
+ /**
+ * Get names of all saved chart templates.
+ *
+ * @returns An array of names.
+ */
+ getAllChartTemplates(): Promise;
+ /**
+ * Save a chart template.
+ *
+ * @param newName The name of the template.
+ * @param theme The template content.
+ */
+ saveChartTemplate(
+ newName: string,
+ theme: ChartTemplateContent
+ ): Promise;
+ /**
+ * Remove a chart template.
+ *
+ * @param templateName The name of the template.
+ */
+ removeChartTemplate(templateName: string): Promise;
+}
+/** Definition of a formatter */
+export interface IFormatter {
+ /** Whatever the input type, formats the data following a certain logic and return that value as a string */
+ format(value?: T): string;
+ /** Check if the input value satisfies the logic and return either an error or the result of the parsing */
+ parse?(
+ value: string
+ ): ErrorFormatterParseResult | SuccessFormatterParseResult;
+}
+/**
+ * Drawing API
+ *
+ * You can retrieve this interface by using the {@link IChartWidgetApi.getShapeById} method.
+ */
+export interface ILineDataSourceApi {
+ /**
+ * Is the drawing selectable by the user.
+ * @returns `true` when the drawing can be selected
+ */
+ isSelectionEnabled(): boolean;
+ /**
+ * Set whether the drawing can be selected by the user or not.
+ * @param {boolean} enable - if `true` then the user can select the drawing (see `disableSelection` option of `createMultipointShape`)
+ */
+ setSelectionEnabled(enable: boolean): void;
+ /**
+ * Can the drawing be saved in the chart layout
+ * @returns `true` when the drawing can be saved
+ */
+ isSavingEnabled(): boolean;
+ /**
+ * Enables or disables saving of the drawing in the chart layout (see `disableSave` option of `createMultipointShape`).
+ * @param {boolean} enable - if `true`, the drawing can be saved to the chart
+ */
+ setSavingEnabled(enable: boolean): void;
+ /**
+ * Is the drawing shown in the Object Tree Panel
+ * @returns `true` when the drawing is visible in the tree.
+ */
+ isShowInObjectsTreeEnabled(): boolean;
+ /**
+ * Enables or disables the visibility of the drawing in the Object Tree panel
+ * @param {boolean} enabled - if `true` then the drawing will be visible
+ */
+ setShowInObjectsTreeEnabled(enabled: boolean): void;
+ /**
+ * Is the drawing editable by the user.
+ * @returns `true` when the drawing is editable
+ */
+ isUserEditEnabled(): boolean;
+ /**
+ * Enables or disables whether the drawing is editable
+ * @param {boolean} enabled - if `true`, then the drawing will be editable
+ */
+ setUserEditEnabled(enabled: boolean): void;
+ /**
+ * Places the drawing on top of all other chart objects.
+ */
+ bringToFront(): void;
+ /**
+ * Places the drawing behind all other chart objects.
+ */
+ sendToBack(): void;
+ /**
+ * Get all the properties of the drawing.
+ * @returns properties of the drawing
+ */
+ getProperties(): Record;
+ /**
+ * Sets the properties of the drawing.
+ * @param {object} newProperties - Drawing properties to be set on the drawing. It should have the same structure as an object from {@link ILineDataSourceApi.getProperties}. It can only include the properties that you want to override.
+ */
+ setProperties(newProperties: object): void;
+ /**
+ * Returns the points of the drawing.
+ */
+ getPoints(): PricedPoint[];
+ /**
+ * Set the new points of the drawing. All points must be provided: for example if the drawing is defined by 5 points then all 5 must be provided.
+ *
+ * @param points - The new points.
+ *
+ */
+ setPoints(points: ShapePoint[]): void;
+ /**
+ * Get the position percents of a fixed drawing.
+ */
+ getAnchoredPosition(): PositionPercents | undefined;
+ /**
+ * Set the position percents for a fixed drawing.
+ * For example `setPoints([{ x: 0.1, y: 0.1 }])` would set a fixed drawing defined by
+ * a single point to be 10% top the left edge of the chart and 10% from the top edge.
+ *
+ * @param positionPercents The new position percents.
+ */
+ setAnchoredPosition(positionPercents: PositionPercents): void;
+}
+export interface IMenuItem {
+ /** Menu item type */
+ readonly type: MenuItemType;
+ /**
+ * An unique ID of an action item. Could be used to distinguish actions between each other.
+ */
+ readonly id: string;
+}
+export interface INewsApi {
+ /** Refresh News */
+ refresh(): void;
+}
+export interface INonSeriesStudyBarsResult {
+ /**
+ * Non series bars
+ */
+ bars: IBarArray[];
+}
+export interface INonSeriesStudyResult {
+ /** Type is `non_series_data` */
+ type: 'non_series_data';
+ /** Always true */
+ nonseries: true;
+ /** Data */
+ data: object;
+}
+/** Specific formatter for number */
+export interface INumberFormatter extends IFormatter {
+ /**
+ * Formatter for a price change
+ * @param currentPrice - current price
+ * @param prevPrice - previous price
+ */
+ formatChange?(currentPrice: number, prevPrice: number): string;
+}
+export interface IObservable {
+ /**
+ * Subscribe to changes
+ * @param {(value:T)=>void} callback - callback function to be evoked when observed value changes
+ */
+ subscribe(callback: (value: T) => void): void;
+ /**
+ * Unsubscribe from changes
+ * @param {(value:T)=>void} callback - callback function to be unsubscribed
+ */
+ unsubscribe(callback: (value: T) => void): void;
+}
+export interface IObservableValue extends IBoxedValue, IObservable {}
+export interface IObservableValueReadOnly
+ extends IBoxedValueReadOnly,
+ IObservable {}
+/**
+ * An API object used to control order lines.
+ */
+export interface IOrderLineAdapter {
+ /**
+ * Remove the order line. This API object cannot be used after this call.
+ */
+ remove(): void;
+ /**
+ * Attach a callback to be executed when the order line is modified.
+ *
+ * @param callback Callback to be executed when the order line is modified.
+ */
+ onModify(callback: () => void): this;
+ /**
+ * Attach a callback to be executed when the order line is modified.
+ *
+ * @param data Data to be passed to the callback.
+ * @param callback Callback to be executed when the order line is modified.
+ */
+ onModify(data: T, callback: (data: T) => void): this;
+ /**
+ * Attach a callback to be executed when the order line is moved.
+ *
+ * @param callback Callback to be executed when the order line is moved.
+ */
+ onMove(callback: () => void): this;
+ /**
+ * Attach a callback to be executed when the order line is moved.
+ *
+ * @param data Data to be passed to the callback.
+ * @param callback Callback to be executed when the order line is moved.
+ */
+ onMove(data: T, callback: (data: T) => void): this;
+ /**
+ * Attach a callback to be executed while the order line is being moved.
+ *
+ * @param callback Callback to be executed while the order line is being moved.
+ */
+ onMoving(callback: () => void): this;
+ /**
+ * Attach a callback to be executed while the order line is being moved.
+ *
+ * @param data Data to be passed to the callback.
+ * @param callback Callback to be executed while the order line is being moved.
+ */
+ onMoving(data: T, callback: (data: T) => void): this;
+ /**
+ * Attach a callback to be executed when the order line is cancelled.
+ *
+ * @param callback Callback to be executed when the order line is cancelled.
+ */
+ onCancel(callback: () => void): this;
+ /**
+ * Attach a callback to be executed when the order line is cancelled.
+ *
+ * @param data Data to be passed to the callback.
+ * @param callback Callback to be executed when the order line is cancelled.
+ */
+ onCancel(data: T, callback: (data: T) => void): this;
+ /**
+ * Get the price of the order line.
+ */
+ getPrice(): number;
+ /**
+ * Set the price of the order line.
+ *
+ * @param value The new price
+ */
+ setPrice(value: number): this;
+ /**
+ * Get the text of the order line.
+ */
+ getText(): string;
+ /**
+ * Set the text of the order line.
+ *
+ * @param value The new text
+ */
+ setText(value: string): this;
+ /**
+ * Get the tooltip of the order line.
+ */
+ getTooltip(): string;
+ /**
+ * Set the tooltip of the order line.
+ *
+ * @param value The new tooltip
+ */
+ setTooltip(value: string): this;
+ /**
+ * Get the modify tooltip of the order line.
+ */
+ getModifyTooltip(): string;
+ /**
+ * Set the modify tooltip of the order line.
+ *
+ * @param value The new modify tooltip
+ */
+ setModifyTooltip(value: string): this;
+ /**
+ * Get the cancel tooltip of the order line.
+ */
+ getCancelTooltip(): string;
+ /**
+ * Set the cancel tooltip of the order line.
+ *
+ * @param value The new cancel tooltip
+ */
+ setCancelTooltip(value: string): this;
+ /**
+ * Get the quantity of the order line.
+ */
+ getQuantity(): string;
+ /**
+ * Set the quantity of the order line.
+ *
+ * @param value The new quantity.
+ */
+ setQuantity(value: string): this;
+ /**
+ * Get the editable flag value of the order line.
+ */
+ getEditable(): boolean;
+ /**
+ * Set the editable of the order line.
+ *
+ * @param value The new editable.
+ */
+ setEditable(value: boolean): this;
+ /**
+ * Get the cancellable flag value of the order line.
+ */
+ getCancellable(): boolean;
+ /**
+ * Set the cancellable flag value of the order line.
+ *
+ * @param value The new cancellable flag value.
+ */
+ setCancellable(value: boolean): this;
+ /**
+ * Get the extend left flag value of the order line.
+ */
+ getExtendLeft(): boolean;
+ /**
+ * Set the extend left flag value of the order line.
+ *
+ * @param value The new extend left flag value.
+ */
+ setExtendLeft(value: boolean): this;
+ /**
+ * Get the line length of the order line.
+ */
+ getLineLength(): number;
+ /**
+ * Get the unit of length specified for the line length of the order line.
+ */
+ getLineLengthUnit(): OrderLineLengthUnit;
+ /**
+ * Set the line length of the order line.
+ *
+ * If negative number is provided for the value and the unit is 'pixel' then
+ * the position will be relative to the left edge of the chart.
+ *
+ * @param value The new line length.
+ * @param [unit] - unit for the line length, defaults to 'percentage'.
+ */
+ setLineLength(value: number, unit?: OrderLineLengthUnit): this;
+ /**
+ * Get the line style of the order line.
+ */
+ getLineStyle(): number;
+ /**
+ * Set the line style of the order line.
+ *
+ * @param value The new line style.
+ */
+ setLineStyle(value: number): this;
+ /**
+ * Get the line width of the order line.
+ */
+ getLineWidth(): number;
+ /**
+ * Set the line width of the order line.
+ *
+ * @param value The new line width.
+ */
+ setLineWidth(value: number): this;
+ /**
+ * Get the body font of the order line.
+ */
+ getBodyFont(): string;
+ /**
+ * Set the body font of the order line.
+ *
+ * @param value The new body font.
+ */
+ setBodyFont(value: string): this;
+ /**
+ * Get the quantity font of the order line.
+ */
+ getQuantityFont(): string;
+ /**
+ * Set the quantity font of the order line.
+ *
+ * @param value The new quantity font.
+ */
+ setQuantityFont(value: string): this;
+ /**
+ * Get the line color of the order line.
+ */
+ getLineColor(): string;
+ /**
+ * Set the line color of the order line.
+ *
+ * @param value The new line color.
+ */
+ setLineColor(value: string): this;
+ /**
+ * Get the body border color of the order line.
+ */
+ getBodyBorderColor(): string;
+ /**
+ * Set the body border color of the order line.
+ *
+ * @param value The new body border color.
+ */
+ setBodyBorderColor(value: string): this;
+ /**
+ * Get the body background color of the order line.
+ */
+ getBodyBackgroundColor(): string;
+ /**
+ * Set the body background color of the order line.
+ *
+ * @param value The new body background color.
+ */
+ setBodyBackgroundColor(value: string): this;
+ /**
+ * Get the body text color of the order line.
+ */
+ getBodyTextColor(): string;
+ /**
+ * Set the body text color of the order line.
+ *
+ * @param value The new body text color.
+ */
+ setBodyTextColor(value: string): this;
+ /**
+ * Get the quantity border color of the order line.
+ */
+ getQuantityBorderColor(): string;
+ /**
+ * Set the quantity border color of the order line.
+ *
+ * @param value The new quantity border color.
+ */
+ setQuantityBorderColor(value: string): this;
+ /**
+ * Get the quantity background color of the order line.
+ */
+ getQuantityBackgroundColor(): string;
+ /**
+ * Set the quantity background color of the order line.
+ *
+ * @param value The new quantity background color.
+ */
+ setQuantityBackgroundColor(value: string): this;
+ /**
+ * Get the quantity text color of the order line.
+ */
+ getQuantityTextColor(): string;
+ /**
+ * Set the quantity text color of the order line.
+ *
+ * @param value The new quantity text color.
+ */
+ setQuantityTextColor(value: string): this;
+ /**
+ * Get the cancel button border color of the order line.
+ */
+ getCancelButtonBorderColor(): string;
+ /**
+ * Set the cancel button border color of the order line.
+ *
+ * @param value The new cancel button border color.
+ */
+ setCancelButtonBorderColor(value: string): this;
+ /**
+ * Get the cancel button background color of the order line.
+ */
+ getCancelButtonBackgroundColor(): string;
+ /**
+ * Set the cancel button background color of the order line.
+ *
+ * @param value The new cancel button background color.
+ */
+ setCancelButtonBackgroundColor(value: string): this;
+ /**
+ * Get the cancel button icon color of the order line.
+ */
+ getCancelButtonIconColor(): string;
+ /**
+ * Set the cancel button icon color of the order line.
+ *
+ * @param value The new cancel button icon color.
+ */
+ setCancelButtonIconColor(value: string): this;
+}
+/**
+ * You can retrieve this interface by using the {@link IChartWidgetApi.getPanes} method
+ */
+export interface IPaneApi {
+ /** Returns `true` if the price scale contains the main series */
+ hasMainSeries(): boolean;
+ /**
+ * Returns an array of the PriceScaleApi instances that allows interaction with right price scales.
+ * The array may be empty if there is not any price scale on the left side of the pane
+ */
+ getLeftPriceScales(): readonly IPriceScaleApi[];
+ /**
+ * Returns an array of the PriceScaleApi instances that allows interaction with right price scales.
+ * The array may be empty if there is not any price scale on the right side of the pane
+ */
+ getRightPriceScales(): readonly IPriceScaleApi[];
+ /**
+ * Returns an instance of the PriceScaleApi that allows you to interact with the price scale of the main source
+ * or `null` if the main source is not attached to any price scale (it is in 'No Scale' mode)
+ */
+ getMainSourcePriceScale(): IPriceScaleApi | null;
+ /** Returns the pane's height */
+ getHeight(): number;
+ /** Sets the pane's height */
+ setHeight(height: number): void;
+ /** Moves the pane to a new position, `paneIndex` should be a number between 0 and all panes count - 1 */
+ moveTo(paneIndex: number): void;
+ /** Returns the pane's index, it's a number between 0 and all panes count - 1 */
+ paneIndex(): number;
+ /** Collapse the current pane */
+ collapse(): void;
+ /** Restore the size of a previously collapsed pane */
+ restore(): void;
+}
+export interface IPineSeries {
+ /**
+ * Get the value at a specific index.
+ *
+ * Note: The indices of a pine series is opposite.
+ *
+ * Example:
+ * - s.get(1) returns second last,
+ * - s.get(2) - third last
+ * - and so on
+ * @param {number} n? - index
+ */
+ get(n?: number): number;
+ /**
+ * Set the value for the pine series at the current index interation.
+ * @param {number} value - value to be set
+ */
+ set(value: number): void;
+ /**
+ * Get the index for the bar at the specified timestamp
+ * @param {number} time - timestamp
+ */
+ indexOf(time: number): number;
+ /**
+ * Map some values from one time scale to another.
+ *
+ * @param source Source times.
+ * @param destination Destination times.
+ * @param mode Adopt mode. `0` for continuous, `1` for precise.
+ *
+ * In continuous mode (`0`) every source time will be mapped to a destination time if one exists. Multiple source times may be mapped to the same destination time.
+ *
+ * In precise mode (`1`) every source time will be mapped to a destination time AT MOST ONCE if one exists. Some source times may not be mapped.
+ *
+ * @example
+ * ```javascript
+ * // A pine series with values [5, 5]
+ * const sourceTimes = ctx.new_var();
+ * // A pine series with values [4, 5]
+ * const destinationTimes = ctx.new_var();
+ * // A pine series with values [1, 2]
+ * const values = ctx.new_var();
+ *
+ * // Creates a pine series with values [2, 2]
+ * const adopted1 = values.adopt(sourceTimes, destinationTimes, 0);
+ *
+ * // Creates a pine series with values [NaN, 2]
+ * const adopted2 = values.adopt(sourceTimes, destinationTimes, 1);
+ * ```
+ *
+ * @example
+ *
+ * Psuedocode of the adopt algorithm:
+ *
+ * ```
+ * adopt(sourceSeries, destinationSeries, mode) =
+ * destinationValue = most recent value in destinationSeries
+ * sourceIndex = index of destinationValue in sourceSeries
+ *
+ * if mode equals 1 then
+ * previousDestinationValue = second most recent value in destinationSeries
+ * previousSourceIndex = index of previousDestinationValue in sourceSeries
+ *
+ * if sourceIndex equals previousSourceIndex
+ * return NaN
+ *
+ * return value at sourceIndex
+ * ```
+ */
+ adopt(source: IPineSeries, destination: IPineSeries, mode: 0 | 1): number;
+}
+/**
+ * An API object used to control position lines.
+ */
+export interface IPositionLineAdapter {
+ /**
+ * Remove the position line. This API object cannot be used after this call.
+ */
+ remove(): void;
+ /**
+ * Attach a callback to be executed when the position line is closed.
+ *
+ * @param callback Callback to be executed when the position line is closed.
+ */
+ onClose(callback: () => void): this;
+ /**
+ * Attach a callback to be executed when the position line is closed.
+ *
+ * @param data Data to be passed to the callback.
+ * @param callback Callback to be executed when the position line is closed.
+ */
+ onClose(data: T, callback: (data: T) => void): this;
+ /**
+ * Attach a callback to be executed when the position line is modified.
+ *
+ * @param callback Callback to be executed when the position line is modified.
+ */
+ onModify(callback: () => void): this;
+ /**
+ * Attach a callback to be executed when the position line is modified.
+ *
+ * @param data Data to be passed to the callback.
+ * @param callback Callback to be executed when the position line is modified.
+ */
+ onModify(data: T, callback: (data: T) => void): this;
+ /**
+ * Attach a callback to be executed when the position line is reversed.
+ *
+ * @param callback Callback to be executed when the position line is reversed.
+ */
+ onReverse(callback: () => void): this;
+ /**
+ * Attach a callback to be executed when the position line is reversed.
+ *
+ * @param data Data to be passed to the callback.
+ * @param callback Callback to be executed when the position line is reversed.
+ */
+ onReverse(data: T, callback: (data: T) => void): this;
+ /**
+ * Get the price of the position line.
+ */
+ getPrice(): number;
+ /**
+ * Set the price of the position line.
+ *
+ * @param value The new price.
+ */
+ setPrice(value: number): this;
+ /**
+ * Get the text of the position line.
+ */
+ getText(): string;
+ /**
+ * Set the text of the position line.
+ *
+ * @param value The new text.
+ */
+ setText(value: string): this;
+ /**
+ * Get the tooltip of the position line.
+ */
+ getTooltip(): string;
+ /**
+ * Set the tooltip of the position line.
+ *
+ * @param value The new tooltip.
+ */
+ setTooltip(value: string): this;
+ /**
+ * Get the protect tooltip of the position line.
+ */
+ getProtectTooltip(): string;
+ /**
+ * Set the protect tooltip of the position line.
+ *
+ * @param value The new protect tooltip.
+ */
+ setProtectTooltip(value: string): this;
+ /**
+ * Get the close tooltip of the position line.
+ */
+ getCloseTooltip(): string;
+ /**
+ * Set the close tooltip of the position line.
+ *
+ * @param value The new close tooltip.
+ */
+ setCloseTooltip(value: string): this;
+ /**
+ * Get the reverse tooltip of the position line.
+ */
+ getReverseTooltip(): string;
+ /**
+ * Set the reverse tooltip of the position line.
+ *
+ * @param value The new reverse tooltip.
+ */
+ setReverseTooltip(value: string): this;
+ /**
+ * Get the quantity of the position line.
+ */
+ getQuantity(): string;
+ /**
+ * Set the quantity of the position line.
+ *
+ * @param value The new quantity.
+ */
+ setQuantity(value: string): this;
+ /**
+ * Get the extend left flag value of the position line.
+ */
+ getExtendLeft(): boolean;
+ /**
+ * Set the extend left flag value of the position line.
+ * @param value The new extend left flag value.
+ */
+ setExtendLeft(value: boolean): this;
+ /**
+ * Get the unit of length specified for the line length of the position line.
+ */
+ getLineLengthUnit(): PositionLineLengthUnit;
+ /**
+ * Get the line length of the position line.
+ */
+ getLineLength(): number;
+ /**
+ * Set the line length of the position line.
+ *
+ * If negative number is provided for the value and the unit is 'pixel' then
+ * the position will be relative to the left edge of the chart.
+ *
+ * @param value The new line length.
+ * @param [unit] - unit for the line length, defaults to 'percentage'.
+ */
+ setLineLength(value: number, unit?: PositionLineLengthUnit): this;
+ /**
+ * Get the line style of the position line.
+ */
+ getLineStyle(): number;
+ /**
+ * Set the line style of the position line.
+ * @param value The new line style.
+ */
+ setLineStyle(value: number): this;
+ /**
+ * Get the line width of the position line.
+ */
+ getLineWidth(): number;
+ /**
+ * Set the line width of the position line.
+ * @param value The new line width.
+ */
+ setLineWidth(value: number): this;
+ /**
+ * Get the body font of the position line.
+ */
+ getBodyFont(): string;
+ /**
+ * Set the body font of the position line.
+ * @param value The new body font.
+ */
+ setBodyFont(value: string): this;
+ /**
+ * Get the quantity font of the position line.
+ */
+ getQuantityFont(): string;
+ /**
+ * Set the quantity font of the position line.
+ * @param value The new quantity font.
+ */
+ setQuantityFont(value: string): this;
+ /**
+ * Get the line color of the position line.
+ */
+ getLineColor(): string;
+ /**
+ * Set the line color of the position line.
+ * @param value The new line color.
+ */
+ setLineColor(value: string): this;
+ /**
+ * Get the body border color of the position line.
+ */
+ getBodyBorderColor(): string;
+ /**
+ * Set the body border color of the position line.
+ * @param value The new body border color.
+ */
+ setBodyBorderColor(value: string): this;
+ /**
+ * Get the body font of the position line.
+ */
+ getBodyBackgroundColor(): string;
+ /**
+ * Set the body font of the position line.
+ * @param value The new body font.
+ */
+ setBodyBackgroundColor(value: string): this;
+ /**
+ * Get the body text color of the position line.
+ */
+ getBodyTextColor(): string;
+ /**
+ * Set the body text color of the position line.
+ * @param value The new body text color.
+ */
+ setBodyTextColor(value: string): this;
+ /**
+ * Get the quantity border color of the position line.
+ */
+ getQuantityBorderColor(): string;
+ /**
+ * Set the quantity border color of the position line.
+ *
+ * @param value The new quantity border color.
+ */
+ setQuantityBorderColor(value: string): this;
+ /**
+ * Get the quantity background color of the position line.
+ */
+ getQuantityBackgroundColor(): string;
+ /**
+ * Set the quantity background color of the position line.
+ *
+ * @param value The new quantity background color.
+ */
+ setQuantityBackgroundColor(value: string): this;
+ /**
+ * Get the quantity text color of the position line.
+ */
+ getQuantityTextColor(): string;
+ /**
+ * Set the quantity text color of the position line.
+ *
+ * @param value The new quantity text color.
+ */
+ setQuantityTextColor(value: string): this;
+ /**
+ * Get the reverse button border color of the position line.
+ */
+ getReverseButtonBorderColor(): string;
+ /**
+ * Set the reverse button border color of the position line.
+ * @param value The new reverse button border color.
+ */
+ setReverseButtonBorderColor(value: string): this;
+ /**
+ * Get the reverse button background color of the position line.
+ */
+ getReverseButtonBackgroundColor(): string;
+ /**
+ * Set the reverse button background color of the position line.
+ * @param value The new reverse button background color.
+ */
+ setReverseButtonBackgroundColor(value: string): this;
+ /**
+ * Get the reverse button icon color of the position line.
+ */
+ getReverseButtonIconColor(): string;
+ /**
+ * Set the reverse button icon color of the position line.
+ * @param value The new reverse button icon color.
+ */
+ setReverseButtonIconColor(value: string): this;
+ /**
+ * Get the close button border color of the position line.
+ */
+ getCloseButtonBorderColor(): string;
+ /**
+ * Set the close button border color of the position line.
+ * @param value The new close button border color.
+ */
+ setCloseButtonBorderColor(value: string): this;
+ /**
+ * Get the close button background color of the position line.
+ */
+ getCloseButtonBackgroundColor(): string;
+ /**
+ * Set the close button background color of the position line.
+ * @param value The new close button background color.
+ */
+ setCloseButtonBackgroundColor(value: string): this;
+ /**
+ * Get the close button icon color of the position line.
+ */
+ getCloseButtonIconColor(): string;
+ /**
+ * Set the close button icon color of the position line.
+ * @param value The new close button icon color.
+ */
+ setCloseButtonIconColor(value: string): this;
+}
+/**
+ * Specific formatter for numbers
+ */
+export interface IPriceFormatter extends ISymbolValueFormatter {
+ /**
+ * Price Formatter
+ * @param {number} price - price
+ * @param {boolean} signPositive? - add plus sign to result string.
+ * @param {number} [tailSize] - add `tailSize` digits to fractional part of result string
+ * @param {boolean} [signNegative] - add minus sign to result string.
+ * @param {boolean} [useRtlFormat] - Use Right to left format
+ * @param {boolean} [cutFractionalByPrecision] - cuts price by priceScalePrecision, without rounding.
+ * @returns formatted price
+ */
+ format(
+ price: number,
+ signPositive?: boolean,
+ tailSize?: number,
+ signNegative?: boolean,
+ useRtlFormat?: boolean,
+ cutFractionalByPrecision?: boolean
+ ): string;
+}
+/**
+ * The Price Scale API allows interacting with the [price scale](https://www.tradingview.com/charting-library-docs/latest/ui_elements/Price-Scale.md).
+ * You can retrieve this interface by evoking the following methods of the {@link IPaneApi}:
+ * - `getLeftPriceScales`
+ * - `getRightPriceScales`
+ * - `getMainSourcePriceScale`
+ */
+export interface IPriceScaleApi {
+ /** Returns current mode of the price scale */
+ getMode(): PriceScaleMode;
+ /**
+ * Changes current mode of the price scale
+ * @param newMode new mode to set for the price scale
+ */
+ setMode(newMode: PriceScaleMode): void;
+ /** Returns whether the price scale is inverted or not */
+ isInverted(): boolean;
+ /**
+ * Changes current inverted state of the price scale
+ * @param isInverted set to `true` if the price scale should become inverted
+ */
+ setInverted(isInverted: boolean): void;
+ /**
+ * Returns `true` when the price scale is locked
+ */
+ isLocked(): boolean;
+ /**
+ * Set whether the price scale should be locked or not
+ * @param {boolean} isLocked - set to `true` to lock the price scale
+ */
+ setLocked(isLocked: boolean): void;
+ /**
+ * Returns `true` when the price scale has auto scaling enabled
+ */
+ isAutoScale(): boolean;
+ /**
+ * Set whether auto scaling should be enabled or not for the price scale
+ * @param {boolean} isAutoScale - set to `true` to enable auto scaling
+ */
+ setAutoScale(isAutoScale: boolean): void;
+ /**
+ * Returns current visible price range of the price scale.
+ * The result is an object with `from` and `to`,
+ * which are the boundaries of the price scale visible range.
+ */
+ getVisiblePriceRange(): VisiblePriceRange | null;
+ /**
+ * Sets current visible price range of the price scale,
+ * @param range an object with `from` and `to`, which are the boundaries of the price scale visible range.
+ */
+ setVisiblePriceRange(range: VisiblePriceRange): void;
+ /** Returns `true` if the price scale contains the main series */
+ hasMainSeries(): boolean;
+ /** Returns an array of IDs of all studies attached to the price scale */
+ getStudies(): EntityId[];
+ /** Returns the current currency info set on the price scale if any or null if none is specified */
+ currency(): CurrencyInfo | null;
+ /**
+ * Sets a currency on the price scale.
+ * @param {currency} string | null - currency supported by your backend (for example 'EUR', 'USD'). A null value will reset the currency to default.
+ */
+ setCurrency(currency: string | null): void;
+ /** Returns the current unit info set on the price scale if any or null if none is specified */
+ unit(): UnitInfo | null;
+ /**
+ * Sets a unit on the price scale.
+ * @param {unit} string | null - unit supported by your backend (for example 'weight', 'energy'). A null value will reset the unit to default.
+ */
+ setUnit(unit: string | null): void;
+}
+export interface IProjectionStudyResult {
+ /** array of projection bars */
+ bars: IProjectionBar[];
+ /** always true */
+ nonseries?: boolean;
+ /** last price displayed on price scale */
+ price?: number;
+ /** always projection */
+ type?: 'projection';
+ /** box size is displayed in the legend */
+ boxSize?: number;
+ /** reversal amount is displayed in the legend */
+ reversalAmount?: number;
+}
+/**
+ * Allows you to select entities ([drawings](https://www.tradingview.com/charting-library-docs/latest/ui_elements/Drawings) and [indicators](https://www.tradingview.com/charting-library-docs/latest/ui_elements/indicators/)) on the chart. Consider the following example:
+ *
+ * ```js
+ * var chart = tvWidget.activeChart();
+ * // Prints all selection changes to the console
+ * chart.selection().onChanged().subscribe(null, s => console.log(chart.selection().allSources()));
+ * // Creates an indicator and saves its ID
+ * var studyId = chart.createStudy("Moving Average", false, false, { length: 10 });
+ * // Adds the indicator to the selection ([] is printed to the console)
+ * chart.selection().add(studyId);
+ * // Clears the selection ([] is printed to the console)
+ * chart.selection().clear();
+ * ```
+ *
+ * #### Multiple Selection
+ *
+ * Multiple selection has the following specifics:
+ *
+ * - Either indicators or drawings can be selected at the same time.
+ * - If you add an indicator to the selection, other entities are removed from it.
+ * - Adding an array of objects to the selection works the same as adding these objects one by one.
+ */
+export interface ISelectionApi {
+ /**
+ * Add entity / entities to selection
+ * @param {EntityId[]|EntityId} entities - entities to be added to selection
+ */
+ add(entities: EntityId[] | EntityId): void;
+ /**
+ * Set entity / entities as the selection
+ * @param {EntityId[]|EntityId} entities - entities to be selected
+ */
+ set(entities: EntityId[] | EntityId): void;
+ /**
+ * Remove entities from the selection
+ * @param {EntityId[]} entities - entities to be removed from the selection
+ */
+ remove(entities: EntityId[]): void;
+ /**
+ * Does the selection contain the entity
+ * @param {EntityId} entity - entity to be checked
+ * @returns `true` when entity is in the selection
+ */
+ contains(entity: EntityId): boolean;
+ /**
+ * Returns all the entities in the selection
+ */
+ allSources(): EntityId[];
+ /**
+ * Is the selection empty
+ * @returns `true` when empty
+ */
+ isEmpty(): boolean;
+ /**
+ * Clear selection
+ */
+ clear(): void;
+ /**
+ * Subscription for selection changes.
+ */
+ onChanged(): ISubscription<() => void>;
+ /**
+ * Whether the entity can be added to the selection
+ * @param {EntityId} entity - entity to be checked
+ * @returns `true` when entity can be added to the selection
+ */
+ canBeAddedToSelection(entity: EntityId): boolean;
+}
+export interface ISeparator extends IMenuItem {
+ /** @inheritDoc */
+ readonly type: MenuItemType.Separator;
+}
+/**
+ * Series API
+ *
+ * You can retrieve this interface by using the {@link IChartWidgetApi.getSeries} method
+ */
+export interface ISeriesApi {
+ /** Returns `true` if a user is able to remove/change/hide the main series */
+ isUserEditEnabled(): boolean;
+ /**
+ * Enables or disables removing/changing/hiding the main series by the user
+ */
+ setUserEditEnabled(enabled: boolean): void;
+ /** Merges the main series up (if possible) */
+ mergeUp(): void;
+ /** Merges the main series down (if possible) */
+ mergeDown(): void;
+ /** Unmerges the main series up (if possible) */
+ unmergeUp(): void;
+ /** Unmerges the main series down (if possible) */
+ unmergeDown(): void;
+ /** Pins the main series to a new price axis at right */
+ detachToRight(): void;
+ /** Pins the main series to a new price axis at left */
+ detachToLeft(): void;
+ /** Makes the main series to be an overlay source */
+ detachNoScale(): void;
+ /** Changes the price scale of the main series */
+ changePriceScale(newPriceScale: SeriesPriceScale): void;
+ /** Returns `true` if the main series is visible */
+ isVisible(): boolean;
+ /** Shows/hides the main series */
+ setVisible(visible: boolean): void;
+ /** Places main series on top of all other chart objects */
+ bringToFront(): void;
+ /** Places main series behind all other chart objects */
+ sendToBack(): void;
+ /** Value that is returned when a study is created via API */
+ entityId(): EntityId;
+ /** Returns properties for a specific chart style */
+ chartStyleProperties(
+ chartStyle: T
+ ): SeriesPreferencesMap[T];
+ /** Sets properties for a specific chart style */
+ setChartStyleProperties(
+ chartStyle: T,
+ newPrefs: Partial
+ ): void;
+}
+export interface ISettingsAdapter {
+ /** Initial settings */
+ initialSettings?: InitialSettingsMap;
+ /** Set a value for a setting */
+ setValue(key: string, value: string): void;
+ /** Remove a value for a setting */
+ removeValue(key: string): void;
+}
+/**
+ * Drawing Groups API.
+ */
+export interface IShapesGroupControllerApi {
+ /**
+ * Create a group of drawings from the selection.
+ *
+ * @throws If selection is empty, or selection contains non-drawings, or selection contains drawings from more than one pane.
+ * @return The ID of the created group.
+ */
+ createGroupFromSelection(): ShapesGroupId;
+ /**
+ * Remove a group of drawings.
+ *
+ * @param groupId A group ID.
+ */
+ removeGroup(groupId: ShapesGroupId): void;
+ /**
+ * Get an array of all drawing groups.
+ *
+ * @returns An array of group IDs.
+ */
+ groups(): readonly ShapesGroupId[];
+ /**
+ * Get an array of IDs for each drawing in a group.
+ *
+ * @param groupId A group ID.
+ * @returns An array of drawing IDs.
+ */
+ shapesInGroup(groupId: ShapesGroupId): readonly EntityId[];
+ /**
+ * Remove a drawing from a group. If the drawing is the only drawing in the group then the group is also removed.
+ *
+ * @param groupId A group ID.
+ * @param shapeId A drawing ID.
+ */
+ excludeShapeFromGroup(groupId: ShapesGroupId, shapeId: EntityId): void;
+ /**
+ * Add a drawing to a group.
+ *
+ * @param groupId A group ID.
+ * @param shapeId A drawing ID.
+ */
+ addShapeToGroup(groupId: ShapesGroupId, shapeId: EntityId): void;
+ /**
+ * Get an object containing the available Z-order operations for a group.
+ *
+ * @param groupId A group ID.
+ * @returns The available Z-order operations.
+ */
+ availableZOrderOperations(groupId: ShapesGroupId): AvailableZOrderOperations;
+ /**
+ * Move the group to the top of the Z-order.
+ *
+ * @param groupId A group ID.
+ */
+ bringToFront(groupId: ShapesGroupId): void;
+ /**
+ * Move the group to the bottom of the Z-order.
+ *
+ * @param groupId A group ID.
+ */
+ sendToBack(groupId: ShapesGroupId): void;
+ /**
+ * Move the group one level up in the Z-order.
+ *
+ * @param groupId A group ID.
+ */
+ bringForward(groupId: ShapesGroupId): void;
+ /**
+ * Move the group one level down in the Z-order.
+ *
+ * @param groupId A group ID.
+ */
+ sendBackward(groupId: ShapesGroupId): void;
+ /**
+ * Move the group immediately below the target in the Z-order.
+ *
+ * @param groupId A group ID.
+ * @param target A target ID.
+ */
+ insertAfter(groupId: ShapesGroupId, target: ShapesGroupId | EntityId): void;
+ /**
+ * Move the group immediately above the target in the Z-order.
+ *
+ * @param groupId A group ID.
+ * @param target A target ID.
+ */
+ insertBefore(groupId: ShapesGroupId, target: ShapesGroupId | EntityId): void;
+ /**
+ * Show or hide all drawings in a group.
+ *
+ * @param groupId A group ID.
+ * @param value A boolean flag. `true` to show, `false` to hide.
+ */
+ setGroupVisibility(groupId: ShapesGroupId, value: boolean): void;
+ /**
+ * Get the visibility state of a group.
+ *
+ * @param groupId A group ID.
+ * @returns The visibility state.
+ */
+ groupVisibility(groupId: ShapesGroupId): GroupVisibilityState;
+ /**
+ * Lock or unlock a group.
+ *
+ * @param groupId A group ID.
+ * @param value A boolean flag. `true` to lock, `false` to unlock.
+ */
+ setGroupLock(groupId: ShapesGroupId, value: boolean): void;
+ /**
+ * Get locked state of a group.
+ *
+ * @param groupId A group ID.
+ * @returns The locked state.
+ */
+ groupLock(groupId: ShapesGroupId): GroupLockState;
+ /**
+ * Get the name of a group.
+ *
+ * @param groupId A group ID.
+ * @returns The name of the group.
+ */
+ getGroupName(groupId: ShapesGroupId): string;
+ /**
+ * Set the name of a group. Names do not need to be unique.
+ *
+ * @param groupId A group ID.
+ * @param name The new name of the group.
+ */
+ setGroupName(groupId: ShapesGroupId, name: string): void;
+ /**
+ * Check if some drawings can be grouped.
+ *
+ * @param shapes An array of drawing IDs.
+ * @return `true` if the drawings can be grouped, `false` otherwise.
+ */
+ canBeGroupped(shapes: readonly EntityId[]): boolean;
+}
+/**
+ * API object for interacting with a study.
+ *
+ * You can retrieve this interface by using the {@link IChartWidgetApi.getStudyById} method
+ */
+export interface IStudyApi {
+ /**
+ * Get if user editing is enabled for the study.
+ *
+ * @returns `true` if editing is enabled, `false` otherwise.
+ */
+ isUserEditEnabled(): boolean;
+ /**
+ * Set if user editing is enabled for the study.
+ *
+ * @param enabled `true` if editing should be enabled, `false` otherwise.
+ */
+ setUserEditEnabled(enabled: boolean): void;
+ /**
+ * Get descriptions of the study inputs.
+ */
+ getInputsInfo(): StudyInputInformation[];
+ /**
+ * Get current values of the study inputs.
+ */
+ getInputValues(): StudyInputValueItem[];
+ /**
+ * Set the value of one or more study inputs.
+ *
+ * @param values Study input values to set.
+ */
+ setInputValues(values: StudyInputValueItem[]): void;
+ /**
+ * Get descriptions of study styles.
+ */
+ getStyleInfo(): StudyStyleInfo;
+ /**
+ * Get current values of the study styles.
+ */
+ getStyleValues(): StudyStyleValues;
+ /**
+ * Merge the study into the pane above, if possible.
+ */
+ mergeUp(): void;
+ /**
+ * Merge the study into the pane below, if possible.
+ */
+ mergeDown(): void;
+ /**
+ * Unmerge the study into the pane above, if possible.
+ */
+ unmergeUp(): void;
+ /**
+ * Unmerge the study into the pane below, if possible.
+ */
+ unmergeDown(): void;
+ /**
+ * Change the price scale that the study is attached to.
+ *
+ * @param newPriceScale Price scale identifier, or the ID of another study whose price scale the study should be moved to.
+ */
+ changePriceScale(newPriceScale: StudyPriceScale | EntityId): void;
+ /**
+ * Get if the study is visible.
+ *
+ * @returns `true` if visible, `false` otherwise.
+ */
+ isVisible(): boolean;
+ /**
+ * Set the study visibility.
+ *
+ * @param visible `true` if the study should be visible, `false` otherwise.
+ */
+ setVisible(visible: boolean): void;
+ /**
+ * Move the study visually in front of all other chart objects.
+ */
+ bringToFront(): void;
+ /**
+ * Move the study visually behind of all other chart objects.
+ */
+ sendToBack(): void;
+ /**
+ * Override one or more of the indicator's properties.
+ * Refer to [Indicator Overrides](https://www.tradingview.com/charting-library-docs/latest/customization/overrides/Studies-Overrides.md#change-the-existing-indicator) for more information.
+ * Overrides for built-in indicators are listed in {@link SingleIndicatorOverrides}.
+ *
+ * @param overrides Property values to override.
+ */
+ applyOverrides(
+ overrides: TOverrides
+ ): void;
+ /**
+ * Copies the study to all charts in the layout.
+ * Only applicable to multi-chart layouts (Trading Platform).
+ */
+ applyToEntireLayout(): void;
+ /**
+ * Get a subscription that can be used to subscribe a callback when the study data has loaded.
+ *
+ * @returns A subscription.
+ *
+ * Example:
+ * ```javascript
+ * studyApi.onDataLoaded().subscribe(
+ * null,
+ * () => console.log('Study data is loaded'),
+ * true
+ * );
+ * ```
+ */
+ onDataLoaded(): ISubscription<() => void>;
+ /**
+ * Get a subscription that can be used to subscribe a callback when the study has an error.
+ *
+ * @returns A subscription.
+ *
+ * Example:
+ * ```javascript
+ * studyApi.studyApi.onStudyError().subscribe(
+ * null,
+ * () => console.log('Study error'),
+ * true
+ * );
+ * ```
+ */
+ onStudyError(): ISubscription<() => void>;
+}
+/**
+ * A subscription. Used to subscribe callbacks to events.
+ */
+export interface ISubscription {
+ /**
+ * Subscribe a callback function to this event. Subscribed callbacks are called when the event fires.
+ *
+ * @param obj Object used as the `this` value bound to the callback function.
+ * @param member Function called when the event is fired.
+ * @param singleshot `true` if the subscription should be automatically removed after the first time it is fired.
+ *
+ * @example
+ * ```
+ * // Log 'Series data loaded!' to the console the next time the data loaded event fires and then unsubscribe automatically.
+ * seriesApi.onDataLoaded().subscribe(null, () => { console.log('Series data loaded!'); }, true);
+ * ```
+ * Subscribe to an event within a class. Manually unsubscribe when some condition is true.
+ * ```
+ * class Example {
+ * constructor(seriesApi) {
+ * this._seriesApi = seriesApi;
+ * this._seriesApi.onDataLoaded().subscribe(this, this._onDataLoaded);
+ * }
+ *
+ * _onDataLoaded() {
+ * // Do something in response to the event.
+ *
+ * if (someUnsubscribeCondition) {
+ * this._seriesApi.onDataLoaded().unsubscribe(this, this._onDataLoaded);
+ * }
+ * }
+ * }
+ * ```
+ */
+ subscribe(obj: object | null, member: TFunc, singleshot?: boolean): void;
+ /**
+ * Unsubscribe a previously subscribed callback function.
+ * It is important that the `obj` and `member` arguments are the same as the ones passed when the callback was subscribed.
+ *
+ * @param obj Object passed as the `this` value when the callback was subscribed.
+ * @param member Function subscribed to the event.
+ */
+ unsubscribe(obj: object | null, member: TFunc): void;
+ /**
+ * Unsubscribe all callbacks that were subscribed with the same `obj` value.
+ *
+ * @param obj `obj` value passed when the callbacks were subscribed.
+ * @example
+ * ```
+ * // Unsubscribe all three callback functions at once in the `destroy` method.
+ * class Example {
+ * constructor(seriesApi) {
+ * this._seriesApi = seriesApi;
+ * this._seriesApi.onDataLoaded().subscribe(this, this._callback1);
+ * this._seriesApi.onDataLoaded().subscribe(this, this._callback2);
+ * this._seriesApi.onDataLoaded().subscribe(this, this._callback3);
+ * }
+ *
+ * destroy() {
+ * this._seriesapi.onDataLoaded().unsubscribeAll(this);
+ * }
+ *
+ * _callback1() { ... }
+ * _callback2() { ... }
+ * _callback3() { ... }
+ * }
+ * ```
+ */
+ unsubscribeAll(obj: object | null): void;
+}
+/**
+ * PineJS execution context symbol information.
+ */
+export interface ISymbolInstrument {
+ /** Period Base */
+ periodBase: string;
+ /** Ticker ID */
+ tickerid: string;
+ /** Currency Code */
+ currencyCode?: string;
+ /** Unit ID */
+ unitId?: string;
+ /** Bar resolution */
+ period: ResolutionString;
+ /** Index */
+ index: number;
+ /** Time */
+ time: number;
+ /** Open bar value */
+ open: number;
+ /** High bar value */
+ high: number;
+ /** Low bar value */
+ low: number;
+ /** Close bar value */
+ close: number;
+ /** Bar Volume value */
+ volume: number;
+ /** Time of the update */
+ updatetime: number;
+ /** Ticker */
+ ticker: string;
+ /** Resolution */
+ resolution: string;
+ /** Interval */
+ interval: number;
+ /** Minimum tick amount */
+ minTick: number;
+ /** Whether this is the first bar */
+ isFirstBar: boolean;
+ /** Whether this is the last bar */
+ isLastBar: boolean;
+ /** Whether this is a new bar */
+ isNewBar: boolean;
+ /** Whether the bar is closed */
+ isBarClosed: boolean;
+ /** Symbol information */
+ info?: LibrarySymbolInfo;
+ /**
+ * Time of the bar.
+ *
+ * @returns the timestamp in milliseconds
+ */
+ bartime(): number;
+ /**
+ * @returns true if the bar resolution is day/week/month, false if it is intraday
+ */
+ isdwm(): boolean;
+}
+export interface ISymbolValueFormatter {
+ /** Default formatter function used to assign the correct sign (+ or -) to a number */
+ format(price: number, signPositive?: boolean): string;
+ /**
+ * Formatter for a price change
+ * @param currentPrice - current price
+ * @param prevPrice - previous price
+ * @param signPositive - is the sign of the number positive
+ */
+ formatChange?(
+ currentPrice: number,
+ prevPrice: number,
+ signPositive?: boolean
+ ): string;
+}
+/**
+ * API object for interacting with the [time scale](https://www.tradingview.com/charting-library-docs/latest/ui_elements/Time-Scale.md).
+ *
+ * You can retrieve this interface by using the {@link IChartWidgetApi.getTimeScale} method
+ */
+export interface ITimeScaleApi {
+ /** Returns the time associated to a given coordinate (distance in pixels from the leftmost visible bar) */
+ coordinateToTime(x: number): number | null;
+ /**
+ * Users will be notified every time `barSpacing` value is changed. This typically occurs when zooming in/out on the chart.
+ * This is to detect when the chart has been zoomed in/out
+ */
+ barSpacingChanged(): ISubscription<(newBarSpacing: number) => void>;
+ /**
+ * Users will be notified every time `rightOffset` value is changed.
+ * This is to detect when the chart has been scrolled left/right.
+ */
+ rightOffsetChanged(): ISubscription<(rightOffset: number) => void>;
+ /** To set a new right offset */
+ setRightOffset(offset: number): void;
+ /** To set a new bar spacing */
+ setBarSpacing(newBarSpacing: number): void;
+ /** Returns the current bar spacing */
+ barSpacing(): number;
+ /** Returns the current right offset */
+ rightOffset(): number;
+ /** Returns the current width of the chart in pixels */
+ width(): number;
+ /** Object that can be used to read/set/watch the default right offset (margin) */
+ defaultRightOffset(): IWatchedValue;
+ /** Object that can be used to read/set/watch the default right offset (in percent) (margin) */
+ defaultRightOffsetPercentage(): IWatchedValue;
+ /**
+ * Object that can be used to read/set/watch whether to use `defaultRightOffset` or `defaultRightOffsetPercentage`
+ * option for the right offset (margin).
+ * - `false`: use `defaultRightOffset`
+ * - `true`: use `defaultRightOffsetPercentage`
+ *
+ * Default: `false`
+ */
+ usePercentageRightOffset(): IWatchedValue;
+}
+export interface ITimezoneApi {
+ /** Array of supported TimezoneInfo */
+ availableTimezones(): readonly TimezoneInfo[];
+ /** Returns the current TimezoneInfo */
+ getTimezone(): TimezoneInfo;
+ /** Sets the current timezone */
+ setTimezone(
+ timezone: TimezoneId | CustomTimezoneId,
+ options?: UndoOptions
+ ): void;
+ /**
+ * To be notified when the timezone is changed
+ *
+ * Example:
+ * ```javascript
+ * timezoneApi.onTimezoneChanged().subscribe(
+ * null,
+ * timezone => console.log(`New timezone: ${timezone}`),
+ * true
+ * );
+ * ```
+ */
+ onTimezoneChanged(): ISubscription<(timezone: TimezoneId) => void>;
+}
+export interface IUpdatableAction extends IAction {
+ /**
+ * Update the options for the Action
+ * @param {Partial} options - updated options
+ */
+ update(options: Partial): void;
+}
+/**
+ * An API object for interacting with the widgetbar (right sidebar) watchlist.
+ *
+ * **Notes about watchlist contents**
+ *
+ * Watchlist items should be symbol names which your datafeed `resolveSymbol` method can resolve. This
+ * means that generally shorter names such as `AAPL` can be used if your datafeed understands it. However,
+ * it is recommend that you provided the symbol names as they appear within the symbolInfo result (for
+ * example: `NASDAQNM:AAPL`).
+ *
+ * Additionally, any item in the list which is prefixed with `###` will be considered a
+ * section divider in the watchlist.
+ */
+export interface IWatchListApi {
+ /**
+ * Get a default list of symbols.
+ * @returns default list of symbols
+ */
+ defaultList(): string[];
+ /**
+ * Get a list of symbols.
+ * If the `id` parameter is not provided then the current list will be returned. If there is no WatchList then `null` will be returned.
+ * @param {string} [id] - Watchlist ID
+ * @returns list of symbols for watchlist
+ */
+ getList(id?: string): string[] | null;
+ /**
+ * Get all watchlists. If there is no WatchList then `null` will be returned.
+ * @returns object of all watchlists
+ */
+ getAllLists(): WatchListSymbolListMap | null;
+ /**
+ * Make the watchlist with the specified `id` active.
+ * @param {string} id - watchlist ID
+ */
+ setActiveList(id: string): void;
+ /**
+ * Get the ID of the current watchlist. If there is no WatchList then `null` will be returned.
+ * @returns id of active watchlist
+ */
+ getActiveListId(): string | null;
+ /**
+ * **Obsolete. Use `updateList` instead.**
+ *
+ * Set the list of symbols for the watchlist. It will replace the entire list.
+ * @param {string[]} symbols - symbol IDs
+ */
+ setList(symbols: string[]): void;
+ /**
+ * Edit the list of symbols for a watchlist.
+ * @param {string} listId - ID of the watchlist
+ * @param {string[]} symbols - symbols to be set for the watchlist. Any item in the list which is prefixed with `###` will be considered a
+ * section divider in the watchlist.
+ */
+ updateList(listId: string, symbols: string[]): void;
+ /**
+ * Rename the watchlist.
+ * @param {string} listId - ID of the watchlist
+ * @param {string} newName - new name to set for the watchlist
+ */
+ renameList(listId: string, newName: string): void;
+ /**
+ * Create a list of symbols with `listName` name. If the `listName` parameter is not provided or there is no WatchList then `null` will be returned;
+ * @param {string} [listName] - name for the watchlist
+ * @param {string[]} [symbols] - symbol IDs for the watchlist. Any item in the list which is prefixed with `###` will be considered a
+ * section divider in the watchlist.
+ * @returns WatchListSymbolList
+ */
+ createList(listName?: string, symbols?: string[]): WatchListSymbolList | null;
+ /**
+ * Save a list of symbols.
+ * @param {WatchListSymbolList} list
+ * @returns If there is no WatchList or an equivalent list already exists then `false` will be returned, otherwise `true` will returned.
+ */
+ saveList(list: WatchListSymbolList): boolean;
+ /**
+ * Delete a watchlist of symbols
+ * @param {string} listId - watchlist ID
+ */
+ deleteList(listId: string): void;
+ /**
+ * Subscription for when the symbols of the active watchlist are changed. Use the `subscribe` method of the returned {@link ISubscription} object to subscribe to the notifications.
+ */
+ onListChanged(): ISubscription;
+ /**
+ * Subscription for when the active watchlist is changed to a different list. Use the `subscribe` method of the returned {@link ISubscription} object to subscribe to the notifications.
+ */
+ onActiveListChanged(): ISubscription;
+ /**
+ * Subscription for when a new list is added to the watchlist widget. Use the `subscribe` method of the returned {@link ISubscription} object to subscribe to the notifications.
+ */
+ onListAdded(): ISubscription;
+ /**
+ * Subscription for when a list is removed from the watchlist widget. Use the `subscribe` method of the returned {@link ISubscription} object to subscribe to the notifications.
+ */
+ onListRemoved(): ISubscription;
+ /**
+ * Subscription for when a list is renamed. Use the `subscribe` method of the returned {@link ISubscription} object to subscribe to the notifications.
+ */
+ onListRenamed(): ISubscription;
+}
+export interface IWatchedValue
+ extends IWatchedValueReadonly,
+ IObservableValue {
+ /**
+ * Set value for the watched value
+ * @param {T} value - value to set
+ * @param {boolean} forceUpdate? - force an update
+ */
+ setValue(value: T, forceUpdate?: boolean): void;
+ /** @inheritDoc */
+ subscribe(
+ callback: WatchedValueCallback,
+ options?: WatchedValueSubscribeOptions
+ ): void;
+ /** @inheritDoc */
+ unsubscribe(callback?: WatchedValueCallback | null): void;
+}
+export interface IWatchedValueReadonly extends IObservableValueReadOnly {
+ /**
+ * Subscribe to watched value changes
+ * @param {(value:T)=>void} callback - callback to be evoked when change occurs
+ * @param {WatchedValueSubscribeOptions} [options] - watch subscriber options
+ */
+ subscribe(
+ callback: (value: T) => void,
+ options?: WatchedValueSubscribeOptions
+ ): void;
+ /**
+ * Unsubscribe to watched value changes
+ * @param {((value:T)=>void)|null} [callback] - callback to remove
+ */
+ unsubscribe(callback?: ((value: T) => void) | null): void;
+ /**
+ * A simplified version of subscription, with promise-like interface, generally for using with boolean-valued watched values
+ * @param {WatchedValueCallback} callback - a function to be called when the value became `true`. `once` and `callWithLast` are implicitly set to true.
+ */
+ when(callback: WatchedValueCallback): void;
+}
+/**
+ * An API object used to change the settings of the watermark.
+ */
+export interface IWatermarkApi {
+ /**
+ * Object that can be used to read/set/watch the color of the watermark text.
+ */
+ color(): IWatchedValue;
+ /**
+ * Object that can be used to read/set/watch the visibility of the watermark.
+ */
+ visibility(): IWatchedValue;
+ /**
+ * Set a custom content provider for the watermark content.
+ *
+ * @param provider - Custom watermark content provider, use `null` if you would like to revert back to the default content for the watermark.
+ */
+ setContentProvider(provider: WatermarkContentProvider | null): void;
+}
+/**
+ * Widget Bar API
+ */
+export interface IWidgetbarApi extends IDestroyable {
+ /**
+ * Show page
+ * @param {PageName} pageName - name of page to show
+ */
+ showPage(pageName: PageName): void;
+ /**
+ * Hide page
+ * @param {PageName} pageName - name of page to hide
+ */
+ hidePage(pageName: PageName): void;
+ /**
+ * Checks if page is visible
+ * @param {PageName} pageName - page to check if visible
+ * @returns true` when page is visible
+ */
+ isPageVisible(pageName: PageName): boolean;
+ /**
+ * Open order panel widget
+ */
+ openOrderPanel(): void;
+ /**
+ * Close order panel widget
+ */
+ closeOrderPanel(): void;
+ /**
+ * Change the visibility of the right toolbar
+ * @param {boolean} visible - true to display the toolbar, false to hide
+ */
+ changeWidgetBarVisibility(visible: boolean): void;
+}
+/**
+ * Override properties for the Icon drawing tool.
+ */
+export interface IconLineToolOverrides {
+ /** Default value: `1.5707963267948966` */
+ 'linetoolicon.angle': number;
+ /** Default value: `#2962FF` */
+ 'linetoolicon.color': string;
+ /** Default value: `61720` */
+ 'linetoolicon.icon': number;
+ /** Default value: `40` */
+ 'linetoolicon.size': number;
+}
+export interface IconOptions {
+ /** Icon number */
+ icon: number;
+}
+/**
+ * Override properties for the Image drawing tool.
+ */
+export interface ImageLineToolOverrides {
+ /** Default value: `0` */
+ 'linetoolimage.angle': number;
+ /** Default value: `0` */
+ 'linetoolimage.cssHeight': number;
+ /** Default value: `0` */
+ 'linetoolimage.cssWidth': number;
+ /** Default value: `0` */
+ 'linetoolimage.transparency': number;
+}
+/**
+ * Override properties for the Infoline drawing tool.
+ */
+export interface InfolineLineToolOverrides {
+ /** Default value: `true` */
+ 'linetoolinfoline.alwaysShowStats': boolean;
+ /** Default value: `false` */
+ 'linetoolinfoline.bold': boolean;
+ /** Default value: `false` */
+ 'linetoolinfoline.extendLeft': boolean;
+ /** Default value: `false` */
+ 'linetoolinfoline.extendRight': boolean;
+ /** Default value: `14` */
+ 'linetoolinfoline.fontsize': number;
+ /** Default value: `center` */
+ 'linetoolinfoline.horzLabelsAlign': string;
+ /** Default value: `false` */
+ 'linetoolinfoline.italic': boolean;
+ /** Default value: `0` */
+ 'linetoolinfoline.leftEnd': number;
+ /** Default value: `#2962FF` */
+ 'linetoolinfoline.linecolor': string;
+ /** Default value: `0` */
+ 'linetoolinfoline.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolinfoline.linewidth': number;
+ /** Default value: `0` */
+ 'linetoolinfoline.rightEnd': number;
+ /** Default value: `true` */
+ 'linetoolinfoline.showAngle': boolean;
+ /** Default value: `true` */
+ 'linetoolinfoline.showBarsRange': boolean;
+ /** Default value: `true` */
+ 'linetoolinfoline.showDateTimeRange': boolean;
+ /** Default value: `true` */
+ 'linetoolinfoline.showDistance': boolean;
+ /** Default value: `false` */
+ 'linetoolinfoline.showLabel': boolean;
+ /** Default value: `false` */
+ 'linetoolinfoline.showMiddlePoint': boolean;
+ /** Default value: `true` */
+ 'linetoolinfoline.showPercentPriceRange': boolean;
+ /** Default value: `true` */
+ 'linetoolinfoline.showPipsPriceRange': boolean;
+ /** Default value: `false` */
+ 'linetoolinfoline.showPriceLabels': boolean;
+ /** Default value: `true` */
+ 'linetoolinfoline.showPriceRange': boolean;
+ /** Default value: `1` */
+ 'linetoolinfoline.statsPosition': number;
+ /** Default value: `#2962FF` */
+ 'linetoolinfoline.textcolor': string;
+ /** Default value: `bottom` */
+ 'linetoolinfoline.vertLabelsAlign': string;
+}
+export interface InitialSettingsMap {
+ /** Initial Setting */
+ [key: string]: string;
+}
+/**
+ * Override properties for the Insidepitchfork drawing tool.
+ */
+export interface InsidepitchforkLineToolOverrides {
+ /** Default value: `false` */
+ 'linetoolinsidepitchfork.extendLines': boolean;
+ /** Default value: `true` */
+ 'linetoolinsidepitchfork.fillBackground': boolean;
+ /** Default value: `0.25` */
+ 'linetoolinsidepitchfork.level0.coeff': number;
+ /** Default value: `#ffb74d` */
+ 'linetoolinsidepitchfork.level0.color': string;
+ /** Default value: `0` */
+ 'linetoolinsidepitchfork.level0.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolinsidepitchfork.level0.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolinsidepitchfork.level0.visible': boolean;
+ /** Default value: `0.382` */
+ 'linetoolinsidepitchfork.level1.coeff': number;
+ /** Default value: `#81c784` */
+ 'linetoolinsidepitchfork.level1.color': string;
+ /** Default value: `0` */
+ 'linetoolinsidepitchfork.level1.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolinsidepitchfork.level1.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolinsidepitchfork.level1.visible': boolean;
+ /** Default value: `0.5` */
+ 'linetoolinsidepitchfork.level2.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolinsidepitchfork.level2.color': string;
+ /** Default value: `0` */
+ 'linetoolinsidepitchfork.level2.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolinsidepitchfork.level2.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolinsidepitchfork.level2.visible': boolean;
+ /** Default value: `0.618` */
+ 'linetoolinsidepitchfork.level3.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolinsidepitchfork.level3.color': string;
+ /** Default value: `0` */
+ 'linetoolinsidepitchfork.level3.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolinsidepitchfork.level3.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolinsidepitchfork.level3.visible': boolean;
+ /** Default value: `0.75` */
+ 'linetoolinsidepitchfork.level4.coeff': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolinsidepitchfork.level4.color': string;
+ /** Default value: `0` */
+ 'linetoolinsidepitchfork.level4.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolinsidepitchfork.level4.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolinsidepitchfork.level4.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolinsidepitchfork.level5.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolinsidepitchfork.level5.color': string;
+ /** Default value: `0` */
+ 'linetoolinsidepitchfork.level5.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolinsidepitchfork.level5.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolinsidepitchfork.level5.visible': boolean;
+ /** Default value: `1.5` */
+ 'linetoolinsidepitchfork.level6.coeff': number;
+ /** Default value: `#9c27b0` */
+ 'linetoolinsidepitchfork.level6.color': string;
+ /** Default value: `0` */
+ 'linetoolinsidepitchfork.level6.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolinsidepitchfork.level6.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolinsidepitchfork.level6.visible': boolean;
+ /** Default value: `1.75` */
+ 'linetoolinsidepitchfork.level7.coeff': number;
+ /** Default value: `#e91e63` */
+ 'linetoolinsidepitchfork.level7.color': string;
+ /** Default value: `0` */
+ 'linetoolinsidepitchfork.level7.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolinsidepitchfork.level7.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolinsidepitchfork.level7.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolinsidepitchfork.level8.coeff': number;
+ /** Default value: `#F77C80` */
+ 'linetoolinsidepitchfork.level8.color': string;
+ /** Default value: `0` */
+ 'linetoolinsidepitchfork.level8.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolinsidepitchfork.level8.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolinsidepitchfork.level8.visible': boolean;
+ /** Default value: `#F23645` */
+ 'linetoolinsidepitchfork.median.color': string;
+ /** Default value: `0` */
+ 'linetoolinsidepitchfork.median.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolinsidepitchfork.median.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolinsidepitchfork.median.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolinsidepitchfork.style': number;
+ /** Default value: `80` */
+ 'linetoolinsidepitchfork.transparency': number;
+}
+export interface InstrumentInfo {
+ /** Quantity field step and boundaries */
+ qty: QuantityMetainfo;
+ /** Value of 1 pip for the instrument in the account currency */
+ pipValue: number;
+ /** Size of 1 pip (e.g., 0.0001 for EURUSD) */
+ pipSize: number;
+ /** Minimal price change (e.g., 0.00001 for EURUSD). Used for price fields. */
+ minTick: number;
+ /** Lot size */
+ lotSize?: number;
+ /** Instrument type. `forex` enables negative pips. You can check that in Order Ticket. */
+ type?: SymbolType;
+ /** Units of quantity or amount. Displayed instead of the Units label in the Quantity/Amount field. */
+ units?: string;
+ /** Display name for the symbol */
+ brokerSymbol?: string;
+ /** A description to be displayed in the UI dialogs. */
+ description: string;
+ /** Number of decimal places of DOM asks/bids volume (optional, 0 by default). */
+ domVolumePrecision?: number;
+ /** Leverage */
+ leverage?: string;
+ /** Minimal price change for limit price field of the Limit and Stop Limit order. If set it will override the `minTick` value. */
+ limitPriceStep?: number;
+ /** Minimal price change for stop price field of the Stop and Stop Limit order. If set it will override the `minTick` value. */
+ stopPriceStep?: number;
+ /** Array of strings with valid duration values. You can check that in Order Ticket. */
+ allowedDurations?: string[];
+ /**
+ * Dynamic minimum price movement.
+ * It is used if the instrument's minimum price movement changes depending on the price range.
+ *
+ * For example: `0.01 10 0.02 25 0.05`, where `minTick` is `0.01` for a price less than `10`, `minTick` is `0.02` for a price less than `25`, `minTick` is `0.05` for a price more and equal than `25`.
+ */
+ variableMinTick?: string;
+ /** Instrument currency that is displayed in Order Ticket */
+ currency?: string;
+ /** The first currency quoted in a currency pair. Used for crypto currencies only. */
+ baseCurrency?: string;
+ /** The second currency quoted in a currency pair. Used for crypto currencies only. */
+ quoteCurrency?: string;
+ /** The value represented by a full point of price movement in the contract currency. This value is used to calculate the Total Value (symbol currency) of the order. */
+ bigPointValue?: number;
+ /** The value represents how much price is multiplied in relation to base monetary unit. */
+ priceMagnifier?: number;
+}
+/** Show a custom message with the reason why the symbol cannot be traded */
+export interface IsTradableResult {
+ /**
+ * Is the symbol tradable
+ */
+ tradable: boolean;
+ /**
+ * Reason is displayed in Order Ticket
+ */
+ reason?: string;
+ /** Solution available to user to resolve the issue */
+ solutions?: TradableSolutions;
+ /** shortReason is displayed in the legend */
+ shortReason?: string;
+}
+export interface KagiStylePreferences {
+ /** Up line color */
+ upColor: string;
+ /** Up down color */
+ downColor: string;
+ /** Up projection line color */
+ upColorProjection: string;
+ /** Down projection line color */
+ downColorProjection: string;
+}
+/**
+ * An API object representing leverage info for an order.
+ */
+export interface LeverageInfo {
+ /**
+ * The title for any Leverage Dialogs shown by the library.
+ */
+ title: string;
+ /**
+ * The leverage.
+ */
+ leverage: number;
+ /**
+ * The minimum leverage value.
+ */
+ min: number;
+ /**
+ * The maximum leverage value.
+ */
+ max: number;
+ /**
+ * The mimimum change between leverage values.
+ */
+ step: number;
+}
+/**
+ * An API object representing an order. Used when requesting leverage information from a broker.
+ */
+export interface LeverageInfoParams {
+ /**
+ * The order symbol.
+ */
+ symbol: string;
+ /**
+ * The type of the order.
+ */
+ orderType: OrderType;
+ /**
+ * The order side. Buy or sell.
+ */
+ side: Side;
+ /**
+ * Custom data for the broker.
+ */
+ customFields?: CustomInputFieldsValues;
+}
+/**
+ * An API object representing some messages describing the leverage value set by the user.
+ *
+ * Shown in any Leverage Dialogs.
+ */
+export interface LeveragePreviewResult {
+ /**
+ * Informative messages about the leverage value.
+ */
+ infos?: string[];
+ /**
+ * Warnings about the leverage value.
+ */
+ warnings?: string[];
+ /**
+ * Errors about the leverage value.
+ */
+ errors?: string[];
+}
+/**
+ * An API object representing an order and leverage. Used when requesting that a broker updates a order's leverage.
+ */
+export interface LeverageSetParams extends LeverageInfoParams {
+ /**
+ * The requested leverage value.
+ */
+ leverage: number;
+}
+/**
+ * An API object representing a response containing the leverage value for a user.
+ */
+export interface LeverageSetResult {
+ /**
+ * The leverage.
+ */
+ leverage: number;
+}
+export interface LibraryPineStudy {
+ /**
+ * Called only once during the lifetime of the study and designed to get additional info for the study.
+ *
+ * Example:
+ * ```
+ * this.init = function(context, inputCallback) {
+ * var symbol = '#EQUITY';
+ * var period = PineJS.Std.period(this._context);
+ * context.new_sym(symbol, period);
+ * };
+ * ```
+ * @param ctx - An object containing symbol info along with some useful methods to load/store symbol
+ * @param {(index:number} inputs - The inputs callback is an array of input values, placed in order of inputs in Metainfo.
+ */
+ init?(
+ ctx: IContext,
+ inputs: (index: number) => T
+ ): void;
+ /**
+ * Called every time the library wants to calculate the study. Also it's called for every bar of every symbol.
+ * Thus, if you request several additional symbols inside your indicator it will increase the count of runs.
+ * @param ctx - An object containing symbol info along with some useful methods to load/store symbol
+ * @param {(index:number} inputs - The inputs callback is an array of input values, placed in order of inputs in Metainfo.
+ */
+ main(
+ ctx: IContext,
+ inputs: (index: number) => T
+ ): TPineStudyResult | null;
+ // Indicator defined properties
+ // tslint:disable-next-line:no-any
+ [key: string]: any;
+}
+export interface LibraryPineStudyConstructor {
+ /**
+ * Custom Study constructor
+ */
+
+ new (): LibraryPineStudy;
+}
+export interface LibrarySubsessionInfo {
+ /**
+ * Description of the subsession.
+ *
+ * @example "Regular Trading Hours"
+ */
+ description: string;
+ /**
+ * Subsession ID.
+ */
+ id: LibrarySessionId;
+ /**
+ * Session string. See {@link LibrarySymbolInfo.session}.
+ */
+ session: string;
+ /**
+ * Session corrections string. See {@link LibrarySymbolInfo.corrections}.
+ */
+ 'session-correction'?: string;
+ /**
+ * Session to display. See {@link LibrarySymbolInfo.session_display}.
+ */
+ 'session-display'?: string;
+}
+export interface LibrarySymbolInfo {
+ /**
+ * Symbol Name
+ * It's the name of the symbol. It is a string that your users will be able to see.
+ * Also, it will be used for data requests if you are not using tickers.
+ */
+ name: string;
+ /**
+ * The full name of the symbol (contains name and exchange)
+ * Example: `BTCE:BTCUSD`
+ */
+ full_name: string;
+ /**
+ * Array of base symbols
+ * Example: for `AAPL*MSFT` it is `['NASDAQ:AAPL', 'NASDAQ:MSFT']`
+ */
+ base_name?: [string];
+ /**
+ * Unique symbol id
+ * It's an unique identifier for this particular symbol in your symbology.
+ * If you specify this property then its value will be used for all data requests for this symbol. ticker will be treated the same as {@link LibrarySymbolInfo.name} if not specified explicitly.
+ */
+ ticker?: string;
+ /**
+ * The description of the symbol.
+ * Will be displayed in the chart legend for this symbol.
+ */
+ description: string;
+ /**
+ * Symbol Long description
+ *
+ * Optional long(er) description for the symbol.
+ */
+ long_description?: string;
+ /**
+ * Type of the instrument.
+ * Possible values: {@link SymbolType}
+ */
+ type: string;
+ /**
+ * Trading hours for this symbol. See the [Trading Sessions article](https://www.tradingview.com/charting-library-docs/latest/connecting_data/Trading-Sessions) to learn more details.
+ * @example "1700-0200"
+ */
+ session: string;
+ /**
+ * The session value to display in the UI. If not specified, then `session` is used.
+ */
+ session_display?: string;
+ /**
+ * List of holidays for this symbol. These dates are not displayed on the chart.
+ * It's a string in the following format: `YYYYMMDD[,YYYYMMDD]`.
+ * @example "20181105,20181107,20181112"
+ */
+ session_holidays?: string;
+ /**
+ * List of corrections for this symbol. Corrections are days with specific trading sessions. They can be applied to holidays as well.
+ *
+ * It's a string in the following format: `SESSION:YYYYMMDD[,YYYYMMDD][;SESSION:YYYYMMDD[,YYYYMMDD]]`
+ * Where SESSION has the same format as [Trading Sessions](https://www.tradingview.com/charting-library-docs/latest/connecting_data/Trading-Sessions).
+ *
+ * @example "1900F4-2350F4,1000-1845:20181113;1000-1400:20181114"
+ */
+ corrections?: string;
+ /**
+ * Traded exchange (current (proxy) exchange).
+ * The name will be displayed in the chart legend for this symbol.
+ *
+ * @example "NYSE"
+ */
+ exchange: string;
+ /**
+ * short name of the exchange where this symbol is traded (real listed exchange).
+ * The name will be displayed in the chart legend for this symbol.
+ *
+ * @example "NYSE"
+ */
+ listed_exchange: string;
+ /**
+ * Timezone of the exchange for this symbol. We expect to get the name of the time zone in `olsondb` format.
+ * See [Timezones](https://www.tradingview.com/charting-library-docs/latest/connecting_data/Symbology#timezone) for a full list of supported timezones
+ */
+ timezone: Timezone;
+ /**
+ * Format of displaying labels on the price scale:
+ *
+ * `price` - formats decimal or fractional numbers based on `minmov`, `pricescale`, `minmove2`, `fractional` and `variableMinTick` values. See [Price Formatting](https://www.tradingview.com/charting-library-docs/latest/connecting_data/Symbology#price-format) for more details
+ * `volume` - formats decimal numbers in thousands, millions, billions or trillions
+ */
+ format: SeriesFormat;
+ /**
+ * Code (Tick)
+ * @example 8/16/.../256 (1/8/100 1/16/100 ... 1/256/100) or 1/10/.../10000000 (1 0.1 ... 0.0000001)
+ */
+ pricescale: number;
+ /**
+ * The number of units that make up one tick.
+ * @example For example, U.S. equities are quotes in decimals, and tick in decimals, and can go up +/- .01. So the tick increment is 1. But the e-mini S&P futures contract, though quoted in decimals, goes up in .25 increments, so the tick increment is 25. (see also Tick Size)
+ */
+ minmov: number;
+ /**
+ * For common prices this can be skipped.
+ *
+ * Fractional prices are displayed 2 different forms: 1) `xx'yy` (for example, `133'21`) 2) `xx'yy'zz` (for example, `133'21'5`).
+ *
+ * - `xx` is an integer part.
+ * - `minmov/pricescale` is a Fraction.
+ * - `minmove2` is used in form 2.
+ * - `fractional` is `true`.
+ * - `variableMinTick` is skipped.
+ *
+ * Example:
+ *
+ * If `minmov = 1`, `pricescale = 128` and `minmove2 = 4`:
+ *
+ * - `119'16'0` represents `119 + 16/32`
+ * - `119'16'2` represents `119 + 16.25/32`
+ * - `119'16'5` represents `119 + 16.5/32`
+ * - `119'16'7` represents `119 + 16.75/32`
+ *
+ * More examples:
+ *
+ * - `ZBM2014 (T-Bond)` with `1/32`: `minmov = 1`, `pricescale = 32`, `minmove2 = 0`
+ * - `ZCM2014 (Corn)` with `2/8`: `minmov = 2`, `pricescale = 8`, `minmove2 = 0`
+ * - `ZFM2014 (5 year t-note)` with `1/4 of 1/32`: `minmov = 1`, `pricescale = 128`, `minmove2 = 4`
+ */
+ fractional?: boolean;
+ /**
+ * For common prices this can be skipped.
+ * @example Quarters of 1/32: pricescale=128, minmovement=1, minmovement2=4
+ */
+ minmove2?: number;
+ /**
+ * Dynamic minimum price movement. It is used if the instrument's minimum price movement changes depending on the price range.
+ *
+ * For example, '0.01 10 0.02 25 0.05', where the tick size is 0.01 for a price less than 10, the tick size is 0.02 for a price less than 25, the tick size is 0.05 for a price greater than or equal to 25.
+ */
+ variable_tick_size?: string;
+ /**
+ * Boolean value showing whether the symbol includes intraday (minutes) historical data.
+ *
+ * If it's `false` then all buttons for intraday resolutions will be disabled for this particular symbol.
+ * If it is set to `true`, all intradays resolutions that are supplied directly by the datafeed must be provided in `intraday_multipliers` array.
+ *
+ * **WARNING** Any daily, weekly or monthly resolutions cannot be inferred from intraday resolutions!
+ *
+ * `false` if DWM only
+ * @default false
+ */
+ has_intraday?: boolean;
+ /**
+ * An array of resolutions which should be enabled in resolutions picker for this symbol.
+ *
+ * Each item of an array is expected to be a string. Format is described in another article.
+ *
+ * If one changes the symbol and new symbol does not support the selected resolution then resolution will be switched to the first available one in the list.
+ *
+ * **Resolution availability logic (pseudocode):**
+ * ```
+ * resolutionAvailable =
+ * resolution.isIntraday
+ * ? symbol.has_intraday && symbol.supported_resolutions(resolution)
+ * : symbol.supported_resolutions(resolution);
+ * ```
+ *
+ * In case of the absence of `supported_resolutions` in a symbol info, all DWM resolutions will be available. Intraday resolutions will be available if `has_intraday` is `true`.
+ * Supported resolutions affect available timeframes too. The timeframe will not be available if it requires the resolution that is not supported.
+ */
+ supported_resolutions?: ResolutionString[];
+ /**
+ * Array of resolutions (in minutes) supported directly by the data feed. Each such resolution may be passed to, and should be implemented by, `getBars`. The default of [] means that the data feed supports aggregating by any number of minutes.
+ *
+ * If the data feed only supports certain minute resolutions but not the requested resolution, `getBars` will be called (repeatedly if needed) with a higher resolution as a parameter, in order to build the requested resolution.
+ *
+ * For example, if the data feed only supports minute resolution, set `intraday_multipliers` to `['1']`.
+ *
+ * When the user wants to see 5-minute data, `getBars` will be called with the resolution set to 1 until the library builds all the 5-minute resolution by itself.
+ * @example (for ex.: "1,5,60") - only these resolutions will be requested, all others will be built using them if possible
+ * @default []
+ */
+ intraday_multipliers?: string[];
+ /**
+ * Boolean value showing whether the symbol includes seconds in the historical data.
+ *
+ * If it's `false` then all buttons for resolutions that include seconds will be disabled for this particular symbol.
+ *
+ * If it is set to `true`, all resolutions that are supplied directly by the data feed must be provided in `seconds_multipliers` array.
+ * @default false
+ */
+ has_seconds?: boolean;
+ /**
+ * Boolean value showing whether the symbol includes ticks in the historical data.
+ *
+ * If it's `false` then all buttons for resolutions that include ticks will be disabled for this particular symbol.
+ * @default false
+ */
+ has_ticks?: boolean;
+ /**
+ * It is an array containing resolutions that include seconds (excluding postfix) that the data feed provides.
+ * E.g., if the data feed supports resolutions such as `["1S", "5S", "15S"]`, but has 1-second bars for some symbols then you should set `seconds_multipliers` of this symbol to `[1]`.
+ * This will make the library build 5S and 15S resolutions by itself.
+ */
+ seconds_multipliers?: string[];
+ /**
+ * The boolean value specifying whether the datafeed can supply historical data at the daily resolution.
+ *
+ * If `has_daily` is set to `false`, all buttons for resolutions that include days are disabled for this particular symbol.
+ * Otherwise, the library requests daily bars from the datafeed.
+ * All daily resolutions that the datafeed supplies must be included in the {@link LibrarySymbolInfo.daily_multipliers} array.
+ *
+ * @default true
+ */
+ has_daily?: boolean;
+ /**
+ * Array (of strings) containing the [resolutions](https://www.tradingview.com/charting-library-docs/latest/core_concepts/Resolution#days) (in days - without the suffix) supported by the data feed. {@link ResolutionString}
+ *
+ * For example it could be something like
+ *
+ * ```javascript
+ * daily_multipliers = ['1', '3', '4', '6', '7'];
+ * ```
+ * @default ['1']
+ */
+ daily_multipliers?: string[];
+ /**
+ * The boolean value showing whether data feed has its own weekly and monthly resolution bars or not.
+ *
+ * If `has_weekly_and_monthly` = `false` then the library will build the respective resolutions using daily bars by itself.
+ * If not, then it will request those bars from the data feed using either the `weekly_multipliers` or `monthly_multipliers` if specified.
+ * If resolution is not within either list an error will be raised.
+ * @default false
+ */
+ has_weekly_and_monthly?: boolean;
+ /**
+ * Array (of strings) containing the [resolutions](https://www.tradingview.com/charting-library-docs/latest/core_concepts/Resolution#weeks) (in weeks - without the suffix) supported by the data feed. {@link ResolutionString}
+ *
+ * For example it could be something like
+ *
+ * ```javascript
+ * weekly_multipliers = ['1', '5', '10'];
+ * ```
+ * @default ['1']
+ */
+ weekly_multipliers?: string[];
+ /**
+ * Array (of strings) containing the [resolutions](https://www.tradingview.com/charting-library-docs/latest/core_concepts/Resolution#months) (in months - without the suffix) supported by the data feed. {@link ResolutionString}
+ *
+ * For example it could be something like
+ *
+ * ```javascript
+ * monthly_multipliers = ['1', '3', '4', '12'];
+ * ```
+ * @default ['1']
+ */
+ monthly_multipliers?: string[];
+ /**
+ * The boolean value showing whether the library should generate empty bars in the session when there is no data from the data feed for this particular time.
+ *
+ * I.e., if your session is `0900-1600` and your data has gaps between `11:00` and `12:00` and your `has_empty_bars` is `true`, then the Library will fill the gaps with bars for this time.
+ *
+ * Flag `has_empty_bars` = `true` cannot be used if featureset `disable_resolution_rebuild` is enabled.
+ * @default false
+ */
+ has_empty_bars?: boolean;
+ /**
+ * Represents what values are supported by the symbol. Possible values:
+ *
+ * - `ohlcv` - the symbol supports open, high, low, close and has volume
+ * - `ohlc` - the symbol supports open, high, low, close, but doesn't have volume
+ * - `c` - the symbol supports only close, it's displayed on the chart using line-based styles only
+ * @default 'ohlcv'
+ */
+ visible_plots_set?: VisiblePlotsSet;
+ /**
+ * Integer showing typical volume value decimal places for a particular symbol.
+ * 0 means volume is always an integer.
+ * 1 means that there might be 1 numeric character after the comma.
+ * @default '0'
+ */
+ volume_precision?: number;
+ /**
+ * The status code of a series with this symbol.
+ * This could be represented as an icon in the legend, next to the market status icon for `delayed_streaming` & `endofday` type of data.
+ * When declaring `delayed_streaming` you also have to specify its {@link LibrarySymbolInfo.delay} in seconds.
+ */
+ data_status?: 'streaming' | 'endofday' | 'pulsed' | 'delayed_streaming';
+ /**
+ * Type of delay that is associated to the data or real delay for real time data.
+ * - `0` for realtime
+ * - `-1` for endofday
+ * - `-2` for pulsed
+ * - or delay in seconds (for delayed realtime)
+ */
+ delay?: number;
+ /**
+ * Boolean showing whether this symbol is expired futures contract or not.
+ * @default false
+ */
+ expired?: boolean;
+ /**
+ * Unix timestamp of the expiration date. One must set this value when `expired` = `true`.
+ * The library will request data for this symbol starting from that time point.
+ */
+ expiration_date?: number;
+ /** Sector for stocks to be displayed in the Symbol Info. */
+ sector?: string;
+ /** Industry for stocks to be displayed in the Symbol Info. */
+ industry?: string;
+ /**
+ * The currency in which the instrument is traded or some other currency if currency conversion is enabled.
+ * It is displayed in the Symbol Info dialog and on the price axes.
+ */
+ currency_code?: string;
+ /** The currency in which the instrument is traded. */
+ original_currency_code?: string;
+ /**
+ * A unique identifier of a unit in which the instrument is traded or some other identifier if unit conversion is enabled.
+ * It is displayed on the price axes.
+ */
+ unit_id?: string;
+ /**
+ * A unique identifier of a unit in which the instrument is traded.
+ */
+ original_unit_id?: string;
+ /**
+ * Allowed unit conversion group names.
+ */
+ unit_conversion_types?: string[];
+ /**
+ * Subsession ID. Must match the `id` property of one of the subsessions.
+ */
+ subsession_id?: string;
+ /**
+ * Subsessions definitions.
+ */
+ subsessions?: LibrarySubsessionInfo[];
+ /**
+ * Optional ID of a price source for this symbol. Should match one of the price sources from the {@link price_sources} array.
+ */
+ price_source_id?: string;
+ /**
+ * Supported price sources for the symbol. The source of the values that this symbol's bars represent.
+ *
+ * For example 'Spot Price', 'Ask', 'Bid', etc.
+ *
+ * Mostly useful when viewing non-OHLC series types. The price source will be shown in the series legend.
+ *
+ * @example [{ id: '1', name: 'Spot Price' }, { id: '321', name: 'Bid' }]
+ */
+ price_sources?: SymbolInfoPriceSource[];
+ /**
+ * URL of image/s to be displayed as the logo/s for the symbol. The `show_symbol_logos` featureset needs to be enabled for this to be visible in the UI.
+ *
+ * - If a single url is returned then that url will solely be used to display the symbol logo.
+ * - If two urls are provided then the images will be displayed as two partially overlapping
+ * circles with the first url appearing on top. This is typically used for FOREX where you would
+ * like to display two country flags are the symbol logo.
+ *
+ * The image/s should ideally be square in dimension. You can use any image type which
+ * the browser supports natively.
+ *
+ * Examples:
+ * - `https://yourserver.com/apple.svg`
+ * - `/images/myImage.png`
+ * - `data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3...`
+ * - `data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4...`
+ */
+ logo_urls?: [string] | [string, string];
+ /**
+ * URL of image to be displayed as the logo for the exchange. The `show_exchange_logos` featureset needs to be enabled for this to be visible in the UI.
+ *
+ * The image should ideally be square in dimension. You can use any image type which
+ * the browser supports natively. Simple SVG images are recommended.
+ *
+ * Examples:
+ * - `https://yourserver.com/exchangeLogo.svg`
+ * - `/images/myImage.png`
+ * - `data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3...`
+ * - `data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4...`
+ */
+ exchange_logo?: string;
+}
+export interface LineBreakStylePreferences {
+ /** Up bar color */
+ upColor: string;
+ /** Down bar color */
+ downColor: string;
+ /** Up bar border color */
+ borderUpColor: string;
+ /** Down bar border color */
+ borderDownColor: string;
+ /** Projection up bar color */
+ upColorProjection: string;
+ /** Projection down bar color */
+ downColorProjection: string;
+ /** Projection up bar border color */
+ borderUpColorProjection: string;
+ /** Projection down bar border color */
+ borderDownColorProjection: string;
+}
+export interface LineStylePreferences {
+ /** Line color */
+ color: string;
+ /** Line Style {@link LineStyle} */
+ linestyle: number;
+ /** Line width */
+ linewidth: number;
+}
+/**
+ * Color styling options for the loading screen (spinner)
+ */
+export interface LoadingScreenOptions {
+ /** Colour of the spinner on the loading screen */
+ foregroundColor?: string;
+ /** Background color for the loading screen */
+ backgroundColor?: string;
+}
+export interface MappedObject {
+ [key: string]: TValue | undefined;
+}
+export interface Mark {
+ /** ID of the mark */
+ id: string | number;
+ /**
+ * Time for the mark.
+ * Amount of **milliseconds** since Unix epoch start in **UTC** timezone.
+ */
+ time: number;
+ /** Color for the mark */
+ color: MarkConstColors | MarkCustomColor;
+ /** Text content for the mark */
+ text: string;
+ /** Label for the mark */
+ label: string;
+ /** Text color for the mark */
+ labelFontColor: string;
+ /** Minimum size for the mark */
+ minSize: number;
+ /** Border Width */
+ borderWidth?: number;
+ /** Border Width when hovering over bar mark */
+ hoveredBorderWidth?: number;
+ /**
+ * Optional URL for an image to be displayed within the timescale mark.
+ *
+ * The image should ideally be square in dimension. You can use any image type which
+ * the browser supports natively.
+ *
+ * Examples:
+ * - `https://yourserver.com/adobe.svg`
+ * - `/images/myImage.png`
+ * - `data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3...`
+ * - `data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4...`
+ */
+ imageUrl?: string;
+ /**
+ * Continue to show text label even when an image has
+ * been loaded for the timescale mark.
+ *
+ * Defaults to `false` if undefined.
+ */
+ showLabelWhenImageLoaded?: boolean;
+}
+export interface MarkCustomColor {
+ /** Border color */
+ border: string;
+ /** Background color */
+ background: string;
+}
+/** Separator for a dropdown or context menu */
+export interface MenuSeparator extends ActionDescription {
+ /** Is a menu separator */
+ separator: boolean;
+}
+export interface MouseEventParams {
+ /** X (horizontal) coordinate (in pixels) at which the mouse event occurred, relative to the left edge of the applications viewport. */
+ clientX: number;
+ /** Y (vertical) coordinate (in pixels) at which the mouse event occurred, relative to the left edge of the applications viewport. */
+ clientY: number;
+ /** X (horizontal) coordinate (in pixels) at which the mouse event occurred, relative to the left edge of the entire document. */
+ pageX: number;
+ /** Y (vertical) coordinate (in pixels) at which the mouse event occurred, relative to the left edge of the entire document. */
+ pageY: number;
+ /** X (horizontal) coordinate (in pixels) at which the mouse event occurred, in global screen coordinates. */
+ screenX: number;
+ /** Y (vertical) coordinate (in pixels) at which the mouse event occurred, in global screen coordinates. */
+ screenY: number;
+}
+export interface NegativeBaseInputFieldValidatorResult
+ extends BaseInputFieldValidatorResult {
+ /** @inheritDoc */
+ valid: false;
+ /** Reason why base input value is invalid */
+ errorMessage: string;
+}
+export interface NewsItem {
+ /** News item title */
+ title: string;
+ /** Source of the news item */
+ source: string;
+ /** Published date */
+ published: number;
+ /** Link to the news item */
+ link?: string;
+ /** Short description */
+ shortDescription?: string;
+ /** Full description */
+ fullDescription?: string;
+}
+/**
+ * Override properties for the Note drawing tool.
+ */
+export interface NoteLineToolOverrides {
+ /** Default value: `rgba(41, 98, 255, 0.7)` */
+ 'linetoolnote.backgroundColor': string;
+ /** Default value: `0` */
+ 'linetoolnote.backgroundTransparency': number;
+ /** Default value: `false` */
+ 'linetoolnote.bold': boolean;
+ /** Default value: `#2962FF` */
+ 'linetoolnote.borderColor': string;
+ /** Default value: `true` */
+ 'linetoolnote.fixedSize': boolean;
+ /** Default value: `14` */
+ 'linetoolnote.fontSize': number;
+ /** Default value: `false` */
+ 'linetoolnote.italic': boolean;
+ /** Default value: `#2962FF` */
+ 'linetoolnote.markerColor': string;
+ /** Default value: `#ffffff` */
+ 'linetoolnote.textColor': string;
+}
+/**
+ * Override properties for the Noteabsolute drawing tool.
+ */
+export interface NoteabsoluteLineToolOverrides {
+ /** Default value: `rgba(41, 98, 255, 0.7)` */
+ 'linetoolnoteabsolute.backgroundColor': string;
+ /** Default value: `0` */
+ 'linetoolnoteabsolute.backgroundTransparency': number;
+ /** Default value: `false` */
+ 'linetoolnoteabsolute.bold': boolean;
+ /** Default value: `#2962FF` */
+ 'linetoolnoteabsolute.borderColor': string;
+ /** Default value: `true` */
+ 'linetoolnoteabsolute.fixedSize': boolean;
+ /** Default value: `14` */
+ 'linetoolnoteabsolute.fontSize': number;
+ /** Default value: `false` */
+ 'linetoolnoteabsolute.italic': boolean;
+ /** Default value: `#2962FF` */
+ 'linetoolnoteabsolute.markerColor': string;
+ /** Default value: `#ffffff` */
+ 'linetoolnoteabsolute.textColor': string;
+}
+/**
+ * Formatting options for numbers
+ */
+export interface NumericFormattingParams {
+ /**
+ * String that would represent the decimal part of a number
+ * @example 123.4 or 123,4 or 123'4
+ */
+ decimal_sign: string;
+}
+/**
+ * Interface for an URL which will be opened
+ */
+export interface OpenUrlSolution {
+ /**
+ * Link to be opened
+ */
+ openUrl: {
+ /** URL to be opened */
+ url: string;
+ /** text for solution button */
+ text: string;
+ };
+}
+export interface OrderDialogOptions extends TradingDialogOptions {
+ /**
+ * Using this flag you can change `Trade Value` to `Total` in the Order Info section of the Order dialog.
+ */
+ showTotal?: boolean;
+}
+export interface OrderDuration {
+ /**
+ * type is OrderDurationMetaInfo.value
+ */
+ type: string;
+ /** Order duration time */
+ datetime?: number;
+}
+/**
+ * Expiration options for orders
+ */
+export interface OrderDurationMetaInfo {
+ /** If it is set to `true`, then the Display date control in Order Ticket for this duration type will be displayed. */
+ hasDatePicker?: boolean;
+ /** If it is set to `true`, then the Display time control in Order Ticket for this duration type will be displayed. */
+ hasTimePicker?: boolean;
+ /**
+ * Default duration.
+ * Only one duration object in the durations array can have a `true` value for this field.
+ * The default duration will be used when the user places orders in the silent mode and it will be the selected one when the user opens Order Ticket for the first time.
+ */
+ default?: boolean;
+ /** Localized title of the duration. The title will be displayed in the Duration control of Order Ticket. */
+ name: string;
+ /** Duration identifier */
+ value: string;
+ /** A list of order types for which this duration type will be displayed in the Duration control of Order Ticket. Default value is `[OrderType.Limit, OrderType.Stop, OrderType.StopLimit]`. */
+ supportedOrderTypes?: OrderType[];
+}
+/**
+ * Override properties for the Order drawing tool.
+ */
+export interface OrderLineToolOverrides {
+ /** Default value: `rgba(255, 255, 255, 0.25)` */
+ 'linetoolorder.bodyBackgroundColor': string;
+ /** Default value: `25` */
+ 'linetoolorder.bodyBackgroundTransparency': number;
+ /** Default value: `#4094e8` */
+ 'linetoolorder.bodyBorderActiveBuyColor': string;
+ /** Default value: `#e75656` */
+ 'linetoolorder.bodyBorderActiveSellColor': string;
+ /** Default value: `rgba(64, 148, 232, 0.5)` */
+ 'linetoolorder.bodyBorderInactiveBuyColor': string;
+ /** Default value: `rgba(231, 86, 86, 0.5)` */
+ 'linetoolorder.bodyBorderInactiveSellColor': string;
+ /** Default value: `true` */
+ 'linetoolorder.bodyFontBold': boolean;
+ /** Default value: `Verdana` */
+ 'linetoolorder.bodyFontFamily': string;
+ /** Default value: `false` */
+ 'linetoolorder.bodyFontItalic': boolean;
+ /** Default value: `9` */
+ 'linetoolorder.bodyFontSize': number;
+ /** Default value: `#4094e8` */
+ 'linetoolorder.bodyTextActiveBuyColor': string;
+ /** Default value: `#268c02` */
+ 'linetoolorder.bodyTextActiveLimitColor': string;
+ /** Default value: `#e75656` */
+ 'linetoolorder.bodyTextActiveSellColor': string;
+ /** Default value: `#e75656` */
+ 'linetoolorder.bodyTextActiveStopColor': string;
+ /** Default value: `rgba(64, 148, 232, 0.5)` */
+ 'linetoolorder.bodyTextInactiveBuyColor': string;
+ /** Default value: `rgba(38, 140, 2, 0.5)` */
+ 'linetoolorder.bodyTextInactiveLimitColor': string;
+ /** Default value: `rgba(231, 86, 86, 0.5)` */
+ 'linetoolorder.bodyTextInactiveSellColor': string;
+ /** Default value: `rgba(231, 86, 86, 0.5)` */
+ 'linetoolorder.bodyTextInactiveStopColor': string;
+ /** Default value: `rgba(255, 255, 255, 0.25)` */
+ 'linetoolorder.cancelButtonBackgroundColor': string;
+ /** Default value: `25` */
+ 'linetoolorder.cancelButtonBackgroundTransparency': number;
+ /** Default value: `#4094e8` */
+ 'linetoolorder.cancelButtonBorderActiveBuyColor': string;
+ /** Default value: `#e75656` */
+ 'linetoolorder.cancelButtonBorderActiveSellColor': string;
+ /** Default value: `rgba(64, 148, 232, 0.5)` */
+ 'linetoolorder.cancelButtonBorderInactiveBuyColor': string;
+ /** Default value: `rgba(231, 86, 86, 0.5)` */
+ 'linetoolorder.cancelButtonBorderInactiveSellColor': string;
+ /** Default value: `#4094e8` */
+ 'linetoolorder.cancelButtonIconActiveBuyColor': string;
+ /** Default value: `#e75656` */
+ 'linetoolorder.cancelButtonIconActiveSellColor': string;
+ /** Default value: `rgba(64, 148, 232, 0.5)` */
+ 'linetoolorder.cancelButtonIconInactiveBuyColor': string;
+ /** Default value: `rgba(231, 86, 86, 0.5)` */
+ 'linetoolorder.cancelButtonIconInactiveSellColor': string;
+ /** Default value: `` */
+ 'linetoolorder.cancelTooltip': string;
+ /** Default value: `inherit` */
+ 'linetoolorder.extendLeft': string;
+ /** Default value: `#4094e8` */
+ 'linetoolorder.lineActiveBuyColor': string;
+ /** Default value: `#e75656` */
+ 'linetoolorder.lineActiveSellColor': string;
+ /** Default value: `#FF0000` */
+ 'linetoolorder.lineColor': string;
+ /** Default value: `rgba(64, 148, 232, 0.5)` */
+ 'linetoolorder.lineInactiveBuyColor': string;
+ /** Default value: `rgba(231, 86, 86, 0.5)` */
+ 'linetoolorder.lineInactiveSellColor': string;
+ /** Default value: `inherit` */
+ 'linetoolorder.lineLength': string;
+ /** Default value: `percentage` */
+ 'linetoolorder.lineLengthUnit': string;
+ /** Default value: `inherit` */
+ 'linetoolorder.lineStyle': string;
+ /** Default value: `inherit` */
+ 'linetoolorder.lineWidth': string;
+ /** Default value: `` */
+ 'linetoolorder.modifyTooltip': string;
+ /** Default value: `#4094e8` */
+ 'linetoolorder.quantityBackgroundActiveBuyColor': string;
+ /** Default value: `#e75656` */
+ 'linetoolorder.quantityBackgroundActiveSellColor': string;
+ /** Default value: `rgba(64, 148, 232, 0.5)` */
+ 'linetoolorder.quantityBackgroundInactiveBuyColor': string;
+ /** Default value: `rgba(231, 86, 86, 0.5)` */
+ 'linetoolorder.quantityBackgroundInactiveSellColor': string;
+ /** Default value: `#4094e8` */
+ 'linetoolorder.quantityBorderActiveBuyColor': string;
+ /** Default value: `#e75656` */
+ 'linetoolorder.quantityBorderActiveSellColor': string;
+ /** Default value: `rgba(64, 148, 232, 0.5)` */
+ 'linetoolorder.quantityBorderInactiveBuyColor': string;
+ /** Default value: `rgba(231, 86, 86, 0.5)` */
+ 'linetoolorder.quantityBorderInactiveSellColor': string;
+ /** Default value: `true` */
+ 'linetoolorder.quantityFontBold': boolean;
+ /** Default value: `Verdana` */
+ 'linetoolorder.quantityFontFamily': string;
+ /** Default value: `false` */
+ 'linetoolorder.quantityFontItalic': boolean;
+ /** Default value: `9` */
+ 'linetoolorder.quantityFontSize': number;
+ /** Default value: `#ffffff` */
+ 'linetoolorder.quantityTextColor': string;
+ /** Default value: `0` */
+ 'linetoolorder.quantityTextTransparency': number;
+ /** Default value: `` */
+ 'linetoolorder.tooltip': string;
+}
+export interface OrderOrPositionMessage {
+ /** Type of message about the order or position */
+ type: OrderOrPositionMessageType;
+ /** Message content */
+ text: string;
+}
+/** Describes the result of the order preview. */
+export interface OrderPreviewResult {
+ /** Order preview section */
+ sections: OrderPreviewSection[];
+ /** Confirmation ID. A unique identifier that should be passed to `placeOrder` method */
+ confirmId?: string;
+ /** Warning messages */
+ warnings?: string[];
+ /** Error messages */
+ errors?: string[];
+}
+/**
+ * Describes a single order preview section.
+ * Order preview can have multiple sections that are divided by separators and may have titles.
+ */
+export interface OrderPreviewSection {
+ /** Order preview items. Each item is a row of the section table. */
+ rows: OrderPreviewSectionRow[];
+ /** Optional title of the section. */
+ header?: string;
+}
+/**
+ * Describes a single row of a section table of the order preview.
+ */
+export interface OrderPreviewSectionRow {
+ /** Description of the item. */
+ title: string;
+ /** Formatted value of the item. */
+ value: string;
+}
+export interface OrderRule {
+ /** Order ID */
+ id: string;
+ /** Severity of Order Rule */
+ severity: 'warning' | 'error';
+}
+/**
+ * Input value of the order ticket
+ * This info is not sufficient to place an order
+ */
+export interface OrderTemplate {
+ /** Symbol identifier */
+ symbol: string;
+ /** Order Type */
+ type?: OrderType;
+ /** order / execution side */
+ side?: Side;
+ /** Order quantity */
+ qty?: number;
+ /** Type of Stop Order */
+ stopType?: StopType;
+ /** Order stop price */
+ stopPrice?: number;
+ /** Order limit price */
+ limitPrice?: number;
+ /** Order Take Profit (Brackets) */
+ takeProfit?: number;
+ /** Order Stop loss (Brackets) */
+ stopLoss?: number;
+ /** Order Trailing stop (Brackets) */
+ trailingStopPips?: number;
+ /** Duration or expiration of an order */
+ duration?: OrderDuration;
+ /** Custom input fields */
+ customFields?: CustomInputFieldsValues;
+}
+export interface Overrides {
+ [key: string]: string | number | boolean;
+}
+/**
+ * Override properties for the Parallelchannel drawing tool.
+ */
+export interface ParallelchannelLineToolOverrides {
+ /** Default value: `rgba(41, 98, 255, 0.2)` */
+ 'linetoolparallelchannel.backgroundColor': string;
+ /** Default value: `false` */
+ 'linetoolparallelchannel.extendLeft': boolean;
+ /** Default value: `false` */
+ 'linetoolparallelchannel.extendRight': boolean;
+ /** Default value: `true` */
+ 'linetoolparallelchannel.fillBackground': boolean;
+ /** Default value: `false` */
+ 'linetoolparallelchannel.labelBold': boolean;
+ /** Default value: `14` */
+ 'linetoolparallelchannel.labelFontSize': number;
+ /** Default value: `left` */
+ 'linetoolparallelchannel.labelHorzAlign': string;
+ /** Default value: `false` */
+ 'linetoolparallelchannel.labelItalic': boolean;
+ /** Default value: `#2962FF` */
+ 'linetoolparallelchannel.labelTextColor': string;
+ /** Default value: `bottom` */
+ 'linetoolparallelchannel.labelVertAlign': string;
+ /** Default value: `false` */
+ 'linetoolparallelchannel.labelVisible': boolean;
+ /** Default value: `#2962FF` */
+ 'linetoolparallelchannel.linecolor': string;
+ /** Default value: `0` */
+ 'linetoolparallelchannel.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolparallelchannel.linewidth': number;
+ /** Default value: `#2962FF` */
+ 'linetoolparallelchannel.midlinecolor': string;
+ /** Default value: `2` */
+ 'linetoolparallelchannel.midlinestyle': number;
+ /** Default value: `1` */
+ 'linetoolparallelchannel.midlinewidth': number;
+ /** Default value: `true` */
+ 'linetoolparallelchannel.showMidline': boolean;
+ /** Default value: `20` */
+ 'linetoolparallelchannel.transparency': number;
+}
+/**
+ * Override properties for the Path drawing tool.
+ */
+export interface PathLineToolOverrides {
+ /** Default value: `0` */
+ 'linetoolpath.leftEnd': number;
+ /** Default value: `#2962FF` */
+ 'linetoolpath.lineColor': string;
+ /** Default value: `0` */
+ 'linetoolpath.lineStyle': number;
+ /** Default value: `2` */
+ 'linetoolpath.lineWidth': number;
+ /** Default value: `1` */
+ 'linetoolpath.rightEnd': number;
+}
+/**
+ * Parameters passed to getBars
+ */
+export interface PeriodParams {
+ /**
+ * Unix timestamp (leftmost requested bar)
+ */
+ from: number;
+ /**
+ * Unix timestamp (rightmost requested bar - not inclusive)
+ */
+ to: number;
+ /**
+ * The exact amount of bars to load, should be considered a higher priority than `from` if your datafeed supports it
+ */
+ countBack: number;
+ /**
+ * Used to identify if it's the first call of getBars
+ */
+ firstDataRequest: boolean;
+}
+export interface PineJS {
+ /** Standard library functions for PineJS */
+ Std: PineJSStd;
+}
+/**
+ * PineJS standard library functions.
+ */
+export interface PineJSStd {
+ /**
+ * Default maximum size of a pine series.
+ */
+ max_series_default_size: 10001;
+ /**
+ * Epsilon (machine precision)
+ *
+ * @returns Epsilon (machine precision). Upper bound on the relative approximation error due to rounding in floating point arithmetic.
+ */
+ eps(): number;
+ /**
+ * High Price
+ *
+ * @param context - PineJS execution context.
+ * @returns Current high price.
+ */
+ high(context: IContext): number;
+ /**
+ * Low Price
+ *
+ * @param context - PineJS execution context.
+ * @returns Current low price.
+ */
+ low(context: IContext): number;
+ /**
+ * Open Price
+ *
+ * @param context - PineJS execution context.
+ * @returns Current open price.
+ */
+ open(context: IContext): number;
+ /**
+ * Close Price
+ *
+ * @param context - PineJS execution context.
+ * @returns Current close price.
+ */
+ close(context: IContext): number;
+ /**
+ * Is a shortcut for (open + high + low + close)/4
+ *
+ * @param context - PineJS execution context.
+ * @returns Calculated average of the current OHLC values
+ */
+ ohlc4(context: IContext): number;
+ /**
+ * Current bar volume
+ *
+ * @param context - PineJS execution context.
+ * @returns Current bar volume
+ */
+ volume(context: IContext): number;
+ /**
+ * Current bar time
+ *
+ * @param context - PineJS execution context.
+ * @returns UNIX time of current bar
+ */
+ time(context: IContext): number;
+ /**
+ * Current bar time
+ *
+ * @param context - PineJS execution context.
+ * @param period - Period
+ * @param spec
+ * @returns UNIX time of current bar
+ */
+ time(context: IContext, period: string, spec: unknown): number;
+ /**
+ * Is a shortcut for (high + low)/2
+ *
+ * @param context - PineJS execution context.
+ * @returns Calculated average of the current HL values
+ */
+ hl2(context: IContext): number;
+ /**
+ * Is a shortcut for (high + low + close)/3
+ *
+ * @param context - PineJS execution context.
+ * @returns Calculated average of the current HLC values
+ */
+ hlc3(context: IContext): number;
+ /**
+ * Resolution string, e.g. 60 - 60 minutes, D - daily, W - weekly, M - monthly, 5D - 5 days, 12M - one year, 3M - one quarter
+ *
+ * @param context - PineJS execution context.
+ * @returns The resolution string for the current context
+ */
+ period(context: IContext): string;
+ /**
+ * Ticker ID
+ *
+ * @param context - PineJS execution context.
+ * @returns Ticker ID for the current symbol
+ */
+ tickerid(context: IContext): string;
+ /**
+ * Year of current bar time in exchange timezone.
+ *
+ * @param context - PineJS execution context.
+ * @param time optional time. Current bar time will be used by default.
+ * @returns Current bar year in exchange timezone.
+ */
+ year(context: IContext, time?: number): number;
+ /**
+ * Month of current bar time in exchange timezone.
+ *
+ * @param context - PineJS execution context.
+ * @param time optional time. Current bar time will be used by default.
+ * @returns Current bar month in exchange timezone.
+ */
+ month(context: IContext, time?: number): number;
+ /**
+ * Week number of current bar time in exchange timezone.
+ *
+ * @param context - PineJS execution context.
+ * @param time optional time. Current bar time will be used by default.
+ * @returns Week number of current bar in exchange timezone.
+ */
+ weekofyear(context: IContext, time?: number): number;
+ /**
+ * Day of month for current bar time in exchange timezone.
+ *
+ * @param context - PineJS execution context.
+ * @param time optional time. Current bar time will be used by default.
+ * @returns Day of month for current bar time in exchange timezone.
+ */
+ dayofmonth(context: IContext, time?: number): number;
+ /**
+ * Day of week for current bar time in exchange timezone.
+ *
+ * @param context - PineJS execution context.
+ * @param time optional time. Current bar time will be used by default.
+ * @returns Day of week for current bar time in exchange timezone.
+ */
+ dayofweek(context: IContext, time?: number): number;
+ /**
+ * Hour of current bar time in exchange timezone.
+ *
+ * @param context - PineJS execution context.
+ * @param time optional time. Current bar time will be used by default.
+ * @returns Current bar hour in exchange timezone.
+ */
+ hour(context: IContext, time?: number): number;
+ /**
+ * Minute of current bar time in exchange timezone.
+ *
+ * @param context - PineJS execution context.
+ * @param time optional time. Current bar time will be used by default.
+ * @returns Current bar minute in exchange timezone.
+ */
+ minute(context: IContext, time?: number): number;
+ /**
+ * Second of current bar time in exchange timezone.
+ *
+ * @param context - PineJS execution context.
+ * @param time optional time. Current bar time will be used by default.
+ * @returns Current bar second in exchange timezone.
+ */
+ second(context: IContext, time?: number): number;
+ /**
+ * Checks if `n1` is greater than or equal to `n2`
+ *
+ * @param n1
+ * @param n2
+ * @param eps - Epsilon (Optional).
+ * @returns True if `n1` is greater than or equal to `n2`.
+ */
+ greaterOrEqual(n1: number, n2: number, eps?: number): boolean;
+ /**
+ * Checks if `n1` is less than or equal to `n2`
+ *
+ * @param n1
+ * @param n2
+ * @param eps - Epsilon (Optional).
+ * @returns True if `n1` is less than or equal to `n2`.
+ */
+ lessOrEqual(n1: number, n2: number, eps?: number): boolean;
+ /**
+ * Checks if `n1` is equal to `n2` (within the accuracy of epsilon).
+ *
+ * @param n1
+ * @param n2
+ * @param eps - Epsilon (Optional).
+ * @returns True if `n1` is equal to `n2`.
+ */
+ equal(n1: number, n2: number, eps?: number): boolean;
+ /**
+ * Checks if `n1` is greater than `n2`
+ *
+ * @param n1
+ * @param n2
+ * @param eps - Epsilon (Optional).
+ * @returns True if `n1` is greater than `n2`.
+ */
+ greater(n1: number, n2: number, eps?: number): boolean;
+ /**
+ * Checks if `n1` is less than `n2`
+ *
+ * @param n1
+ * @param n2
+ * @param eps - Epsilon (Optional).
+ * @returns True if `n1` is less than `n2`.
+ */
+ less(n1: number, n2: number, eps?: number): boolean;
+ /**
+ * Compare the values of `n1` and `n2`
+ *
+ * @param n1
+ * @param n2
+ * @param eps - Epsilon (Optional).
+ * @returns `0` if values are equal. `1` if x1 is greater than x2. `-1` if x1 is less than x2
+ */
+ compare(n1: number, n2: number, eps?: number): -1 | 0 | 1;
+ /**
+ * Checks if `n1` is greater than or equal to `n2`
+ *
+ * @param n1
+ * @param n2
+ * @returns `1` if `n1` is greater than or equal to `n2`, `0` otherwise.
+ */
+ ge(n1: number, n2: number): number;
+ /**
+ * Checks if `n1` is less than or equal to `n2`
+ *
+ * @param n1
+ * @param n2
+ * @returns `1` if `n1` is greater than or equal to `n2`, `0` otherwise.
+ */
+ le(n1: number, n2: number): number;
+ /**
+ * Checks if `n1` is equal to `n2`.
+ *
+ * @param n1
+ * @param n2
+ * @returns `1` if `n1` is equal to `n2`, `0` otherwise.
+ */
+ eq(n1: number, n2: number): number;
+ /**
+ * Checks if `n1` is not equal to `n2`.
+ *
+ * @param n1
+ * @param n2
+ * @returns `1` if `n1` is not equal to `n2`, `0` otherwise.
+ */
+ neq(n1: number, n2: number): number;
+ /**
+ * Checks if `n1` is greater than `n2`
+ *
+ * @param n1
+ * @param n2
+ * @returns `1` if `n1` is greater than `n2`, `0` otherwise.
+ */
+ gt(n1: number, n2: number): number;
+ /**
+ * Checks if `n1` is less than `n2`
+ *
+ * @param n1
+ * @param n2
+ * @returns `1` if `n1` is less than `n2`, `0` otherwise.
+ */
+ lt(n1: number, n2: number): number;
+ /**
+ * If ... then ... else ...
+ * `iff` does exactly the same thing as ternary conditional operator `?:` but in a functional style. Also `iff` is slightly less efficient than operator `?:`
+ *
+ * @param condition - condition to check
+ * @param thenValue - value to use if condition is true
+ * @param elseValue - value to use if condition is false
+ * @returns either thenValue or elseValue
+ */
+ iff(condition: number, thenValue: number, elseValue: number): number;
+ /**
+ * True Range
+ *
+ * @param n_handleNaN - How NaN values are handled. If truthy, and previous bar's close is `NaN` then tr would be calculated as current bar `high-low`. Otherwise tr would return `NaN` in such cases. Also note, that `atr` uses `tr(true)`.
+ * @param ctx - PineJS execution context.
+ * @returns True range. It is `max(high - low, abs(high - close[1]), abs(low - close[1]))`
+ */
+ tr(n_handleNaN: number | undefined, ctx: IContext): number;
+ /**
+ * Function atr (average true range) returns the RMA of true range. True range is `max(high - low, abs(high - close[1]), abs(low - close[1]))`
+ *
+ * @param length - Length (number of bars back).
+ * @param context - PineJS execution context.
+ * @returns Average true range.
+ */
+ atr(length: number, context: IContext): number;
+ /**
+ * Determines whether the current resolution is a daily, weekly, or monthly resolution.
+ *
+ * @param context - PineJS execution context.
+ * @returns true if current resolution is a daily or weekly or monthly resolution
+ */
+ isdwm(context: IContext): boolean;
+ /**
+ * Determines whether the current resolution is an intraday (minutes or seconds) resolution.
+ *
+ * @param context - PineJS execution context.
+ * @returns true if current resolution is an intraday (minutes or seconds) resolution
+ */
+ isintraday(context: IContext): boolean;
+ /**
+ * Determines whether the current resolution is a daily resolution.
+ *
+ * @param context - PineJS execution context.
+ * @returns true if current resolution is a daily resolution
+ */
+ isdaily(context: IContext): boolean;
+ /**
+ * Determines whether the current resolution is a weekly resolution.
+ *
+ * @param context - PineJS execution context.
+ * @returns true if current resolution is a weekly resolution
+ */
+ isweekly(context: IContext): boolean;
+ /**
+ * Determines whether the current resolution is a monthly resolution.
+ *
+ * @param context - PineJS execution context.
+ * @returns true if current resolution is a monthly resolution
+ */
+ ismonthly(context: IContext): boolean;
+ /**
+ * select session breaks for intraday resolutions only
+ *
+ * @param context - PineJS execution context.
+ * @param times - An array of numbers representing the times to select session breaks from.
+ * @returns session breaks for intraday resolutions only.
+ */
+ selectSessionBreaks(context: IContext, times: number[]): number[];
+ /**
+ * checks whether a new session can be created
+ *
+ * @param context - PineJS execution context.
+ * @returns checks whether a new session can be created
+ */
+ createNewSessionCheck(context: IContext): (time: number) => boolean;
+ /**
+ * Display an error message.
+ *
+ * @param message - message to display for error
+ */
+ error(message: string): never;
+ /**
+ * Zig-zag pivot points
+ *
+ * @param n_deviation - Deviation
+ * @param n_depth - Depth (integer)
+ * @param context - PineJS execution context.
+ * @returns the zig-zag pivot points
+ */
+ zigzag(n_deviation: number, n_depth: number, context: IContext): number;
+ /**
+ * Zig-zag pivot points
+ *
+ * @param n_deviation - Deviation
+ * @param n_depth - Depth (integer)
+ * @param context - PineJS execution context.
+ * @returns the zig-zag pivot points (for bars)
+ */
+ zigzagbars(n_deviation: number, n_depth: number, context: IContext): number;
+ /**
+ * Time of the current update
+ *
+ * @param context - PineJS execution context.
+ * @returns symbol update time
+ */
+ updatetime(context: IContext): number;
+ /**
+ * Ticker ID for the current symbol
+ *
+ * @param context - PineJS execution context.
+ * @returns Ticker ID for the current symbol
+ */
+ ticker(context: IContext): string;
+ /**
+ * Percent rank is the percentage of how many previous values were less than or equal to the current value of given series.
+ *
+ * @param source - Series of values to process.
+ * @param length - Number of bars (length).
+ * @returns Percent rank of `source` for `length` bars back.
+ */
+ percentrank(source: IPineSeries, length: number): number;
+ /**
+ * Test if the series is now rising for length bars long.
+ *
+ * @param series - Series of values to process.
+ * @param length - Number of bars (length).
+ * @returns `true` if current `x` is greater than any previous `x` for length bars back, `false` otherwise.
+ */
+ rising(series: IPineSeries, length: number): number;
+ /**
+ * Test if the series is now falling for length bars long.
+ *
+ * @param series - Series of values to process.
+ * @param length - Number of bars (length).
+ * @returns `true` if current `x` is less than any previous `x` for length bars back, `false` otherwise.
+ */
+ falling(series: IPineSeries, length: number): number;
+ /**
+ * Relative strength index. It is calculated based on rma's of upward and downward change of x.
+ *
+ * @param upper - upward change
+ * @param lower - downward change
+ * @returns Relative strength index.
+ */
+ rsi(upper: number, lower: number): number;
+ /**
+ * The sum function returns the sliding sum of last y values of x.
+ *
+ * @param source - Series of values to process.
+ * @param length - Number of bars (length).
+ * @param context - PineJS execution context.
+ * @returns Sum of x for y bars back.
+ */
+ sum(source: IPineSeries, length: number, context: IContext): number;
+ /**
+ * Simple Moving Average. The sum of last `length` values of `source`, divided by `length`.
+ *
+ * @param source - Series of values to process.
+ * @param length - Number of bars (length).
+ * @param context - PineJS execution context.
+ * @returns Simple moving average of x for y bars back.
+ */
+ sma(source: IPineSeries, length: number, context: IContext): number;
+ /**
+ * Smoothed Moving Average.
+ *
+ * @param n_value Next value in the series to calculate.
+ * @param n_length Smoothing length.
+ * @param ctx PineJS execution context.
+ * @returns The smoothed moving average value.
+ */
+ smma(n_value: number, n_length: number, ctx: IContext): number;
+ /**
+ * Moving average used in RSI. It is the exponentially weighted moving average with `alpha = 1 / length`.
+ *
+ * @param source - Series of values to process.
+ * @param length - Number of bars (length).
+ * @param context - PineJS execution context.
+ * @returns Exponential moving average of `x` with `alpha = 1 / y`.
+ */
+ rma(source: IPineSeries, length: number, context: IContext): number;
+ /**
+ * Exponential Moving Average. In EMA weighting factors decrease exponentially.
+ *
+ * It calculates by using a formula: `EMA = alpha * x + (1 - alpha) * EMA[1]`, where `alpha = 2 / (y + 1)`.
+ *
+ * @param source - Series of values to process.
+ * @param length - Number of bars (length).
+ * @param context - PineJS execution context.
+ * @returns Exponential moving average of `x` with `alpha = 2 / (y + 1)`
+ */
+ ema(source: IPineSeries, length: number, context: IContext): number;
+ /**
+ * The wma function returns weighted moving average of `source` for `length` bars back. In wma weighting factors decrease in arithmetical progression.
+ *
+ * @param source - Series of values to process.
+ * @param length - Number of bars (length).
+ * @param context - PineJS execution context.
+ * @returns Weighted moving average of `series` for `length` bars back.
+ */
+ wma(source: IPineSeries, length: number, context: IContext): number;
+ /**
+ * The vwma function returns volume-weighted moving average of `source` for `length` bars back. It is the same as: `sma(x * volume, y) / sma(volume, y)`
+ *
+ * @param source - Series of values to process.
+ * @param length - Number of bars (length).
+ * @param context - PineJS execution context.
+ * @returns Volume-weighted moving average of `source` for `length` bars back.
+ */
+ vwma(source: IPineSeries, length: number, context: IContext): number;
+ /**
+ * Symmetrically weighted moving average with fixed length: 4. Weights: `[1/6, 2/6, 2/6, 1/6]`.
+ *
+ * @param source - Series of values to process.
+ * @param context - PineJS execution context.
+ * @returns Symmetrically weighted moving average
+ */
+ swma(source: IPineSeries, context: IContext): number;
+ /**
+ * For a given series replaces NaN values with previous nearest non-NaN value.
+ *
+ * @param n_current - Series of values to process.
+ * @param context - PineJS execution context.
+ * @returns Series without na gaps.
+ */
+ fixnan(n_current: number, context: IContext): number;
+ /**
+ * Lowest value offset for a given number of bars back.
+ *
+ * @param source - Series of values to process.
+ * @param length - Number of bars (length).
+ * @param context - PineJS execution context.
+ * @returns Offset to the lowest bar.
+ */
+ lowestbars(source: IPineSeries, length: number, context: IContext): number;
+ /**
+ * Lowest value for a given number of bars back.
+ *
+ * @param source - Series of values to process.
+ * @param length - Number of bars (length).
+ * @param context - PineJS execution context.
+ * @returns Lowest value.
+ */
+ lowest(source: IPineSeries, length: number, context: IContext): number;
+ /**
+ * Highest value offset for a given number of bars back.
+ *
+ * @param source - Series of values to process.
+ * @param length - Number of bars (length).
+ * @param context - PineJS execution context.
+ * @returns Offset to the highest bar.
+ */
+ highestbars(source: IPineSeries, length: number, context: IContext): number;
+ /**
+ * Highest value for a given number of bars back.
+ *
+ * @param source - Series of values to process.
+ * @param length - Number of bars (length).
+ * @param context - PineJS execution context.
+ * @returns Highest value.
+ */
+ highest(source: IPineSeries, length: number, context: IContext): number;
+ /**
+ * Cumulative (total) sum. The function tracks the previous values internally.
+ *
+ * @param n_value Value to add to the sum.
+ * @param context PineJS execution context.
+ * @returns The sum.
+ */
+ cum(n_value: number, context: IContext): number;
+ /**
+ * Accumulation/distribution index.
+ *
+ * @param context - PineJS execution context.
+ * @returns Accumulation/distribution index.
+ */
+ accdist(context: IContext): number;
+ /**
+ * Correlation coefficient. Describes the degree to which two series tend to deviate from their `sma` values.
+ *
+ * @param sourceA - Source series.
+ * @param sourceB - Target series.
+ * @param length - Length (number of bars back).
+ * @param context - PineJS execution context.
+ * @returns Correlation coefficient.
+ */
+ correlation(
+ sourceA: IPineSeries,
+ sourceB: IPineSeries,
+ length: number,
+ context: IContext
+ ): number;
+ /**
+ * Stochastic. It is calculated by a formula: `100 * (close - lowest(low, length)) / (highest(high, length) - lowest(low, length))`
+ *
+ * @param source - Source series.
+ * @param high - Series of high.
+ * @param low - Series of low.
+ * @param length - Length (number of bars back).
+ * @param context - PineJS execution context.
+ * @returns Stochastic value.
+ */
+ stoch(
+ source: IPineSeries,
+ high: IPineSeries,
+ low: IPineSeries,
+ length: number,
+ context: IContext
+ ): number;
+ /**
+ * True strength index. It uses moving averages of the underlying momentum of a financial instrument.
+ *
+ * @param source - Source series.
+ * @param shortLength - Length (number of bars back).
+ * @param longLength - Length (number of bars back).
+ * @param context - PineJS execution context.
+ * @returns True strength index. A value in range `[-1, 1]`
+ */
+ tsi(
+ source: IPineSeries,
+ shortLength: number,
+ longLength: number,
+ context: IContext
+ ): number;
+ /**
+ * Crossing of series.
+ *
+ * @param n_0 - First value.
+ * @param n_1 - Second value.
+ * @param context - PineJS execution context.
+ * @returns `true` if two series have crossed each other, otherwise `false`.
+ */
+ cross(n_0: number, n_1: number, context: IContext): boolean;
+ /**
+ * Linear regression curve. A line that best fits the prices specified over a user-defined time period.
+ * It is calculated using the least squares method. The result of this function is calculated using the formula:
+ * `linreg = intercept + slope * (length - 1 - offset)`, where intercept and slope are the values calculated with
+ * the least squares method on source series (x argument).
+ *
+ * @param source - Source series.
+ * @param length - Length (number of bars back).
+ * @param offset - Offset (number of bars)
+ * @returns Linear regression curve point.
+ */
+ linreg(source: IPineSeries, length: number, offset: number): number;
+ /**
+ * Parabolic SAR (parabolic stop and reverse) is a method devised by J. Welles Wilder, Jr., to find potential reversals in the market price direction of traded goods.
+ *
+ * @param start - Start.
+ * @param inc - Increment.
+ * @param max - Maximum.
+ * @param context - PineJS execution context.
+ * @returns Parabolic SAR value.
+ */
+ sar(start: number, inc: number, max: number, context: IContext): number;
+ /**
+ * Arnaud Legoux Moving Average. It uses Gaussian distribution as weights for moving average.
+ *
+ * @param series - Series of values to process.
+ * @param length - Number of bars (length).
+ * @param offset - Controls tradeoff between smoothness (closer to 1) and responsiveness (closer to 0).
+ * @param sigma - Changes the smoothness of ALMA. The larger sigma the smoother ALMA.
+ */
+ alma(
+ series: IPineSeries,
+ length: number,
+ offset: number,
+ sigma: number
+ ): number;
+ /**
+ * Difference between current value and previous, `x - x[1]`.
+ *
+ * @param source - Series to process.
+ * @returns The result of subtraction.
+ */
+ change(source: IPineSeries): number;
+ /**
+ * Rate of Change.
+ *
+ * Function roc (rate of change) showing the difference between current value of `source` and the value of `source` that was `length` days ago. It is calculated by the formula: `100 * change(src, length) / src[length]`.
+ *
+ * @param source - Series of values to process.
+ * @param length - Number of bars (length).
+ * @returns The rate of change of `source` for `length` bars back.
+ */
+ roc(source: IPineSeries, length: number): number;
+ /**
+ * Measure of difference between the series and its sma.
+ *
+ * @param source - Series of values to process.
+ * @param length - Number of bars (length).
+ * @param context - PineJS execution context.
+ * @returns Deviation of source for length bars back.
+ */
+ dev(source: IPineSeries, length: number, context: IContext): number;
+ /**
+ * Standard deviation. Note: This is a biased estimation of standard deviation.
+ *
+ * @param source - Series of values to process.
+ * @param length - Number of bars (length).
+ * @param context - PineJS execution context.
+ * @returns Standard deviation.
+ */
+ stdev(source: IPineSeries, length: number, context: IContext): number;
+ /**
+ * Variance is the expectation of the squared deviation of a series from its mean `sma`, and it informally measures how far a set of numbers are spread out from their mean. Note: This is a biased estimation of sample variance.
+ *
+ * @param source - Series of values to process.
+ * @param length - Number of bars (length).
+ * @param context - PineJS execution context.
+ * @returns Variance of `source` for `length` bars back.
+ */
+ variance(source: IPineSeries, length: number, context: IContext): number;
+ /**
+ * Get time in `daysCount` number of days while taking Daylight savings time into account.
+ *
+ * @param timezone - Timezone
+ * @param utcTime - Date (JS built-in)
+ * @param daysCount - Number of days
+ * @returns The time is `daysCount` number of days, taking into account Daylight savings time.
+ */
+ add_days_considering_dst(
+ timezone: string,
+ utcTime: Date,
+ daysCount: number
+ ): Date;
+ /**
+ * Get time in `yearsCount` number of years while taking Daylight savings time into account.
+ *
+ * @param timezone - Timezone
+ * @param utcTime - Date (JS built-in)
+ * @param yearsCount - Number of years
+ * @returns The time is `yearsCount` number of years, taking into account Daylight savings time.
+ */
+ add_years_considering_dst(
+ timezone: string,
+ utcTime: Date,
+ yearsCount: number
+ ): Date;
+ /**
+ * Calculates the directional movement values +DI, -DI, DX, ADX, and ADXR.
+ *
+ * @param diLength - Number of bars (length) used when calculating the +DI and -DI values.
+ * @param adxSmoothingLength - Number of bars (length) used when calculating the ADX value.
+ * @param context - PineJS execution context.
+ * @returns An array of the +DI, -DI, DX, ADX, and ADXR values with diLength smoothing for the (+/-)DI values and adxSmoothingLength for the ADX value.
+ */
+ dmi(
+ diLength: number,
+ adxSmoothingLength: number,
+ context: IContext
+ ): [number, number, number, number, number];
+ /**
+ * Test value if it's a NaN.
+ *
+ * @param n - value to test
+ * @returns `1` if `n` is not a valid number (`n` is `NaN`), otherwise `0`. Returns `NaN` if `n` is undefined.
+ */
+ na(n?: number): number;
+ /**
+ * Replaces NaN values with zeros (or given value) in a series.
+ *
+ * @param x - value to test (and potentially replace)
+ * @param y - fallback value. `0` by default.
+ * @returns `x` if it's a valid (not NaN) number, otherwise `y`
+ */
+ nz(x: number, y?: number): number;
+ /**
+ * Logical AND.
+ *
+ * @returns `1` if both values are truthy, `0` otherwise.
+ */
+ and(n_0: number, n_1: number): number;
+ /**
+ * Logical OR.
+ *
+ * @returns `1` if either value is truthy, `0` otherwise.
+ */
+ or(n_0: number, n_1: number): number;
+ /**
+ * Logical negation (NOT).
+ *
+ * @returns `1` if value is falsy, `0` if value is truthy.
+ */
+ not(n_0: number): number;
+ /**
+ * Maximum number in the array
+ *
+ * @returns The greatest of multiple given values
+ */
+ max(...values: number[]): number;
+ /**
+ * Minimum number in the array
+ *
+ * @returns The smallest of multiple given values
+ */
+ min(...values: number[]): number;
+ /**
+ * Mathematical power function.
+ *
+ * @param base - Specify the base to use.
+ * @param exponent - Specifies the exponent.
+ * @returns `x` raised to the power of `y`.
+ */
+ pow(base: number, exponent: number): number;
+ /**
+ * Absolute value of x is x if x >= 0, or -x otherwise.
+ *
+ * @returns The absolute value of `x`
+ */
+ abs(x: number): number;
+ /**
+ * Natural logarithm of any `x > 0` is the unique `y` such that `e^y = x`
+ *
+ * @returns The natural logarithm of `x`.
+ */
+ log(x: number): number;
+ /**
+ * Base 10 logarithm of any `x > 0` is the unique `y` such that `10^y = x`
+ *
+ * @returns The base 10 logarithm of `x`.
+ */
+ log10(x: number): number;
+ /**
+ * Square root of any `x >= 0` is the unique `y >= 0` such that `y^2 = x`
+ *
+ * @returns The square root of `x`
+ */
+ sqrt(x: number): number;
+ /**
+ * Sign (signum) of `x` is `0` if the x is zero, `1.0` if the `x` is greater than zero, `-1.0` if the `x` is less than zero.
+ *
+ * @returns The sign of `x`
+ */
+ sign(x: number): number;
+ /**
+ * The exp function of `x` is `e^x`, where `x` is the argument and `e` is Euler's number.
+ *
+ * @returns A number representing `e^x`.
+ */
+ exp(x: number): number;
+ /**
+ * The sin function returns the trigonometric sine of an angle.
+ *
+ * @param x - Angle, in radians.
+ * @returns The trigonometric sine of an angle.
+ */
+ sin(x: number): number;
+ /**
+ * The cos function returns the trigonometric cosine of an angle.
+ *
+ * @param x - Angle, in radians.
+ * @returns The trigonometric cosine of an angle.
+ */
+ cos(x: number): number;
+ /**
+ * The tan function returns the trigonometric tangent of an angle.
+ *
+ * @param x - Angle, in radians.
+ * @returns The trigonometric tangent of an angle.
+ */
+ tan(x: number): number;
+ /**
+ * The asin function returns the arcsine (in radians) of number such that `sin(asin(y)) = y` for `y` in range `[-1, 1]`.
+ *
+ * @param x - Angle, in radians.
+ * @returns The arcsine of a value; the returned angle is in the range `[-Pi/2, Pi/2]`, or na if y is outside of range `[-1, 1]`.
+ */
+ asin(x: number): number;
+ /**
+ * The acos function returns the arccosine (in radians) of number such that `cos(acos(y)) = y` for `y` in range `[-1, 1]`.
+ *
+ * @param x - Angle, in radians.
+ * @returns The arc cosine of a value; the returned angle is in the range `[0, Pi]`, or na if y is outside of range `[-1, 1]`.
+ */
+ acos(x: number): number;
+ /**
+ * The atan function returns the arctangent (in radians) of number such that `tan(atan(y)) = y` for any `y`.
+ *
+ * @param x - Angle, in radians.
+ * @returns The arc tangent of a value; the returned angle is in the range `[-Pi/2, Pi/2]`.
+ */
+ atan(x: number): number;
+ /**
+ * Round the number down to the closest integer
+ *
+ * @returns The largest integer less than or equal to the given number.
+ */
+ floor(x: number): number;
+ /**
+ * The ceil function returns the smallest (closest to negative infinity) integer that is greater than or equal to the argument.
+ *
+ * @returns The smallest integer greater than or equal to the given number.
+ */
+ ceil(x: number): number;
+ /**
+ * Round the number to the nearest integer
+ *
+ * @returns The value of `x` rounded to the nearest integer, with ties rounding up. If the precision parameter is used, returns a float value rounded to that number of decimal places.
+ */
+ round(x: number): number;
+ /**
+ * Calculates average of all given series (elementwise).
+ *
+ * @returns the average of the values
+ */
+ avg(...values: number[]): number;
+ /**
+ * Current bar index
+ *
+ * @param context - PineJS execution context.
+ * @returns Current bar index. Numbering is zero-based, index of the first historical bar is 0.
+ */
+ n(context: IContext): number;
+ /**
+ * Check if a value is zero.
+ *
+ * @param v the value to test.
+ * @returns `true` if the value is zero, `false` otherwise.
+ */
+ isZero: (v: number) => number;
+ /**
+ * Convert a number to a boolean.
+ *
+ * @param v the value to convert.
+ * @returns `true` if the number is finite and non-zero, `false` otherwise.
+ */
+ toBool(v: number): boolean;
+ /**
+ * Get the symbol currency code.
+ *
+ * @param ctx PineJS execution context.
+ * @returns Symbol currency code.
+ */
+ currencyCode(ctx: IContext): string | null | undefined;
+ /**
+ * Get the symbol unit ID.
+ *
+ * @param ctx PineJS execution context.
+ * @returns Symbol unit ID.
+ */
+ unitId(ctx: IContext): string | null | undefined;
+ /**
+ * Get the symbol interval. For example: if the symbol has a resolution of `1D` then this function would return `1`.
+ *
+ * @param ctx PineJS execution context.
+ * @returns Symbol interval.
+ */
+ interval(ctx: IContext): number;
+}
+export interface PineStudyResultComposite {
+ /** Type is composite */
+ type: 'composite';
+ /** Composite data */
+ data: TPineStudyResultSimple[];
+}
+export interface PipValues {
+ /** value of 1 pip if you buy */
+ buyPipValue: number;
+ /** value of 1 pip if you sell */
+ sellPipValue: number;
+}
+/**
+ * Override properties for the Pitchfan drawing tool.
+ */
+export interface PitchfanLineToolOverrides {
+ /** Default value: `true` */
+ 'linetoolpitchfan.fillBackground': boolean;
+ /** Default value: `0.25` */
+ 'linetoolpitchfan.level0.coeff': number;
+ /** Default value: `#ffb74d` */
+ 'linetoolpitchfan.level0.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfan.level0.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfan.level0.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolpitchfan.level0.visible': boolean;
+ /** Default value: `0.382` */
+ 'linetoolpitchfan.level1.coeff': number;
+ /** Default value: `#81c784` */
+ 'linetoolpitchfan.level1.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfan.level1.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfan.level1.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolpitchfan.level1.visible': boolean;
+ /** Default value: `0.5` */
+ 'linetoolpitchfan.level2.coeff': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolpitchfan.level2.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfan.level2.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfan.level2.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolpitchfan.level2.visible': boolean;
+ /** Default value: `0.618` */
+ 'linetoolpitchfan.level3.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolpitchfan.level3.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfan.level3.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfan.level3.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolpitchfan.level3.visible': boolean;
+ /** Default value: `0.75` */
+ 'linetoolpitchfan.level4.coeff': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolpitchfan.level4.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfan.level4.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfan.level4.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolpitchfan.level4.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolpitchfan.level5.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolpitchfan.level5.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfan.level5.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfan.level5.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolpitchfan.level5.visible': boolean;
+ /** Default value: `1.5` */
+ 'linetoolpitchfan.level6.coeff': number;
+ /** Default value: `#9c27b0` */
+ 'linetoolpitchfan.level6.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfan.level6.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfan.level6.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolpitchfan.level6.visible': boolean;
+ /** Default value: `1.75` */
+ 'linetoolpitchfan.level7.coeff': number;
+ /** Default value: `#e91e63` */
+ 'linetoolpitchfan.level7.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfan.level7.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfan.level7.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolpitchfan.level7.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolpitchfan.level8.coeff': number;
+ /** Default value: `#F77C80` */
+ 'linetoolpitchfan.level8.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfan.level8.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfan.level8.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolpitchfan.level8.visible': boolean;
+ /** Default value: `#F23645` */
+ 'linetoolpitchfan.median.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfan.median.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfan.median.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolpitchfan.median.visible': boolean;
+ /** Default value: `80` */
+ 'linetoolpitchfan.transparency': number;
+}
+/**
+ * Override properties for the Pitchfork drawing tool.
+ */
+export interface PitchforkLineToolOverrides {
+ /** Default value: `false` */
+ 'linetoolpitchfork.extendLines': boolean;
+ /** Default value: `true` */
+ 'linetoolpitchfork.fillBackground': boolean;
+ /** Default value: `0.25` */
+ 'linetoolpitchfork.level0.coeff': number;
+ /** Default value: `#ffb74d` */
+ 'linetoolpitchfork.level0.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfork.level0.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfork.level0.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolpitchfork.level0.visible': boolean;
+ /** Default value: `0.382` */
+ 'linetoolpitchfork.level1.coeff': number;
+ /** Default value: `#81c784` */
+ 'linetoolpitchfork.level1.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfork.level1.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfork.level1.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolpitchfork.level1.visible': boolean;
+ /** Default value: `0.5` */
+ 'linetoolpitchfork.level2.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolpitchfork.level2.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfork.level2.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfork.level2.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolpitchfork.level2.visible': boolean;
+ /** Default value: `0.618` */
+ 'linetoolpitchfork.level3.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolpitchfork.level3.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfork.level3.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfork.level3.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolpitchfork.level3.visible': boolean;
+ /** Default value: `0.75` */
+ 'linetoolpitchfork.level4.coeff': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolpitchfork.level4.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfork.level4.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfork.level4.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolpitchfork.level4.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolpitchfork.level5.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolpitchfork.level5.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfork.level5.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfork.level5.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolpitchfork.level5.visible': boolean;
+ /** Default value: `1.5` */
+ 'linetoolpitchfork.level6.coeff': number;
+ /** Default value: `#9c27b0` */
+ 'linetoolpitchfork.level6.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfork.level6.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfork.level6.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolpitchfork.level6.visible': boolean;
+ /** Default value: `1.75` */
+ 'linetoolpitchfork.level7.coeff': number;
+ /** Default value: `#e91e63` */
+ 'linetoolpitchfork.level7.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfork.level7.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfork.level7.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolpitchfork.level7.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolpitchfork.level8.coeff': number;
+ /** Default value: `#F77C80` */
+ 'linetoolpitchfork.level8.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfork.level8.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfork.level8.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolpitchfork.level8.visible': boolean;
+ /** Default value: `#F23645` */
+ 'linetoolpitchfork.median.color': string;
+ /** Default value: `0` */
+ 'linetoolpitchfork.median.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpitchfork.median.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolpitchfork.median.visible': boolean;
+ /** Default value: `0` */
+ 'linetoolpitchfork.style': number;
+ /** Default value: `80` */
+ 'linetoolpitchfork.transparency': number;
+}
+export interface PlaceOrderResult {
+ /** Order id */
+ orderId?: string;
+}
+export interface PlacedOrder extends PlacedOrderBase, CustomFields {}
+/**
+ * Info about a placed order
+ */
+export interface PlacedOrderBase {
+ /** Order ID */
+ id: string;
+ /** Symbol name */
+ symbol: string;
+ /** Order type */
+ type: OrderType;
+ /** Order side (buy or sell) */
+ side: Side;
+ /** Order quantity (double) */
+ qty: number;
+ /** Order status */
+ status: OrderStatus;
+ /** Stop loss price (double). Available when Brackets are enabled */
+ stopLoss?: number;
+ /** Trailing stop Pips value (double). Available when Brackets are enabled */
+ trailingStopPips?: number;
+ /** Stop Loss type. It should be set to 1 (StopType.TrailingStop) for trailing stop orders. */
+ stopType?: StopType;
+ /** Take profit price (double). Available when Brackets are enabled */
+ takeProfit?: number;
+ /** Order duration */
+ duration?: OrderDuration;
+ /**
+ * An object that contains the results of broker specific user inputs (for example a digital signature).
+ * There are two possible kinds of custom fields: an input field with a checkbox and a custom combobox.
+ */
+ customFields?: CustomInputFieldsValues;
+ /** Filled order quantity (double) */
+ filledQty?: number;
+ /** Average fulfilled price for the order (double) */
+ avgPrice?: number;
+ /** Last update time (unix timestamp in milliseconds) */
+ updateTime?: number;
+ /** Price for the limit order (double) */
+ limitPrice?: number;
+ /** Price for the stop order (double) */
+ stopPrice?: number;
+ /** Message describing the state of the order */
+ message?: OrderOrPositionMessage;
+}
+export interface PlusClickParams extends MouseEventParams {
+ /** Symbol identifier */
+ symbol: string | null;
+ /** Price */
+ price: number;
+}
+export interface PnFStylePreferences {
+ /** Up mark color */
+ upColor: string;
+ /** Down mark color */
+ downColor: string;
+ /** Up projection mark color */
+ upColorProjection: string;
+ /** Down projection mark color */
+ downColorProjection: string;
+}
+/**
+ * Polygon Preferences
+ */
+export interface PolygonPreferences {
+ /** Transparency of the Polygon. Value between 0 and 100, where `100` -> fully transparent */
+ transparency: number;
+ /** Color of the Polygon */
+ color: string;
+}
+
+/**
+ * Override properties for the Polyline drawing tool.
+ */
+export interface PolylineLineToolOverrides {
+ /** Default value: `rgba(0, 188, 212, 0.2)` */
+ 'linetoolpolyline.backgroundColor': string;
+ /** Default value: `true` */
+ 'linetoolpolyline.fillBackground': boolean;
+ /** Default value: `false` */
+ 'linetoolpolyline.filled': boolean;
+ /** Default value: `#00bcd4` */
+ 'linetoolpolyline.linecolor': string;
+ /** Default value: `0` */
+ 'linetoolpolyline.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolpolyline.linewidth': number;
+ /** Default value: `80` */
+ 'linetoolpolyline.transparency': number;
+}
+export interface Position extends PositionBase, CustomFields {}
+/**
+ * Describes a single position.
+ */
+export interface PositionBase {
+ /** Position ID. Usually id should be equal to brokerSymbol */
+ id: string;
+ /** Symbol name */
+ symbol: string;
+ /** Position Quantity (positive number) */
+ qty: number;
+ /** Short position quantity */
+ shortQty?: number;
+ /** Long position quantity */
+ longQty?: number;
+ /** Position Side */
+ side: Side;
+ /** Average price */
+ avgPrice: number;
+ /** Message describing the state of the position */
+ message?: OrderOrPositionMessage;
+}
+export interface PositionDialogOptions extends TradingDialogOptions {}
+/**
+ * Override properties for the Position drawing tool.
+ */
+export interface PositionLineToolOverrides {
+ /** Default value: `rgba(255, 255, 255, 0.25)` */
+ 'linetoolposition.bodyBackgroundColor': string;
+ /** Default value: `25` */
+ 'linetoolposition.bodyBackgroundTransparency': number;
+ /** Default value: `#4094e8` */
+ 'linetoolposition.bodyBorderBuyColor': string;
+ /** Default value: `#e75656` */
+ 'linetoolposition.bodyBorderSellColor': string;
+ /** Default value: `true` */
+ 'linetoolposition.bodyFontBold': boolean;
+ /** Default value: `Verdana` */
+ 'linetoolposition.bodyFontFamily': string;
+ /** Default value: `false` */
+ 'linetoolposition.bodyFontItalic': boolean;
+ /** Default value: `9` */
+ 'linetoolposition.bodyFontSize': number;
+ /** Default value: `#e75656` */
+ 'linetoolposition.bodyTextNegativeColor': string;
+ /** Default value: `#646464` */
+ 'linetoolposition.bodyTextNeutralColor': string;
+ /** Default value: `#268c02` */
+ 'linetoolposition.bodyTextPositiveColor': string;
+ /** Default value: `rgba(255, 255, 255, 0.25)` */
+ 'linetoolposition.closeButtonBackgroundColor': string;
+ /** Default value: `25` */
+ 'linetoolposition.closeButtonBackgroundTransparency': number;
+ /** Default value: `#4094e8` */
+ 'linetoolposition.closeButtonBorderBuyColor': string;
+ /** Default value: `#e75656` */
+ 'linetoolposition.closeButtonBorderSellColor': string;
+ /** Default value: `#4094e8` */
+ 'linetoolposition.closeButtonIconBuyColor': string;
+ /** Default value: `#e75656` */
+ 'linetoolposition.closeButtonIconSellColor': string;
+ /** Default value: `` */
+ 'linetoolposition.closeTooltip': string;
+ /** Default value: `inherit` */
+ 'linetoolposition.extendLeft': string;
+ /** Default value: `#4094e8` */
+ 'linetoolposition.lineBuyColor': string;
+ /** Default value: `inherit` */
+ 'linetoolposition.lineLength': string;
+ /** Default value: `percentage` */
+ 'linetoolposition.lineLengthUnit': string;
+ /** Default value: `#e75656` */
+ 'linetoolposition.lineSellColor': string;
+ /** Default value: `inherit` */
+ 'linetoolposition.lineStyle': string;
+ /** Default value: `inherit` */
+ 'linetoolposition.lineWidth': string;
+ /** Default value: `` */
+ 'linetoolposition.protectTooltip': string;
+ /** Default value: `#4094e8` */
+ 'linetoolposition.quantityBackgroundBuyColor': string;
+ /** Default value: `#e75656` */
+ 'linetoolposition.quantityBackgroundSellColor': string;
+ /** Default value: `#4094e8` */
+ 'linetoolposition.quantityBorderBuyColor': string;
+ /** Default value: `#e75656` */
+ 'linetoolposition.quantityBorderSellColor': string;
+ /** Default value: `true` */
+ 'linetoolposition.quantityFontBold': boolean;
+ /** Default value: `Verdana` */
+ 'linetoolposition.quantityFontFamily': string;
+ /** Default value: `false` */
+ 'linetoolposition.quantityFontItalic': boolean;
+ /** Default value: `9` */
+ 'linetoolposition.quantityFontSize': number;
+ /** Default value: `#ffffff` */
+ 'linetoolposition.quantityTextColor': string;
+ /** Default value: `0` */
+ 'linetoolposition.quantityTextTransparency': number;
+ /** Default value: `rgba(255, 255, 255, 0.25)` */
+ 'linetoolposition.reverseButtonBackgroundColor': string;
+ /** Default value: `25` */
+ 'linetoolposition.reverseButtonBackgroundTransparency': number;
+ /** Default value: `#4094e8` */
+ 'linetoolposition.reverseButtonBorderBuyColor': string;
+ /** Default value: `#e75656` */
+ 'linetoolposition.reverseButtonBorderSellColor': string;
+ /** Default value: `#4094e8` */
+ 'linetoolposition.reverseButtonIconBuyColor': string;
+ /** Default value: `#e75656` */
+ 'linetoolposition.reverseButtonIconSellColor': string;
+ /** Default value: `` */
+ 'linetoolposition.reverseTooltip': string;
+ /** Default value: `` */
+ 'linetoolposition.tooltip': string;
+}
+/**
+ * Anchored (fixed) drawing point position as a percentage from the top left of a chart.
+ * For example `{ x: 0.5, y: 0.5 }` for the centre of the chart.
+ */
+export interface PositionPercents {
+ /**
+ * Position as a percentage from the left edge of the chart.
+ */
+ x: number;
+ /**
+ * Position as a percentage from the top edge of the chart.
+ */
+ y: number;
+}
+export interface PositiveBaseInputFieldValidatorResult
+ extends BaseInputFieldValidatorResult {
+ /** @inheritDoc */
+ valid: true;
+}
+/**
+ * Output value of the order ticket and input value of the broker's place order command
+ * This info is sufficient to place an order
+ */
+export interface PreOrder extends OrderTemplate {
+ /** @inheritDoc */
+ symbol: string;
+ /** @inheritDoc */
+ type: OrderType;
+ /** @inheritDoc */
+ side: Side;
+ /** @inheritDoc */
+ qty: number;
+ /** Current Quotes */
+ currentQuotes?: AskBid;
+ /**
+ * It is set to `true`, if the order closes a position.
+ */
+ isClose?: boolean;
+}
+/**
+ * Override properties for the Prediction drawing tool.
+ */
+export interface PredictionLineToolOverrides {
+ /** Default value: `#202020` */
+ 'linetoolprediction.centersColor': string;
+ /** Default value: `#F23645` */
+ 'linetoolprediction.failureBackground': string;
+ /** Default value: `#ffffff` */
+ 'linetoolprediction.failureTextColor': string;
+ /** Default value: `#ead289` */
+ 'linetoolprediction.intermediateBackColor': string;
+ /** Default value: `#6d4d22` */
+ 'linetoolprediction.intermediateTextColor': string;
+ /** Default value: `#2962FF` */
+ 'linetoolprediction.linecolor': string;
+ /** Default value: `2` */
+ 'linetoolprediction.linewidth': number;
+ /** Default value: `#2962FF` */
+ 'linetoolprediction.sourceBackColor': string;
+ /** Default value: `#2962FF` */
+ 'linetoolprediction.sourceStrokeColor': string;
+ /** Default value: `#ffffff` */
+ 'linetoolprediction.sourceTextColor': string;
+ /** Default value: `#4caf50` */
+ 'linetoolprediction.successBackground': string;
+ /** Default value: `#ffffff` */
+ 'linetoolprediction.successTextColor': string;
+ /** Default value: `#2962FF` */
+ 'linetoolprediction.targetBackColor': string;
+ /** Default value: `#2962FF` */
+ 'linetoolprediction.targetStrokeColor': string;
+ /** Default value: `#ffffff` */
+ 'linetoolprediction.targetTextColor': string;
+ /** Default value: `10` */
+ 'linetoolprediction.transparency': number;
+}
+/**
+ * Position defined by a price and time.
+ */
+export interface PricedPoint extends TimePoint {
+ /** Price */
+ price: number;
+}
+/**
+ * Override properties for the Pricelabel drawing tool.
+ */
+export interface PricelabelLineToolOverrides {
+ /** Default value: `#2962FF` */
+ 'linetoolpricelabel.backgroundColor': string;
+ /** Default value: `#2962FF` */
+ 'linetoolpricelabel.borderColor': string;
+ /** Default value: `#ffffff` */
+ 'linetoolpricelabel.color': string;
+ /** Default value: `14` */
+ 'linetoolpricelabel.fontsize': number;
+ /** Default value: `bold` */
+ 'linetoolpricelabel.fontWeight': string;
+ /** Default value: `0` */
+ 'linetoolpricelabel.transparency': number;
+}
+/**
+ * Override properties for the Projection drawing tool.
+ */
+export interface ProjectionLineToolOverrides {
+ /** Default value: `rgba(41, 98, 255, 0.2)` */
+ 'linetoolprojection.color1': string;
+ /** Default value: `rgba(156, 39, 176, 0.2)` */
+ 'linetoolprojection.color2': string;
+ /** Default value: `true` */
+ 'linetoolprojection.fillBackground': boolean;
+ /** Default value: `1` */
+ 'linetoolprojection.level1.coeff': number;
+ /** Default value: `#808080` */
+ 'linetoolprojection.level1.color': string;
+ /** Default value: `0` */
+ 'linetoolprojection.level1.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolprojection.level1.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolprojection.level1.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolprojection.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolprojection.showCoeffs': boolean;
+ /** Default value: `80` */
+ 'linetoolprojection.transparency': number;
+ /** Default value: `#9598A1` */
+ 'linetoolprojection.trendline.color': string;
+ /** Default value: `0` */
+ 'linetoolprojection.trendline.linestyle': number;
+ /** Default value: `true` */
+ 'linetoolprojection.trendline.visible': boolean;
+}
+/**
+ * Quantity field step and boundaries
+ */
+export interface QuantityMetainfo {
+ /** Minimum quantity */
+ min: number;
+ /** Maximum quantity */
+ max: number;
+ /** Quantity step size */
+ step: number;
+ /** Quantity step size for scrolling */
+ uiStep?: number;
+ /** Default quantity value */
+ default?: number;
+}
+export interface QuoteDataResponse {
+ /** Status code for symbol. Expected values: `ok` | `error` */
+ s: 'ok' | 'error';
+ /** Symbol name. This value must be **exactly the same** as in the request */
+ n: string;
+ /** Quote Values */
+ v: unknown;
+}
+/** Quote Data Error Response */
+export interface QuoteErrorData extends QuoteDataResponse {
+ /** @inheritDoc */
+ s: 'error';
+ /** @inheritDoc */
+ v: object;
+}
+/** Quote Data Ok Response */
+export interface QuoteOkData extends QuoteDataResponse {
+ /** @inheritDoc */
+ s: 'ok';
+ /** @inheritDoc */
+ v: DatafeedQuoteValues;
+}
+/**
+ * Options for specifying a Range which includes a resolution, and a time frame.
+ */
+export interface RangeOptions {
+ /**
+ * Time frame for the range.
+ */
+ val: TimeFrameValue;
+ /**
+ * Resolution for the range.
+ */
+ res: ResolutionString;
+}
+export interface RawStudyMetaInfo extends RawStudyMetaInfoBase {
+ /** Identifier for Study */
+ readonly id: RawStudyMetaInfoId;
+}
+export interface RawStudyMetaInfoBase {
+ /**
+ * Description of the study. It will be displayed in the Indicators window and will be used as a name argument when calling the createStudy method
+ */
+ readonly description: string;
+ /** Short description of the study. Will be displayed on the chart */
+ readonly shortDescription: string;
+ /** Name for the study */
+ readonly name?: string;
+ /** Metainfo version of the study. The current version is 53, and the default one is 0. */
+ readonly _metainfoVersion?: number;
+ /** Precision of the study's output values (quantity of digits after the decimal separator) */
+ readonly precision?: number | string;
+ /** Info about the Price Scale formatting */
+ readonly format: StudyPlotValueFormat;
+ /** Whether the study should appear on the main series pane */
+ readonly is_price_study?: boolean;
+ /** should be `true` in Custom Study */
+ readonly isCustomIndicator?: boolean;
+ /** Whether the study price scale should be the same as the main series one. */
+ readonly linkedToSeries?: boolean;
+ /** Price scale to use for the study */
+ readonly priceScale?: StudyTargetPriceScale;
+ /** Whether the study should appear in Indicators list. */
+ readonly is_hidden_study?: boolean;
+ /** an object containing settings that are applied when user clicks 'Apply Defaults'. See dedicated article: [Custom Studies Defaults](https://www.tradingview.com/charting-library-docs/latest/custom_studies/metainfo/Custom-Studies-Defaults.md) */
+ readonly defaults: Readonly>;
+ /** Bands */
+ readonly bands?: readonly Readonly[];
+ /** Filled area is a special object, which allows coloring an area between two plots or hlines. Please note, that it is impossible to fill the area between a band and a hline. */
+ readonly filledAreas?: readonly Readonly[];
+ /** array with inputs info depending on type. See dedicated article: [Custom Studies Inputs](https://www.tradingview.com/charting-library-docs/latest/custom_studies/metainfo/Custom-Studies-Inputs.md) */
+ readonly inputs?: StudyInputInfoList;
+ /** Symbol source */
+ readonly symbolSource?: SymbolSource;
+ /**
+ * definitions of palettes that are used in plots and defaults. Palettes allows you use different styles (not only colors) for each line point.
+ *
+ * This object contains palette names as keys, and palette info as values: `[palette.name]: { colors, valToIndex, addDefaultColor }`, where
+ * - `colors`* - an object `{ [color_id]: { name: 'name' }}`, where name is a string that will appear on Style tab of study properties dialog.
+ * - `valToIndex` - an object, the mapping between the values that are returned by the script and palette colors.
+ * - `addDefaultColor` - boolean, if true the defaults are used for colorer type plot, when its value is null or undefined.
+ */
+ readonly palettes?: MappedObject>;
+ /** array with study plots info. See dedicated article: [Custom Studies Plots](https://www.tradingview.com/charting-library-docs/latest/custom_studies/Custom-Studies-Plots.md) */
+ readonly plots?: readonly Readonly[];
+ /** an object with plot id as keys and style info as values. */
+ readonly styles?: MappedObject>;
+ /** array with study plots info. See dedicated article: [Custom Studies OHLC Plots](https://www.tradingview.com/charting-library-docs/latest/custom_studies/Custom-Studies-OHLC-Plots.md) */
+ readonly ohlcPlots?: MappedObject>;
+ /** Financial Period */
+ readonly financialPeriod?: FinancialPeriod;
+ /** Key for grouping studies */
+ readonly groupingKey?: string;
+}
+/**
+ * Override properties for the Ray drawing tool.
+ */
+export interface RayLineToolOverrides {
+ /** Default value: `false` */
+ 'linetoolray.alwaysShowStats': boolean;
+ /** Default value: `false` */
+ 'linetoolray.bold': boolean;
+ /** Default value: `false` */
+ 'linetoolray.extendLeft': boolean;
+ /** Default value: `true` */
+ 'linetoolray.extendRight': boolean;
+ /** Default value: `14` */
+ 'linetoolray.fontsize': number;
+ /** Default value: `center` */
+ 'linetoolray.horzLabelsAlign': string;
+ /** Default value: `false` */
+ 'linetoolray.italic': boolean;
+ /** Default value: `0` */
+ 'linetoolray.leftEnd': number;
+ /** Default value: `#2962FF` */
+ 'linetoolray.linecolor': string;
+ /** Default value: `0` */
+ 'linetoolray.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolray.linewidth': number;
+ /** Default value: `0` */
+ 'linetoolray.rightEnd': number;
+ /** Default value: `false` */
+ 'linetoolray.showAngle': boolean;
+ /** Default value: `false` */
+ 'linetoolray.showBarsRange': boolean;
+ /** Default value: `false` */
+ 'linetoolray.showDateTimeRange': boolean;
+ /** Default value: `false` */
+ 'linetoolray.showDistance': boolean;
+ /** Default value: `false` */
+ 'linetoolray.showLabel': boolean;
+ /** Default value: `false` */
+ 'linetoolray.showMiddlePoint': boolean;
+ /** Default value: `false` */
+ 'linetoolray.showPercentPriceRange': boolean;
+ /** Default value: `false` */
+ 'linetoolray.showPipsPriceRange': boolean;
+ /** Default value: `false` */
+ 'linetoolray.showPriceLabels': boolean;
+ /** Default value: `false` */
+ 'linetoolray.showPriceRange': boolean;
+ /** Default value: `2` */
+ 'linetoolray.statsPosition': number;
+ /** Default value: `#2962FF` */
+ 'linetoolray.textcolor': string;
+ /** Default value: `bottom` */
+ 'linetoolray.vertLabelsAlign': string;
+}
+/**
+ * Override properties for the Rectangle drawing tool.
+ */
+export interface RectangleLineToolOverrides {
+ /** Default value: `rgba(156, 39, 176, 0.2)` */
+ 'linetoolrectangle.backgroundColor': string;
+ /** Default value: `false` */
+ 'linetoolrectangle.bold': boolean;
+ /** Default value: `#9c27b0` */
+ 'linetoolrectangle.color': string;
+ /** Default value: `false` */
+ 'linetoolrectangle.extendLeft': boolean;
+ /** Default value: `false` */
+ 'linetoolrectangle.extendRight': boolean;
+ /** Default value: `true` */
+ 'linetoolrectangle.fillBackground': boolean;
+ /** Default value: `14` */
+ 'linetoolrectangle.fontSize': number;
+ /** Default value: `left` */
+ 'linetoolrectangle.horzLabelsAlign': string;
+ /** Default value: `false` */
+ 'linetoolrectangle.italic': boolean;
+ /** Default value: `2` */
+ 'linetoolrectangle.linewidth': number;
+ /** Default value: `#9c27b0` */
+ 'linetoolrectangle.middleLine.lineColor': string;
+ /** Default value: `2` */
+ 'linetoolrectangle.middleLine.lineStyle': number;
+ /** Default value: `1` */
+ 'linetoolrectangle.middleLine.lineWidth': number;
+ /** Default value: `false` */
+ 'linetoolrectangle.middleLine.showLine': boolean;
+ /** Default value: `false` */
+ 'linetoolrectangle.showLabel': boolean;
+ /** Default value: `#9c27b0` */
+ 'linetoolrectangle.textColor': string;
+ /** Default value: `50` */
+ 'linetoolrectangle.transparency': number;
+ /** Default value: `bottom` */
+ 'linetoolrectangle.vertLabelsAlign': string;
+}
+/**
+ * Override properties for the Regressiontrend drawing tool.
+ */
+export interface RegressiontrendLineToolOverrides {
+ /** Default value: `0` */
+ 'linetoolregressiontrend.inputs.first bar time': number;
+ /** Default value: `0` */
+ 'linetoolregressiontrend.inputs.last bar time': number;
+ /** Default value: `-2` */
+ 'linetoolregressiontrend.inputs.lower diviation': number;
+ /** Default value: `close` */
+ 'linetoolregressiontrend.inputs.source': string;
+ /** Default value: `2` */
+ 'linetoolregressiontrend.inputs.upper diviation': number;
+ /** Default value: `true` */
+ 'linetoolregressiontrend.inputs.use lower diviation': boolean;
+ /** Default value: `true` */
+ 'linetoolregressiontrend.inputs.use upper diviation': boolean;
+ /** Default value: `0` */
+ 'linetoolregressiontrend.linestyle': number;
+ /** Default value: `1` */
+ 'linetoolregressiontrend.linewidth': number;
+ /** Default value: `default` */
+ 'linetoolregressiontrend.precision': string;
+ /** Default value: `rgba(242, 54, 69, 0.3)` */
+ 'linetoolregressiontrend.styles.baseLine.color': string;
+ /** Default value: `15` */
+ 'linetoolregressiontrend.styles.baseLine.display': number;
+ /** Default value: `2` */
+ 'linetoolregressiontrend.styles.baseLine.linestyle': number;
+ /** Default value: `1` */
+ 'linetoolregressiontrend.styles.baseLine.linewidth': number;
+ /** Default value: `rgba(41, 98, 255, 0.3)` */
+ 'linetoolregressiontrend.styles.downLine.color': string;
+ /** Default value: `15` */
+ 'linetoolregressiontrend.styles.downLine.display': number;
+ /** Default value: `0` */
+ 'linetoolregressiontrend.styles.downLine.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolregressiontrend.styles.downLine.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolregressiontrend.styles.extendLines': boolean;
+ /** Default value: `true` */
+ 'linetoolregressiontrend.styles.showPearsons': boolean;
+ /** Default value: `70` */
+ 'linetoolregressiontrend.styles.transparency': number;
+ /** Default value: `rgba(41, 98, 255, 0.3)` */
+ 'linetoolregressiontrend.styles.upLine.color': string;
+ /** Default value: `15` */
+ 'linetoolregressiontrend.styles.upLine.display': number;
+ /** Default value: `0` */
+ 'linetoolregressiontrend.styles.upLine.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolregressiontrend.styles.upLine.linewidth': number;
+}
+export interface RenkoStylePreferences {
+ /** Up bar color */
+ upColor: string;
+ /** Down bar color */
+ downColor: string;
+ /** Up bar border color */
+ borderUpColor: string;
+ /** Down bar border color */
+ borderDownColor: string;
+ /** Projection up bar color */
+ upColorProjection: string;
+ /** Projection down bar color */
+ downColorProjection: string;
+ /** Projection up bar border color */
+ borderUpColorProjection: string;
+ /** Projection down bar border color */
+ borderDownColorProjection: string;
+ /** Up bar wick color */
+ wickUpColor: string;
+ /** Down bar wick color */
+ wickDownColor: string;
+}
+export interface RestBrokerConnectionInfo {
+ /** URL endpoint */
+ url: string;
+ /** Access token for the REST API */
+ access_token: string;
+}
+/**
+ * Override properties for the Riskrewardlong drawing tool.
+ */
+export interface RiskrewardlongLineToolOverrides {
+ /** Default value: `1000` */
+ 'linetoolriskrewardlong.accountSize': number;
+ /** Default value: `false` */
+ 'linetoolriskrewardlong.alwaysShowStats': boolean;
+ /** Default value: `#667b8b` */
+ 'linetoolriskrewardlong.borderColor': string;
+ /** Default value: `false` */
+ 'linetoolriskrewardlong.compact': boolean;
+ /** Default value: `false` */
+ 'linetoolriskrewardlong.drawBorder': boolean;
+ /** Default value: `true` */
+ 'linetoolriskrewardlong.fillBackground': boolean;
+ /** Default value: `true` */
+ 'linetoolriskrewardlong.fillLabelBackground': boolean;
+ /** Default value: `12` */
+ 'linetoolriskrewardlong.fontsize': number;
+ /** Default value: `#585858` */
+ 'linetoolriskrewardlong.labelBackgroundColor': string;
+ /** Default value: `#787B86` */
+ 'linetoolriskrewardlong.linecolor': string;
+ /** Default value: `1` */
+ 'linetoolriskrewardlong.linewidth': number;
+ /** Default value: `1` */
+ 'linetoolriskrewardlong.lotSize': number;
+ /** Default value: `rgba(8, 153, 129, 0.2)` */
+ 'linetoolriskrewardlong.profitBackground': string;
+ /** Default value: `80` */
+ 'linetoolriskrewardlong.profitBackgroundTransparency': number;
+ /** Default value: `25` */
+ 'linetoolriskrewardlong.risk': number;
+ /** Default value: `percents` */
+ 'linetoolriskrewardlong.riskDisplayMode': string;
+ /** Default value: `true` */
+ 'linetoolriskrewardlong.showPriceLabels': boolean;
+ /** Default value: `rgba(242, 54, 69, 0.2)` */
+ 'linetoolriskrewardlong.stopBackground': string;
+ /** Default value: `80` */
+ 'linetoolriskrewardlong.stopBackgroundTransparency': number;
+ /** Default value: `#ffffff` */
+ 'linetoolriskrewardlong.textcolor': string;
+}
+/**
+ * Override properties for the Riskrewardshort drawing tool.
+ */
+export interface RiskrewardshortLineToolOverrides {
+ /** Default value: `1000` */
+ 'linetoolriskrewardshort.accountSize': number;
+ /** Default value: `false` */
+ 'linetoolriskrewardshort.alwaysShowStats': boolean;
+ /** Default value: `#667b8b` */
+ 'linetoolriskrewardshort.borderColor': string;
+ /** Default value: `false` */
+ 'linetoolriskrewardshort.compact': boolean;
+ /** Default value: `false` */
+ 'linetoolriskrewardshort.drawBorder': boolean;
+ /** Default value: `true` */
+ 'linetoolriskrewardshort.fillBackground': boolean;
+ /** Default value: `true` */
+ 'linetoolriskrewardshort.fillLabelBackground': boolean;
+ /** Default value: `12` */
+ 'linetoolriskrewardshort.fontsize': number;
+ /** Default value: `#585858` */
+ 'linetoolriskrewardshort.labelBackgroundColor': string;
+ /** Default value: `#787B86` */
+ 'linetoolriskrewardshort.linecolor': string;
+ /** Default value: `1` */
+ 'linetoolriskrewardshort.linewidth': number;
+ /** Default value: `1` */
+ 'linetoolriskrewardshort.lotSize': number;
+ /** Default value: `rgba(8, 153, 129, 0.2)` */
+ 'linetoolriskrewardshort.profitBackground': string;
+ /** Default value: `80` */
+ 'linetoolriskrewardshort.profitBackgroundTransparency': number;
+ /** Default value: `25` */
+ 'linetoolriskrewardshort.risk': number;
+ /** Default value: `percents` */
+ 'linetoolriskrewardshort.riskDisplayMode': string;
+ /** Default value: `true` */
+ 'linetoolriskrewardshort.showPriceLabels': boolean;
+ /** Default value: `rgba(242, 54, 69, 0.2)` */
+ 'linetoolriskrewardshort.stopBackground': string;
+ /** Default value: `80` */
+ 'linetoolriskrewardshort.stopBackgroundTransparency': number;
+ /** Default value: `#ffffff` */
+ 'linetoolriskrewardshort.textcolor': string;
+}
+/**
+ * Override properties for the Rotatedrectangle drawing tool.
+ */
+export interface RotatedrectangleLineToolOverrides {
+ /** Default value: `rgba(76, 175, 80, 0.2)` */
+ 'linetoolrotatedrectangle.backgroundColor': string;
+ /** Default value: `#4caf50` */
+ 'linetoolrotatedrectangle.color': string;
+ /** Default value: `true` */
+ 'linetoolrotatedrectangle.fillBackground': boolean;
+ /** Default value: `2` */
+ 'linetoolrotatedrectangle.linewidth': number;
+ /** Default value: `50` */
+ 'linetoolrotatedrectangle.transparency': number;
+}
+export interface RssNewsFeedInfo {
+ /**
+ * URL for the RSS feed.
+ * Can contain tags in curly brackets that will be replaced by the terminal: `{SYMBOL}`, `{TYPE}`, `{EXCHANGE}`.
+ */
+ url: string;
+ /** Name of the feed to be displayed underneath the news */
+ name: string;
+}
+export interface RssNewsFeedParams {
+ /** Default news feed */
+ default: RssNewsFeedItem;
+ /** Additional news feeds */
+ [symbolType: string]: RssNewsFeedItem;
+}
+/**
+ * Options: Save Chart to Server
+ */
+export interface SaveChartToServerOptions {
+ /** Name of chart */
+ chartName?: string;
+ /** Default chart name */
+ defaultChartName?: string;
+}
+export interface SaveLoadChartRecord {
+ /** Unique id for chart */
+ id: string;
+ /** Name of chart */
+ name: string;
+ /** URL of chart image */
+ image_url: string;
+ /** Modified ISO number for chart */
+ modified_iso: number;
+ /** Short symbol name */
+ short_symbol: string;
+ /** Chart interval */
+ interval: ResolutionString;
+}
+export interface SavedStateMetaInfo {
+ /** Unique ID */
+ uid: number;
+ /** Name of chart */
+ name: string;
+ /** Chart description */
+ description: string;
+}
+/**
+ * Override properties for the Schiffpitchfork2 drawing tool.
+ */
+export interface Schiffpitchfork2LineToolOverrides {
+ /** Default value: `false` */
+ 'linetoolschiffpitchfork2.extendLines': boolean;
+ /** Default value: `true` */
+ 'linetoolschiffpitchfork2.fillBackground': boolean;
+ /** Default value: `0.25` */
+ 'linetoolschiffpitchfork2.level0.coeff': number;
+ /** Default value: `#ffb74d` */
+ 'linetoolschiffpitchfork2.level0.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork2.level0.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork2.level0.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolschiffpitchfork2.level0.visible': boolean;
+ /** Default value: `0.382` */
+ 'linetoolschiffpitchfork2.level1.coeff': number;
+ /** Default value: `#81c784` */
+ 'linetoolschiffpitchfork2.level1.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork2.level1.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork2.level1.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolschiffpitchfork2.level1.visible': boolean;
+ /** Default value: `0.5` */
+ 'linetoolschiffpitchfork2.level2.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolschiffpitchfork2.level2.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork2.level2.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork2.level2.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolschiffpitchfork2.level2.visible': boolean;
+ /** Default value: `0.618` */
+ 'linetoolschiffpitchfork2.level3.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolschiffpitchfork2.level3.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork2.level3.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork2.level3.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolschiffpitchfork2.level3.visible': boolean;
+ /** Default value: `0.75` */
+ 'linetoolschiffpitchfork2.level4.coeff': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolschiffpitchfork2.level4.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork2.level4.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork2.level4.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolschiffpitchfork2.level4.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolschiffpitchfork2.level5.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolschiffpitchfork2.level5.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork2.level5.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork2.level5.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolschiffpitchfork2.level5.visible': boolean;
+ /** Default value: `1.5` */
+ 'linetoolschiffpitchfork2.level6.coeff': number;
+ /** Default value: `#9c27b0` */
+ 'linetoolschiffpitchfork2.level6.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork2.level6.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork2.level6.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolschiffpitchfork2.level6.visible': boolean;
+ /** Default value: `1.75` */
+ 'linetoolschiffpitchfork2.level7.coeff': number;
+ /** Default value: `#e91e63` */
+ 'linetoolschiffpitchfork2.level7.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork2.level7.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork2.level7.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolschiffpitchfork2.level7.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork2.level8.coeff': number;
+ /** Default value: `#F77C80` */
+ 'linetoolschiffpitchfork2.level8.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork2.level8.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork2.level8.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolschiffpitchfork2.level8.visible': boolean;
+ /** Default value: `#F23645` */
+ 'linetoolschiffpitchfork2.median.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork2.median.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork2.median.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolschiffpitchfork2.median.visible': boolean;
+ /** Default value: `3` */
+ 'linetoolschiffpitchfork2.style': number;
+ /** Default value: `80` */
+ 'linetoolschiffpitchfork2.transparency': number;
+}
+/**
+ * Override properties for the Schiffpitchfork drawing tool.
+ */
+export interface SchiffpitchforkLineToolOverrides {
+ /** Default value: `false` */
+ 'linetoolschiffpitchfork.extendLines': boolean;
+ /** Default value: `true` */
+ 'linetoolschiffpitchfork.fillBackground': boolean;
+ /** Default value: `0.25` */
+ 'linetoolschiffpitchfork.level0.coeff': number;
+ /** Default value: `#ffb74d` */
+ 'linetoolschiffpitchfork.level0.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork.level0.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork.level0.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolschiffpitchfork.level0.visible': boolean;
+ /** Default value: `0.382` */
+ 'linetoolschiffpitchfork.level1.coeff': number;
+ /** Default value: `#81c784` */
+ 'linetoolschiffpitchfork.level1.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork.level1.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork.level1.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolschiffpitchfork.level1.visible': boolean;
+ /** Default value: `0.5` */
+ 'linetoolschiffpitchfork.level2.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolschiffpitchfork.level2.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork.level2.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork.level2.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolschiffpitchfork.level2.visible': boolean;
+ /** Default value: `0.618` */
+ 'linetoolschiffpitchfork.level3.coeff': number;
+ /** Default value: `#089981` */
+ 'linetoolschiffpitchfork.level3.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork.level3.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork.level3.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolschiffpitchfork.level3.visible': boolean;
+ /** Default value: `0.75` */
+ 'linetoolschiffpitchfork.level4.coeff': number;
+ /** Default value: `#00bcd4` */
+ 'linetoolschiffpitchfork.level4.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork.level4.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork.level4.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolschiffpitchfork.level4.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolschiffpitchfork.level5.coeff': number;
+ /** Default value: `#2962FF` */
+ 'linetoolschiffpitchfork.level5.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork.level5.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork.level5.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolschiffpitchfork.level5.visible': boolean;
+ /** Default value: `1.5` */
+ 'linetoolschiffpitchfork.level6.coeff': number;
+ /** Default value: `#9c27b0` */
+ 'linetoolschiffpitchfork.level6.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork.level6.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork.level6.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolschiffpitchfork.level6.visible': boolean;
+ /** Default value: `1.75` */
+ 'linetoolschiffpitchfork.level7.coeff': number;
+ /** Default value: `#e91e63` */
+ 'linetoolschiffpitchfork.level7.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork.level7.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork.level7.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolschiffpitchfork.level7.visible': boolean;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork.level8.coeff': number;
+ /** Default value: `#F77C80` */
+ 'linetoolschiffpitchfork.level8.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork.level8.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork.level8.linewidth': number;
+ /** Default value: `false` */
+ 'linetoolschiffpitchfork.level8.visible': boolean;
+ /** Default value: `#F23645` */
+ 'linetoolschiffpitchfork.median.color': string;
+ /** Default value: `0` */
+ 'linetoolschiffpitchfork.median.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolschiffpitchfork.median.linewidth': number;
+ /** Default value: `true` */
+ 'linetoolschiffpitchfork.median.visible': boolean;
+ /** Default value: `1` */
+ 'linetoolschiffpitchfork.style': number;
+ /** Default value: `80` */
+ 'linetoolschiffpitchfork.transparency': number;
+}
+/**
+ * [Symbol Search](https://www.tradingview.com/charting-library-docs/latest/ui_elements/Symbol-Search) result item.
+ * Pass the resulting array of symbols as a parameter to {@link SearchSymbolsCallback} of the [`searchSymbols`](https://www.tradingview.com/charting-library-docs/latest/connecting_data/Datafeed-API#searchsymbols) method.
+ *
+ j;q
+ * @example
+ * ```
+ * {
+ * description: 'Apple Inc.',
+ * exchange: 'NasdaqNM',
+ * full_name: 'NasdaqNM:AAPL',
+ * symbol: 'AAPL',
+ * ticker: 'AAPL',
+ * type: 'stock',
+ * }
+ * ```
+ */
+export interface SearchSymbolResultItem {
+ /** Short symbol name */
+ symbol: string;
+ /** Full symbol name */
+ full_name: string;
+ /** Description */
+ description: string;
+ /** Exchange name */
+ exchange: string;
+ /** Symbol ticker name. Should be an unique id */
+ ticker?: string;
+ /**
+ * Type of symbol
+ *
+ * 'stock' | 'futures' | 'forex' | 'index'
+ */
+ type: string;
+ /**
+ * URL of image/s to be displayed as the logo/s for the symbol. The `show_symbol_logos` featureset needs to be enabled for this to be visible in the UI.
+ *
+ * - If a single url is returned then that url will solely be used to display the symbol logo.
+ * - If two urls are provided then the images will be displayed as two partially overlapping
+ * circles with the first url appearing on top. This is typically used for FOREX where you would
+ * like to display two country flags as the symbol logo.
+ *
+ * The image/s should ideally be square in dimension. You can use any image type which
+ * the browser supports natively. Simple SVG images are recommended.
+ *
+ * Examples:
+ * - `https://yourserver.com/symbolName.svg`
+ * - `/images/myImage.png`
+ * - `data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3...`
+ * - `data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4...`
+ */
+ logo_urls?: [string] | [string, string];
+ /**
+ * URL of image to be displayed as the logo for the exchange. The `show_exchange_logos` featureset needs to be enabled for this to be visible in the UI.
+ *
+ * The image should ideally be square in dimension. You can use any image type which
+ * the browser supports natively. Simple SVG images are recommended.
+ *
+ * Examples:
+ * - `https://yourserver.com/exchangeLogo.svg`
+ * - `/images/myImage.png`
+ * - `data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3...`
+ * - `data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4...`
+ */
+ exchange_logo?: string;
+}
+/**
+ * Description of a series field.
+ * This is used when `includeSeries: true` is defined in `exportData`.
+ */
+export interface SeriesFieldDescriptor {
+ /** Type is a `value` */
+ type: 'value';
+ /** Source type is a `series` */
+ sourceType: 'series';
+ /** The name of the plot (open, high, low, close) */
+ plotTitle: string;
+ /** Title of the series */
+ sourceTitle: string;
+}
+/**
+ * Style preferences map for the chart types
+ */
+export interface SeriesPreferencesMap {
+ /** Bar Style Preferences */
+ [ChartStyle.Bar]: BarStylePreferences;
+ /** Candle Style Preferences */
+ [ChartStyle.Candle]: CandleStylePreferences;
+ /** Line Style Preferences */
+ [ChartStyle.Line]: LineStylePreferences;
+ /** Line With Markers Style Preferences */
+ [ChartStyle.LineWithMarkers]: LineStylePreferences;
+ /** Step Line Style Preferences */
+ [ChartStyle.Stepline]: LineStylePreferences;
+ /** Area Style Preferences */
+ [ChartStyle.Area]: AreaStylePreferences;
+ /** HLC Area Style Preferences */
+ [ChartStyle.HLCArea]: HLCAreaStylePreferences;
+ /** Renko Style Preferences */
+ [ChartStyle.Renko]: RenkoStylePreferences;
+ /** Kagi Style Preferences */
+ [ChartStyle.Kagi]: KagiStylePreferences;
+ /** Point and Figure Style Preferences */
+ [ChartStyle.PnF]: PnFStylePreferences;
+ /** Line Break Style Preferences */
+ [ChartStyle.LineBreak]: LineBreakStylePreferences;
+ /** Heikin Ashi Style Preferences */
+ [ChartStyle.HeikinAshi]: HeikinAshiStylePreferences;
+ /** Hollow Candle Style Preferences */
+ [ChartStyle.HollowCandle]: HollowCandleStylePreferences;
+ /** Baseline Style Preferences */
+ [ChartStyle.Baseline]: BaselineStylePreferences;
+ /** High-Low Style Preferences */
+ [ChartStyle.HiLo]: HiLoStylePreferences;
+ /** Columns Style Preferences */
+ [ChartStyle.Column]: ColumnStylePreferences;
+}
+/**
+ * Options for setting a chart's resolution.
+ */
+export interface SetResolutionOptions {
+ /**
+ * An optional callback function. Called when the data for the new resolution has loaded.
+ */
+ dataReady?: () => void;
+ /**
+ * A boolean flag. Allows to disable making the current chart active in the layout.
+ */
+ doNotActivateChart?: boolean;
+}
+/**
+ * Options for setting a chart's symbol.
+ */
+export interface SetSymbolOptions {
+ /**
+ * An optional callback function. Called when the data for the new symbol has loaded.
+ */
+ dataReady?: () => void;
+ /**
+ * A boolean flag. Allows to disable making the current chart active in the layout.
+ */
+ doNotActivateChart?: boolean;
+}
+/**
+ * Options for setting the visible range.
+ *
+ * Setting `applyDefaultRightMargin` or `percentRightMargin` will result in the `to` value
+ * of the range specified being ignored and the timestamp of the latest bar on the chart
+ * being used instead.
+ */
+export interface SetVisibleRangeOptions {
+ /**
+ * Apply the default right offset (margin) when setting the range.
+ */
+ applyDefaultRightMargin?: boolean;
+ /**
+ * Apply a percentage right offset (margin) when setting the range.
+ */
+ percentRightMargin?: number;
+}
+/**
+ * Override properties for the Signpost drawing tool.
+ */
+export interface SignpostLineToolOverrides {
+ /** Default value: `false` */
+ 'linetoolsignpost.bold': boolean;
+ /** Default value: `🙂` */
+ 'linetoolsignpost.emoji': string;
+ /** Default value: `12` */
+ 'linetoolsignpost.fontSize': number;
+ /** Default value: `false` */
+ 'linetoolsignpost.italic': boolean;
+ /** Default value: `1` */
+ 'linetoolsignpost.itemType': number;
+ /** Default value: `#2962FF` */
+ 'linetoolsignpost.plateColor': string;
+ /** Default value: `false` */
+ 'linetoolsignpost.showImage': boolean;
+}
+/**
+ * Override properties for the Sineline drawing tool.
+ */
+export interface SinelineLineToolOverrides {
+ /** Default value: `#159980` */
+ 'linetoolsineline.linecolor': string;
+ /** Default value: `0` */
+ 'linetoolsineline.linestyle': number;
+ /** Default value: `2` */
+ 'linetoolsineline.linewidth': number;
+}
+export interface SingleBrokerMetaInfo {
+ /**
+ * Broker Configuration Flags
+ */
+ configFlags: BrokerConfigFlags;
+ /**
+ * Optional field. You can use it if you have custom fields in orders or positions that should be taken into account when showing notifications.
+ *
+ * @example
+ * if you have field `additionalType` in orders and you want the chart to show a notification when it is changed, you should set:
+ * ```javascript
+ * customNotificationFields: ['additionalType']
+ * ```
+ */
+ customNotificationFields?: string[];
+ /**
+ * List of expiration options of orders. It is optional. Do not set it if you don't want the durations to be displayed in Order Ticket.
+ *
+ * The objects have the following keys: `{ name, value, hasDatePicker?, hasTimePicker?, default?, supportedOrderTypes? }`.
+ */
+ durations?: OrderDurationMetaInfo[];
+ /** Dialog options for Positions (order type) */
+ positionDialogOptions?: PositionDialogOptions;
+ /**
+ * Order Rules
+ */
+ orderRules?: OrderRule[];
+ /**
+ * This optional field can be used to replace the standard Order Ticket and the Add Protection dialogs with your own.
+ * Values of the following two fields are functions that are called by the Trading Platform to show the dialogs. Each function shows a dialog and returns a `Promise` object that should be resolved when the operation is finished or cancelled.
+ *
+ * **NOTE:** The returned `Promise` object should be resolved with either `true` or `false` value.
+ *
+ * @example
+ * ```ts
+ * customUI: {
+ * showOrderDialog?: (order: Order, focus?: OrderTicketFocusControl) => Promise;
+ * showPositionDialog?: (position: Position | Trade, brackets: Brackets, focus?: OrderTicketFocusControl) => Promise;
+ * showCancelOrderDialog?: (order: Order) => Promise;
+ * showClosePositionDialog?: (position: Position) => Promise;
+ * }
+ * ```
+ */
+ customUI?: BrokerCustomUI;
+}
+export interface SortingParameters {
+ /** `property` of the data object that will be used for sorting */
+ property: string;
+ /** Ascending sorting order (default `true`) - If it is `false`, then initial sorting will be in descending order */
+ asc?: boolean;
+}
+/* eslint-disable jsdoc/require-jsdoc */
+export interface StandardFormattersDependenciesMapping {
+ [StandardFormatterName.Default]: string[];
+ [StandardFormatterName.Symbol]:
+ | [brokerSymbolProperty: string, symbolProperty: string, message: string]
+ | [brokerSymbolProperty: string, symbolProperty: string];
+ [StandardFormatterName.Side]: [sideProperty: string];
+ [StandardFormatterName.PositionSide]: [sideProperty: string];
+ [StandardFormatterName.Text]: string[];
+ [StandardFormatterName.Type]: [
+ orderTypeProperty: string,
+ parentIdProperty: string,
+ stopTypeProperty: string
+ ];
+ [StandardFormatterName.FormatPrice]: [priceProperty: string];
+ [StandardFormatterName.FormatPriceForexSup]: [priceProperty: string];
+ [StandardFormatterName.Status]: [statusProperty: string];
+ [StandardFormatterName.Date]: [dateProperty: string];
+ [StandardFormatterName.LocalDate]: [dateProperty: string];
+ [StandardFormatterName.DateOrDateTime]: [dateProperty: string];
+ [StandardFormatterName.LocalDateOrDateTime]: [dateProperty: string];
+ [StandardFormatterName.Fixed]: [valueProperty: string];
+ [StandardFormatterName.FixedInCurrency]: [
+ valueProperty: string,
+ currencyProperty: string
+ ];
+ [StandardFormatterName.VariablePrecision]: [valueProperty: string];
+ [StandardFormatterName.Pips]: [pipsProperty: string];
+ [StandardFormatterName.IntegerSeparated]: [valueProperty: string];
+ [StandardFormatterName.FormatQuantity]: [qtyProperty: string];
+ [StandardFormatterName.Profit]: [profitProperty: string];
+ [StandardFormatterName.ProfitInInstrumentCurrency]: [
+ profitProperty: string,
+ currencyProperty: string
+ ];
+ [StandardFormatterName.Percentage]: [valueProperty: string];
+ [StandardFormatterName.MarginPercent]: [valueProperty: string];
+ [StandardFormatterName.Empty]: [];
+}
+/* eslint-enable jsdoc/require-jsdoc */
+/**
+ * Position defined by an OHLC price on a bar at a specified time.
+ */
+export interface StickedPoint extends TimePoint {
+ /** Candle stick value to 'stick' on */
+ channel: 'open' | 'high' | 'low' | 'close';
+}
+/**
+ * Override properties for the Sticker drawing tool.
+ */
+export interface StickerLineToolOverrides {
+ /** Default value: `1.5707963267948966` */
+ 'linetoolsticker.angle': number;
+ /** Default value: `110` */
+ 'linetoolsticker.size': number;
+ /** Default value: `bitcoin` */
+ 'linetoolsticker.sticker': string;
+}
+/**
+ * A description of a study arrows plot.
+ */
+export interface StudyArrowsPlotInfo extends StudyPlotBaseInfo {
+ /** @inheritDoc */
+ readonly type: StudyPlotType.Arrows;
+}
+/**
+ * Study arrow plot style preferences.
+ */
+export interface StudyArrowsPlotPreferences extends StudyPlotBasePreferences {
+ /**
+ * Up arrow color.
+ */
+ colorup: string;
+ /**
+ * Down arrow color.
+ */
+ colordown: string;
+ /**
+ * Minimum arrow height.
+ */
+ minHeight?: number;
+ /**
+ * Maximum arrow height.
+ */
+ maxHeight?: number;
+}
+/**
+ * Preferences for adjusting the visual appearance of the background of a band area.
+ */
+export interface StudyBandBackgroundPreferences {
+ /** Background color for the Band area */
+ backgroundColor: string;
+ /** Transparency of the band area */
+ transparency: number;
+ /** Whether the background area should be filled with the `backgroundColor` */
+ fillBackground: boolean;
+}
+/**
+ * A description of a study band.
+ */
+export interface StudyBandInfo {
+ /**
+ * Band ID. Used in {@link StudyFilledAreaInfo.objAId} and {@link StudyFilledAreaInfo.objBId}.
+ *
+ * @see StudyFilledAreaInfo
+ */
+ readonly id?: string;
+ /**
+ * Band name.
+ */
+ readonly name: string;
+ /**
+ * Band style inputs visibility flag. Used to hide the band from the style tab of study properties dialogs.
+ */
+ readonly isHidden?: boolean;
+ /**
+ * Band z-order.
+ */
+ readonly zorder?: number;
+}
+/**
+ * Study band style preferences.
+ */
+export interface StudyBandPreferences extends StudyBandStyle, StudyBandInfo {}
+/**
+ * Study band style preferences.
+ */
+export interface StudyBandStyle {
+ /**
+ * Color.
+ *
+ * @example '#ffffff'.
+ */
+ color: string;
+ /**
+ * Line style.
+ *
+ * @example 2 // Dotted line.
+ */
+ linestyle: number;
+ /**
+ * Line width.
+ */
+ linewidth: number;
+ /**
+ * Value at which the band will be drawn.
+ *
+ * @example 75 // Drawn at price = 75.
+ */
+ value: number;
+ /**
+ * Band visibility flag.
+ */
+ visible: boolean;
+}
+/**
+ * A description of a bar colorer plot.
+ */
+export interface StudyBarColorerPlotInfo extends StudyPalettedPlotInfo {
+ /** @inheritDoc */
+ readonly type: StudyPlotType.BarColorer;
+}
+export interface StudyBarTimeInputInfo extends StudyInputBaseInfo {
+ /** Input type is BarTime */
+ readonly type: StudyInputType.BarTime;
+ /** Default value */
+ readonly defval: number;
+ /** Maximum time */
+ readonly max: number;
+ /** Minimum time */
+ readonly min: number;
+}
+/**
+ * A description of a background colorer plot.
+ */
+export interface StudyBgColorerPlotInfo extends StudyPalettedPlotInfo {
+ /** @inheritDoc */
+ readonly type: StudyPlotType.BgColorer;
+}
+export interface StudyBooleanInputInfo extends StudyInputBaseInfo {
+ /** Input type is Boolean */
+ readonly type: StudyInputType.Bool;
+ /** Default value for the input */
+ readonly defval: boolean;
+}
+/**
+ * A description of a border colorer plot.
+ */
+export interface StudyCandleBorderColorerPlotInfo
+ extends StudyPalettedPlotInfo,
+ StudyTargetedPlotInfo {
+ /** @inheritDoc */
+ readonly type: StudyPlotType.CandleBorderColorer;
+}
+/**
+ * A description of a wick colorer plot.
+ */
+export interface StudyCandleWickColorerPlotInfo
+ extends StudyPalettedPlotInfo,
+ StudyTargetedPlotInfo {
+ /** @inheritDoc */
+ readonly type: StudyPlotType.CandleWickColorer;
+}
+/**
+ * A description of a study characters plot.
+ */
+export interface StudyCharsPlotInfo extends StudyPlotBaseInfo {
+ /** @inheritDoc */
+ readonly type: StudyPlotType.Chars;
+}
+export interface StudyCharsPlotPreferences extends StudyPlotBasePreferences {
+ /** Character */
+ char?: string;
+ /** Location for the mark */
+ location: MarkLocation;
+ /** Color */
+ color: string;
+ /** Text color */
+ textColor: string;
+}
+export interface StudyColorInputInfo extends StudyInputBaseInfo {
+ /** Input type is Color */
+ readonly type: StudyInputType.Color;
+ /** Default value for the input */
+ readonly defval: string;
+}
+/**
+ * A description of a colorer plot.
+ */
+export interface StudyColorerPlotInfo
+ extends StudyPalettedPlotInfo,
+ StudyTargetedPlotInfo {
+ /** @inheritDoc */
+ readonly type: StudyPlotType.Colorer;
+}
+/**
+ * A description of a study data offset plot.
+ */
+export interface StudyDataOffsetPlotInfo extends StudyTargetedPlotInfo {
+ /** @inheritDoc */
+ readonly type: StudyPlotType.DataOffset;
+}
+/**
+ * A description of a study data plot.
+ */
+export interface StudyDataPlotInfo extends StudyTargetedPlotInfo {
+ /** @inheritDoc */
+ readonly type: StudyPlotType.Data;
+}
+export interface StudyDefaults {
+ /** Defaults for the area background */
+ areaBackground: StudyBandBackgroundPreferences;
+ /** Defaults for the bands background */
+ bandsBackground: StudyBandBackgroundPreferences;
+ /** Defaults for the bands */
+ bands: readonly Required[];
+ /** Defaults for the filled area styles */
+ filledAreasStyle: MappedObject;
+ /** Defaults for the study inputs */
+ inputs: StudyInputsSimple;
+ /** Defaults for the study palette styles */
+ palettes: MappedObject;
+ /** Default for the study precision */
+ precision: number | string;
+ /** Defaults for the study styles */
+ styles: MappedObject;
+ /** Defaults for the OHLC plots */
+ ohlcPlots: MappedObject;
+ /** Defaults for the study graphics */
+ graphics: StudyGraphicsDefaults;
+}
+/**
+ * A description of a down colorer plot.
+ */
+export interface StudyDownColorerPlotInfo
+ extends StudyPalettedPlotInfo,
+ StudyTargetedPlotInfo {
+ /** @inheritDoc */
+ readonly type: StudyPlotType.DownColorer;
+}
+/**
+ * Description of a study field.
+ * This is used when `includedStudies: true` is defined in `exportData`.
+ */
+export interface StudyFieldDescriptor {
+ /** Type is a `value` */
+ type: 'value';
+ /** Source type is a `study` */
+ sourceType: 'study';
+ /**
+ * The ID of the source study.
+ */
+ sourceId: string;
+ /**
+ * The title of the source study.
+ */
+ sourceTitle: string;
+ /**
+ * The title of the source plot.
+ */
+ plotTitle: string;
+}
+/**
+ * Study filled area gradient styles.
+ */
+export interface StudyFilledAreaGradientColorStyle
+ extends StudyFilledAreaStyleBase {
+ /** Gradient fill type */
+ fillType: 'gradient';
+ /**
+ * Gradient top color.
+ */
+ topColor?: string;
+ /**
+ * Gradient bottom color.
+ */
+ bottomColor?: string;
+ /**
+ * Value at which the top of the gradient is drawn.
+ *
+ * @example 75 // Drawn at price = 75
+ */
+ topValue?: number;
+ /**
+ * Value at which the bottom of the gradient is drawn.
+ *
+ * @example 75 // Drawn at price = 75
+ */
+ bottomValue?: number;
+}
+/**
+ * A description of a study filled area.
+ */
+export interface StudyFilledAreaInfo {
+ /**
+ * Study ID.
+ */
+ readonly id: string;
+ /**
+ * Study band ID.
+ *
+ * @see StudyBandInfo
+ */
+ readonly objAId: string;
+ /**
+ * Study band ID.
+ *
+ * @see StudyBandInfo
+ */
+ readonly objBId: string;
+ /**
+ * Title that will appear in the styles tab of the study settings dialog.
+ */
+ readonly title: string;
+ /**
+ * Filled area type.
+ */
+ readonly type: FilledAreaType;
+ /**
+ * Should gaps in the area be filled?
+ */
+ readonly fillgaps?: boolean;
+ /**
+ * Filled area z-order.
+ */
+ readonly zorder?: number;
+ /**
+ * Filled area's style inputs visibility flag. Used to hide the band from the style tab of study properties dialogs.
+ */
+ readonly isHidden?: boolean;
+ /**
+ * Color palette ID.
+ */
+ readonly palette?: string;
+ /**
+ * Value at which the top of the filled area is drawn.
+ *
+ * @example 75 // Drawn at price = 75
+ */
+ readonly topValue?: number;
+ /**
+ * Value at which the bottom of the filled area is drawn.
+ *
+ * @example 75 // Drawn at price = 75
+ */
+ readonly bottomValue?: number;
+ /**
+ * Color for the top of the filled area.
+ */
+ readonly topColor?: string;
+ /**
+ * Color for the bottom of the filled area.
+ */
+ readonly bottomColor?: string;
+}
+/**
+ * Study solid color filled area style preferences.
+ */
+export interface StudyFilledAreaSolidColorStyle
+ extends StudyFilledAreaStyleBase {
+ /** Solid Fill type */
+ fillType: undefined;
+ /**
+ * Color.
+ *
+ * @example '#ffffff'
+ */
+ color: string;
+}
+/**
+ * Base study filled area style preferences.
+ */
+export interface StudyFilledAreaStyleBase {
+ /**
+ * Filled area's visibility.
+ */
+ visible: boolean;
+ /**
+ * Filled area's transparency.
+ *
+ * @min 0
+ * @max 100
+ */
+ transparency: number;
+}
+export interface StudyGraphicsDefaults {
+ /** Defaults for the horizontal lines study graphics */
+ horizlines?: ValueByStyleId;
+ /** Defaults for the polygon study graphics */
+ polygons?: ValueByStyleId;
+ /** Defaults for the horizontal histogram study graphics */
+ hhists?: ValueByStyleId;
+ /** Defaults for the vertical lines study graphics */
+ vertlines?: ValueByStyleId;
+}
+export interface StudyInputBaseInfo {
+ /** Id for the input */
+ readonly id: string;
+ /** Title of the input */
+ readonly name: string;
+ /** default value of the input variable. It has the specific type for a given input and can be optional. */
+ readonly defval?: StudyInputValue;
+ /** Input type */
+ readonly type: StudyInputType;
+ /** if true, then user will be asked to confirm input value before indicator is added to chart. Default value is false. */
+ readonly confirm?: boolean;
+ /** Is the input hidden */
+ readonly isHidden?: boolean;
+ /** Is the input visible */
+ readonly visible?: string;
+}
+/**
+ * A description of a study input.
+ */
+export interface StudyInputInformation {
+ /**
+ * The input ID.
+ */
+ id: StudyInputId;
+ /**
+ * The input name.
+ */
+ name: string;
+ /**
+ * The input type.
+ */
+ type: string;
+ /**
+ * The localized input name.
+ */
+ localizedName: string;
+}
+export interface StudyInputOptionsTitles {
+ [option: string]: string;
+}
+/**
+ * A description of a study input value.
+ */
+export interface StudyInputValueItem {
+ /**
+ * The input ID.
+ */
+ id: StudyInputId;
+ /**
+ * The input value.
+ */
+ value: StudyInputValue;
+}
+export interface StudyInputsSimple {
+ [inputId: string]: StudyInputValue;
+}
+/**
+ * A description of a study line plot.
+ */
+export interface StudyLinePlotInfo extends StudyPlotBaseInfo {
+ /** @inheritDoc */
+ readonly type: StudyPlotType.Line;
+}
+/**
+ * Study line plot style preferences.
+ */
+export interface StudyLinePlotPreferences extends StudyPlotBasePreferences {
+ /**
+ * Plot style.
+ */
+ plottype: LineStudyPlotStyle;
+ /**
+ * Line color.
+ */
+ color: string;
+ /**
+ * Line style.
+ */
+ linestyle: LineStyle;
+ /**
+ * Line width.
+ */
+ linewidth: number;
+ /**
+ * Price line visibility flag.
+ */
+ trackPrice: boolean;
+ /**
+ * If defined, defines the number of bars to plot on chart.
+ */
+ readonly showLast?: number;
+}
+export interface StudyNumericInputInfo extends StudyInputBaseInfo {
+ /** Input type is Numeric */
+ readonly type:
+ | StudyInputType.Integer
+ | StudyInputType.Float
+ | StudyInputType.Price;
+ /** Default value */
+ readonly defval: number;
+ /** Maximum value */
+ readonly max?: number;
+ /** Minimum value */
+ readonly min?: number;
+ /** Step size for value */
+ readonly step?: number;
+}
+/**
+ * A description of an OHLC colorer plot.
+ */
+export interface StudyOhlcColorerPlotInfo
+ extends StudyPalettedPlotInfo,
+ StudyTargetedPlotInfo {
+ /** @inheritDoc */
+ readonly type: StudyPlotType.OhlcColorer;
+}
+export interface StudyOhlcPlotBarsStylePreferences
+ extends StudyOhlcPlotBaseStylePreferences {
+ /** OHLC Plot type: Bars */
+ plottype: OhlcStudyPlotStyle.OhlcBars;
+}
+export interface StudyOhlcPlotBaseStylePreferences {
+ /** OHLC plot color */
+ color: string;
+ /** Bitmask with values from StudyPlotDisplayTarget */
+ display: StudyPlotDisplayMode;
+ /** Visibility */
+ visible?: boolean;
+}
+export interface StudyOhlcPlotCandlesStylePreferences
+ extends StudyOhlcPlotBaseStylePreferences {
+ /** OHLC Plot Type: Candles */
+ plottype: OhlcStudyPlotStyle.OhlcCandles;
+ /** Whether to draw candle wick */
+ drawWick: boolean;
+ /** Whether to draw candle border */
+ drawBorder: boolean;
+ /** Candle wick color */
+ wickColor: string;
+ /** Candle border color */
+ borderColor: string;
+}
+/**
+ * A description of an OHLC plot.
+ */
+export interface StudyOhlcPlotInfo extends StudyTargetedPlotInfo {
+ /** @inheritDoc */
+ readonly type:
+ | StudyPlotType.OhlcOpen
+ | StudyPlotType.OhlcHigh
+ | StudyPlotType.OhlcLow
+ | StudyPlotType.OhlcClose;
+}
+export interface StudyOhlcStylesInfo {
+ /** Title */
+ readonly title: string;
+ /** Is hidden */
+ readonly isHidden?: boolean;
+ /** Draw border for OHLC candles */
+ readonly drawBorder?: boolean;
+ /** Show last value */
+ readonly showLast?: number;
+}
+/**
+ * Parameter object passed to event callback.
+ */
+export interface StudyOrDrawingAddedToChartEventParams {
+ /**
+ * Name of the added study or drawing.
+ */
+ value: string;
+}
+/**
+ * Study overrides.
+ * See [Studies Overrides](https://www.tradingview.com/charting-library-docs/latest/customization/overrides/Studies-Overrides) to get a list of all possible properties to override.
+ *
+ * @example { 'a.overridable.property': 123 }
+ */
+export interface StudyOverrides {
+ /**
+ * Override values.
+ */
+ [key: string]: StudyOverrideValueType;
+}
+/**
+ * Study palette color.
+ */
+export interface StudyPaletteColor {
+ /**
+ * Palette color.
+ */
+ color: string;
+ /**
+ * Palette style.
+ */
+ style: number;
+ /**
+ * Palette width.
+ */
+ width: number;
+}
+/**
+ * Study palette style preferences.
+ */
+export interface StudyPaletteColorPreferences
+ extends StudyPaletteColor,
+ StudyPaletteInfo {}
+/**
+ * A description of a study palette.
+ */
+export interface StudyPaletteInfo {
+ /**
+ * Palette name.
+ */
+ readonly name: string;
+}
+/**
+ * Study palette style preferences.
+ */
+export interface StudyPalettePreferences {
+ /**
+ * Palette colors.
+ */
+ colors: Record;
+}
+/**
+ * Study palette style.
+ */
+export interface StudyPaletteStyle {
+ /**
+ * Palette colors.
+ */
+ colors: MappedObject | StudyPaletteColor[];
+}
+/**
+ * A description of a study plot with a palette.
+ */
+export interface StudyPalettedPlotInfo extends StudyPlotBaseInfo {
+ /**
+ * A color palette ID.
+ */
+ readonly palette: string;
+}
+/**
+ * A description of a study color palettes.
+ */
+export interface StudyPalettesInfo {
+ /**
+ * Palette colors.
+ */
+ readonly colors: MappedObject | StudyPaletteInfo[];
+ /**
+ * Mapping from values returned by the study to palette color index.
+ */
+ readonly valToIndex?: MappedObject;
+ /**
+ * Use default color for {@link StudyPlotType.Colorer} plots when the value is `NaN`.
+ */
+ readonly addDefaultColor?: boolean;
+}
+/**
+ * Base type for all study plot descriptions.
+ */
+export interface StudyPlotBaseInfo {
+ /**
+ * Plot ID.
+ */
+ readonly id: string;
+ /**
+ * Plot type.
+ */
+ readonly type: string;
+}
+/**
+ * Base type for all study plot style preferences.
+ */
+export interface StudyPlotBasePreferences {
+ /**
+ * Transparency. A number between 1 and 100.
+ *
+ * @example 80
+ */
+ transparency: number;
+ /**
+ * Display mode. See {@link StudyPlotDisplayMode}.
+ *
+ * @example StudyPlotDisplayTarget.None // Do not display the plot.
+ */
+ display: StudyPlotDisplayMode;
+ /** Visibility */
+ visible?: boolean;
+}
+export interface StudyPlotValueInheritFormat {
+ /** Plot value type */
+ type: 'inherit';
+}
+export interface StudyPlotValuePrecisionFormat {
+ /** Plot value type */
+ type: 'price' | 'volume' | 'percent';
+ /** Plot Value Precision */
+ precision?: number;
+}
+export interface StudyPriceInputInfo extends StudyInputBaseInfo {
+ /** Input type is Price */
+ readonly type: StudyInputType.Price;
+ /** Default value */
+ readonly defval: number;
+ /** Maximum value */
+ readonly max?: number;
+ /** Minimum value */
+ readonly min?: number;
+ /** Step size for value */
+ readonly step?: number;
+}
+export interface StudyResolutionInputInfo extends StudyInputBaseInfo {
+ /** Input type is Resolution */
+ readonly type: StudyInputType.Resolution;
+ /** Default value */
+ readonly defval: ResolutionString;
+ /** Source Input Options */
+ readonly options?: string[];
+ /** Options for Input Titles */
+ readonly optionsTitles?: StudyInputOptionsTitles;
+ /** Is Monday to Friday Resolution */
+ readonly isMTFResolution?: boolean;
+}
+export interface StudyResultValueWithOffset {
+ /**
+ * Value which will be offset
+ */
+ value: number;
+ /**
+ * Allows you to override the offset of every plot (note that offset of a certain plot should always be the same)
+ */
+ offset: number;
+}
+/**
+ * A description of a RGBA colorer plot.
+ */
+export interface StudyRgbaColorerPlotInfo extends StudyTargetedPlotInfo {
+ /** @inheritDoc */
+ readonly type: StudyPlotType.Colorer;
+}
+export interface StudySessionInputInfo extends StudyInputBaseInfo {
+ /** Input type is Session */
+ readonly type: StudyInputType.Session;
+ /** Default value */
+ readonly defval: string;
+ /** Source Input Options */
+ readonly options?: string[];
+ /** Options for Input Titles */
+ readonly optionsTitles?: StudyInputOptionsTitles;
+}
+/**
+ * A description of a study shapes plot.
+ */
+export interface StudyShapesPlotInfo extends StudyPlotBaseInfo {
+ /** @inheritDoc */
+ readonly type: StudyPlotType.Shapes;
+}
+/**
+ * Study shape plot style preferences.
+ */
+export interface StudyShapesPlotPreferences extends StudyPlotBasePreferences {
+ /**
+ * Plot type.
+ */
+ plottype: PlotShapeId;
+ /**
+ * Location relative to the bar.
+ */
+ location: MarkLocation;
+ /**
+ * Color.
+ */
+ color: string;
+ /**
+ * Text color.
+ */
+ textColor: string;
+}
+export interface StudySourceInputInfo extends StudyInputBaseInfo {
+ /** Input type is Source */
+ readonly type: StudyInputType.Source;
+ /** Default value */
+ readonly defval: StudyAvailableConstSources | string;
+ /** Source Input Options */
+ readonly options?: (StudyAvailableConstSources | string)[];
+ /** Options for Input Titles */
+ readonly optionsTitles?: StudyInputOptionsTitles;
+}
+/**
+ * Study style description.
+ */
+export interface StudyStyleInfo {
+ /**
+ * Default study description values.
+ */
+ defaults?: StudyStyleInfoDefaults;
+ /**
+ * Study plot descriptions.
+ */
+ plots?: readonly Readonly[];
+ /**
+ * Study plot style descriptions. An object with `plot id` as keys and style info as values
+ */
+ styles?: Record | undefined>;
+ /**
+ * Study band descriptions.
+ */
+ bands?: readonly Readonly[];
+ /**
+ * Study filled area descriptions. Filled area is a special object, which allows coloring an area between two plots.
+ */
+ filledAreas?: readonly Readonly[];
+ /**
+ * Study color palettes descriptions.
+ */
+ palettes?: Record