StudyFilledAreaInfo

Interface

A description of a study filled area.

Properties

bottomColor

OptionalReadonly

Color for the bottom of the filled area.

Type

​string

---

bottomValue

OptionalReadonly

Value at which the bottom of the filled area is drawn.

Example

75 // Drawn at price = 75

Type

​number

---

fillToIntersection

OptionalReadonly

Should the area be filled up to the point that two plots intersect, instead of by plot index?

Used for plot_plot filled area types.

Type

​boolean

---

fillgaps

OptionalReadonly

Should gaps in the area be filled?

Type

​boolean

---

id

Readonly

Study ID.

Type

​string

---

isHidden

OptionalReadonly

Filled area's style inputs visibility flag. Used to hide the band from the style tab of study properties dialogs.

Type

​boolean

---

objAId

Readonly

Study band ID.

See

StudyBandInfo

Type

​string

---

objBId

Readonly

Study band ID.

See

StudyBandInfo

Type

​string

---

palette

OptionalReadonly

Color palette ID.

Type

​string

---

title

Readonly

Title that will appear in the styles tab of the study settings dialog.

Type

​string

---

topColor

OptionalReadonly

Color for the top of the filled area.

Type

​string

---

topValue

OptionalReadonly

Value at which the top of the filled area is drawn.

Example

75 // Drawn at price = 75

Type

​number

---

type

Readonly

Filled area type.

Type

​FilledAreaType

---

zorder

OptionalReadonly

Filled area z-order.

Type

​number