API Reference - Configuration

ChartAppInitials initialInstrument Initial instrument when rendering ChartReactApp. Specify null if you want to chart be loaded without default instrument. Example: 'AAPL' string initialAggregationPeriods Initial aggregation periods. Example: [{ duration: 30, durationType: 'm' }, { duration: 1, durationType: 'h' }] AggregationPeriod[] initialAggregation Initial aggregation period. Example: { duration: 30, durationType: 'm' } AggregationPeriod Aggregation period main model. duration number durationType "y" | "t" | "r" | "s" | "m" | "h" | "d" | "w" | "mo" | "v" initialTimezone Initial timezone Example: 'Asia/Anadyr', 'UTC' string initialChartConfig Initial chart-core config. ChartAppInitials_initialChartConfig scale Controls how chart series are positioned horizontally and vertically. Other configurations like: inverse, lockRatio etc. any components Group of component configurations. Chart component is a single visual object on chart. Examples: chart itself, events, x-axis, highlights, cross tool. any dateFormatter Date and time formatting configuration. any timezone Timezone to use on chart X axis labels and any other timestamps. Examples: Africa/Accra, Europe/Moscow, Asia/Tehran. any fixedSize If set - chart canvas will have fixed size always. any rtl Right to left mode. Used in drawings (like text drawing) calculation. any drawingOrder Initial visual order of chart drawers. Reorder to put volumes on top of candles for example. any intlFormatter any useUTCTimeOverride any animation any devexpertsPromoLink any shortDays any shortMonths any themes any initialStudies Array of initial studies. string[] initialChartTheme Initial theme. "dark" | "light" | "cloudDancer" | "oud" | "solar" | "still" initialChartReactSettings Initial chart react settings. ChartAppInitials_initialChartReactSettings initialTimeframePresets Array of Timeframe presets. By default there are few presets: day, week, month, year, and all data. Example: { presets: [{ timeframe: { label: '1D', value: 86400 }, aggregation: { duration: 1, durationType: 'm', }] } TimeframePresetsList<Timeframe> initialTimeframePreset Initial Timeframe preset. TimeframePreset<Timeframe>

ChartReactAppConfig The main configuration place for chart-react. initialLoading Array of loading state objcts. `dxchart5-react` has some basic loading state objects such as candles data loading, symbols loading etc. These loading state objects are used to render loading bar on top of the chart. With this option you can provide your own loading state objects in addition to default ones. InitialLoadingItem[] localization Object with all textual information in chart - override it to make chart in other language. ChartReactAppConfig_localization chartReactConfig Configuration for Chart-React application. chartReactConfig is now partial - default values will be merged, so you could provide only those parameters, that you need. PartialChartReactConfig !IMPORTANT !IMPORTANT !IMPORTANT Partial config needs for Dedok documentation, to make tables with interfaces nesting. Please, don't modify it to full required interface. Full required interface will be generated with DeepRequired<T> utility. toolbarMode In multiple mode each chart will render its own toolbar. "single" | "multiple" rtl boolean layout PartialLayoutConfig saveDelay number enabled boolean studyTemplates PartialChartReactConfig_studyTemplates dataExport PartialChartReactConfig_dataExport multiChart PartialChartReactConfig_multiChart trading PartialTradingConfig enabled Use it, if you want to hide/show Trading tab from settings boolean addNewOrderEnabled Enables/disables creating new orders from Order Entry boolean showPriceAsLabels When true, displays order prices as Y-axis labels instead of text on the order line boolean rightOffset Initial right offset (in pixels) for the trading UI resizer position number takeProfitStopLossEnabled Enables/disables Take Profit and Stop Loss buttons on orders and positions boolean defaultOrderQuantity Default quantity value for order entry number quantityPrecision Number of decimal places for order quantity (e.g. 0 for integers, 2 for 0.01 precision) number quantityStep Step value for quantity increment/decrement buttons number minOrderQuantity Limits min quantity for order entry number maxOrderQuantity Limits max quantity for order entry number currency Currency symbol to display (e.g. '$', '€') string orderTypes Configuration for available order types (market, limit, stop) PartialOrderTypes market boolean limit boolean stop boolean studies PartialStudiesConfig maxSelectedStudiesCount number dxScriptEnabled boolean addStudyButtonEnabled boolean drawings PartialDrawingsConfig drawingsList DrawingGroup[] toolbar PartialDrawingsConfig_toolbar sidebar PartialDrawingsConfig_sidebar limitOfDrawings number drawingGroups Important! Couldn't be used along with object tree(layers) component PartialDrawingsConfig_drawingGroups toolbar PartialChartReactConfig_toolbar settingsTabs Configuration for chart settings tabs visibility SettingsTabsConfig Configuration for chart settings tabs visibility general General settings tab SettingsTabsConfig_general trading Trading settings tab SettingsTabsConfig_trading legend Legend settings tab SettingsTabsConfig_legend scales Scales settings tab SettingsTabsConfig_scales market Market settings tab SettingsTabsConfig_market colors Colors settings tab SettingsTabsConfig_colors events Events settings tab SettingsTabsConfig_events paddings Paddings settings tab SettingsTabsConfig_paddings yAxisControls PartialChartReactConfig_yAxisControls instrumentSuggest PartialChartReactConfig_instrumentSuggest actionsHistory PartialActionsHistoryConfig undoKeyCode string redoKeyCode string limit number popups PartialPopupsConfig showOutside boolean layers PartialLayersConfig enabled boolean customPeriodInput PartialCustomPeriodInputConfig enabled boolean timeframePresets PartialTimeframePresetsConfig mode PartialTimeframePresetsConfigMode toString Returns a string representation of a string. () => string charAt Returns the character at the specified index. (pos: number) => string charCodeAt Returns the Unicode value of the character at the specified location. (index: number) => number concat Returns a string that contains the concatenation of two or more strings. (...strings: string[]) => string indexOf Returns the position of the first occurrence of a substring. (searchString: string, position?: number) => number lastIndexOf Returns the last occurrence of a substring in the string. (searchString: string, position?: number) => number localeCompare Determines whether two strings are equivalent in the current locale. Determines whether two strings are equivalent in the current or specified locale. { (that: string): number; (that: string, locales?: string | string[], options?: CollatorOptions): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions): number; } match Matches a string with a regular expression, and returns an array containing the results of that search. Matches a string or an object that supports being matched against, and returns an array containing the results of that search, or null if no matches are found. { (regexp: string | RegExp): RegExpMatchArray; (matcher: { [Symbol.match](string: string): RegExpMatchArray; }): RegExpMatchArray; } replace Replaces text in a string, using a regular expression or search string. Passes a string and {@linkcode replaceValue} to the `[Symbol.replace]` method on {@linkcode searchValue}. This method is expected to implement its own replacement algorithm. Replaces text in a string, using an object that supports replacement within a string. { (searchValue: string | RegExp, replaceValue: string): string; (searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; } search Finds the first substring match in a regular expression search. { (regexp: string | RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; } slice Returns a section of a string. (start?: number, end?: number) => string split Split a string into substrings using the specified separator and return them as an array. { (separator: string | RegExp, limit?: number): string[]; (splitter: { [Symbol.split](string: string, limit?: number): string[]; }, limit?: number): string[]; } substring Returns the substring at the specified location within a String object. (start: number, end?: number) => string toLowerCase Converts all the alphabetic characters in a string to lowercase. () => string toLocaleLowerCase Converts all alphabetic characters to lowercase, taking into account the host environment's current locale. { (locales?: string | string[]): string; (locales?: LocalesArgument): string; } toUpperCase Converts all the alphabetic characters in a string to uppercase. () => string toLocaleUpperCase Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale. { (locales?: string | string[]): string; (locales?: LocalesArgument): string; } trim Removes the leading and trailing white space and line terminator characters from a string. () => string length Returns the length of a String object. number substr Gets a substring beginning at the specified location and having the specified length. (from: number, length?: number) => string valueOf Returns the primitive value of the specified object. () => string codePointAt Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point value of the UTF-16 encoded code point starting at the string element at position pos in the String resulting from converting this object to a String. If there is no element at that position, the result is undefined. If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos. (pos: number) => number includes Returns true if searchString appears as a substring of the result of converting this object to a String, at one or more positions that are greater than or equal to position; otherwise, returns false. (searchString: string, position?: number) => boolean endsWith Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at endPosition – length(this). Otherwise returns false. (searchString: string, endPosition?: number) => boolean normalize Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms. { (form: "NFC" | "NFD" | "NFKC" | "NFKD"): string; (form?: string): string; } repeat Returns a String value that is made from count copies appended together. If count is 0, the empty string is returned. (count: number) => string startsWith Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at position. Otherwise returns false. (searchString: string, position?: number) => boolean anchor Returns an `<a>` HTML anchor element and sets the name attribute to the text value (name: string) => string big Returns a `<big>` HTML element () => string blink Returns a `<blink>` HTML element () => string bold Returns a `<b>` HTML element () => string fixed Returns a `<tt>` HTML element () => string fontcolor Returns a `<font>` HTML element and sets the color attribute value (color: string) => string fontsize Returns a `<font>` HTML element and sets the size attribute value { (size: number): string; (size: string): string; } italics Returns an `<i>` HTML element () => string link Returns an `<a>` HTML element and sets the href attribute value (url: string) => string small Returns a `<small>` HTML element () => string strike Returns a `<strike>` HTML element () => string sub Returns a `<sub>` HTML element () => string sup Returns a `<sup>` HTML element () => string padStart Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the start (left) of the current string. (maxLength: number, fillString?: string) => string padEnd Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the end (right) of the current string. (maxLength: number, fillString?: string) => string trimEnd Removes the trailing white space and line terminator characters from a string. () => string trimStart Removes the leading white space and line terminator characters from a string. () => string trimLeft Removes the leading white space and line terminator characters from a string. () => string trimRight Removes the trailing white space and line terminator characters from a string. () => string matchAll Matches a string with a regular expression, and returns an iterable of matches containing the results of that search. (regexp: RegExp) => RegExpStringIterator<RegExpExecArray> __@iterator@2235 Iterator () => StringIterator<string> chartDataOptionsSettings PartialChartDataOptionsConfig extendedHours PartialChartDataOptionsConfig_extendedHours sessionBreaks PartialChartDataOptionsConfig_sessionBreaks priceType PartialChartDataOptionsConfig_priceType candlesAlignment PartialChartDataOptionsConfig_candlesAlignment maxCandlesCount number dataTimeout Timeout in ms during which the chart will wait for the data if no data are sent, the chart will apply empty array number disableWorkers Can useful with some tools like vite & rollup, bcs there is strange bug with workers. Looks like we have to raise an issue in vite repo. boolean priceTypes An array of supported price types PartialPriceTypesConfig length Gets or sets the length of the array. This is a number one higher than the highest index in the array. number toString Returns a string representation of an array. () => string toLocaleString Returns a string representation of an array. The elements are converted to string using their toLocaleString methods. { (): string; (locales: string | string[], options?: NumberFormatOptions & DateTimeFormatOptions): string; } pop Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified. () => "last" | "mark" | "bid" | "ask" push Appends new elements to the end of an array, and returns the new length of the array. (...items: ("last" | "mark" | "bid" | "ask")[]) => number concat Combines two or more arrays. This method returns a new array without modifying any existing arrays. { (...items: ConcatArray<"last" | "mark" | "bid" | "ask">[]): ("last" | "mark" | "bid" | "ask")[]; (...items: ("last" | "mark" | "bid" | "ask" | ConcatArray<"last" | "mark" | "bid" | "ask">)[]): ("last" | ... 2 more ... | "ask")[]; } join Adds all the elements of an array into a string, separated by the specified separator string. (separator?: string) => string reverse Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array. () => ("last" | "mark" | "bid" | "ask")[] shift Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified. () => "last" | "mark" | "bid" | "ask" slice Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array. (start?: number, end?: number) => ("last" | "mark" | "bid" | "ask")[] sort Sorts an array in place. This method mutates the array and returns a reference to the same array. (compareFn?: (a: "last" | "mark" | "bid" | "ask", b: "last" | "mark" | "bid" | "ask") => number) => PartialPriceTypesConfig splice Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. { (start: number, deleteCount?: number): ("last" | "mark" | "bid" | "ask")[]; (start: number, deleteCount: number, ...items: ("last" | "mark" | "bid" | "ask")[]): ("last" | "mark" | "bid" | "ask")[]; } unshift Inserts new elements at the start of an array, and returns the new length of the array. (...items: ("last" | "mark" | "bid" | "ask")[]) => number indexOf Returns the index of the first occurrence of a value in an array, or -1 if it is not present. (searchElement: "last" | "mark" | "bid" | "ask", fromIndex?: number) => number lastIndexOf Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present. (searchElement: "last" | "mark" | "bid" | "ask", fromIndex?: number) => number every Determines whether all the members of an array satisfy the specified test. { <S extends "last" | "mark" | "bid" | "ask">(predicate: (value: "last" | "mark" | "bid" | "ask", index: number, array: ("last" | "mark" | "bid" | "ask")[]) => value is S, thisArg?: any): this is S[]; (predicate: (value: "last" | ... 2 more ... | "ask", index: number, array: ("last" | ... 2 more ... | "ask")[]) => u... some Determines whether the specified callback function returns true for any element of an array. (predicate: (value: "last" | "mark" | "bid" | "ask", index: number, array: ("last" | "mark" | "bid" | "ask")[]) => unknown, thisArg?: any) => boolean forEach Performs the specified action for each element in an array. (callbackfn: (value: "last" | "mark" | "bid" | "ask", index: number, array: ("last" | "mark" | "bid" | "ask")[]) => void, thisArg?: any) => void map Calls a defined callback function on each element of an array, and returns an array that contains the results. <U>(callbackfn: (value: "last" | "mark" | "bid" | "ask", index: number, array: ("last" | "mark" | "bid" | "ask")[]) => U, thisArg?: any) => U[] filter Returns the elements of an array that meet the condition specified in a callback function. { <S extends "last" | "mark" | "bid" | "ask">(predicate: (value: "last" | "mark" | "bid" | "ask", index: number, array: ("last" | "mark" | "bid" | "ask")[]) => value is S, thisArg?: any): S[]; (predicate: (value: "last" | ... 2 more ... | "ask", index: number, array: ("last" | ... 2 more ... | "ask")[]) => unknown, ... reduce Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. { (callbackfn: (previousValue: "last" | "mark" | "bid" | "ask", currentValue: "last" | "mark" | "bid" | "ask", currentIndex: number, array: ("last" | "mark" | "bid" | "ask")[]) => "last" | "mark" | "bid" | "ask"): "last" | ... 2 more ... | "ask"; (callbackfn: (previousValue: "last" | ... 2 more ... | "ask", currentV... reduceRight Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. { (callbackfn: (previousValue: "last" | "mark" | "bid" | "ask", currentValue: "last" | "mark" | "bid" | "ask", currentIndex: number, array: ("last" | "mark" | "bid" | "ask")[]) => "last" | "mark" | "bid" | "ask"): "last" | ... 2 more ... | "ask"; (callbackfn: (previousValue: "last" | ... 2 more ... | "ask", currentV... find Returns the value of the first element in the array where predicate is true, and undefined otherwise. { <S extends "last" | "mark" | "bid" | "ask">(predicate: (value: "last" | "mark" | "bid" | "ask", index: number, obj: ("last" | "mark" | "bid" | "ask")[]) => value is S, thisArg?: any): S; (predicate: (value: "last" | ... 2 more ... | "ask", index: number, obj: ("last" | ... 2 more ... | "ask")[]) => unknown, thisAr... findIndex Returns the index of the first element in the array where predicate is true, and -1 otherwise. (predicate: (value: "last" | "mark" | "bid" | "ask", index: number, obj: ("last" | "mark" | "bid" | "ask")[]) => unknown, thisArg?: any) => number fill Changes all array elements from `start` to `end` index to a static `value` and returns the modified array (value: "last" | "mark" | "bid" | "ask", start?: number, end?: number) => PartialPriceTypesConfig copyWithin Returns the this object after copying a section of the array identified by start and end to the same array starting at position target (target: number, start: number, end?: number) => PartialPriceTypesConfig entries Returns an iterable of key, value pairs for every entry in the array () => ArrayIterator<[number, "last" | "mark" | "bid" | "ask"]> keys Returns an iterable of keys in the array () => ArrayIterator<number> values Returns an iterable of values in the array () => ArrayIterator<"last" | "mark" | "bid" | "ask"> includes Determines whether an array includes a certain element, returning true or false as appropriate. (searchElement: "last" | "mark" | "bid" | "ask", fromIndex?: number) => boolean flatMap Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1. <U, This = undefined>(callback: (this: This, value: "last" | "mark" | "bid" | "ask", index: number, array: ("last" | "mark" | "bid" | "ask")[]) => U | readonly U[], thisArg?: This) => U[] flat Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth. <A, D extends number = 1>(this: A, depth?: D) => FlatArray<A, D>[] __@iterator@2235 Iterator () => ArrayIterator<"last" | "mark" | "bid" | "ask"> __@unscopables@5171 Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement. PartialPriceTypesConfig___@unscopables@5171 autoApplyPriceType If true, chart will use it's inner logic to change price types For example, for the STOCK instruments 'Last' price type will be set but for the FOREX it will be switched to the 'Market' Set as true by default boolean shouldInitLayoutScale boolean timezoneControls Removes timezone select box in UI and sets current timezone to specified in timezones.currentTimezone or if timezones.currentTimezone is not specified to instruments exchange timezone PartialChartReactConfig_timezoneControls themeControls PartialChartReactConfig_themeControls watermark PartialChartReactConfig_watermark rightClickMenu PartialRightClickMenuConfig tradingButtons PartialRightClickMenuConfig_tradingButtons backgroundMenu Configuration for background menu elements visibility BackgroundMenuElementsConfig Configuration for background right-click menu elements buyMarketButton Buy at market price button BackgroundMenuElementsConfig_buyMarketButton sellMarketButton Sell at market price button BackgroundMenuElementsConfig_sellMarketButton buyLimitButton Buy limit order button BackgroundMenuElementsConfig_buyLimitButton sellLimitButton Sell limit order button BackgroundMenuElementsConfig_sellLimitButton crosshairCheckbox Crosshair toggle checkbox BackgroundMenuElementsConfig_crosshairCheckbox sessionBreaksCheckbox Session breaks toggle checkbox BackgroundMenuElementsConfig_sessionBreaksCheckbox extendedHoursCheckbox Extended hours toggle checkbox BackgroundMenuElementsConfig_extendedHoursCheckbox watermarkCheckbox Watermark toggle checkbox BackgroundMenuElementsConfig_watermarkCheckbox gridPopover Grid settings popover BackgroundMenuElementsConfig_gridPopover themePopover Theme settings popover BackgroundMenuElementsConfig_themePopover recentDrawingsPopover Recent drawings popover BackgroundMenuElementsConfig_recentDrawingsPopover hideDrawingsCheckbox Hide/show drawings checkbox BackgroundMenuElementsConfig_hideDrawingsCheckbox clearDrawingsButton Clear all drawings button BackgroundMenuElementsConfig_clearDrawingsButton clearIndicatorsButton Clear all indicators button BackgroundMenuElementsConfig_clearIndicatorsButton settingsButton Open settings button BackgroundMenuElementsConfig_settingsButton resetChartButton Reset chart button BackgroundMenuElementsConfig_resetChartButton dataMenu Configuration for data series menu elements visibility DataMenuElementsConfig Configuration for data series right-click menu elements chartTypePopover Chart type popover DataMenuElementsConfig_chartTypePopover priceTypePopover Price type popover DataMenuElementsConfig_priceTypePopover colorPickerItem Color picker item DataMenuElementsConfig_colorPickerItem bringToFrontButton Bring to front button DataMenuElementsConfig_bringToFrontButton sendToBackButton Send to back button DataMenuElementsConfig_sendToBackButton studiesMenu Configuration for studies menu elements visibility StudiesMenuElementsConfig Configuration for studies right-click menu elements bringToFrontButton Bring to front button StudiesMenuElementsConfig_bringToFrontButton sendToBackButton Send to back button StudiesMenuElementsConfig_sendToBackButton duplicateStudyButton Duplicate study button StudiesMenuElementsConfig_duplicateStudyButton hideStudyButton Hide study button StudiesMenuElementsConfig_hideStudyButton moveToPaneAboveButton Move to pane above button StudiesMenuElementsConfig_moveToPaneAboveButton moveToPaneBelowButton Move to pane below button StudiesMenuElementsConfig_moveToPaneBelowButton pinToScalePopover Pin to scale popover StudiesMenuElementsConfig_pinToScalePopover configureStudyButton Configure study button StudiesMenuElementsConfig_configureStudyButton drawingsMenu Configuration for drawings menu elements visibility DrawingsMenuElementsConfig Configuration for drawings right-click menu elements bringToFrontButton Bring to front button DrawingsMenuElementsConfig_bringToFrontButton bringForwardButton Bring forward button DrawingsMenuElementsConfig_bringForwardButton sendBackwardButton Send backward button DrawingsMenuElementsConfig_sendBackwardButton sendToBackButton Send to back button DrawingsMenuElementsConfig_sendToBackButton lockDrawingButton Lock drawing button DrawingsMenuElementsConfig_lockDrawingButton hideDrawingButton Hide drawing button DrawingsMenuElementsConfig_hideDrawingButton legendMenu Configuration for legend menu elements visibility LegendMenuElementsConfig Configuration for legend right-click menu elements instrumentNameCheckbox Instrument name checkbox LegendMenuElementsConfig_instrumentNameCheckbox ohlcValuesCheckbox OHLC values checkbox LegendMenuElementsConfig_ohlcValuesCheckbox volumeCheckbox Volume checkbox LegendMenuElementsConfig_volumeCheckbox periodCheckbox Period checkbox LegendMenuElementsConfig_periodCheckbox yAxisMenu Configuration for Y-axis menu elements visibility YAxisMenuElementsConfig Configuration for Y-axis right-click menu elements autoScaleCheckbox Auto scale checkbox YAxisMenuElementsConfig_autoScaleCheckbox fitOrdersCheckbox Fit orders checkbox YAxisMenuElementsConfig_fitOrdersCheckbox fitPositionsCheckbox Fit positions checkbox YAxisMenuElementsConfig_fitPositionsCheckbox fitStudiesCheckbox Fit studies checkbox YAxisMenuElementsConfig_fitStudiesCheckbox invertScaleCheckbox Invert scale checkbox YAxisMenuElementsConfig_invertScaleCheckbox lockPriceToBarRatioCheckbox Lock price to bar ratio checkbox YAxisMenuElementsConfig_lockPriceToBarRatioCheckbox axisAlignButton Axis align button YAxisMenuElementsConfig_axisAlignButton regularAxisTypeCheckbox Regular axis type checkbox YAxisMenuElementsConfig_regularAxisTypeCheckbox percentAxisTypeCheckbox Percent axis type checkbox YAxisMenuElementsConfig_percentAxisTypeCheckbox logarithmicAxisTypeCheckbox Logarithmic axis type checkbox YAxisMenuElementsConfig_logarithmicAxisTypeCheckbox labelsAndLinesPopover Labels and lines popover YAxisMenuElementsConfig_labelsAndLinesPopover floatingButtons Configuration for floating buttons (zoom in/out, return to now, move pane buttons) PartialChartReactConfig_floatingButtons fixedSize PartialChartReactConfig_fixedSize dateFormatters DateFormattersConfig dateInput `DMY` or NA standart `MDY` DateFormatType toString Returns a string representation of a string. () => string charAt Returns the character at the specified index. (pos: number) => string charCodeAt Returns the Unicode value of the character at the specified location. (index: number) => number concat Returns a string that contains the concatenation of two or more strings. (...strings: string[]) => string indexOf Returns the position of the first occurrence of a substring. (searchString: string, position?: number) => number lastIndexOf Returns the last occurrence of a substring in the string. (searchString: string, position?: number) => number localeCompare Determines whether two strings are equivalent in the current locale. Determines whether two strings are equivalent in the current or specified locale. { (that: string): number; (that: string, locales?: string | string[], options?: CollatorOptions): number; (that: string, locales?: LocalesArgument, options?: CollatorOptions): number; } match Matches a string with a regular expression, and returns an array containing the results of that search. Matches a string or an object that supports being matched against, and returns an array containing the results of that search, or null if no matches are found. { (regexp: string | RegExp): RegExpMatchArray; (matcher: { [Symbol.match](string: string): RegExpMatchArray; }): RegExpMatchArray; } replace Replaces text in a string, using a regular expression or search string. Passes a string and {@linkcode replaceValue} to the `[Symbol.replace]` method on {@linkcode searchValue}. This method is expected to implement its own replacement algorithm. Replaces text in a string, using an object that supports replacement within a string. { (searchValue: string | RegExp, replaceValue: string): string; (searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string): string; (searchValue: { ...; }, replaceValue: string): string; (searchValue: { ...; }, replacer: (substring: string, ...args: any[]) => string): string; } search Finds the first substring match in a regular expression search. { (regexp: string | RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; } slice Returns a section of a string. (start?: number, end?: number) => string split Split a string into substrings using the specified separator and return them as an array. { (separator: string | RegExp, limit?: number): string[]; (splitter: { [Symbol.split](string: string, limit?: number): string[]; }, limit?: number): string[]; } substring Returns the substring at the specified location within a String object. (start: number, end?: number) => string toLowerCase Converts all the alphabetic characters in a string to lowercase. () => string toLocaleLowerCase Converts all alphabetic characters to lowercase, taking into account the host environment's current locale. { (locales?: string | string[]): string; (locales?: LocalesArgument): string; } toUpperCase Converts all the alphabetic characters in a string to uppercase. () => string toLocaleUpperCase Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale. { (locales?: string | string[]): string; (locales?: LocalesArgument): string; } trim Removes the leading and trailing white space and line terminator characters from a string. () => string length Returns the length of a String object. number substr Gets a substring beginning at the specified location and having the specified length. (from: number, length?: number) => string valueOf Returns the primitive value of the specified object. () => string codePointAt Returns a nonnegative integer Number less than 1114112 (0x110000) that is the code point value of the UTF-16 encoded code point starting at the string element at position pos in the String resulting from converting this object to a String. If there is no element at that position, the result is undefined. If a valid UTF-16 surrogate pair does not begin at pos, the result is the code unit at pos. (pos: number) => number includes Returns true if searchString appears as a substring of the result of converting this object to a String, at one or more positions that are greater than or equal to position; otherwise, returns false. (searchString: string, position?: number) => boolean endsWith Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at endPosition – length(this). Otherwise returns false. (searchString: string, endPosition?: number) => boolean normalize Returns the String value result of normalizing the string into the normalization form named by form as specified in Unicode Standard Annex #15, Unicode Normalization Forms. { (form: "NFC" | "NFD" | "NFKC" | "NFKD"): string; (form?: string): string; } repeat Returns a String value that is made from count copies appended together. If count is 0, the empty string is returned. (count: number) => string startsWith Returns true if the sequence of elements of searchString converted to a String is the same as the corresponding elements of this object (converted to a String) starting at position. Otherwise returns false. (searchString: string, position?: number) => boolean anchor Returns an `<a>` HTML anchor element and sets the name attribute to the text value (name: string) => string big Returns a `<big>` HTML element () => string blink Returns a `<blink>` HTML element () => string bold Returns a `<b>` HTML element () => string fixed Returns a `<tt>` HTML element () => string fontcolor Returns a `<font>` HTML element and sets the color attribute value (color: string) => string fontsize Returns a `<font>` HTML element and sets the size attribute value { (size: number): string; (size: string): string; } italics Returns an `<i>` HTML element () => string link Returns an `<a>` HTML element and sets the href attribute value (url: string) => string small Returns a `<small>` HTML element () => string strike Returns a `<strike>` HTML element () => string sub Returns a `<sub>` HTML element () => string sup Returns a `<sup>` HTML element () => string padStart Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the start (left) of the current string. (maxLength: number, fillString?: string) => string padEnd Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the end (right) of the current string. (maxLength: number, fillString?: string) => string trimEnd Removes the trailing white space and line terminator characters from a string. () => string trimStart Removes the leading white space and line terminator characters from a string. () => string trimLeft Removes the leading white space and line terminator characters from a string. () => string trimRight Removes the trailing white space and line terminator characters from a string. () => string matchAll Matches a string with a regular expression, and returns an iterable of matches containing the results of that search. (regexp: RegExp) => RegExpStringIterator<RegExpExecArray> __@iterator@2235 Iterator () => StringIterator<string> legend You can configure date format with a function {@link DateAggregationFormatterFunction}. Function should return a pattern like `HH:mm` etc (all formats you can check in `date-fns` official docs) DateAggregationFormatterFunction events You can configure date format with a function {@link DateEventFormatterFunction}. Function should return a pattern like `HH:mm` etc (all formats you can check in `date-fns` official docs) DateEventFormatterFunction colorPalette Array of colors, that will be used in color picker component. Supports all common color models: hex, rgb/rgba, hsl/hsla, default string color, for example, "yellow". string[] iconsPool Icons set for Icon drawing. Readonly<Record<string, IconDefinition>> drawingsConfig Default drawings configuration. Use the themed config if you want different drawings styles per theme. Override if you need other defaults styles. DrawingsConfig<"line" | "rectangle" | "horizontal_line" | "horizontal_ray" | "vertical_line" | "extended_line" | "ellipse" | "pitchfork" | "ray" | "curve" | "arc" | "info_line" | "brush" | ... 35 more ... | "anchored_volume_by_price"> | ThemedDrawingsConfig onApiCreated Callback which returns you object with useful API that you can call on chart to modify it. (api: ChartReactAPI) => void palette Main object to override colors in chart. Each theme expects an object with colors configuration. Supports all common color nomenclatures: hex, rgb/rgba, hsl/hsla, default string color, for example, "yellow". ChartReactAppConfig_palette timezones List of timezones and your current timezone. Example: ['Europe/Berlin', 'America/Argentina/Buenos_Aires'] Partial<TimezonesConfig> chartTypesConfig List of chart types and initial chart type Example: { initialChartType: candle, listOfChartTypes: ['candle', 'line', 'area', 'equivolume', 'heikinAshi']} Partial<ChartTypesConfig> containerClassName string