Interface: RawStudyMetaInfo
Charting Library.RawStudyMetaInfo
Hierarchy
-
↳
RawStudyMetaInfo
Properties
_metainfoVersion
• Optional Readonly _metainfoVersion: number
Metainfo version of the study. The current version is 53, and the default one is 0.
Inherited from
RawStudyMetaInfoBase._metainfoVersion
bands
• Optional Readonly bands: readonly Readonly<StudyBandInfo>[]
Bands
Inherited from
defaults
• Readonly defaults: Readonly<Partial<StudyDefaults>>
an object containing settings that are applied when user clicks 'Apply Defaults'. See dedicated article: Custom Studies Defaults
Inherited from
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
Inherited from
RawStudyMetaInfoBase.description
filledAreas
• Optional Readonly 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.
Inherited from
RawStudyMetaInfoBase.filledAreas
financialPeriod
• Optional Readonly financialPeriod: FinancialPeriod
Financial Period
Inherited from
RawStudyMetaInfoBase.financialPeriod
format
• Readonly format: StudyPlotValueFormat
Info about the Price Scale formatting
Inherited from
groupingKey
• Optional Readonly groupingKey: string
Key for grouping studies
Inherited from
RawStudyMetaInfoBase.groupingKey
id
• Readonly id: RawStudyMetaInfoId
Identifier for Study
inputs
• Optional Readonly inputs: StudyInputInfoList
array with inputs info depending on type. See dedicated article: Custom Studies Inputs
Inherited from
isCustomIndicator
• Optional Readonly isCustomIndicator: boolean
should be true in Custom Study
Inherited from
RawStudyMetaInfoBase.isCustomIndicator
is_hidden_study
• Optional Readonly is_hidden_study: boolean
Whether the study should appear in Indicators list.
Inherited from
RawStudyMetaInfoBase.is_hidden_study
is_price_study
• Optional Readonly is_price_study: boolean
Whether the study should appear on the main series pane
Inherited from
RawStudyMetaInfoBase.is_price_study
linkedToSeries
• Optional Readonly linkedToSeries: boolean
Whether the study price scale should be the same as the main series one.
Inherited from
RawStudyMetaInfoBase.linkedToSeries
name
• Optional Readonly name: string
Name for the study
Inherited from
ohlcPlots
• Optional Readonly ohlcPlots: MappedObject<Readonly<StudyOhlcStylesInfo>>
array with study plots info. See dedicated article: Custom Studies OHLC Plots
Inherited from
RawStudyMetaInfoBase.ohlcPlots
palettes
• Optional Readonly 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.
Inherited from
plots
• Optional Readonly plots: readonly Readonly<StudyPlotInformation>[]
array with study plots info. See dedicated article: Custom Studies Plots
Inherited from
precision
• Optional Readonly precision: string | number
Precision of the study's output values (quantity of digits after the decimal separator)
Inherited from
RawStudyMetaInfoBase.precision
priceScale
• Optional Readonly priceScale: StudyTargetPriceScale
Price scale to use for the study
Inherited from
RawStudyMetaInfoBase.priceScale
shortDescription
• Readonly shortDescription: string
Short description of the study. Will be displayed on the chart
Inherited from
RawStudyMetaInfoBase.shortDescription
styles
• Optional Readonly styles: MappedObject<Readonly<StudyStylesInfo>>
an object with plot id as keys and style info as values.
Inherited from
symbolSource
• Optional Readonly symbolSource: SymbolInputSymbolSource
Symbol source