TK.Drag

new Drag(optionsopt)

TK.Drag enables dragging of elements on the screen positioned absolutely or by CSS transformation.

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

An object containing initial options.
Properties:
Name Type Attributes Default Description
options.node HTMLElement | SVGElement

The element to drag.
options.handle HTMLElement | SVGElement <optional>

A DOM node to be used as a handle. If not set, options.node is used.
options.active Boolean <optional>
 true

Enable or disable dragging
options.min Object | Boolean <optional>
 {x: false, y: false}

Object containing the minimum positions for x and y. A value of false is interpreted as no minimum.
options.max Object | Boolean <optional>
 {x: false, y: false}

Object containing the maximum positions for x and y. A value of false is interpreted as no maximum.
options.initial Number <optional>
 2

Number of pixels the user has to move until dragging starts.
options.transform Boolean <optional>
 false

Use CSS transformations instead of absolute positioning.
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, fun)

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 arguments value and key.

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.

userset(key, value)

Sets an option by user interaction. Emits the userset event. The userset event can be cancelled (if an event handler returns false), in which case the option is not set. Returns true if the option was set, false otherwise. If the option was set, it will emit a useraction event.

Events

dragging

The user is dragging this item.

Parameters:
Name Type Description
event DOMEvent

The native DOM event.
Source:

startdrag

The user started dragging this item.

Parameters:
Name Type Description
event DOMEvent

The native DOM event.
Source:

stopdrag

The user stopped dragging this item.

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.