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
|
<?xml version="1.0" encoding="UTF-8" ?>
<dt-api group="utility">
<name>unshift()</name>
<summary>Add one or more items to the start of an API instance's result set.</summary>
<since>1.10</since>
<type type="function">
<signature>unshift( value_1 [, value_2 [, ...] ] )</signature>
<description>Add one or more items to the start of an API instance's result set.</description>
<parameter type="*" name="value_1">
Item to add to the API instance's result set.
</parameter>
<parameter type="*" name="value_2" default="undefined">
Additional item(s) to add to the API instance's result set. Use as many parameters as you require to add additional items.
</parameter>
<returns type="integer">The length of the modified API instance</returns>
</type>
<description>
Just as with Javascript arrays', since the DataTables API object is "array like", items can be added to a result set using this method. *Unshifting* an item onto an API instance adds it to the start of the result set. Items can be added at the end of the result set using `dt-api push()` if required.
This method is a proxy for the Javascript `Array.prototype.unshift` method and is provided as a utility method for the DataTables API. For more information about the original method, please refer to the [Mozilla MDN documentation for `unshift`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/unshift).
</description>
<example title="Add an empty string to the array returned from a column's data (might be useful for building a search list for example)"><![CDATA[
var table = $('#example').DataTable();
var data = table
.column( 0 )
.data();
data.unshift( '' );
]]></example>
</dt-api>
|
