Skip to main content

Module: Charting Library

TradingView Advanced Charts

Enumerations​

Interfaces​

Type Aliases​

AccountId​

AccountId: Nominal<string, "AccountID">

AccountManagerColumn​

AccountManagerColumn<TPossibleFields>: { [TFormatterName in StandardFormatterName | FormatterName]: AccountManagerColumnBase<TFormatterName, TPossibleFields> }[StandardFormatterName | FormatterName]

Type parameters​

NameType
TPossibleFieldsextends string = string

ActionMetaInfo​

ActionMetaInfo: ActionDescriptionWithCallback | MenuSeparator

Describes a single action to put it into a dropdown or a context menu.

AskBid​

AskBid: Required<Pick<TradingQuotes, "ask" | "bid">>

The Ask and Bid quotes.

AvailableSaveloadVersions​

AvailableSaveloadVersions: "1.0" | "1.1"

BrokerDebugMode​

BrokerDebugMode: "all" | "normal" | "host-only" | "broker-only"

Sets the debug level for TradingTerminalWidgetOptions.debug_broker.

  • host-only: logs only messages related to the IBrokerConnectionAdapterHost interface.
  • broker-only: logs only messages related to the IBrokerTerminal interface.
  • normal: logs messages for the broker and host but excludes frequently called methods, such as connectionStatus.
  • all: logs all possible debug messages.

CellAlignment​

CellAlignment: "left" | "right"

ChartActionId​

ChartActionId: "addPlusButton" | "chartProperties" | "compareOrAdd" | "scalesProperties" | "paneObjectTree" | "insertIndicator" | "symbolSearch" | "changeInterval" | "timeScaleReset" | "chartReset" | "seriesHide" | "studyHide" | "lineToggleLock" | "lineHide" | "scaleSeriesOnly" | "drawingToolbarAction" | "stayInDrawingModeAction" | "hideAllMarks" | "showCountdown" | "showSeriesLastValue" | "showSymbolLabelsAction" | "showStudyLastValue" | "showStudyPlotNamesAction" | "undo" | "redo" | "paneRemoveAllStudiesDrawingTools" | "showSymbolInfoDialog"

A chart action ID.

ChartDescriptorFunction​

ChartDescriptorFunction: (context: ChartDescriptionContext) => Promise<string | null>

Function to provide a description of the chart described by the context data

Parameters​
NameType
contextChartDescriptionContext
Returns​

Promise<string | null>

ChartTypeFavorites​

ChartTypeFavorites: "Area" | "Bars" | "Candles" | "Heiken Ashi" | "Hollow Candles" | "Line" | "Line Break" | "Baseline" | "LineWithMarkers" | "Stepline" | "Columns" | "High-low"

Chart type names for use within the favorites Widget Constructor option. This type is for Advanced Charts, if you are looking for the Trading Platform type then please see TradingTerminalChartTypeFavorites.

See Favorites for the Widget Constructor option where you can define these favorites, and ChartingLibraryWidgetOptions.favorites for the Widget Constructor option.

ChartingLibraryFeatureset​

ChartingLibraryFeatureset: "use_localstorage_for_settings" | "items_favoriting" | "save_chart_properties_to_local_storage" | "create_volume_indicator_by_default" | "create_volume_indicator_by_default_once" | "volume_force_overlay" | "right_bar_stays_on_scroll" | "constraint_dialogs_movement" | "charting_library_debug_mode" | "side_toolbar_in_fullscreen_mode" | "header_in_fullscreen_mode" | "disable_resolution_rebuild" | "chart_scroll" | "chart_zoom" | "horz_touch_drag_scroll" | "vert_touch_drag_scroll" | "mouse_wheel_scroll" | "pressed_mouse_move_scroll" | "mouse_wheel_scale" | "pinch_scale" | "axis_pressed_mouse_move_scale" | "low_density_bars" | "uppercase_instrument_names" | "no_min_chart_width" | "fix_left_edge" | "lock_visible_time_range_on_resize" | "shift_visible_range_on_new_bar" | "custom_resolutions" | "end_of_period_timescale_marks" | "cropped_tick_marks" | "study_overlay_compare_legend_option" | "study_symbol_ticker_description" | "auto_enable_symbol_labels" | "insert_indicator_dialog_shortcut" | "two_character_bar_marks_labels" | "pin_bar_mark_tooltips_on_click" | "confirm_overwrite_if_chart_layout_with_name_exists" | "determine_first_data_request_size_using_visible_range" | "move_logo_to_main_pane" | "study_templates" | "datasource_copypaste" | "seconds_resolution" | "tick_resolution" | "secondary_series_extend_time_scale" | "header_widget" | "header_symbol_search" | "symbol_search_hot_key" | "allow_arbitrary_symbol_search_input" | "header_resolutions" | "show_interval_dialog_on_key_press" | "header_chart_type" | "header_settings" | "header_indicators" | "header_compare" | "header_undo_redo" | "header_quick_search" | "header_screenshot" | "header_fullscreen_button" | "border_around_the_chart" | "header_saveload" | "left_toolbar" | "control_bar" | "timeframes_toolbar" | "legend_widget" | "display_legend_on_all_charts" | "object_tree_legend_mode" | "edit_buttons_in_legend" | "show_hide_button_in_legend" | "format_button_in_legend" | "delete_button_in_legend" | "context_menus" | "pane_context_menu" | "scales_context_menu" | "legend_context_menu" | "main_series_scale_menu" | "display_market_status" | "remove_library_container_border" | "property_pages" | "show_chart_property_page" | "chart_property_page_scales" | "chart_property_page_trading" | "chart_property_page_right_margin_editor" | "countdown" | "dont_show_boolean_study_arguments" | "hide_last_na_study_output" | "symbol_info" | "timezone_menu" | "snapshot_trading_drawings" | "source_selection_markers" | "go_to_date" | "adaptive_logo" | "show_dom_first_time" | "hide_left_toolbar_by_default" | "chart_style_hilo" | "chart_style_hilo_last_price" | "pricescale_currency" | "pricescale_unit" | "scales_date_format" | "popup_hints" | "save_shortcut" | "show_right_widgets_panel_by_default" | "show_object_tree" | "show_spread_operators" | "hide_exponentiation_spread_operator" | "hide_reciprocal_spread_operator" | "compare_symbol_search_spread_operators" | "studies_symbol_search_spread_operators" | "hide_resolution_in_legend" | "hide_unresolved_symbols_in_legend" | "show_zoom_and_move_buttons_on_touch" | "hide_main_series_symbol_from_indicator_legend" | "hide_price_scale_global_last_bar_value" | "show_average_close_price_line_and_label" | "hide_image_invalid_symbol" | "hide_object_tree_and_price_scale_exchange_label" | "scales_time_hours_format" | "use_na_string_for_not_available_values" | "pre_post_market_sessions" | "show_percent_option_for_right_margin" | "lock_visible_time_range_when_adjusting_percentage_right_margin" | "iframe_loading_compatibility_mode" | "use_last_visible_bar_value_in_legend" | "symbol_info_long_description" | "symbol_info_price_source" | "chart_template_storage" | "request_only_visible_range_on_reset" | "clear_price_scale_on_error_or_empty_bars" | "legend_inplace_edit" | "disable_legend_inplace_resolution_change" | "disable_legend_inplace_symbol_change" | "show_symbol_logos" | "show_exchange_logos" | "show_symbol_logo_in_legend" | "show_symbol_logo_for_compare_studies" | "always_show_legend_values_on_mobile" | "studies_extend_time_scale" | "accessible_keyboard_shortcuts" | "aria_detailed_chart_descriptions" | "aria_crosshair_price_description" | "saveload_separate_drawings_storage" | "disable_pulse_animation" | "iframe_loading_same_origin" | "library_custom_color_themes" | "use_symbol_name_for_header_toolbar" | "inactivity_gaps" | "long_press_floating_tooltip" | "legend_bar_change_colors_based_on_value" | "chart_drag_export" | "always_show_study_symbol_input_values_in_legend"

