Skip to main content

Interface: StudyBooleanInputInfo

Charting Library.StudyBooleanInputInfo

Hierarchy​

Properties​

active​

OptionalReadonly

active: boolean

Whether the input should be rendered based on user inputs

Inherited from​

StudyInputBaseInfo.active

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.

Inherited from​

StudyInputBaseInfo.confirm

defval​

Readonly

defval: boolean

Default value for the input

Overrides​

StudyInputBaseInfo.defval

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.

Inherited from​

StudyInputBaseInfo.group

hideWhenPlotsHidden​

OptionalReadonly

hideWhenPlotsHidden: string[]

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

Inherited from​

StudyInputBaseInfo.hideWhenPlotsHidden

id​

Readonly

id: string

Id for the input

Inherited from​

StudyInputBaseInfo.id

isAlwaysShownInLegend​

OptionalReadonly

isAlwaysShownInLegend: boolean

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

Inherited from​

StudyInputBaseInfo.isAlwaysShownInLegend

isHidden​

OptionalReadonly

isHidden: boolean

Is the input hidden

Inherited from​

StudyInputBaseInfo.isHidden

name​

Readonly

name: string

Title of the input

Inherited from​

StudyInputBaseInfo.name

type​

Readonly

type: Bool

Input type is Boolean

Overrides​

StudyInputBaseInfo.type

visible​

OptionalReadonly

visible: string

Is the input visible

Inherited from​

StudyInputBaseInfo.visible