fejn-kline
Version:
kline chart
1,665 lines (1,662 loc) • 549 kB
text/typescript
import { Options as Options$2, Chart as Chart$2 } from 'klinecharts';
export { dispose as simpleDispose } from 'klinecharts';
import { T as Theme } from './shared/fejn-kline.D_0RGm2f.cjs';
type Options$1 = Options$2 & {
theme?: Theme;
showMa?: boolean;
showVol?: boolean;
};
type Chart$1 = (Chart$2 & {
$updateTooltip: () => void;
$setTheme: (theme: Theme) => void;
$screenshot: () => void;
$setGraph: (shape: number) => void;
$addDefaultMa: () => void;
$addVol: () => void;
}) | null;
declare function initChart(el: HTMLElement | string, options: Options$1): Chart$1;
/**
* 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 PlotSymbolSize {
Auto = "auto",
Tiny = "tiny",
Small = "small",
Normal = "normal",
Large = "large",
Huge = "huge"
}
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"
}
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.
*/
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
}
/**
* Filled area type.
*/
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.
*/
declare const enum MarketStatus {
Open = "market",
Pre = "pre_market",
Post = "post_market",
Close = "out_of_session",
Holiday = "holiday"
}
declare const enum MenuItemType {
Separator = "separator",
Action = "action"
}
declare const enum OhlcStudyPlotStyle {
OhlcBars = "ohlc_bars",
OhlcCandles = "ohlc_candles"
}
/**
* Plot line style
*/
declare const enum OverrideLineStyle {
/**
* Solid line style.
*/
Solid = 0,
/**
* Dotted line style.
*/
Dotted = 1,
/**
* Dashed line style.
*/
Dashed = 2
}
/**
* Last value label mode.
*/
declare const enum OverridePriceAxisLastValueMode {
/**
* Price and % value.
*/
LastPriceAndPercentageValue = 0,
/**
* Value according to scale.
*/
LastValueAccordingToScale = 1
}
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
}
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
}
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"
}
declare const enum StudyPlotDisplayTarget {
None = 0,
Pane = 1,
DataWindow = 2,
PriceScale = 4,
StatusLine = 8,
All = 15
}
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"
}
declare const enum StudyTargetPriceScale {
Right = 0,
Left = 1,
NoScale = 2
}
declare const enum TimeFrameType {
PeriodBack = "period-back",
TimeRange = "time-range"
}
declare const enum TimeHoursFormat {
TwentyFourHours = "24-hours",
TwelveHours = "12-hours"
}
declare const enum VisibilityType {
AlwaysOn = "alwaysOn",
VisibleOnMouseOver = "visibleOnMouseOver",
AlwaysOff = "alwaysOff"
}
/**
* 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<number, 'Index'>;
* // let i: Index = 42; // this fails to compile
* let i: Index = 42 as Index; // OK
* @example
* type TagName = Nominal<string, 'TagName'>;
*/
declare type Nominal<T, Name extends string> = T & { /* eslint-disable-next-line jsdoc/require-jsdoc */
[Symbol.species]: Name;
};
/**
* Override properties for the Abcd drawing tool.
*/
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: `1` */
"linetoolabcd.linewidth": number;
/** Default value: `#ffffff` */
"linetoolabcd.textcolor": string;
}
/**
* Defines a whitelist / blacklist of studies or drawing tools.
*/
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[];
}
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;
}
interface ActionOptions extends Partial<Omit<ActionState, "actionId">>, Pick<ActionState, "actionId"> {
/**
* A function which will be called when an action should be executed (e.g. when a user clicks on the item).
*/
onExecute?: OnActionExecuteHandler;
}
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;
}
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<ActionOptions>) => IUpdatableAction;
/**
* Creates a separator item.
*/
createSeparator: () => ISeparator;
}
/**
* custom symbol info fields to be shown in the Symbol Info dialog
*/
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.
*/
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.
*/
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: `1` */
"linetoolarc.linewidth": number;
/** Default value: `80` */
"linetoolarc.transparency": number;
}
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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
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;
}
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.
*/
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
*/
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;
}
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.
*/
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;
}
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.
*/
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: `1` */
"linetoolbeziercubic.linewidth": number;
/** Default value: `0` */
"linetoolbeziercubic.rightEnd": number;
/** Default value: `80` */
"linetoolbeziercubic.transparency": number;
}
/**
* Override properties for the Bezierquadro drawing tool.
*/
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: `1` */
"linetoolbezierquadro.linewidth": number;
/** Default value: `0` */
"linetoolbezierquadro.rightEnd": number;
/** Default value: `50` */
"linetoolbezierquadro.transparency": number;
}
/**
* Override properties for the Brush drawing tool.
*/
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: `1` */
"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.
*/
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: `1` */
"linetoolcallout.linewidth": number;
/** Default value: `50` */
"linetoolcallout.transparency": number;
/** Default value: `false` */
"linetoolcallout.wordWrap": boolean;
/** Default value: `200` */
"linetoolcallout.wordWrapWidth": number;
}
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;
}
interface ChangeThemeOptions {
/** Disable undo for the theme change */
disableUndo: boolean;
}
/**
* Saved chart data
*/
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
*/
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}.
*/
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;
/**
* Scales (axis) highlight color.
*
* @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 tr