Chart configuration

DXcharts is highly customizable. Use the ChartConfig object to define the initial chart properties during setup.

FullChartConfig The main configuration file for chart-core. Includes all components' configurations, global configs like dateFormatter, and colors. scale Controls how chart series are positioned horizontally and vertically. Other configurations like: inverse, lockRatio etc. ChartScale auto Auto scale will always fit whole chart series in viewport. boolean zoomToCursor True - will zoom to cursor on mouse wheel. False - zoom to last candle. boolean lockPriceToBarRatio Locks the ratio between price/time, so when zooming it will feel like google maps. boolean inverse Inverses the Y scale vertically. boolean autoScaleOnCandles Do auto scale (even if it's not enabled in config) after instrument change. boolean autoScaleDisableOnDrag When dragging chart under specific angle - will automatically disable auto-scale. AutoScaleDisableOnDrag enabled boolean edgeAngle The angle of mouse movement. Default - Math.PI / 9. number yDiff Distance that mouse should travel vertically in px. Default - 80. number zoomSensitivity ChartScale_zoomSensitivity defaultViewportItems Defines how much items (candles) will be in viewport when chart applies basic scale number keepZoomXOnYAxisChange Adjust x viewport when y-axis width is changed, so x zoom remains the same boolean disableAnimations Disable all scale process animations boolean components Group of component configurations. Chart component is a single visual object on chart. Examples: chart itself, events, x-axis, highlights, cross tool. ChartComponents chart ChartConfigComponentsChart type The type of chart. Candle, bar, area and others. keyof BarTypes showCandlesBorder Shows the border of candle. Useful for hollow-candles and to increase contrast on thin candles. boolean showActiveCandlesBorder Shows the border for active candle (tapped by finger on mobile devices). boolean showWicks Shows candle wicks - high and low. boolean candleLineWidth number barLineWidth number lineWidth number areaLineWidth number minCandles The minimum amount of candles in viewport. It will not be possible to make fewer than that by using zoom. number defaultZoomCandleWidth number minWidth number zoomStep number candlePaddingPercent number highlightActiveCandle boolean cursor string selectedWidth number minCandlesOffset number histogram ChartConfigComponentsHistogram barCapSize number maxYAxisScalesAmount The maximum amount of Y axis scales on a single chart number applyBackgroundToAxes Background color will be also applied to the chart axes ChartConfigComponentsChart_applyBackgroundToAxes sortCandles (candles: Candle[]) => Candle[] xAxis ChartConfigComponentsXAxis visible boolean cursor string formatsForLabelsConfig Record<TimeFormatWithDuration, string> padding ChartConfigComponentsXAxis_padding fontSize number fontFamily string fontStyle string yAxis YAxisConfig visible boolean type Type of Y axis. Currently supported 'regular', 'percent', 'logarithmic'. PriceAxisType 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> align Align Y axis left or right. YAxisAlign 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> labels Configures the labels on Y axis. YAxisLabels descriptions boolean settings Settings contains required labels ('lastPrice', 'countDownToBarClose') and optional labels ('bidAsk', 'highLow', 'prevDayClose', 'prePostMarket'). Record<string, YAxisLabelConfig> typeConfig Override appearance of different label types. Useful to change all labels of the same type. YAxisTypeConfig badge any rectangle any plain any labelHeight The height of the single label in pixels. Used during calculation step between labels. You can make it smaller to fit more labels on Y axis. Or less to fit less labels. number zeroPercentLine Always show zero line for percent scale. boolean customScale Allow to scale chart vertically by dragging Y axis with mouse. boolean customScaleDblClick Allows to double-click on Y axis to turn on auto-scale. boolean cursor string resizeDisabledCursor string labelBoxMargin YAxisConfig_labelBoxMargin fontSize number fontFamily string treasuryFormat Treasury format for price values (1/32 tick format for bonds) YAxisConfigTreasuryFormat enabled boolean grid GridComponentConfig visible boolean vertical Shows vertical grid lines. boolean horizontal Shows horizontal grid lines. boolean width Width of grid lines in pixels. number dash Line dash configuration like [1,2]. number[] color string volumes ChartConfigComponentsVolumes visible boolean showSeparately Show volumes in overlaying mode or as sub-chart like a study. boolean volumeFillColor string valueLines number barCapSize number volumeBarSpace number offsets ChartConfigComponentsOffsets visible boolean top Top offset, measured in percents of chart height. number left Left offset, measured in amount of candles. number right Right offset, measured in amount of candles. number bottom Bottom offset, measured in percents of chart height. number waterMark ChartConfigComponentsWaterMark visible boolean position Position on the screen. WaterMarkPositionType 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> offsetX number offsetY number logoWidth number logoHeight number fontFamily string firstRowFontSize Font size for first text line. number firstRowBottomPadding Padding after first text line. number secondRowFontSize Font size for second text line. number secondRowBottomPadding Padding after second text line. number thirdRowFontSize Font size for third text line. number thirdRowBottomPadding Padding after third text line. number events ChartConfigComponentsEvents visible Toggle events visibility. boolean eventsVisibility Toggle specific event type visibility (for example: dividends, splits, earnings). Record<EventType, boolean> height Height of events area in pixels number cursor Configure events cursor type. string xAxisLabelFormat Configure x axis labels DateTimeFormatConfig[] icons Configure icons, the format is string which contains svg tag, for example: '<svg width="13" height="13" viewBox="0 0 13 13" fill="none" xmlns="http://www.w3.org/2000/svg"> <path d="M1.06066 6.5L6.5 1.06066L11.9393 6.5L6.5 11.9393L1.06066 6.5Z" stroke="#D92C40" stroke-width="1.5"/> </svg>' ChartConfigComponentsEventsIcons earnings CustomIcon normal string hover string dividends CustomIcon splits CustomIcon conference-calls CustomIcon line Configure the event type vertical line appearance ChartConfigComponentsEventsLine earnings ChartConfigComponentsEventsLine_earnings dividends ChartConfigComponentsEventsLine_dividends splits ChartConfigComponentsEventsLine_splits conference-calls ChartConfigComponentsEventsLine_conference-calls highLow ChartConfigComponentsHighLow visible boolean font Font config of high/low labels. string prefix ChartConfigComponentsHighLow_prefix lineDash number[] crossTool ChartConfigComponentsCrossTool type The type of cross tool. Visibility is also contolled by type, set 'none' to hide the cross tool. string lineDash Line dash for cross tool. number[] discrete When discrete is ON - the cross tool X coordinate will always be at the middle of candle. boolean magnetTarget Cross tool Y coordinate can magnet to OHLC values of candle. MagnetTarget 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> xAxisLabelFormat Format of X label config for different periods. DateTimeFormatConfig[] xLabel X label appearance. ChartConfigComponentsCrossTool_xLabel yLabel X label appearance. ChartConfigComponentsCrossTool_yLabel highlights ChartConfigComponentsHighlights visible boolean border Border of highlights (session breaks for example). ChartConfigComponentsHighlights_border fontFamily string fontSize number navigationMap ChartConfigComponentsNavigationMap visible boolean allCandlesHistory boolean timeLabels ChartConfigComponentsNavigationMap_timeLabels cursors ChartConfigComponentsNavigationMap_cursors knots ChartConfigComponentsNavigationMap_knots minSliderWindowWidth number baseline ChartConfigComponentsBaseline cursor string dragZone number height number paneResizer Horizontal resizer between panes ChartConfigComponentsPaneResizer visible boolean height Height of resizer in pixels. number fixedMode Make the horizontal line fixed and disable resizing. boolean dragZone Hover area of resizer in pixels. number cursor string colors All colors in chart-core are configured here. FullChartColors candleTheme CandleTheme upColor string downColor string noneColor string upWickColor string downWickColor string noneWickColor string borderOpacity number activeCandleTheme CandleTheme barTheme LineStyleTheme upColor string downColor string noneColor string lineTheme LineStyleTheme areaTheme AreaStyleTheme lineColor string startColor string stopColor string chartAreaTheme ChartAreaTheme backgroundMode "regular" | "gradient" backgroundColor string backgroundGradientTopColor string backgroundGradientBottomColor string gridColor string scatterPlot ScatterPlotStyle mainColor string baseLineTheme BaselineStyleTheme upperSectionStrokeColor string lowerSectionStrokeColor string upperSectionFillColor string lowerSectionFillColor string baselineColor string histogram HistogramColors upCap string upBottom string upBright string downCap string downBottom string downBright string noneCap string noneBottom string noneBright string highlights Record<"AFTER_MARKET" | "PRE_MARKET" | "NO_TRADING" | "REGULAR", HighlightsColors> volume VolumeColors downCapColor string upCapColor string noneCapColor string downBarColor string upBarColor string noneBarColor string secondaryChartTheme SecondaryChartTheme[] waterMarkTheme FullChartColors_waterMarkTheme highLowTheme FullChartColors_highLowTheme yAxis FullChartColors_yAxis xAxis FullChartColors_xAxis crossTool FullChartColors_crossTool events ChartConfigComponentsEventsColors earnings EventColors line string normal string hover string color string dividends EventColors splits EventColors conference-calls EventColors navigationMap FullChartColors_navigationMap instrumentInfo FullChartColors_instrumentInfo paneResizer FullChartColors_paneResizer labels YAxisLabelsColors lastPrice YAxisLastPriceLabelColorConfig boxSelected string boxPositive string boxNegative string textSelected string textNegative string textPositive string bidAsk YAxisBidAskLabelColorConfig bid YAxisLabelColorConfig boxColor string textColor string descriptionText string descriptionTextColor string ask YAxisLabelColorConfig highLow YAxisHighLowLabelColorConfig high YAxisLabelColorConfig low YAxisLabelColorConfig prePostMarket YAxisPrePostMarketLabelColorConfig pre YAxisLabelColorConfig post YAxisLabelColorConfig prevDayClose YAxisLabelColorConfig dateFormatter Date and time formatting configuration. DateFormatter applyPattern (pattern: string) => string createFormatterFunction (pattern: string) => DateTimeFormatter utcTimeOverride DateFormatter_utcTimeOverride timezone Timezone to use on chart X axis labels and any other timestamps. Examples: Africa/Accra, Europe/Moscow, Asia/Tehran. string fixedSize If set - chart canvas will have fixed size always. FullChartConfig_fixedSize rtl Right to left mode. Used in drawings (like text drawing) calculation. boolean drawingOrder Initial visual order of chart drawers. Reorder to put volumes on top of candles for example. ("MAIN_BACKGROUND" | "MAIN_CLEAR" | "HIT_TEST_CLEAR" | "YAXIS_CLEAR" | "SERIES_CLEAR" | "OVER_SERIES_CLEAR" | "HIT_TEST_DRAWINGS" | "GRID" | "X_AXIS" | "Y_AXIS" | "HIGH_LOW" | ... 11 more ... | "CROSS_TOOL")[] intlFormatter IntlFormatter decimalSeparator string thousandsSeparator string useUTCTimeOverride boolean animation AnimationConfig duration number timeLeft number devexpertsPromoLink boolean shortDays string[] shortMonths string[]