MDN may have intermittent access issues April 18 13:00 - April 19 01:00 UTC. See whistlepig.mozilla.org for all notifications.

mozilla

Compare Revisions

Array.prototype.splice()

Change Revisions

Revision 238162:

Revision 238162 by zirak on

Revision 26372:

Revision 26372 by ethertank on

Title:
Array splice method
Array splice method
Slug:
JavaScript/Reference/Global_Objects/Array/splice
JavaScript/Reference/Global_Objects/Array/splice
Tags:
Array
Array
Content:

Revision 238162
Revision 26372
n7    <h2>n7    <h2 id="Summary">
n40    <h2>n40    <h2 id="Syntax">
n47    <h2>n47    <h2 id="Parameters">
n74    <h2>n74    <h2 id="Returns">
n80    <h2>n80    <h2 id="Description">
n86    <h2>n86    <h2 id="Backward_Compatibility">
n89    <h3>n89    <h3 id="JavaScript_1.2">
n95    <h2>n95    <h2 id="Examples">
t98    <h2>t98    <h3 id="Example:_Using_splice">
99      Summary
100    </h2>
101    <p>
102      Changes the content of an array, adding new elements while 
>removing old elements. 
103    </p>
104    <table class="standard-table">
105      <thead>
106        <tr>
107          <th class="header" colspan="2">
108            Method of <a href="/en/JavaScript/Reference/Global_Ob
>jects/Array" title="en/JavaScript/Reference/Global_Objects/Array" 
>><code>Array</code></a> 
109          </th>
110        </tr>
111      </thead>
112      <tbody>
113        <tr>
114          <td>
115            Implemented in
116          </td>
117          <td>
118            JavaScript 1.2
119          </td>
120        </tr>
121        <tr>
122          <td>
123            ECMAScript Edition
124          </td>
125          <td>
126            ECMAScript 3rd Edition
127          </td>
128        </tr>
129      </tbody>
130    </table>
131    <h2>
132      Syntax
133    </h2>
134    <p>
135      <code><em>array</em>.splice(<em>index</em> , <em>howMany</e
>m>[<em>,</em> <em>element1</em>[, ...[, <em>elementN</em>]]])</co 
>de><br> 
136      <code><em>array</em>.splice(<em>index</em>[, <em>howMany</e
>m>[, <em>element1</em>[, ...[, <em>elementN</em>]]]])</code> 
137    </p>
138    <h2>
139      Parameters
140    </h2>
141    <dl>
142      <dt>
143        <code>index</code>
144      </dt>
145      <dd>
146        Index at which to start changing the array. If negative, 
>will begin that many elements from the end. 
147      </dd>
148    </dl>
149    <dl>
150      <dt>
151        <code>howMany</code>
152      </dt>
153      <dd>
154        An integer indicating the number of old array elements to
> remove. If <code>howMany</code> is 0, no elements are removed. I 
>n this case, you should specify at least one new element. If no < 
>code>howMany</code> parameter is specified (second syntax above,  
>which is a SpiderMonkey extension), all elements after <code>inde 
>x</code> are removed. 
155      </dd>
156    </dl>
157    <dl>
158      <dt>
159        <code>element1, ..., element<em>N</em></code>
160      </dt>
161      <dd>
162        (Optional) The elements to add to the array. If you don't
> specify any elements, <code>splice</code> simply removes element 
>s from the array. 
163      </dd>
164    </dl>
165    <h2>
166      Returns
167    </h2>
168    <p>
169      An array containing the removed element(s).
170    </p>
171    <h2>
172      Description
173    </h2>
174    <p>
175      If you specify a different number of elements to insert tha
>n the number you're removing, the array will have a different len 
>gth at the end of the call. 
176    </p>
177    <h2>
178      Backward Compatibility
179    </h2>
180    <h3>
181      JavaScript 1.2
182    </h3>
183    <p>
184      The <code>splice</code> method returns the element removed,
> if only one element is removed (<code>howMany</code> parameter i 
>s 1); otherwise, the method returns an array containing the remov 
>ed elements. Note that the last browser to use JavaScript 1.2 was 
> Netscape Navigator 4, so you can depend on <code>splice</code> a 
>lways returning an array. 
185    </p>
186    <h2>
187      Examples
188    </h2>
189    <h3>

Back to History