Setting

Defined in: obsidian.d.ts:3665

Constructors

new Setting()

new Setting(containerEl): Setting

Defined in: obsidian.d.ts:3681

Parameters

containerEl

HTMLElement

Returns

Setting

Properties

components

components: BaseComponent[]

Defined in: obsidian.d.ts:3677

---

controlEl

controlEl: HTMLElement

Defined in: obsidian.d.ts:3675

---

descEl

descEl: HTMLElement

Defined in: obsidian.d.ts:3673

---

infoEl

infoEl: HTMLElement

Defined in: obsidian.d.ts:3669

---

nameEl

nameEl: HTMLElement

Defined in: obsidian.d.ts:3671

---

settingEl

settingEl: HTMLElement

Defined in: obsidian.d.ts:3667

Methods

addButton()

addButton(cb): this

Defined in: obsidian.d.ts:3710

Parameters

cb

(component) => any

Returns

this

---

addColorPicker()

addColorPicker(cb): this

Defined in: obsidian.d.ts:3742

Parameters

cb

(component) => any

Returns

this

---

addDropdown()

addDropdown(cb): this

Defined in: obsidian.d.ts:3738

Parameters

cb

(component) => any

Returns

this

---

addExtraButton()

addExtraButton(cb): this

Defined in: obsidian.d.ts:3714

Parameters

cb

(component) => any

Returns

this

---

addMomentFormat()

addMomentFormat(cb): this

Defined in: obsidian.d.ts:3734

Parameters

cb

(component) => any

Returns

this

---

addProgressBar()

addProgressBar(cb): this

Defined in: obsidian.d.ts:3746

Parameters

cb

(component) => any

Returns

this

---

addSearch()

addSearch(cb): this

Defined in: obsidian.d.ts:3726

Parameters

cb

(component) => any

Returns

this

---

addSlider()

addSlider(cb): this

Defined in: obsidian.d.ts:3750

Parameters

cb

(component) => any

Returns

this

---

addText()

addText(cb): this

Defined in: obsidian.d.ts:3722

Parameters

cb

(component) => any

Returns

this

---

addTextArea()

addTextArea(cb): this

Defined in: obsidian.d.ts:3730

Parameters

cb

(component) => any

Returns

this

---

addToggle()

addToggle(cb): this

Defined in: obsidian.d.ts:3718

Parameters

cb

(component) => any

Returns

this

---

clear()

clear(): this

Defined in: obsidian.d.ts:3759

Returns

this

---

setClass()

setClass(cls): this

Defined in: obsidian.d.ts:3693

Parameters

cls

string

Returns

this

---

setDesc()

setDesc(desc): this

Defined in: obsidian.d.ts:3689

Parameters

desc

string | DocumentFragment

Returns

this

---

setDisabled()

setDisabled(disabled): this

Defined in: obsidian.d.ts:3705

Parameters

disabled

boolean

Returns

this

---

setHeading()

setHeading(): this

Defined in: obsidian.d.ts:3701

Returns

this

---

setName()

setName(name): this

Defined in: obsidian.d.ts:3685

Parameters

name

string | DocumentFragment

Returns

this

---

setNoInfo()

setNoInfo(): this

Defined in: src/obsidian/augmentations/Setting.d.ts:8

Hide the info section of the setting

Returns

this

---

setTooltip()

setTooltip(tooltip, options?): this

Defined in: obsidian.d.ts:3697

Parameters

tooltip

string

options?

TooltipOptions

Returns

this

---

setVisibility()

setVisibility(visible): this

Defined in: src/obsidian/augmentations/Setting.d.ts:14

Shows/hides the setting

Parameters

visible

boolean

Whether the setting should be visible

Returns

this

---

then()

then(cb): this

Defined in: obsidian.d.ts:3755

Facilitates chaining

Parameters

cb

(setting) => any

Returns

this