Skip to main content
Version: latest

RawStudyMetaInfoBase

Interface

Properties

_metainfoVersion

OptionalReadonly

Metainfo version of the study. The current version is 53, and the default one is 0.

Type

number


bands

OptionalReadonly

Bands

Type

readonly Readonly<StudyBandInfo>[]


defaults

Readonly

an object containing settings that are applied when user clicks 'Apply Defaults'. See dedicated article: Custom Studies Defaults

Type

Readonly<Partial<StudyDefaults>>


description

Readonly

Description of the study. It will be displayed in the Indicators window and will be used as a name argument when calling the createStudy method

Type

string


filledAreas

OptionalReadonly

Filled area is a special object, which allows coloring an area between two plots or hlines. Please note, that it is impossible to fill the area between a band and a hline.

Type

readonly Readonly<StudyFilledAreaInfo>[]


financialPeriod

OptionalReadonly

Financial Period

Type

FinancialPeriod


format

Readonly

A type of data that an indicator displays, such as volume or price. Values on the Price Scale depend on this data type. Additionally, you can adjust a precision of indicator values. To do this, specify the precision property in StudyPlotValuePrecisionFormat.

For more information about format, refer to the Metainfo article.

Type

StudyPlotValueFormat


groupingKey

OptionalReadonly

Key for grouping studies

Type

string


inputs

OptionalReadonly

array with inputs info depending on type. See dedicated article: Custom Studies Inputs

Type

StudyInputInfoList


isCustomIndicator

OptionalReadonly

should be true in Custom Study

Type

boolean


is_hidden_study

OptionalReadonly

Whether the study should appear in Indicators list.

Type

boolean


is_price_study

OptionalReadonly

Whether the study should appear on the main series pane

Type

boolean


linkedToSeries

OptionalReadonly

Whether the study price scale should be the same as the main series one.

Type

boolean


name

OptionalReadonly

Name for the study

Type

string


ohlcPlots

OptionalReadonly

array with study plots info. See dedicated article: Custom Studies OHLC Plots

Type

MappedObject<Readonly<StudyOhlcStylesInfo>>


palettes

OptionalReadonly

definitions of palettes that are used in plots and defaults. Palettes allows you use different styles (not only colors) for each line point.

This object contains palette names as keys, and palette info as values: [palette.name]: { colors, valToIndex, addDefaultColor }, where

  • colors* - an object { [color_id]: { name: 'name' }}, where name is a string that will appear on Style tab of study properties dialog.
  • valToIndex - an object, the mapping between the values that are returned by the script and palette colors.
  • addDefaultColor - boolean, if true the defaults are used for colorer type plot, when its value is null or undefined.

Type

MappedObject<Readonly<StudyPalettesInfo>>


plots

OptionalReadonly

array with study plots info. See dedicated article: Custom Studies Plots

Type

readonly Readonly<StudyPlotInformation>[]


precision

DeprecatedOptionalReadonly

Use format instead.

Type

string | number


priceScale

OptionalReadonly

Price scale to use for the study

Type

StudyTargetPriceScale


shortDescription

Readonly

Short description of the study. Will be displayed on the chart

Type

string


styles

OptionalReadonly

an object with plot id as keys and style info as values.

Type

MappedObject<Readonly<StudyStylesInfo>>


symbolSource

OptionalReadonly

Symbol source

Type

SymbolInputSymbolSource