Skip to main content

Interface: StudyInputBaseInfo

Charting Library.StudyInputBaseInfo

Hierarchy​

Properties​

active​

OptionalReadonly

active: boolean

Whether the input should be rendered based on user inputs

confirm​

OptionalReadonly

confirm: boolean

if true, then user will be asked to confirm input value before indicator is added to chart. Default value is false.

defval​

OptionalReadonly

defval: StudyInputValue

default value of the input variable. It has the specific type for a given input and can be optional.

group​

OptionalReadonly

group: string

Creates a header above all inputs that share the same group string. This string is used as the header's display text in the Settings dialog.

hideWhenPlotsHidden​

OptionalReadonly

hideWhenPlotsHidden: string[]

An array of plot ids, upon the hiding of which, this input should also be hidden within the legend

id​

Readonly

id: string

Id for the input

isAlwaysShownInLegend​

OptionalReadonly

isAlwaysShownInLegend: boolean

Is the input always visible in the legend, even when the user hides indicator inputs in the legend

isHidden​

OptionalReadonly

isHidden: boolean

Is the input hidden

name​

Readonly

name: string

Title of the input

type​

Readonly

type: StudyInputType

Input type

visible​

OptionalReadonly

visible: string

Is the input visible