control-freak-ide/Control-Freak-Documentation/jQuery/docs/entries/jQuery.dequeue.json

{"name":"jQuery.dequeue","type":"method","title":"jQuery.dequeue()","deprecated":null,"removed":null,"desc":"Execute the next function on the queue for the matched element.","categories":["data","utilities","version/1.3"],"entries":[{"return":"undefined","signatures":{"added":"1.3","argument":[{"desc":"A DOM element from which to remove and execute a queued function.","name":"element","type":"Element"},{"desc":"A string containing the name of the queue. Defaults to <code>fx</code>, the standard effects queue.","name":"queueName","optional":"true","type":"String"}]},"examples":{"desc":"Use jQuery.dequeue() to end a custom queue function which allows the queue to keep going.","code":"\n$( \"button\" ).click(function() {\n  $( \"div\" )\n    .animate({ left: '+=200px' }, 2000 )\n    .animate({ top: '0px' }, 600 )\n    .queue(function() {\n      $( this ).toggleClass( \"red\" );\n      $.dequeue( this );\n    })\n    .animate({ left:'10px', top:'30px' }, 700 );\n});\n","css":"\n  div {\n    margin: 3px;\n    width: 50px;\n    position: absolute;\n    height: 50px;\n    left: 10px;\n    top: 30px;\n    background-color: yellow;\n  }\n  div.red {\n    background-color: red;\n  }\n","html":"\n<button>Start</button>\n<div></div>\n"},"longdesc":"\n    <p><strong>Note:</strong> This is a low-level method, you should probably use <code><a href=\"/dequeue/\">.dequeue()</a></code> instead.</p>\n    <p>When <code>jQuery.dequeue()</code> is called, the next function on the queue is removed from the queue, and then executed. This function should in turn (directly or indirectly) cause <code>jQuery.dequeue()</code> to be called, so that the sequence can continue.</p>\n  "}]}