Skip to main content

Interface: RawStudyMetaInfoBase

Charting Library.RawStudyMetaInfoBase

Hierarchy​

Properties​

_metainfoVersion​

OptionalReadonly

_metainfoVersion: number

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

bands​

OptionalReadonly

bands: readonly Readonly<StudyBandInfo>[]

Bands

behind_chart​

OptionalReadonly

behind_chart: boolean

Define should be study on series level or not

defaults​

Readonly

defaults: Readonly<Partial<StudyDefaults>>

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

description​

Readonly

description: string

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

filledAreas​

OptionalReadonly

filledAreas: readonly Readonly<StudyFilledAreaInfo>[]

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.

financialPeriod​

OptionalReadonly

financialPeriod: FinancialPeriodOrAggregated

Financial Period

format​

Readonly

format: StudyPlotValueFormat

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.

groupingKey​

OptionalReadonly

groupingKey: string

Key for grouping studies

inputs​

OptionalReadonly

inputs: StudyInputInfoList

An array of objects that represent input parameters. For more information, refer to the Inputs article.

isCustomIndicator​

OptionalReadonly

isCustomIndicator: boolean

should be true in Custom Study

is_hidden_study​

OptionalReadonly

is_hidden_study: boolean

Whether the study should appear in Indicators list.

is_price_study​

OptionalReadonly

is_price_study: boolean

Whether the study should appear on the main series pane

linkedToSeries​

OptionalReadonly

linkedToSeries: boolean

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

name​

OptionalReadonly

name: string

Name for the study

ohlcPlots​

OptionalReadonly

ohlcPlots: MappedObject<Readonly<StudyOhlcStylesInfo>>

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

palettes​

OptionalReadonly

palettes: MappedObject<Readonly<StudyPalettesInfo>>

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.

plots​

OptionalReadonly

plots: readonly Readonly<StudyPlotInformation>[]

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

precision​

DeprecatedOptionalReadonly

precision: string | number

Deprecated

This signature is deprecated.

Use format instead.

priceScale​

OptionalReadonly

priceScale: StudyTargetPriceScale

Price scale to use for the study

shortDescription​

Readonly

shortDescription: string

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

styles​

OptionalReadonly

styles: MappedObject<Readonly<StudyStylesInfo>>

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

symbolSource​

OptionalReadonly

symbolSource: SymbolInputSymbolSource

Symbol source