Skip to main content
Version: v26

Favorites<TChartTypeFavorites>

Interface

Favorites which can be defined within the Widget Constructor options (see ChartingLibraryWidgetOptions.favorites).

Type parameters​

Name
TChartTypeFavorites

Properties​

chartTypes​

Optional

An array of chart types that are marked as favorite. The names of chart types are listed within the ChartTypeFavorites or TradingTerminalChartTypeFavorites type.

Example: ["Area", "Candles"].

Type​

​TChartTypeFavorites[]

drawingTools​

Optional

An array of drawing tool identifiers that should be marked as favorite. These will only be applied if there aren't existing favorites.

Example: ['LineToolBrush', 'LineToolCallout', 'LineToolCircle']

Type​

​DrawingToolIdentifier[]

indicators​

Optional

An array of indicator titles that are marked as favorite. The names of indicators are identical to the title property of the indicator. For built-in indicators this will match the chart UI in the English version.

Example: ["Awesome Oscillator", "Bollinger Bands"].

Type​

​string[]

intervals​

Optional

An array of time intervals that are marked as favorite.

Example: ["D", "2D"]

Type​

​ResolutionString[]