DD.Draggable

Provide abilities to make specified node draggable

parents: Base

defined in: draggable.js

Class

Attributes

  • activeHandler {NodeList} the handler which fired the drag event.
  • bufferTime {Number} the number of milliseconds to start a drag operation after mousedown,default is 1000
  • clickPixelThresh {Number} the number of pixels to move to start a drag operation,default is 3.
  • disabled {Boolean} set to disable this draggable so that it can not be dragged.
  • dragging {Boolean} indicate whether this draggable object is being dragged
  • dragNode {HTMLElement} the draggable element
  • groups {Object} groups this draggable object belongs to
  • halt {Boolean} whether halt mousedown event.
  • handlers {HTMLElement[]|Function[]|String[]} valid handlers to initiate a drag operation
  • mode {String}
    can be set 'point' or 'intersect' or 'strict'
    In point mode, a Drop is targeted by the cursor being over the Target
    In intersect mode, a Drop is targeted by "part" of the drag node being over the Target
    In strict mode, a Drop is targeted by the "entire" drag node being over the Target
    
  • move {Boolean} whether the drag node moves with cursor.default:false,can be used to resize element.
  • node {HTMLElement} the dragged node.
  • primaryButtonOnly {Boolean} whether a drag operation can only be trigged by primary(left) mouse button.
  • shim {Boolean} use protective shim to cross iframe.default:true

Methods

  • destroy () make the drag node undraggable
  • stopDrag () force to stop this drag operation

Events

  • drag (e) fired during dragging
  • dragalign (e) fired when need to get draggable 's position during dragging
  • dragdrophit (e) fired after drop a draggable onto a droppable object
  • dragdropmiss (e) fired after drop a draggable onto nothing
  • dragend (e) fired after drag
  • dragenter (e) fired after a draggable object mouseenter a droppable object
  • dragexit (e) fired after a draggable leaves a droppable
  • dragover (e) fired after a draggable object mouseover a droppable object
  • dragstart (e) fired after a draggable object start to drag

Class Detail

  • DD.Draggable ()
    Provide abilities to make specified node draggable

Attributes Detail

  • activeHandler {NodeList} the handler which fired the drag event.
  • bufferTime {Number} the number of milliseconds to start a drag operation after mousedown,default is 1000
  • clickPixelThresh {Number} the number of pixels to move to start a drag operation,default is 3.
  • disabled {Boolean} set to disable this draggable so that it can not be dragged. default:false
  • dragging {Boolean} indicate whether this draggable object is being dragged
  • dragNode {HTMLElement} the draggable element
  • groups {Object} groups this draggable object belongs to
    Example
    • 
      {
          "group1":1,
          "group2":1
      }
      
  • halt {Boolean} whether halt mousedown event. default:true
  • handlers {HTMLElement[]|Function[]|String[]} valid handlers to initiate a drag operation
  • mode {String}
    can be set 'point' or 'intersect' or 'strict'
    In point mode, a Drop is targeted by the cursor being over the Target
    In intersect mode, a Drop is targeted by "part" of the drag node being over the Target
    In strict mode, a Drop is targeted by the "entire" drag node being over the Target
    
  • move {Boolean} whether the drag node moves with cursor.default:false,can be used to resize element.
  • node {HTMLElement} the dragged node. maybe a proxy node.
  • primaryButtonOnly {Boolean} whether a drag operation can only be trigged by primary(left) mouse button. Setting false will allow for all mousedown events to trigger drag.
  • shim {Boolean} use protective shim to cross iframe.default:true

Methods Detail

Events Detail

  • drag (e) view source
    fired during dragging
    Parameters
    •   e
    •   e.drag current draggable object
  • dragalign (e) view source
    fired when need to get draggable 's position during dragging
    Parameters
    •   e
    •   e.drag current draggable object
  • dragdrophit (e) view source
    fired after drop a draggable onto a droppable object
    Parameters
    •   e
    •   e.drag current draggable object
    •   e.drop current droppable object
  • dragdropmiss (e) view source
    fired after drop a draggable onto nothing
    Parameters
    •   e
    •   e.drag current draggable object
  • dragend (e) view source
    fired after drag
    Parameters
    •   e
    •   e.drag current draggable object
  • dragenter (e) view source
    fired after a draggable object mouseenter a droppable object
    Parameters
    •   e
    •   e.drag current draggable object
    •   e.drop current droppable object
  • dragexit (e) view source
    fired after a draggable leaves a droppable
    Parameters
    •   e
    •   e.drag current draggable object
    •   e.drop current droppable object
  • dragover (e) view source
    fired after a draggable object mouseover a droppable object
    Parameters
    •   e
    •   e.drag current draggable object
    •   e.drop current droppable object
  • dragstart (e) view source
    fired after a draggable object start to drag
    Parameters
    •   e
    •   e.drag current draggable object
blog comments powered by Disqus
Top