ProgressBarComponent
Defined in: obsidian.d.ts:3461
Extends
Section titled “Extends”ValueComponent<number>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ProgressBarComponent(
containerEl):ProgressBarComponent
Defined in: obsidian.d.ts:3466
Parameters
Section titled “Parameters”containerEl
Section titled “containerEl”Returns
Section titled “Returns”ProgressBarComponent
Overrides
Section titled “Overrides”Properties
Section titled “Properties”disabled
Section titled “disabled”disabled:
boolean
Defined in: obsidian.d.ts:439
Inherited from
Section titled “Inherited from”lineEl
Section titled “lineEl”lineEl:
HTMLDivElement
Defined in: src/obsidian/augmentations/Components/ProgressBarComponent.d.ts:13
Access the “line” element which is a child of the progressBar element.
progressBar
Section titled “progressBar”progressBar:
HTMLDivElement
Defined in: src/obsidian/augmentations/Components/ProgressBarComponent.d.ts:20
Access the “bar” element.
Methods
Section titled “Methods”constructor__()
Section titled “constructor__()”constructor__(
containerEl):this
Defined in: src/obsidian/augmentations/Components/ProgressBarComponent.d.ts:29
Creates a new ProgressBarComponent.
Parameters
Section titled “Parameters”containerEl
Section titled “containerEl”The container element.
Returns
Section titled “Returns”this
getValue()
Section titled “getValue()”Call Signature
Section titled “Call Signature”getValue():
number
Defined in: obsidian.d.ts:3470
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”getValue():
number
Defined in: src/obsidian/augmentations/Components/ProgressBarComponent.d.ts:37
Get the current value of the progress bar (0-100).
Returns
Section titled “Returns”number
The current value of the progress bar.
Inherited from
Section titled “Inherited from”ValueComponent.getValue
getValue__()?
Section titled “getValue__()?”
optionalgetValue__():number
Defined in: src/obsidian/augmentations/Components/ValueComponent.d.ts:15
Get the value of the component.
Returns
Section titled “Returns”number
The value of the component.
Inherited from
Section titled “Inherited from”registerOptionListener()
Section titled “registerOptionListener()”Call Signature
Section titled “Call Signature”registerOptionListener(
listeners,key):this
Defined in: obsidian.d.ts:4305
Parameters
Section titled “Parameters”listeners
Section titled “listeners”Record<string, (value?) => number>
string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”ValueComponent.registerOptionListener
Call Signature
Section titled “Call Signature”registerOptionListener(
listeners,key):this
Defined in: src/obsidian/augmentations/Components/ValueComponent.d.ts:33
Register an option listener.
Parameters
Section titled “Parameters”listeners
Section titled “listeners”Record<string, (value?) => number>
The listeners to register.
string
The key of the option.
Returns
Section titled “Returns”this
The component.
Example
Section titled “Example”valueComponent.registerOptionListener({ 'foo': (value) => { console.log(value); }}, 'foo');Inherited from
Section titled “Inherited from”ValueComponent.registerOptionListener
setDisabled()
Section titled “setDisabled()”Call Signature
Section titled “Call Signature”setDisabled(
disabled):this
Defined in: obsidian.d.ts:448
Parameters
Section titled “Parameters”disabled
Section titled “disabled”boolean
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”setDisabled(
disabled):this
Defined in: src/obsidian/augmentations/Components/BaseComponent.d.ts:26
Sets the disabled state of the component.
Parameters
Section titled “Parameters”disabled
Section titled “disabled”boolean
Whether to disable the component.
Returns
Section titled “Returns”this
The component instance.
Example
Section titled “Example”component.setDisabled(true);Inherited from
Section titled “Inherited from”setValue()
Section titled “setValue()”Call Signature
Section titled “Call Signature”setValue(
value):this
Defined in: obsidian.d.ts:3475
Parameters
Section titled “Parameters”number
The progress amount, a value between 0-100.
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”setValue(
value):this
Defined in: src/obsidian/augmentations/Components/ProgressBarComponent.d.ts:46
Set the current value of the progress bar.
Parameters
Section titled “Parameters”number
The progress amount, a value between 0-100.
Returns
Section titled “Returns”this
The progress bar component.
Inherited from
Section titled “Inherited from”ValueComponent.setValue
setValue__()
Section titled “setValue__()”setValue__(
value):this
Defined in: src/obsidian/augmentations/Components/ValueComponent.d.ts:47
Set the value of the component.
Parameters
Section titled “Parameters”number
The value to set.
Returns
Section titled “Returns”this
The component.
Example
Section titled “Example”valueComponent.setValue('foo');Inherited from
Section titled “Inherited from”setVisibility()
Section titled “setVisibility()”setVisibility(
visible):this
Defined in: src/obsidian/augmentations/Components/ProgressBarComponent.d.ts:55
Shows/hides the component.
Parameters
Section titled “Parameters”visible
Section titled “visible”boolean
Whether the setting should be visible.
Returns
Section titled “Returns”this
The component.
then()
Section titled “then()”Call Signature
Section titled “Call Signature”then(
cb):this
Defined in: obsidian.d.ts:444
Facilitates chaining
Parameters
Section titled “Parameters”(component) => any
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”then(
cb):this
Defined in: src/obsidian/augmentations/Components/BaseComponent.d.ts:41
Facilitates chaining.
Parameters
Section titled “Parameters”(component) => any
The callback to execute.
Returns
Section titled “Returns”this
The component instance.
Example
Section titled “Example”component.then((x) => { console.log(x);});