TK.Drag

new Drag(options)

TK.Drag enables dragging of absolutely positioned elements on the screen.

Parameters:
Name Type Description
options Object
Properties:
Name Type Attributes Default Description
options.node HTMLElement | SVGElement

The element to drag

options.handle HTMLElement | SVGElement <optional>
options.node

A DOM node to be used as a handle. If not set options.node is used.

options.active boolean

Enable or disable dragging

options.min Object <optional>
{x: -1, y: -1}

Object containing the minimum positions for x and y. A value of false is interpreted as no minimum.

options.max Object <optional>
{x: -1, y: -1}

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.

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

dragging

The user is dragging this item. The arguments are the native DOM event object and both the x and y coordinate.

Parameters:
Name Type Description
event DOMEvent

The native DOM event.

x int

The new x position.

y int

The new y position.

Source:

dragstart

The user started dragging this item.

Parameters:
Name Type Description
event DOMEvent

The native DOM event.

Source:

dragstop

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.