Skip to content

SliderComponent

Defined in: obsidian.d.ts:3812

Extends

Constructors

new SliderComponent()

new SliderComponent(containerEl): SliderComponent

Defined in: obsidian.d.ts:3821

Parameters

containerEl

HTMLElement

Returns

SliderComponent

Overrides

ValueComponent.constructor

Properties

changeCallback()?

optional changeCallback: (value) => void

Defined in: src/obsidian/augmentations/Components/SliderComponent.d.ts:9

The function that’s called after changing the value of the component.

Parameters

value

number

Returns

void

disabled

disabled: boolean

Defined in: obsidian.d.ts:423

Inherited from

ValueComponent.disabled


sliderEl

sliderEl: HTMLInputElement

Defined in: obsidian.d.ts:3816

Methods

getValue()

getValue(): number

Defined in: obsidian.d.ts:3838

Returns

number

Overrides

ValueComponent.getValue


getValuePretty()

getValuePretty(): string

Defined in: obsidian.d.ts:3846

Returns

string


onChange()

onChange(callback): this

Defined in: obsidian.d.ts:3858

Parameters

callback

(value) => any

Returns

this


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:3825

Parameters

disabled

boolean

Returns

this

Overrides

ValueComponent.setDisabled


setDynamicTooltip()

setDynamicTooltip(): this

Defined in: obsidian.d.ts:3850

Returns

this


setInstant()

setInstant(instant): this

Defined in: obsidian.d.ts:3830

Parameters

instant

boolean

whether or not the value should get updated while the slider is dragging

Returns

this


setLimits()

setLimits(min, max, step): this

Defined in: obsidian.d.ts:3834

Parameters

min

number

max

number

step

number | "any"

Returns

this


setValue()

setValue(value): this

Defined in: obsidian.d.ts:3842

Parameters

value

number

Returns

this

Overrides

ValueComponent.setValue


showTooltip()

showTooltip(): void

Defined in: obsidian.d.ts:3854

Returns

void


then()

then(cb): this

Defined in: obsidian.d.ts:428

Facilitates chaining

Parameters

cb

(component) => any

Returns

this

Inherited from

ValueComponent.then