API Reference - Configuration
ChartAppInitials
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[]
Initial aggregation period.
Example: { duration: 30, durationType: 'm' }
AggregationPeriod
"y" | "t" | "r" | "s" | "m" | "h" | "d" | "w" | "mo" | "v"
Initial timezone
Example: 'Asia/Anadyr', 'UTC'
string
Initial chart-core config.
PartialFullChartCoreConfigWithModulesColors
Controls how chart series are positioned horizontally and vertically.
Other configurations like: inverse, lockRatio etc.
any
Group of component configurations. Chart component is a single visual object on chart.
Examples: chart itself, events, x-axis, highlights, cross tool.
any
Date and time formatting configuration.
any
Timezone to use on chart X axis labels and any other timestamps.
Examples: Africa/Accra, Europe/Moscow, Asia/Tehran.
any
If set - chart canvas will have fixed size always.
any
Right to left mode. Used in drawings (like text drawing) calculation.
any
Initial visual order of chart drawers. Reorder to put volumes on top of candles for example.
any
Array of initial studies.
string[]
Initial theme.
"dark" | "light" | "cloudDancer" | "oud" | "solar" | "still"
initialChartReactSettings
Initial chart react settings.
DeepPartial<ChartReactSettings>
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>
Initial Timeframe preset.
TimeframePreset<Timeframe>
ChartReactAppConfig
The main configuration place for chart-react.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[]
Object with all textual information in chart - override it to make chart in other language.
DeepPartial<Localization>
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
In multiple mode each chart will render its own toolbar.
"single" | "multiple"
{
enabled?: boolean;
/**
* The maximum allowed amount of charts
* Accepts values: 1, 2, 3, 4, 8
*/
maxChartsAmount?: ChartsAmount;
/** Configuration for multichart settings popover options */
options?: {
/** Layout selector section */
layout?: { enabled?: boolean };
/** Synchronize symbol option */
symbol?: { enabled?: boolean };
/** Synchronize chart type option */
chartType?: { enabled?: boolean };
/** Synchronize timeframe/range option */
timeframeRange?: { enabled?: boolean };
/** Synchronize appearance option */
appearance?: { enabled?: boolean };
/** Synchronize indicators/studies option */
indicators?: { enabled?: boolean };
/** Synchronize crosshair option */
crosshair?: { enabled?: boolean };
/** Synchronize drawings option */
drawings?: { enabled?: boolean };
};
}
Use it, if you want to hide/show Trading tab from settings
boolean
Enables/disables creating new orders from Order Entry
boolean
When true, displays order prices as Y-axis labels instead of text on the order line
boolean
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
Default quantity value for order entry
number
Number of decimal places for order quantity (e.g. 0 for integers, 2 for 0.01 precision)
number
Step value for quantity increment/decrement buttons
number
Limits min quantity for order entry
number
Limits max quantity for order entry
number
Currency symbol to display (e.g. '$', '€')
string
Configuration for available order types (market, limit, stop)
PartialOrderTypes
customTradingGroupComparator
Comparator for ordering orders and positions inside a trading group.
TradingGroupComparator
Configuration for legend order entry UI visibility
PartialLegendOrderEntryConfig
Show/hide buy/sell buttons in the legend header
boolean
Show/hide quantity counter in the legend header
boolean
Configuration for y axis order entry UI visibility
PartialYAxisOrderEntryConfig
Show/hide the "+" button on y axis
boolean
specificCompactStudyTitles
Record<string, string>
{
enabled?: boolean;
footer?: DrawingsSidebarFooterConfig;
}
PartialRiskRewardDrawingsConfig
Important!
Couldn't be used along with object tree(layers) component
{
enabled?: boolean;
}
{
enabled?: boolean;
showButtonsTooltip?: boolean;
/** Configuration for individual toolbar buttons visibility */
buttons?: ToolbarButtonsConfig;
}
Configuration for chart settings tabs visibility
SettingsTabsConfig
General settings tab
{
enabled?: boolean;
/** Configuration for individual general settings options */
options?: {
/** High and low price labels */
highAndLow?: { enabled?: boolean };
/** Horizontal grid lines */
horizontalGrid?: { enabled?: boolean };
/** Vertical grid lines */
verticalGrid?: { enabled?: boolean };
/** Candle wicks visibility */
candleWick?: { enabled?: boolean };
/** Show close price (for equivolume chart type) */
showClosePrice?: { enabled?: boolean };
/** Watermark visibility */
watermark?: { enabled?: boolean };
/** Crosshair and snap to options */
crosshair?: { enabled?: boolean };
};
}
Trading settings tab
{
enabled?: boolean;
/** Configuration for individual trading settings options */
options?: {
/** Trading from chart checkbox */
tradingFromChart?: { enabled?: boolean };
/** Show orders checkbox */
showOrders?: { enabled?: boolean };
/** Show positions checkbox */
showPositions?: { enabled?: boolean };
/** Show executed orders checkbox */
showExecutedOrders?: { enabled?: boolean };
};
}
Legend settings tab
{
enabled?: boolean;
/** Configuration for individual legend settings options */
options?: {
/** Instrument name checkbox */
instrumentName?: { enabled?: boolean };
/** OHLC values checkbox */
ohlcValues?: { enabled?: boolean };
/** Price change checkbox */
priceChange?: { enabled?: boolean };
/** Volume checkbox */
volume?: { enabled?: boolean };
/** Period checkbox */
period?: { enabled?: boolean };
};
}
Scales settings tab
{
enabled?: boolean;
/** Configuration for individual scales settings options */
options?: {
/** Auto scale checkbox */
autoScale?: { enabled?: boolean };
/** Fit studies checkbox */
fitStudies?: { enabled?: boolean };
/** Fit positions checkbox */
fitPositions?: { enabled?: boolean };
/** Fit orders checkbox */
fitOrders?: { enabled?: boolean };
/** Invert scale checkbox */
invertScale?: { enabled?: boolean };
/** Lock price to bar ratio checkbox */
lockPriceToBarRatio?: { enabled?: boolean };
/** Axis type radio buttons */
axisType?: { enabled?: boolean };
/** Axis align radio buttons */
axisAlign?: { enabled?: boolean };
/** Labels and lines popover */
labelsAndLinesPopover?: { enabled?: boolean };
};
}
Market settings tab
{
enabled?: boolean;
/** Configuration for individual market settings options */
options?: {
/** Session breaks checkbox */
sessionBreaks?: { enabled?: boolean };
/** Extended hours checkbox */
extendedHours?: { enabled?: boolean };
/** Align data to session start checkbox */
alignDataToSessionStart?: { enabled?: boolean };
/** Price type selectbox */
priceType?: { enabled?: boolean };
/** Volume checkbox */
volume?: { enabled?: boolean };
/** Volume type radio buttons (overlaying/separate) */
volumeType?: { enabled?: boolean };
};
}
Colors settings tab
{
enabled?: boolean;
/** Configuration for individual colors settings options */
options?: {
/** Theme switcher */
themeSwitcher?: { enabled?: boolean };
};
}
Events settings tab
{
enabled?: boolean;
/** Configuration for individual events settings options */
options?: {
/** Events on chart checkbox */
eventsOnChart?: { enabled?: boolean };
/** Dividends checkbox */
dividends?: { enabled?: boolean };
/** Splits checkbox */
splits?: { enabled?: boolean };
/** Earnings checkbox */
earnings?: { enabled?: boolean };
/** Conference calls checkbox */
conferenceCalls?: { enabled?: boolean };
/** News checkbox */
news?: { enabled?: boolean };
};
}
Paddings settings tab
{
enabled?: boolean;
/** Configuration for individual paddings settings options */
options?: {
/** Top padding stepper */
top?: { enabled?: boolean };
/** Right padding stepper */
right?: { enabled?: boolean };
/** Bottom padding stepper */
bottom?: { enabled?: boolean };
};
}
{
enabled?: boolean;
visible?: boolean;
}
PartialActionsHistoryConfig
PartialCustomPeriodInputConfig
PartialTimeframePresetsConfig
PartialTimeframePresetsConfigMode
Returns a string representation of a string.
() => string
Returns the character at the specified index.
(pos: number) => string
Returns the Unicode value of the character at the specified location.
(index: number) => number
Returns a string that contains the concatenation of two or more strings.
(...strings: string[]) => string
Returns the position of the first occurrence of a substring.
(searchString: string, position?: number) => number
Returns the last occurrence of a substring in the string.
(searchString: string, position?: number) => number
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; }
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; }
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; }
Finds the first substring match in a regular expression search.
{ (regexp: string | RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }
Returns a section of a string.
(start?: number, end?: number) => string
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[]; }
Returns the substring at the specified location within a String object.
(start: number, end?: number) => string
Converts all the alphabetic characters in a string to lowercase.
() => string
Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.
{ (locales?: string | string[]): string; (locales?: LocalesArgument): string; }
Converts all the alphabetic characters in a string to uppercase.
() => string
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; }
Removes the leading and trailing white space and line terminator characters from a string.
() => string
Returns the length of a String object.
number
Gets a substring beginning at the specified location and having the specified length.
(from: number, length?: number) => string
Returns the primitive value of the specified object.
() => string
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
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
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
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; }
Returns a String value that is made from count copies appended together. If count is 0,
the empty string is returned.
(count: number) => string
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
Returns an `<a>` HTML anchor element and sets the name attribute to the text value
(name: string) => string
Returns a `<big>` HTML element
() => string
Returns a `<blink>` HTML element
() => string
Returns a `<b>` HTML element
() => string
Returns a `<tt>` HTML element
() => string
Returns a `<font>` HTML element and sets the color attribute value
(color: string) => string
Returns a `<font>` HTML element and sets the size attribute value
{ (size: number): string; (size: string): string; }
Returns an `<i>` HTML element
() => string
Returns an `<a>` HTML element and sets the href attribute value
(url: string) => string
Returns a `<small>` HTML element
() => string
Returns a `<strike>` HTML element
() => string
Returns a `<sub>` HTML element
() => string
Returns a `<sup>` HTML element
() => string
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
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
Removes the trailing white space and line terminator characters from a string.
() => string
Removes the leading white space and line terminator characters from a string.
() => string
Removes the leading white space and line terminator characters from a string.
() => string
Removes the trailing white space and line terminator characters from a string.
() => string
Matches a string with a regular expression, and returns an iterable of matches
containing the results of that search.
(regexp: RegExp) => RegExpStringIterator<RegExpExecArray>
Iterator
() => StringIterator<string>
PartialChartDataOptionsConfig
Timeout in ms during which the chart will wait for the data
if no data are sent, the chart will apply empty array
number
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
An array of supported price types
PartialPriceTypesConfig
Gets or sets the length of the array. This is a number one higher than the highest index in the array.
number
Returns a string representation of an array.
() => string
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; }
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"
Appends new elements to the end of an array, and returns the new length of the array.
(...items: ("last" | "mark" | "bid" | "ask")[]) => number
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")[]; }
Adds all the elements of an array into a string, separated by the specified separator string.
(separator?: string) => string
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")[]
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"
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")[]
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
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")[]; }
Inserts new elements at the start of an array, and returns the new length of the array.
(...items: ("last" | "mark" | "bid" | "ask")[]) => number
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
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
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...
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
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
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[]
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, ...
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...
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...
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...
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
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
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
Returns an iterable of key, value pairs for every entry in the array
() => ArrayIterator<[number, "last" | "mark" | "bid" | "ask"]>
Returns an iterable of keys in the array
() => ArrayIterator<number>
Returns an iterable of values in the array
() => ArrayIterator<"last" | "mark" | "bid" | "ask">
Determines whether an array includes a certain element, returning true or false as appropriate.
(searchElement: "last" | "mark" | "bid" | "ask", fromIndex?: number) => boolean
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[]
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
() => ArrayIterator<"last" | "mark" | "bid" | "ask">
Is an object whose properties have the value 'true'
when they will be absent when used in a 'with' statement.
{ [x: number]: boolean; length?: boolean; toString?: boolean; toLocaleString?: boolean; pop?: boolean; push?: boolean; concat?: boolean; join?: boolean; reverse?: boolean; shift?: boolean; slice?: boolean; sort?: boolean; ... 22 more ...; readonly [Symbol.unscopables]?: boolean; }
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
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
{
enabled: boolean;
}
{
/* instrument - default chart watermark logic (shows selected instrument data)
** custom - data is customizable with chart.watermark.setWaterMarkData
*/
mode: 'instrument' | 'custom';
}
PartialRightClickMenuConfig
{
showMarketPrice?: boolean;
showLimitPrice?: boolean;
showStopPrice?: boolean;
}
Configuration for background menu elements visibility
BackgroundMenuElementsConfig
Buy at market price button
{ enabled?: boolean }
Sell at market price button
{ enabled?: boolean }
Buy limit order button
{ enabled?: boolean }
Sell limit order button
{ enabled?: boolean }
Crosshair toggle checkbox
{ enabled?: boolean }
Session breaks toggle checkbox
{ enabled?: boolean }
Extended hours toggle checkbox
{ enabled?: boolean }
Watermark toggle checkbox
{ enabled?: boolean }
Grid settings popover
{ enabled?: boolean }
Theme settings popover
{ enabled?: boolean }
Recent drawings popover
{ enabled?: boolean }
Hide/show drawings checkbox
{ enabled?: boolean }
Clear all drawings button
{ enabled?: boolean }
Clear all indicators button
{ enabled?: boolean }
Open settings button
{ enabled?: boolean }
Reset chart view (X/Y scale) — top of menu; same as floating reset / Alt+R
{ enabled?: boolean }
Restore default chart settings (layout, studies, etc.)
{ enabled?: boolean }
Configuration for data series menu elements visibility
DataMenuElementsConfig
Chart type popover
{ enabled?: boolean }
Price type popover
{ enabled?: boolean }
Color picker item
{ enabled?: boolean }
Bring to front button
{ enabled?: boolean }
Send to back button
{ enabled?: boolean }
Configuration for studies menu elements visibility
StudiesMenuElementsConfig
Bring to front button
{ enabled?: boolean }
Send to back button
{ enabled?: boolean }
Duplicate study button
{ enabled?: boolean }
Hide study button
{ enabled?: boolean }
Move to pane above button
{ enabled?: boolean }
Move to pane below button
{ enabled?: boolean }
Pin to scale popover
{ enabled?: boolean }
Configure study button
{ enabled?: boolean }
Configuration for drawings menu elements visibility
DrawingsMenuElementsConfig
Bring to front button
{ enabled?: boolean }
Bring forward button
{ enabled?: boolean }
Send backward button
{ enabled?: boolean }
Send to back button
{ enabled?: boolean }
Lock drawing button
{ enabled?: boolean }
Hide drawing button
{ enabled?: boolean }
Configuration for legend menu elements visibility
LegendMenuElementsConfig
Instrument name checkbox
{ enabled?: boolean }
OHLC values checkbox
{ enabled?: boolean }
Price change checkbox
{ enabled?: boolean }
Volume checkbox
{ enabled?: boolean }
Period checkbox
{ enabled?: boolean }
Configuration for Y-axis menu elements visibility
YAxisMenuElementsConfig
Auto scale checkbox
{ enabled?: boolean }
Fit orders checkbox
{ enabled?: boolean }
Fit positions checkbox
{ enabled?: boolean }
Fit studies checkbox
{ enabled?: boolean }
Invert scale checkbox
{ enabled?: boolean }
lockPriceToBarRatioCheckbox
Lock price to bar ratio checkbox
{ enabled?: boolean }
Axis align button
{ enabled?: boolean }
Regular axis type checkbox
{ enabled?: boolean }
Percent axis type checkbox
{ enabled?: boolean }
logarithmicAxisTypeCheckbox
Logarithmic axis type checkbox
{ enabled?: boolean }
Labels and lines popover
{ enabled?: boolean }
Configuration for floating buttons (zoom in/out, return to now, move pane buttons)
{
zoom?: { enabled?: boolean };
/** Reset chart view (default X/Y scale) — floating button + Alt/Option+R */
resetChartView?: { enabled?: boolean };
returnToNow?: { enabled?: boolean };
movePaneButtons?: { enabled?: boolean };
}
{
width: number;
height: number;
}
`DMY` or NA standart `MDY`
DateFormatType
Returns a string representation of a string.
() => string
Returns the character at the specified index.
(pos: number) => string
Returns the Unicode value of the character at the specified location.
(index: number) => number
Returns a string that contains the concatenation of two or more strings.
(...strings: string[]) => string
Returns the position of the first occurrence of a substring.
(searchString: string, position?: number) => number
Returns the last occurrence of a substring in the string.
(searchString: string, position?: number) => number
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; }
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; }
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; }
Finds the first substring match in a regular expression search.
{ (regexp: string | RegExp): number; (searcher: { [Symbol.search](string: string): number; }): number; }
Returns a section of a string.
(start?: number, end?: number) => string
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[]; }
Returns the substring at the specified location within a String object.
(start: number, end?: number) => string
Converts all the alphabetic characters in a string to lowercase.
() => string
Converts all alphabetic characters to lowercase, taking into account the host environment's current locale.
{ (locales?: string | string[]): string; (locales?: LocalesArgument): string; }
Converts all the alphabetic characters in a string to uppercase.
() => string
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; }
Removes the leading and trailing white space and line terminator characters from a string.
() => string
Returns the length of a String object.
number
Gets a substring beginning at the specified location and having the specified length.
(from: number, length?: number) => string
Returns the primitive value of the specified object.
() => string
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
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
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
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; }
Returns a String value that is made from count copies appended together. If count is 0,
the empty string is returned.
(count: number) => string
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
Returns an `<a>` HTML anchor element and sets the name attribute to the text value
(name: string) => string
Returns a `<big>` HTML element
() => string
Returns a `<blink>` HTML element
() => string
Returns a `<b>` HTML element
() => string
Returns a `<tt>` HTML element
() => string
Returns a `<font>` HTML element and sets the color attribute value
(color: string) => string
Returns a `<font>` HTML element and sets the size attribute value
{ (size: number): string; (size: string): string; }
Returns an `<i>` HTML element
() => string
Returns an `<a>` HTML element and sets the href attribute value
(url: string) => string
Returns a `<small>` HTML element
() => string
Returns a `<strike>` HTML element
() => string
Returns a `<sub>` HTML element
() => string
Returns a `<sup>` HTML element
() => string
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
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
Removes the trailing white space and line terminator characters from a string.
() => string
Removes the leading white space and line terminator characters from a string.
() => string
Removes the leading white space and line terminator characters from a string.
() => string
Removes the trailing white space and line terminator characters from a string.
() => string
Matches a string with a regular expression, and returns an iterable of matches
containing the results of that search.
(regexp: RegExp) => RegExpStringIterator<RegExpExecArray>
Iterator
() => StringIterator<string>
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
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
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[]
Icons set for Icon drawing.
Readonly<Record<string, IconDefinition>>
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" | ... 37 more ... | "risk_reward_short"> | ThemedDrawingsConfig
Callback which returns you object with useful API that you can call on chart to modify it.
(api: ChartReactAPI) => void
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".
DeepPartial<ChartAppPalette>
List of timezones and your current timezone.
Example: ['Europe/Berlin', 'America/Argentina/Buenos_Aires']
Partial<TimezonesConfig>
List of chart types and initial chart type
Example: { initialChartType: candle, listOfChartTypes: ['candle', 'line', 'area', 'equivolume', 'heikinAshi']}
Partial<ChartTypesConfig>