.finish()

jQuery

previous page next page

.finish()

Categories: Effects > Custom

.finish( [queue ] ) Returns: jQuery

Description: Stop the currently-running animation, remove all queued animations, and complete all animations for the matched elements.

  • version added: 1.9.finish( [queue ] )

    • queue
      Type: String
      The name of the queue in which to stop animations.

When .finish() is called on an element, the currently-running animation and all queued animations (if any) immediately stop and their CSS properties set to their target values. All queued animations are removed.

If the first argument is provided, only the animations in the queue represented by that string will be stopped.

The .finish() method is similar to .stop(true, true) in that it clears the queue and the current animation jumps to its end value. It differs, however, in that .finish() also causes the CSS property of all queued animations to jump to their end values, as well.

Animations may be stopped globally by setting the property $.fx.off to true. When this is done, all animation methods will immediately set elements to their final state when called, rather than displaying an effect.

Example:

Click the Go button once to start the animation, and then click the other buttons to see how they affect the current and queued animations.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
                                  

                                    

                                      
                                        <!DOCTYPE html>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <html>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <head>
                                      
                                    

                                  

                                  

                                    

                                        <style>.box {
                                    

                                  

                                  

                                    

                                        position: absolute;
                                    

                                  

                                  

                                    

                                        top: 10px;
                                    

                                  

                                  

                                    

                                        left: 10px;
                                    

                                  

                                  

                                    

                                        width: 15px;
                                    

                                  

                                  

                                    

                                        height: 15px;
                                    

                                  

                                  

                                    

                                        background: black;
                                    

                                  

                                  

                                    

                                      
                                        }
                                      
                                    

                                  

                                  

                                    

                                      #path {
                                    

                                  

                                  

                                    

                                        height: 244px;
                                    

                                  

                                  

                                    

                                        font-size: 70%;
                                    

                                  

                                  

                                    

                                        border-left: 2px dashed red;
                                    

                                  

                                  

                                    

                                        border-bottom: 2px dashed green;
                                    

                                  

                                  

                                    

                                        border-right: 2px dashed blue;
                                    

                                  

                                  

                                    

                                      
                                        }
                                      
                                    

                                  

                                  

                                    

                                      button {
                                    

                                  

                                  

                                    

                                        width: 12em;
                                    

                                  

                                  

                                    

                                        display: block;
                                    

                                  

                                  

                                    

                                        text-align: left;
                                    

                                  

                                  

                                    

                                        margin: 0 auto;
                                    

                                  

                                  

                                    

                                      
                                        }
                                      
                                    

                                  

                                  

                                    

                                      
                                        </style>
                                      
                                    

                                  

                                  

                                    

                                        <script src="http://code.jquery.com/jquery-latest.js"></script>
                                    

                                  

                                  

                                    

                                      
                                        </head>
                                      
                                    

                                  

                                  

                                    

                                      
                                        <body>
                                      
                                    

                                  

                                  

                                    

                                        <div class="box"></div>
                                    

                                  

                                  

                                    

                                      
                                        <div id="path">
                                      
                                    

                                  

                                  

                                    

                                        <button id="go">Go</button>
                                    

                                  

                                  

                                    

                                        <br>
                                    

                                  

                                  

                                    

                                        <button id="bstt" class="b">.stop(true,true)</button>
                                    

                                  

                                  

                                    

                                        <button id="bcf" class="b">.clearQueue().finish()</button>
                                    

                                  

                                  

                                    

                                        <br>
                                    

                                  

                                  

                                    

                                        <button id="bstf" class="b">.stop(true, false)</button>
                                    

                                  

                                  

                                    

                                        <button id="bcs" class="b">.clearQueue().stop()</button>
                                    

                                  

                                  

                                    

                                        <br>
                                    

                                  

                                  

                                    

                                        <button id="bsff" class="b">.stop(false, false)</button>
                                    

                                  

                                  

                                    

                                        <button id="bs" class="b">.stop()</button>
                                    

                                  

                                  

                                    

                                        <br>
                                    

                                  

                                  

                                    

                                        <button id="bsft" class="b">.stop(false, true)</button>
                                    

                                  

                                  

                                    

                                        <br>
                                    

                                  

                                  

                                    

                                        <button id="bf" class="b">.finish()</button>
                                    

                                  

                                  

                                    

                                      
                                        </div>
                                      
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      
                                        <script>
                                        
                                      
                                    

                                  

                                  

                                    

                                      var horiz = $("#path").width() - 20,
                                    

                                  

                                  

                                    

                                          vert = $("#path").height() - 20;
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      var btns = {
                                    

                                  

                                  

                                    

                                        bstt: function () {
                                    

                                  

                                  

                                    

                                          $("div.box").stop(true, true);
                                    

                                  

                                  

                                    

                                        },
                                    

                                  

                                  

                                    

                                        bs: function () {
                                    

                                  

                                  

                                    

                                          $("div.box").stop();
                                    

                                  

                                  

                                    

                                        },
                                    

                                  

                                  

                                    

                                        bsft: function () {
                                    

                                  

                                  

                                    

                                          $("div.box").stop(false, true);
                                    

                                  

                                  

                                    

                                        },
                                    

                                  

                                  

                                    

                                        bf: function () {
                                    

                                  

                                  

                                    

                                          $("div.box").finish();
                                    

                                  

                                  

                                    

                                        },
                                    

                                  

                                  

                                    

                                        bcf: function () {
                                    

                                  

                                  

                                    

                                          $("div.box").clearQueue().finish();
                                    

                                  

                                  

                                    

                                        },
                                    

                                  

                                  

                                    

                                        bsff: function () {
                                    

                                  

                                  

                                    

                                          $("div.box").stop(false, false);
                                    

                                  

                                  

                                    

                                        },
                                    

                                  

                                  

                                    

                                        bstf: function () {
                                    

                                  

                                  

                                    

                                          $("div.box").stop(true, false);
                                    

                                  

                                  

                                    

                                        },
                                    

                                  

                                  

                                    

                                        bcs: function () {
                                    

                                  

                                  

                                    

                                          $("div.box").clearQueue().stop();
                                    

                                  

                                  

                                    

                                        }
                                    

                                  

                                  

                                    

                                      };
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      $("button.b").on("click", function () {
                                    

                                  

                                  

                                    

                                        btns[this.id]();
                                    

                                  

                                  

                                    

                                      });
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      $("#go").on("click", function () {
                                    

                                  

                                  

                                    

                                        $(".box")
                                    

                                  

                                  

                                    

                                          .clearQueue()
                                    

                                  

                                  

                                    

                                          .stop()
                                    

                                  

                                  

                                    

                                          .css({
                                    

                                  

                                  

                                    

                                          left: 10,
                                    

                                  

                                  

                                    

                                          top: 10
                                    

                                  

                                  

                                    

                                        })
                                    

                                  

                                  

                                    

                                          .animate({
                                    

                                  

                                  

                                    

                                          top: vert
                                    

                                  

                                  

                                    

                                        }, 3000)
                                    

                                  

                                  

                                    

                                          .animate({
                                    

                                  

                                  

                                    

                                          left: horiz
                                    

                                  

                                  

                                    

                                        }, 3000)
                                    

                                  

                                  

                                    

                                          .animate({
                                    

                                  

                                  

                                    

                                          top: 10
                                    

                                  

                                  

                                    

                                        }, 3000);
                                    

                                  

                                  

                                    

                                      });
                                    

                                  

                                  

                                    

                                      
                                        </script>
                                      
                                    

                                  

                                  

                                    

                                       
                                    

                                  

                                  

                                    

                                      
                                        </body>
                                      
                                    

                                  

                                  

                                    

                                      
                                        </html>
 POWERED BYHERONOTE
previous page start next page