TK.ScrollValue

new ScrollValue()

TK.ScrollValue enables the scroll wheel for setting a value of an object. For instance, it is used by TK.Knob to allow turning the knob using the scroll wheel.

Properties:
Name Type Attributes Default Description
get function <optional>
function () { return; }

Callback returning the value.

set function <optional>
function () { return; }

Callback setting the value.

range function <optional>
function () { return {}; }

A TK.Range instance.

events Object <optional>
false

Element receiving events or false to fire events on the main element.

classes Object <optional>
false

Element receiving classes or false to set classes on the main element.

node HTMLElement <optional>
false

The element receiving the scroll event.

active Boolean <optional>
true

Disable the scroll event.

Source:

Extends

Methods inherited from TK.Base

add_event(event, func, prevent, stop)

Register an event handler.

add_events(events, func)

Add multiple event handlers at once, either as dedicated event handlers or a list of event descriptors with a single handler function.

delegate_events(element) → {HTMLElement}

Delegates all occuring DOM events of a specific DOM node to the widget. This way the widget fires e.g. a click event if someone clicks on the given DOM node.

destroy()

Destroys all event handlers and the options object.

fire_event(event, …args)

Fires an event.

fire_events(events)

Fires several events.

get(key)

Get the value of an option.

has_event_listeners(event) → {boolean}

Test if the event descriptor has some handler functions in the queue.

remove_event(event, func)

Removes the given function from the event queue. If it is a native DOM event, it removes the DOM event listener as well.

remove_events(events, func)

Remove multiple event handlers at once, either as dedicated event handlers or a list of event descriptors with a single handler function.

set(key, value)

Sets an option. Fires both the events set with arguments key and value; and the event 'set_'+key with argument value.

set_options(optionsopt)

Merges a new options object into the existing one including deep copies of objects. If an option key begins with the string "on" it is considered as event handler. In this case the value should be the handler function for the event with the corresponding name without the first "on" characters.

Events

scrollended

Is fired when scrolling ended.

Source:

scrolling

Is fired while scrolling happens.

Parameters:
Name Type Description
event DOMEvent

The native DOM event.

Source:

scrollstarted

Is fired when scrolling starts.

Parameters:
Name Type Description
event DOMEvent

The native DOM event.

Source:

Events inherited from TK.Base

delegated

Is fired when an element is delegated.

initialized

Is fired when an instance is initialized.

set

Is fired when an option is set.

set_[option]

Is fired when an option is set.