ProgressBarComponent

Defined in: obsidian.d.ts:3393

Extends

• ValueComponent<number>

Constructors

new ProgressBarComponent()

new ProgressBarComponent(containerEl): ProgressBarComponent

Defined in: obsidian.d.ts:3398

Parameters

containerEl

HTMLElement

Returns

ProgressBarComponent

Overrides

ValueComponent.constructor

Properties

disabled

disabled: boolean

Defined in: obsidian.d.ts:423

Inherited from

ValueComponent.disabled

---

lineEl

lineEl: HTMLDivElement

Defined in: src/obsidian/augmentations/Components/ProgressBarComponent.d.ts:8

Access the “line” element which is a child of the progressBar element

---

progressBar

progressBar: HTMLDivElement

Defined in: src/obsidian/augmentations/Components/ProgressBarComponent.d.ts:12

Access the “bar” element

Methods

getValue()

getValue(): number

Defined in: obsidian.d.ts:3402

Returns

number

Overrides

ValueComponent.getValue

---

registerOptionListener()

registerOptionListener(listeners, key): this

Defined in: obsidian.d.ts:4219

Parameters

listeners

Record<string, (value?) => number>

key

string

Returns

this

Inherited from

ValueComponent.registerOptionListener

---

setDisabled()

setDisabled(disabled): this

Defined in: obsidian.d.ts:432

Parameters

disabled

boolean

Returns

this

Inherited from

ValueComponent.setDisabled

---

setValue()

setValue(value): this

Defined in: obsidian.d.ts:3407

Parameters

value

number

The progress amount, a value between 0-100.

Returns

this

Overrides

ValueComponent.setValue

---

setVisibility()

setVisibility(visible): this

Defined in: src/obsidian/augmentations/Components/ProgressBarComponent.d.ts:20

Shows/hides the component

Parameters

visible

boolean

Whether the setting should be visible

Returns

this

The component

---

then()

then(cb): this

Defined in: obsidian.d.ts:428

Facilitates chaining

Parameters

cb

(component) => any

Returns

this

Inherited from

ValueComponent.then