This is the list of all featuresets that work in Advanced Charts

ColorGradient​

ColorGradient: [lightness50: string, lightness100: string, lightness150: string, lightness200: string, lightness250: string, lightness300: string, lightness350: string, lightness400: string, lightness450: string, lightness500: string, lightness550: string, lightness600: string, lightness650: string, lightness700: string, lightness750: string, lightness800: string, lightness850: string, lightness900: string, lightness950: string]

A color gradient from lightest to darkest to override one of the default color theme colors.

ColorTypes​

ColorTypes: "solid" | "gradient"

These are defining the types for a background

ColumnStyleBaselinePosition​

ColumnStyleBaselinePosition: "bottom" | "zero"

Determines the baseline position for column series, either at the bottom of the pane or aligned with the price scale's zero value.

ConfirmDialogParams​

ConfirmDialogParams: Omit<DialogParams<(confirmed: boolean) => void>, "callback">

ContextMenuItemsProcessor​

ContextMenuItemsProcessor: (items: readonly IActionVariant[], actionsFactory: ActionsFactory, params: CreateContextMenuParams) => Promise<readonly IActionVariant[]>

Context menu items processor signature

Parameters​
NameTypeDescription
itemsreadonly IActionVariant[]an array of items the library wants to display
actionsFactoryActionsFactoryfactory you could use to create a new items for the context menu.
paramsCreateContextMenuParamsan object representing additional information about the context menu, such as the menu name.
Returns​

Promise<readonly IActionVariant[]>

ContextMenuRendererFactory​

ContextMenuRendererFactory: (items: readonly IActionVariant[], params: CreateContextMenuParams, onDestroy: () => void) => Promise<IContextMenuRenderer | null>

Parameters​
NameTypeDescription
itemsreadonly IActionVariant[]an array of items the library wants to display
paramsCreateContextMenuParamsan object representing where the user right-clicked on (only if there is an existing menu)
onDestroy() => voidfunction that you should call once a created menu is hidden/destroyed
Returns​

Promise<IContextMenuRenderer | null>

  • promise for a renderer or null. If the promise resolves with null, default chart menu is used

CreateButtonOptions​

CreateButtonOptions: CreateHTMLButtonOptions | CreateTradingViewStyledButtonOptions

CustomStudyFormatter​

CustomStudyFormatter: Omit<INumberFormatter, "parse">

CustomStudyFormatterFactory​

CustomStudyFormatterFactory: (format: CustomStudyFormatterFormat, symbolInfo: LibrarySymbolInfo | null, precision: string | undefined) => CustomStudyFormatter | null

Factory function that can be implemented to create custom study formatters.

Parameters​
NameType
formatCustomStudyFormatterFormat
symbolInfoLibrarySymbolInfo | null
precisionstring | undefined
Returns​

CustomStudyFormatter | null

CustomTableFormatElementFunction​

CustomTableFormatElementFunction<T>: (inputs: TableFormatterInputs<T>) => undefined | string | HTMLElement

Type parameters​

NameType
Textends TableFormatterInputValues = TableFormatterInputValues

A function that takes an TableFormatterInputs object and returns a string or an HTMLElement.

Parameters​
NameType
inputsTableFormatterInputs<T>
Returns​

undefined | string | HTMLElement

CustomTimezoneId​

CustomTimezoneId: Nominal<"CustomTimezoneId", string>

Identifier for a custom timezone (string).

CustomTimezones​

CustomTimezones: "Africa/Cairo" | "Africa/Casablanca" | "Africa/Johannesburg" | "Africa/Lagos" | "Africa/Nairobi" | "Africa/Tunis" | "America/Anchorage" | "America/Argentina/Buenos_Aires" | "America/Bogota" | "America/Caracas" | "America/Chicago" | "America/El_Salvador" | "America/Halifax" | "America/Juneau" | "America/Lima" | "America/Los_Angeles" | "America/Mexico_City" | "America/New_York" | "America/Phoenix" | "America/Santiago" | "America/Sao_Paulo" | "America/Toronto" | "America/Vancouver" | "Asia/Almaty" | "Asia/Ashkhabad" | "Asia/Bahrain" | "Asia/Bangkok" | "Asia/Chongqing" | "Asia/Colombo" | "Asia/Dhaka" | "Asia/Dubai" | "Asia/Ho_Chi_Minh" | "Asia/Hong_Kong" | "Asia/Jakarta" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Karachi" | "Asia/Kathmandu" | "Asia/Kolkata" | "Asia/Kuala_Lumpur" | "Asia/Kuwait" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Qatar" | "Asia/Riyadh" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Taipei" | "Asia/Tehran" | "Asia/Tokyo" | "Asia/Yangon" | "Atlantic/Azores" | "Atlantic/Reykjavik" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Perth" | "Australia/Sydney" | "Europe/Amsterdam" | "Europe/Athens" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Helsinki" | "Europe/Istanbul" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Moscow" | "Europe/Oslo" | "Europe/Paris" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zurich" | "Pacific/Auckland" | "Pacific/Chatham" | "Pacific/Fakaofo" | "Pacific/Honolulu" | "Pacific/Norfolk" | "US/Mountain"

CustomTranslateFunction​

CustomTranslateFunction: (originalText: string, singularOriginalText: string, translatedText?: string) => string | null

Custom translation function

Parameters​
NameTypeDescription
originalTextstringoriginal raw text taking into account pluralization rules
singularOriginalTextstringoriginalText in singular
translatedText?stringtranslated originalText
Returns​

string | null

DOMCallback​

