Fader

Fader

new Fader(optionsopt)

Source:
Properties:
Name Type Attributes Default Description
options.value Number <optional>

The fader's position. This options is modified by user interaction.
options.layout String <optional>

The fader's layout. One out of top, left, right or bottom, defining the fader handles position in comparison to the scale.
options.bind_click Boolean <optional>
 false

If true, a click on the fader will move the handle to the pointed position.
options.bind_dblclick Boolean <optional>
 true

If true, a dblclick on the fader will reset the fader value to options.reset.
options.reset Number <optional>
 options.value

The reset value, which is used by the dblclick event and the Fader#reset method.
options.show_scale Boolean <optional>
 true

If true, a Scale is added to the fader.
options.show_value Boolean <optional>
 false

If true, a Value widget is added to the fader.
options.label String | Boolean <optional>
 false

Add a label to the fader. Set to false to remove the label from the DOM.
{options.cursor String | Boolean false}

set a cursor from standard cursors on drag or scroll. Set to false to disable.

Fader is a slidable control with a Scale next to it which can be both dragged and scrolled. Fader implements Ranged and inherits its options. A Label and a Value are available optionally.

Parameters:
Name Type Attributes Default Description
options Object <optional>
 { }

An object containing initial options.

Extends

Members

_bar :HTMLDivElement

Source:

The DIV element of the bar. It can be used to e.g. visualize the value set in the backend or to draw a simple levelmeter.

Type:
  • HTMLDivElement

_handle :HTMLDivElement

Source:

The handle of the fader. Has class .aux-handle.

Type:
  • HTMLDivElement

_pointer :HTMLDivElement

Source:

The DIV element of the pointer. It can be used to e.g. visualize the value set in the backend.

Type:
  • HTMLDivElement

_track :HTMLDivElement

Source:

The track for the handle. Has class .aux-track.

Type:
  • HTMLDivElement

drag :DragValue

Source:

Instance of DragValue used for the handle interaction.

Type:

element :HTMLDivElement

Source:

The main DIV container. Has class .aux-fader.

Type:
  • HTMLDivElement

label :Label

Source:

A Label to display a title.

Type:

scale :Scale

Source:

A Scale to display a scale next to the fader.

Type:

scroll :ScrollValue

Source:

Instance of ScrollValue used for the handle interaction.

Type:

value :Value

Source:

A Value to display the current value, offering a way to enter a value via keyboard.

Type:

Methods

addChild(child)

Source:
Inherited From:
See:

Registers a widget as a child widget. This method is used to build up the widget tree. It does not modify the DOM tree.

Parameters:
Name Type Description
child Widget

The child to add.
Fires:
  • Widget#event:child_added

addChildren(a)

Source:
Inherited From:

Registers an array of widgets as children.

Parameters:
Name Type Description
a Array.<Widget>

An array of Widgets.

allChildren()

Source:
Inherited From:

Returns an array of all children.

appendChild(child)

Source:
Inherited From:

Appends child.element to the widget element and registers child as a child widget.

Parameters:
Name Type Description
child Widget

The child widget to append.

appendChildren(children)

Source:
Inherited From:

Calls Widget#appendChild for an array of widgets.

Parameters:
Name Type Description
children Array.<Widget>

The child widgets to append.

destroy()

Source:
Overrides:

Dispose of this Widget.

destroyAndRemove()

Source:
Inherited From:

Dispose of this Widget and remove it from the DOM.

disableTansitions()

Source:
Inherited From:

Disable CSS transitions.

enableDraw()

Source:
Overrides:

Schedules this widget for drawing.

Fires:

enableDrawChildren()

Source:
Inherited From:

Enables rendering for all children of this widget.

enableTransitions()

Source:
Inherited From:

Enable CSS transitions.

forceHide()

Source:
Inherited From:

Hide the widget immediately by applying the class aux-hide. Does not call disableDraw().

forceShow()

Source:
Inherited From:

Show the widget immediately by applying the class aux-show. Does not call enableDraw().

getStyle()

Source:
Inherited From:

Returns the computed style of this widget's DOM element.

hidden()

Source:
Inherited From:

Returns the current hidden status.

hide()

Source:
Inherited From:

Hide the widget. This will result in the class aux-hide being applied to this widget in the next rendering step.

invalidate(key)

Source:
Inherited From:

Invalidates an option and triggers a redraw() call.

Parameters:
Name Type Description
key string

invalidateAll()

Source:
Inherited From:

Invalidates all dependencies which will trigger all renderers to rerun.

observeResize(cb)

Source:
Inherited From:

Calls a callback whenever the widget resizes. This method will trigger one resize.

Parameters:
Name Type Description
cb function

removeChild(child)

Source:
Inherited From:

Removes a child widget. Note that this method only modifies the widget tree and does not change the DOM.

Parameters:
Name Type Description
child Widget

The child to remove.
Fires:
  • Widget#event:child_removed

removeChildren(a)

Source:
Inherited From:

Removes an array of children.

Parameters:
Name Type Description
a Array.<Widget>

An array of Widgets.

set(key, value)

Source:
Overrides:

Sets an option.

Parameters:
Name Type Description
key string

The option name.
value

The option value.

setStyle()

Source:
Inherited From:

Sets a CSS style property in this widget's DOM element.

show()

Source:
Inherited From:

Make the widget visible. This will apply the class aux-show during the next rendering step.

toggleHidden()

Source:
Inherited From:

Toggle the hidden status. This is equivalent to calling hide() or show(), depending on the current hidden status of this widget.

transitionsDisabled()

Source:
Inherited From:

Returns true if transitions are currently disabled on this widget.

visibleChildren()

Source:
Inherited From:

Returns an array of all visible children.

Events

destroy

Source:
Inherited From:

Is fired when a widget is destroyed.

doubleclick

Source:
Overrides:

Is fired when the handle receives a double click.

Parameters:
Name Type Description
value number

The value of the Fader.

GenericDOMEvents

Source:
Inherited From:

Generic DOM events. Please refer to W3Schools for further details.

hide

Source:
Inherited From:

The hide event is emitted when a widget is hidden and is not rendered anymore. This happens both with browser visibility changes and also internally when using layout widgets such as Pager.

initialized

Source:
Inherited From:

Is fired when a widget is initialized.

resize

Source:
Inherited From:

The resize event is emitted whenever a widget is being resized. This event can be used to e.g. measure its new size. Note that some widgets do internal adjustments after the resize event. If that is relevant, the Widget#resized event can be used instead.

resized

Source:
Inherited From:

The resized event is emitted after each rendering frame, which was triggered by a resize event.

scalechanged

Source:

Is fired when the scale was changed.

Parameters:
Name Type Description
key string

The key of the option.
value mixed

The value to which it was set.

scalechanged

Source:

Is fired when one or more or no files were selected by the user.

Parameters:
Name Type Description
key string

The key of the option.
value mixed

The value to which it was set.

set

Source:
Inherited From:

The set event is emitted when an option was set using the Widget#set method. The arguments are the option name and its new value.

Note that this happens both for user interaction and programmatical option changes.

show

Source:
Inherited From:

The show event is emitted when a widget is shown and is being rendered. This is the counterpart to Widget#hide.

useraction

Source:

The useraction event is emitted when a widget gets modified by user interaction. The event is emitted for the option value.

Parameters:
Name Type Description
name string

The name of the option which was changed due to the users action
value mixed

The new value of the option

visibility

Source:
Inherited From:

Is fired when the visibility state changes. The first argument is the visibility state, which is either true or false.