DOMCallback: (data: DOMData) => void

Parameters​
NameType
dataDOMData

DatafeedErrorCallback​

DatafeedErrorCallback: (reason: string) => void

Parameters​
NameType
reasonstring

DateFormat​

DateFormat: "qq 'yy" | "qq yyyy" | "dd MMM 'yy" | "MMM 'yy" | "MMM dd, yyyy" | "MMM d, yyyy" | "MMM yyyy" | "MMM dd" | "dd MMM" | "yyyy-MM-dd" | "yy-MM-dd" | "yy/MM/dd" | "yyyy/MM/dd" | "dd-MM-yyyy" | "dd-MM-yy" | "dd/MM/yy" | "dd/MM/yyyy" | "MM/dd/yy" | "MM/dd/yyyy"

DeepPartial​

DeepPartial<T>: { [P in keyof T]?: T[P] extends (infer U)[] ? DeepPartial<U>[] : T[P] extends readonly (infer X)[] ? readonly DeepPartial<X>[] : DeepPartial<T[P]> }

Type parameters​

Name
T

DeepWriteable​

DeepWriteable<T>: { -readonly [P in keyof T]: DeepWriteable<T[P]> }

Type parameters​

Name
T

Direction​

Direction: "buy" | "sell"

The direction of an execution line. Either buy or sell.

DisplayOption​

DisplayOption: "all" | "data_window" | "none"

DrawingEventType​

DrawingEventType: "click" | "move" | "remove" | "hide" | "show" | "create" | "properties_changed" | "points_changed"

A event related to a drawing.

  • Note that the properties_changed event can be emitted before create event, and that the event isn't debounced (for example dragging a slider for a property will result in this event firing for each movement on the slider), you may want to debounce this within your code.
  • The move event is emitted when a drawing is moved as a whole, whilst the points_changed event is emitted when a single point of the drawing is moved. points_changed will always fire when move fires but not vice-versa.

DrawingOverrides​

DrawingOverrides: FivepointspatternLineToolOverrides | AbcdLineToolOverrides | AnchoredvpLineToolOverrides | AnchoredvwapLineToolOverrides | ArcLineToolOverrides | ArrowLineToolOverrides | ArrowmarkdownLineToolOverrides | ArrowmarkerLineToolOverrides | ArrowmarkleftLineToolOverrides | ArrowmarkrightLineToolOverrides | ArrowmarkupLineToolOverrides | BalloonLineToolOverrides | BarspatternLineToolOverrides | BeziercubicLineToolOverrides | BezierquadroLineToolOverrides | BrushLineToolOverrides | CalloutLineToolOverrides | CircleLineToolOverrides | CommentLineToolOverrides | CrosslineLineToolOverrides | CypherpatternLineToolOverrides | DateandpricerangeLineToolOverrides | DaterangeLineToolOverrides | DisjointangleLineToolOverrides | ElliottcorrectionLineToolOverrides | ElliottdoublecomboLineToolOverrides | ElliottimpulseLineToolOverrides | ElliotttriangleLineToolOverrides | ElliotttriplecomboLineToolOverrides | EllipseLineToolOverrides | EmojiLineToolOverrides | ExecutionLineToolOverrides | ExtendedLineToolOverrides | FibchannelLineToolOverrides | FibcirclesLineToolOverrides | FibretracementLineToolOverrides | FibspeedresistancearcsLineToolOverrides | FibspeedresistancefanLineToolOverrides | FibtimezoneLineToolOverrides | FibwedgeLineToolOverrides | FlagmarkLineToolOverrides | FlatbottomLineToolOverrides | GanncomplexLineToolOverrides | GannfanLineToolOverrides | GannfixedLineToolOverrides | GannsquareLineToolOverrides | GhostfeedLineToolOverrides | HeadandshouldersLineToolOverrides | HighlighterLineToolOverrides | HorzlineLineToolOverrides | HorzrayLineToolOverrides | IconLineToolOverrides | ImageLineToolOverrides | InfolineLineToolOverrides | InsidepitchforkLineToolOverrides | OrderLineToolOverrides | ParallelchannelLineToolOverrides | PathLineToolOverrides | PitchfanLineToolOverrides | PitchforkLineToolOverrides | PolylineLineToolOverrides | PositionLineToolOverrides | PredictionLineToolOverrides | PricelabelLineToolOverrides | ProjectionLineToolOverrides | RayLineToolOverrides | RegressiontrendLineToolOverrides | RiskrewardlongLineToolOverrides | RiskrewardshortLineToolOverrides | RotatedrectangleLineToolOverrides | SchiffpitchforkLineToolOverrides | Schiffpitchfork2LineToolOverrides | SignpostLineToolOverrides | SinelineLineToolOverrides | StickerLineToolOverrides | TextLineToolOverrides | TextabsoluteLineToolOverrides | ThreedriversLineToolOverrides | TimecyclesLineToolOverrides | TrendangleLineToolOverrides | TrendbasedfibextensionLineToolOverrides | TrendbasedfibtimeLineToolOverrides | TrendlineLineToolOverrides | TriangleLineToolOverrides | TrianglepatternLineToolOverrides | VertlineLineToolOverrides

Override properties for drawings. Refer to the Drawing Overrides article for information on how to customize drawings.

The following constants are used within the default properties. You cannot use these names directly.

  • LINESTYLE
    • SOLID = 0
    • DOTTED = 1
    • DASHED = 2
    • LARGE_DASHED = 3
  • LINEEND
    • NORMAL = 0
    • ARROW = 1
    • CIRCLE = 2
  • MODE
    • BARS = 0
    • LINE = 1
    • OPENCLOSE = 2;
    • LINEOPEN = 3;
    • LINEHIGH = 4;
    • LINELOW = 5;
    • LINEHL2 = 6;
  • PITCHFORK_STYLE
    • ORIGINAL = 0
    • SCHIFF = 1
    • SCHIFF2 = 2
    • INSIDE = 3
  • STATS_POSITION
    • LEFT = 0
    • CENTER = 1
    • RIGHT = 2
  • RISK_DISPLAY_MODE
    • PERCENTAGE = 'percents'
    • MONEY = 'money'

DrawingToolIdentifier​

DrawingToolIdentifier: "arrow" | "cursor" | "dot" | "eraser" | "LineTool5PointsPattern" | "LineToolABCD" | "LineToolArc" | "LineToolArrow" | "LineToolArrowMarkDown" | "LineToolArrowMarker" | "LineToolArrowMarkLeft" | "LineToolArrowMarkRight" | "LineToolArrowMarkUp" | "LineToolBarsPattern" | "LineToolBezierCubic" | "LineToolBezierQuadro" | "LineToolBrush" | "LineToolCallout" | "LineToolCircle" | "LineToolCircleLines" | "LineToolComment" | "LineToolCrossLine" | "LineToolCypherPattern" | "LineToolDateAndPriceRange" | "LineToolDateRange" | "LineToolDisjointAngle" | "LineToolElliottCorrection" | "LineToolElliottDoubleCombo" | "LineToolElliottImpulse" | "LineToolElliottTriangle" | "LineToolElliottTripleCombo" | "LineToolEllipse" | "LineToolExtended" | "LineToolFibChannel" | "LineToolFibCircles" | "LineToolFibRetracement" | "LineToolFibSpeedResistanceArcs" | "LineToolFibSpeedResistanceFan" | "LineToolFibSpiral" | "LineToolFibTimeZone" | "LineToolFibWedge" | "LineToolFixedRangeVolumeProfile" | "LineToolFlagMark" | "LineToolFlatBottom" | "LineToolGannComplex" | "LineToolGannFan" | "LineToolGannFixed" | "LineToolGannSquare" | "LineToolGhostFeed" | "LineToolHeadAndShoulders" | "LineToolHighlighter" | "LineToolHorzLine" | "LineToolHorzRay" | "LineToolInfoLine" | "LineToolInsidePitchfork" | "LineToolNote" | "LineToolNoteAbsolute" | "LineToolParallelChannel" | "LineToolPath" | "LineToolPitchfan" | "LineToolPitchfork" | "LineToolPolyline" | "LineToolPrediction" | "LineToolPriceLabel" | "LineToolTextNote" | "LineToolPriceRange" | "LineToolPriceRange" | "LineToolProjection" | "LineToolRay" | "LineToolRectangle" | "LineToolRegressionTrend" | "LineToolRiskRewardLong" | "LineToolRiskRewardShort" | "LineToolRotatedRectangle" | "LineToolSchiffPitchfork" | "LineToolSchiffPitchfork2" | "LineToolSignpost" | "LineToolSineLine" | "LineToolText" | "LineToolTextAbsolute" | "LineToolThreeDrivers" | "LineToolTimeCycles" | "LineToolTrendAngle" | "LineToolTrendBasedFibExtension" | "LineToolTrendBasedFibTime" | "LineToolTrendLine" | "LineToolTriangle" | "LineToolTrianglePattern" | "LineToolVertLine"

DropdownUpdateParams: Partial<Omit<DropdownParams, "align">>

Dropdown options which can be adjusted on an existing menu.

EditObjectDialogObjectType​

EditObjectDialogObjectType: "mainSeries" | "drawing" | "study" | "other"

EmptyCallback​

EmptyCallback: () => void

EntityId​

EntityId: Nominal<string, "EntityId">

FieldDescriptor​

FieldDescriptor: TimeFieldDescriptor | UserTimeFieldDescriptor | SeriesFieldDescriptor | StudyFieldDescriptor

Description of each field of exported data from the chart

FieldRef​

FieldRef<T>: T | [T, ...string[]]

Type parameters​

NameType
Textends string = string

FillOptions​

FillOptions: SolidFillOptions | GradientFillOptions

FinancialPeriod​

FinancialPeriod: "FY" | "FQ" | "FH" | "TTM" | "NFY" | "NFQ" | "NFH" | "N4FQ" | "N4FY" | "N4FH" | "NTM"

FinancialPeriodOrAggregated​

FinancialPeriodOrAggregated: FinancialPeriod | "AGG" | "NOAGG"

FormatterName​

FormatterName: Nominal<string, "FormatterName">

GetMarksCallback​

GetMarksCallback<T>: (marks: T[]) => void

Type parameters​

Name
T
Parameters​
NameType
marksT[]

GetNewsFunction​

GetNewsFunction: (symbol: string, callback: (response: GetNewsResponse) => void) => void

Parameters​
NameType
symbolstring
callback(response: GetNewsResponse) => void

GmtTimezoneId​

GmtTimezoneId: `Etc/GMT${"+" | "-"}${number}${`:${number}` | ""}`

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).

GroupLockState​

GroupLockState: "Locked" | "Unlocked" | "Partial"

GroupVisibilityState​

GroupVisibilityState: "Visible" | "Invisible" | "Partial"

HeaderWidgetButtonsMode​

HeaderWidgetButtonsMode: "fullsize" | "compact" | "adaptive"

Mode can be of the following:

  • fullsize: always full-size buttons on the top toolbar
  • adaptive: adaptive/auto mode (fullsize if the window width allows and icons on small windows).
  • compact: icons only buttons on the top toolbar (favorites won't be shown)

HistoryCallback​

HistoryCallback: (bars: Bar[], meta?: HistoryMetadata) => void

Parameters​
NameType
barsBar[]
meta?HistoryMetadata

IActionVariant​

IActionVariant: IAction | ISeparator

Item variants within a context menu

IBarArray​

IBarArray: [number, number, number, number, number, number]

IBasicDataFeed​

IBasicDataFeed: IDatafeedChartApi & IExternalDatafeed

IPineStudyResult​

IPineStudyResult: IPineStudyResultTypes<IPineStudyResultSimple>

IPineStudyResultSimple​

IPineStudyResultSimple: StudyPrimitiveResult | ISeriesStudyResult | INonSeriesStudyBarsResult | IProjectionStudyResult | INonSeriesStudyResult

IPineStudyResultTypes​

IPineStudyResultTypes<TPineStudyResultSimple>: TPineStudyResultSimple | PineStudyResultComposite<TPineStudyResultSimple>

Type parameters​

Name
TPineStudyResultSimple

IProjectionBar​

IProjectionBar: [number, number, number, number, number, number] | [number, number, number, number, number, number, number]

ISeriesStudyResult​

ISeriesStudyResult: [time: number, open: number, high: number, low: number, close: number, volume: number, updatetime: number | undefined, isBarClosed: boolean | undefined, emptyBars: number[] | undefined, emptyBarsPrice: number | undefined]

An array of bar values.

[time, open, high, low, close, volume, updatetime, isBarClosed, emptyBars, emptyBarsPrice]

InputFieldValidator​

InputFieldValidator: (value: any) => InputFieldValidatorResult

Input field validator

Parameters​
NameTypeDescription
valueanyvalue to be validated
Returns​

InputFieldValidatorResult

InputFieldValidatorResult​

InputFieldValidatorResult: PositiveBaseInputFieldValidatorResult | NegativeBaseInputFieldValidatorResult

LanguageCode​

LanguageCode: "ar" | "zh" | "ca_ES" | "en" | "fr" | "de" | "he_IL" | "id_ID" | "it" | "ja" | "ko" | "pl" | "pt" | "ru" | "es" | "sv" | "th" | "tr" | "vi" | "ms_MY" | "zh_TW"

LayoutSizes​

LayoutSizes: Record<LayoutType, LayoutSizesState>

LayoutSizesState​

LayoutSizesState: SubLayoutSizesState[]

LayoutType​

LayoutType: SingleChartLayoutType | MultipleChartsLayoutType

LegendMode​

LegendMode: "horizontal" | "vertical"

LibrarySessionId​

LibrarySessionId: "regular" | "extended" | "premarket" | "postmarket" | "24h" | "night"

LineStudyPlotStyleName​

LineStudyPlotStyleName: "line" | "histogram" | "cross" | "area" | "columns" | "circles" | "line_with_breaks" | "area_with_breaks" | "step_line" | "step_line_with_breaks" | "step_line_with_diamonds"

Plot Style. Used for plottype properties within Indicator overrides.

LineToolsAndGroupsLoadRequestType​

LineToolsAndGroupsLoadRequestType: "allLineTools" | "lineToolsWithoutSymbol" | "studiesLineTools" | "mainSeriesLineTools"

The type of data being requested from the IExternalSaveLoadAdapter.loadLineToolsAndGroups method.

Usually, the 'mainSeriesLineTools' is the requested type that is important for implementing the restoration of drawings associated with a chart.

MarkConstColors​

MarkConstColors: "red" | "green" | "blue" | "yellow"

MarkupText​

MarkupText: (string | HyperlinkInfo)[]

MultipleChartsLayoutType​

MultipleChartsLayoutType: "2h" | "2v" | "3h" | "3v" | "3s" | "3r" | "2-1" | "1-2" | "4" | "4v" | "4h" | "4s" | "4s-l" | "1-3" | "3-1" | "2-2-l" | "2-2-r" | "2-2" | "1-4" | "5h" | "5v" | "5s" | "5s-l" | "2-3" | "3-2" | "4-1" | "2-3-l" | "2-3-r" | "6" | "6h" | "6v" | "6c" | "2-4" | "4-2" | "4-3" | "7h" | "7s" | "8" | "8c" | "8h" | "8v"

Nominal​

Nominal<T, Name>: T & { [species]: Name }

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'>;

Type parameters​

NameType
TT
Nameextends string

NoticeDialogParams​

NoticeDialogParams: Omit<DialogParams<() => void>, "callback">

ObservableCallback​

ObservableCallback<T>: (value: T) => void

Type parameters​

Name
T
Parameters​
NameType
valueT

OmitActionId​

OmitActionId<T>: Omit<T, "actionId">

Type parameters​

NameType
Textends Object

OnActionExecuteHandler​

OnActionExecuteHandler: (action: IAction) => void

Parameters​
NameType
actionIAction

OnActionUpdateHandler​

OnActionUpdateHandler: (action: IAction) => void

Parameters​
NameType
actionIAction

OnReadyCallback​

OnReadyCallback: (configuration: DatafeedConfiguration) => void

Parameters​
NameType
configurationDatafeedConfiguration

Order​

Order: PlacedOrder | BracketOrder

OrderLineLengthUnit​

OrderLineLengthUnit: "pixel" | "percentage"

OrderPreviewMessage​

OrderPreviewMessage: string | MarkupText

OrderTableColumn​

OrderTableColumn: AccountManagerColumn<keyof PlacedOrder & BracketOrder> & { supportedStatusFilters?: OrderStatusFilter[] }

OverlayIndicatorOverridesAll​

OverlayIndicatorOverridesAll: OverlayIndicatorOverridesBar | OverlayIndicatorOverridesCandle | OverlayIndicatorOverridesLine | OverlayIndicatorOverridesArea | OverlayIndicatorOverridesHollowCandle | OverlayIndicatorOverridesBaseline | OverlayIndicatorOverridesHiLo | OverlayIndicatorOverridesColumn | OverlayIndicatorOverridesHLCArea | OverlayIndicatorOverridesLineWithMarkers | OverlayIndicatorOverridesStepline

OverlayIndicatorStyleExclusions​

OverlayIndicatorStyleExclusions: Renko | Kagi | PnF | LineBreak | HeikinAshi | VolCandle

PageName​

PageName: "watchlist_details_news" | "data_window" | "object_tree"

PlotShapeId​

PlotShapeId: "shape_arrow_down" | "shape_arrow_up" | "shape_circle" | "shape_cross" | "shape_xcross" | "shape_diamond" | "shape_flag" | "shape_square" | "shape_label_down" | "shape_label_up" | "shape_triangle_down" | "shape_triangle_up"

Plot shape ID.

PositionLineLengthUnit​

PositionLineLengthUnit: "pixel" | "percentage"

PriceSource​

PriceSource: "open" | "high" | "low" | "close"

QuoteData​

QuoteData: QuoteOkData | QuoteErrorData

QuotesCallback​

QuotesCallback: (data: QuoteData[]) => void

Callback to provide Quote data.

Parameters​
NameTypeDescription
dataQuoteData[]Quote Data

QuotesErrorCallback​

QuotesErrorCallback: (reason: string) => void

Error callback for quote data request.

Parameters​
NameTypeDescription
reasonstringmessage describing the reason for the error

RawStudyMetaInfoId​

RawStudyMetaInfoId: Nominal<string, "RawStudyMetaInfoId">

RawStudyMetaInformation​

RawStudyMetaInformation: Omit<RawStudyMetaInfo, "defaults" | "plots"> & { defaults?: Readonly<DeepPartial<StudyDefaults>> ; plots?: readonly Readonly<StudyPlotInformation>[] }

ResolutionString​

ResolutionString: Nominal<string, "ResolutionString">

Resolution or time interval is a time period of one bar. Advanced Charts supports tick, intraday (seconds, minutes, hours), and DWM (daily, weekly, monthly) resolutions. The table below describes how to specify different types of resolutions:

ResolutionFormatExample
TicksxT1T — one tick, 5T — five ticks, 100T — one hundred ticks
SecondsxS1S — one second
Minutesx1 — one minute
Hoursx minutes60 — one hour
DaysxD1D — one day
WeeksxW1W — one week
MonthsxM1M — one month
YearsxM months12M — one year

Refer to Resolution for more information.

ResolveCallback​

ResolveCallback: (symbolInfo: LibrarySymbolInfo) => void

Parameters​
NameType
symbolInfoLibrarySymbolInfo

RssNewsFeedItem​

RssNewsFeedItem: RssNewsFeedInfo | RssNewsFeedInfo[]

RSS news feed.

SearchSymbolsCallback​

SearchSymbolsCallback: (items: SearchSymbolResultItem[]) => void

Parameters​
NameType
itemsSearchSymbolResultItem[]

SearchSymbolsPaginatedCallback​

SearchSymbolsPaginatedCallback: (items: SearchSymbolResultItem[], symbolsRemaining: number) => void

Parameters​
NameType
itemsSearchSymbolResultItem[]
symbolsRemainingnumber

SelectableItem​

SelectableItem: EntityId | ShapesGroupId

Identifier of an entity that can participate in selection — either a drawing/indicator ([EntityId]) or a drawings group ([ShapesGroupId]).

SeriesEventType​

SeriesEventType: "price_scale_changed"

An event related to the series. Currently the only possible value for this argument is price_scale_changed

SeriesFormat​

SeriesFormat: "price" | "volume"

SeriesFormatterFactory​

SeriesFormatterFactory: (symbolInfo: LibrarySymbolInfo | null, minTick: string) => ISymbolValueFormatter | null

Parameters​
NameType
symbolInfoLibrarySymbolInfo | null
minTickstring
Returns​

ISymbolValueFormatter | null

SeriesPriceScale​

SeriesPriceScale: "new-left" | "new-right" | "no-scale" | EntityId

Where to attach the price scale. Options are either to the left, right, next to an already existing price axis using a reference or no scale if there are no other scales on the main pane.

SeriesStatusViewSymbolTextSource​

SeriesStatusViewSymbolTextSource: "ticker" | "description" | "ticker-and-description" | "long-description"

ServerTimeCallback​

ServerTimeCallback: (serverTime: number) => void

Parameters​
NameType
serverTimenumber

SessionId​

SessionId: Nominal<string, "SessionId">

SetVisibleTimeRange​

SetVisibleTimeRange: Omit<VisibleTimeRange, "to"> & Partial<Pick<VisibleTimeRange, "to">>

A time range to set. The end to value is optional.

When the optional to value is omitted then the value will fallback to the timestamp of the latest bar on the chart.

ShapePoint​

ShapePoint: StickedPoint | PricedPoint | TimePoint

Drawing point

ShapesGroupId​

ShapesGroupId: Nominal<string, "ShapesGroupId">

SingleChartLayoutType​

SingleChartLayoutType: "s"

SingleIndicatorOverrides​

SingleIndicatorOverrides: FiftyTwoWeekHighLowIndicatorOverrides | AcceleratorOscillatorIndicatorOverrides | AccumulationDistributionIndicatorOverrides | AccumulativeSwingIndexIndicatorOverrides | AdvanceDeclineIndicatorOverrides | AnchoredVWAPIndicatorOverrides | ArnaudLegouxMovingAverageIndicatorOverrides | AroonIndicatorOverrides | AverageDirectionalIndexIndicatorOverrides | AveragePriceIndicatorOverrides | AverageTrueRangeIndicatorOverrides | AwesomeOscillatorIndicatorOverrides | BalanceofPowerIndicatorOverrides | BollingerBandsIndicatorOverrides | BollingerBandsBIndicatorOverrides | BollingerBandsWidthIndicatorOverrides | ChaikinMoneyFlowIndicatorOverrides | ChaikinOscillatorIndicatorOverrides | ChaikinVolatilityIndicatorOverrides | ChandeKrollStopIndicatorOverrides | ChandeMomentumOscillatorIndicatorOverrides | ChopZoneIndicatorOverrides | ChoppinessIndexIndicatorOverrides | CommodityChannelIndexIndicatorOverrides | CompareIndicatorOverrides | ConnorsRSIIndicatorOverrides | CoppockCurveIndicatorOverrides | CorrelationLogIndicatorOverrides | CorrelationCoefficientIndicatorOverrides | DetrendedPriceOscillatorIndicatorOverrides | DirectionalMovementIndicatorOverrides | DonchianChannelsIndicatorOverrides | DoubleEMAIndicatorOverrides | EMACrossIndicatorOverrides | EaseOfMovementIndicatorOverrides | EldersForceIndexIndicatorOverrides | EnvelopesIndicatorOverrides | FisherTransformIndicatorOverrides | FixedRangeIndicatorOverrides | GuppyMultipleMovingAverageIndicatorOverrides | HistoricalVolatilityIndicatorOverrides | HullMovingAverageIndicatorOverrides | IchimokuCloudIndicatorOverrides | KeltnerChannelsIndicatorOverrides | KlingerOscillatorIndicatorOverrides | KnowSureThingIndicatorOverrides | LeastSquaresMovingAverageIndicatorOverrides | LinearRegressionCurveIndicatorOverrides | LinearRegressionSlopeIndicatorOverrides | MACrossIndicatorOverrides | MAwithEMACrossIndicatorOverrides | MACDIndicatorOverrides | MajorityRuleIndicatorOverrides | MassIndexIndicatorOverrides | McGinleyDynamicIndicatorOverrides | MedianPriceIndicatorOverrides | MomentumIndicatorOverrides | MoneyFlowIndexIndicatorOverrides | MovingAverageIndicatorOverrides | MovingAverageAdaptiveIndicatorOverrides | MovingAverageChannelIndicatorOverrides | MovingAverageDoubleIndicatorOverrides | MovingAverageExponentialIndicatorOverrides | MovingAverageHammingIndicatorOverrides | MovingAverageMultipleIndicatorOverrides | MovingAverageTripleIndicatorOverrides | MovingAverageWeightedIndicatorOverrides | NetVolumeIndicatorOverrides | OnBalanceVolumeIndicatorOverrides | OverlayIndicatorOverrides | ParabolicSARIndicatorOverrides | PivotPointsStandardIndicatorOverrides | PriceChannelIndicatorOverrides | PriceOscillatorIndicatorOverrides | PriceVolumeTrendIndicatorOverrides | RankCorrelationIndexIndicatorOverrides | RateOfChangeIndicatorOverrides | RatioIndicatorOverrides | RegressionTrendIndicatorOverrides | RelativeStrengthIndexIndicatorOverrides | RelativeVigorIndexIndicatorOverrides | RelativeVolatilityIndexIndicatorOverrides | SMIErgodicIndicatorOscillatorIndicatorOverrides | SessionsIndicatorOverrides | SmoothedMovingAverageIndicatorOverrides | SpreadIndicatorOverrides | StandardDeviationIndicatorOverrides | StandardErrorIndicatorOverrides | StandardErrorBandsIndicatorOverrides | StochasticIndicatorOverrides | StochasticRSIIndicatorOverrides | SuperTrendIndicatorOverrides | TRIXIndicatorOverrides | TrendStrengthIndexIndicatorOverrides | TripleEMAIndicatorOverrides | TrueStrengthIndexIndicatorOverrides | TypicalPriceIndicatorOverrides | UltimateOscillatorIndicatorOverrides | VWAPIndicatorOverrides | VWMAIndicatorOverrides | VolatilityClosetoCloseIndicatorOverrides | VolatilityIndexIndicatorOverrides | VolatilityOHLCIndicatorOverrides | VolatilityZeroTrendClosetoCloseIndicatorOverrides | VolumeIndicatorOverrides | VolumeOscillatorIndicatorOverrides | VolumeProfileFixedRangeIndicatorOverrides | VolumeProfileVisibleRangeIndicatorOverrides | VortexIndicatorIndicatorOverrides | WilliamsRIndicatorOverrides | WilliamsAlligatorIndicatorOverrides | WilliamsFractalIndicatorOverrides | ZigZagIndicatorOverrides | OverlayIndicatorOverridesAll

StudyEventType​

StudyEventType: "create" | "remove" | "price_scale_changed" | "paste_study"

An event related to a study.

StudyFilledAreaStyle​

StudyFilledAreaStyle: StudyFilledAreaSolidColorStyle | StudyFilledAreaGradientColorStyle

StudyInputId​

StudyInputId: Nominal<string, "StudyInputId">

StudyInputInfo​

StudyInputInfo: StudyBooleanInputInfo | StudyTextInputInfo | StudySymbolInputInfo | StudyResolutionInputInfo | StudySessionInputInfo | StudySourceInputInfo | StudyNumericInputInfo | StudyPriceInputInfo | StudyColorInputInfo | StudyTimeInputInfo | StudyBarTimeInputInfo | StudyTextareaInputInfo

StudyInputInfoList​

StudyInputInfoList: readonly Readonly<StudyInputInfo>[]

StudyInputValue​

StudyInputValue: string | number | boolean

The value of a study input.

StudyMetaInfo​

StudyMetaInfo: DeepWriteable<RawStudyMetaInformation> & { id: string }

StudyOhlcPlotPreferences​

StudyOhlcPlotPreferences: StudyOhlcPlotBarsStylePreferences | StudyOhlcPlotCandlesStylePreferences

StudyOverrideValueType​

StudyOverrideValueType: string | number | boolean

StudyPlotDefaultPreferences​

StudyPlotDefaultPreferences: StudyLinePlotDefaultPreferences | StudyShapesPlotDefaultPreferences | StudyCharsPlotDefaultPreferences | StudyArrowsPlotPreferences

StudyPlotDisplayMode​

StudyPlotDisplayMode: Nominal<number, "StudyPlotDisplayTarget"> | StudyPlotDisplayTarget

StudyPlotInfo​

StudyPlotInfo: StudyPlotInformation

StudyPlotInformation​

StudyPlotInformation: StudyArrowsPlotInfo | StudyCharsPlotInfo | StudyColorerPlotInfo | StudyRgbaColorerPlotInfo | StudyDataPlotInfo | StudyDataOffsetPlotInfo | StudyLinePlotInfo | StudyOhlcPlotInfo | StudyShapesPlotInfo | StudyBarColorerPlotInfo | StudyBgColorerPlotInfo | StudyTextColorerPlotInfo | StudyOhlcColorerPlotInfo | StudyCandleWickColorerPlotInfo | StudyCandleBorderColorerPlotInfo | StudyUpColorerPlotInfo | StudyDownColorerPlotInfo

A description of a study plot.

StudyPlotPreferences​

StudyPlotPreferences: StudyLinePlotPreferences | StudyShapesPlotPreferences | StudyCharsPlotPreferences | StudyArrowsPlotPreferences

Study plot style preferences.

StudyPlotValueFormat​

StudyPlotValueFormat: StudyPlotValueInheritFormat | StudyPlotValuePrecisionFormat

StudyPriceScale​

StudyPriceScale: "new-left" | "new-right" | "no-scale" | "as-series"

Price scale to display a study on.

Possible values are:

  • new-left - attach the study to a new left price scale
  • new-right - attach the study to a new right price scale
  • no-scale - do not attach the study to any price scale. The study will be added in 'No Scale' mode
  • as-series - attach the study to the price scale where the main series is attached (it is only applicable the study is added to the pane with the main series)

StudyPriceSource​

StudyPriceSource: "open" | "high" | "low" | "close" | "hl2" | "hlc3" | "ohlc4" | "hlcc4"

StudyPrimitiveResult​

StudyPrimitiveResult: (number | StudyResultValueWithOffset)[]

StudyScript​

StudyScript: (ctx: ScriptContext) => void

Parameters​
NameType
ctxScriptContext

SubscribeBarsCallback​

SubscribeBarsCallback: (bar: Bar) => void

Parameters​
NameType
barBar

SuggestedQtyChangedListener​

SuggestedQtyChangedListener: (newQty: number) => void

Parameters​
NameType
newQtynumber

SupportedLineTools​

SupportedLineTools: "text" | "anchored_text" | "note" | "anchored_note" | "signpost" | "double_curve" | "arc" | "icon" | "emoji" | "sticker" | "arrow_up" | "arrow_down" | "arrow_left" | "arrow_right" | "price_label" | "price_note" | "arrow_marker" | "flag" | "vertical_line" | "horizontal_line" | "cross_line" | "horizontal_ray" | "trend_line" | "info_line" | "trend_angle" | "arrow" | "ray" | "extended" | "parallel_channel" | "disjoint_angle" | "flat_bottom" | "anchored_vwap" | "pitchfork" | "schiff_pitchfork_modified" | "schiff_pitchfork" | "balloon" | "comment" | "inside_pitchfork" | "pitchfan" | "gannbox" | "gannbox_square" | "gannbox_fixed" | "gannbox_fan" | "fib_retracement" | "fib_trend_ext" | "fib_speed_resist_fan" | "fib_timezone" | "fib_trend_time" | "fib_circles" | "fib_spiral" | "fib_speed_resist_arcs" | "fib_channel" | "xabcd_pattern" | "cypher_pattern" | "abcd_pattern" | "callout" | "text_note" | "triangle_pattern" | "3divers_pattern" | "head_and_shoulders" | "fib_wedge" | "elliott_impulse_wave" | "elliott_triangle_wave" | "elliott_triple_combo" | "elliott_correction" | "elliott_double_combo" | "cyclic_lines" | "time_cycles" | "sine_line" | "long_position" | "short_position" | "forecast" | "date_range" | "price_range" | "date_and_price_range" | "bars_pattern" | "ghost_feed" | "projection" | "rectangle" | "rotated_rectangle" | "circle" | "ellipse" | "triangle" | "polyline" | "path" | "curve" | "cursor" | "dot" | "arrow_cursor" | "eraser" | "measure" | "zoom" | "brush" | "highlighter" | "regression_trend" | "fixed_range_volume_profile" | "table"

SymbolSearchCompleteOverrideFunction​

SymbolSearchCompleteOverrideFunction: (symbol: string, searchResultItem?: SearchSymbolResultItem) => Promise<SymbolSearchCompleteData>

function to override the symbol input from symbol search dialogs

Parameters​
NameTypeDescription
symbolstringinput from the symbol search
searchResultItem?SearchSymbolResultItem-
Returns​

Promise<SymbolSearchCompleteData>

SymbolSource​

SymbolSource: SymbolInputSymbolSource

SymbolType​

SymbolType: "stock" | "index" | "forex" | "futures" | "bitcoin" | "crypto" | "undefined" | "expression" | "spread" | "cfd" | "economic" | "equity" | "dr" | "bond" | "right" | "warrant" | "fund" | "structured" | "commodity" | "fundamental" | "spot" | "swap" | "option" | "ndf"

TableFormatTextFunction​

TableFormatTextFunction<T>: (inputs: TableFormatterInputs<T>) => string

Type parameters​

NameType
Textends TableFormatterInputValues = TableFormatterInputValues

A function that takes an TableFormatterInputs object and returns a string.

Parameters​
NameType
inputsTableFormatterInputs<T>
Returns​

string

TableFormatterInputValue​

TableFormatterInputValue: any

TableFormatterInputValues​

TableFormatterInputValues: TableFormatterInputValue[]

TextInputFieldValidator​

TextInputFieldValidator: (value: string) => InputFieldValidatorResult

Parameters​
NameType
valuestring
Returns​

InputFieldValidatorResult

ThemeName​

ThemeName: "light" | "dark"

TickMarkType​

TickMarkType: "Year" | "Month" | "DayOfMonth" | "Time" | "TimeWithSeconds" | "TimeWithMilliseconds"

TickerId​

TickerId: Nominal<string, "Ticker">

TimeFrameValue​

TimeFrameValue: TimeFramePeriodBack | TimeFrameTimeRange

Type of timeframe defined in the UI. Can either be a single one TimeFramePeriodBack or a range TimeFrameTimeRange

Examples:

  1. a timeframe object, {type, value}:
  • type: period-back.
  • value: valid timeframe is a number with letter D for days and M for months.
  1. a range object, {type, from, to}
  • type: time-range.
  • from, to: UNIX timestamps, UTC.

TimeScaleMarkShape​

TimeScaleMarkShape: "circle" | "earningUp" | "earningDown" | "earning"

TimeframeOption​

TimeframeOption: string | { from: number ; to: number }

Timezone​

Timezone: "Etc/UTC" | CustomTimezones

TimezoneId​

TimezoneId: CustomTimezones | "Etc/UTC" | "exchange"

TradableSolutions​

TradableSolutions: TradableSolutionsTypes[keyof TradableSolutionsTypes]

TradableSolutions has one of the following keys:

  • changeAccount - id of a sub-account suitable for trading the symbol
  • changeSymbol - the symbol suitable for trading with current sub-account
  • openUrl - the object with URL to be opened and text for solution button

TradingDialogCustomField​

TradingDialogCustomField: CheckboxFieldMetaInfo | TextWithCheckboxFieldMetaInfo | CustomComboBoxMetaInfo | TextFieldMetaInfo

TradingTerminalChartTypeFavorites​

TradingTerminalChartTypeFavorites: ChartTypeFavorites | "Renko" | "Kagi" | "Point & figure" | "Line Break"

Chart type names for use within the favorites Widget Constructor option. This type is for Trading Platform, if you are looking for the Advanced Charts type then please see ChartTypeFavorites.

See Favorites for the Widget Constructor option where you can define these favorites, and TradingTerminalWidgetOptions.favorites for the Widget Constructor option.

TradingTerminalFeatureset​

TradingTerminalFeatureset: ChartingLibraryFeatureset | "chart_crosshair_menu" | "support_multicharts" | "header_layouttoggle" | "add_to_watchlist" | "open_account_manager" | "trading_notifications" | "multiple_watchlists" | "show_trading_notifications_history" | "always_pass_called_order_to_modify" | "drawing_templates" | "trading_account_manager" | "right_toolbar" | "order_panel" | "order_info" | "buy_sell_buttons" | "broker_button" | "show_order_panel_on_start" | "order_panel_close_button" | "order_panel_undock" | "chart_hide_close_position_button" | "chart_hide_close_order_button" | "watchlist_import_export" | "dom_widget" | "keep_object_tree_widget_in_right_toolbar" | "show_last_price_and_change_only_in_series_legend" | "legend_last_day_change" | "watchlist_context_menu " | "hide_right_toolbar" | "hide_right_toolbar_tabs" | "hide_price_scale_if_all_sources_hidden" | "show_symbol_logo_in_account_manager" | "show_symbol_logo_in_close_position_dialog" | "show_symbol_logo_in_cancel_order_dialog" | "watchlist_sections" | "prefer_symbol_name_over_fullname" | "prefer_quote_short_name" | "image_drawingtool" | "pre_post_market_price_line" | "watchlist_cross_tab_sync" | "static_dom" | "keep_selected_group_on_tool_creation" | "show_buy_sell_buttons_on_unsupported_resolution"

This is the list of all featuresets that work on Trading Platform (which is an extension of Advanced Charts)

VisiblePlotsSet​

VisiblePlotsSet: "ohlcv" | "ohlc" | "c" | "hlc"

WatchListSymbolListAddedCallback​

WatchListSymbolListAddedCallback: (listId: string, symbols: string[]) => void

Parameters​
NameType
listIdstring
symbolsstring[]

WatchListSymbolListChangedCallback​

WatchListSymbolListChangedCallback: (listId: string) => void

Parameters​
NameType
listIdstring

WatchListSymbolListRemovedCallback​

WatchListSymbolListRemovedCallback: (listId: string) => void

Parameters​
NameType
listIdstring

WatchListSymbolListRenamedCallback​

WatchListSymbolListRenamedCallback: (listId: string, oldName: string, newName: string) => void

Parameters​
NameType
listIdstring
oldNamestring
newNamestring

WatchedValueCallback​

WatchedValueCallback<T>: (value: T) => void

Type parameters​

Name
T
Parameters​
NameType
valueT

WatermarkContentProvider​

WatermarkContentProvider: (data: WatermarkContentData) => WatermarkLine[] | null

Custom watermark content provider which should return an array of watermark lines to be displayed. Return null if you would like to use the default content.

Parameters​
NameType
dataWatermarkContentData
Returns​

WatermarkLine[] | null

WidgetOverrides​

WidgetOverrides: DrawingOverrides & { [key: string]: string | number | boolean; }

Variables​

SaveChartError​

Const

SaveChartError: Object

Call signature​

new SaveChartError(info): SaveChartError

Parameters​
NameType
infoSaveChartErrorInfo
Returns​

SaveChartError

Type declaration​

NameType
prototypeSaveChartError

widget​

Const

widget: ChartingLibraryWidgetConstructor

Functions​

version​

version(): string

Returns a build version string. For example "CL v23.012 (internal id e0d59dc3 @ 2022-08-23T06:07:00.808Z)".

Returns​

string — The build version string.