Current File : /home/jalalj2hb/public_html/ftm-admin/bower_components/datatables-buttons/docs/button/csv.xml
<?xml version="1.0" encoding="UTF-8" ?>
<dt-button library="Buttons">
<name>csv</name>
<summary>Create and save a CSV file that contains the data from the table</summary>
<since>1.0.0</since>
<requires>
* Buttons' _Flash export button_ plug-in **and / or**
* Buttons' _HTML5 export button_ plug-in
</requires>
<description>
This button type serves as a proxy that will automatically detect if the `b-button csvHtml5` or `b-button csvFlash` buttons can be used based on the browser's capabilities and the libraries available on the page.
This is provided as an option since the HTML5 button type requires a reasonably modern browser which may not always be available to the end user.
The order of selection, in priority order is:
* `b-button csvHtml5`
* `b-button csvFlash`
If the requirements of both buttons are not satisfied, no button will be presented to the end user. For the requirements of each button type, please refer to its own documentation.
The options available to the HTML5 and Flash buttons are common between them to ensure that no additional logic is required by the developer based on which button type is selected - e.g. if you set the `fieldSeparator` option, it will be used by the HTML5 and Flash button types.
</description>
<option type="string" name="text" default="CSV">
The button's display text. The text can be configured using this option (see `b-init buttons.buttons.text`) or the `buttons.copy` option of the DataTables `dt-init language` object.
</option>
<option type="string" name="className" default="buttons-csv buttons-html5">
The button's class name. See `b-init buttons.buttons.className` for details.
</option>
<option type="function" name="action">
Create and save a CSV file.
</option>
<option type="string" name="fieldSeparator" default=",">
The character(s) used to separate fields in the plain text representation of the table that is copied to the system's clipboard.
</option>
<option type="string" name="fieldBoundary" default='"'>
The character(s) used to enclose each field in the plain text representation of the table that is copied to the system's clipboard. This is automatically added at the start and end of each cell's data.
</option>
<option type="string" name="newline" default="\n">
The character(s) used to separate the lines of data. Please note that on Windows client's the default is `\r\n`. All other platforms have a default or `\n` only.
</option>
<option type="object" name="exportOptions" default="{}">
Select the data to be gathered from the DataTable for export. This includes options for which columns, rows, ordering and search. Please see the `b-api buttons.exportData()` method for full details - the object given by this parameter is passed directly into that action to gather the required data.
</option>
<option type="boolean" name="header" default="true">
Indicate if the table header should be included in the exported data or not.
</option>
<option type="boolean" name="footer" default="false">
Indicate if the table footer should be included in the exported data or not.
</option>
<option type="string|function" name="filename" default="*">
File name to give the created file (plus the extension defined by the `extension` option). The special character `*` is automatically replaced with the value read from the host document's `-tag title` tag.
</option>
<option type="string" name="extension" default=".csv">
The extension to give the created file name.
</option>
<option type="boolean" name="bom" default="false" since="1.2.2">
Option to include UTF-8 Byte Order Mark (`true`) or not (`false`). This is disabled by default as the [Unicode Standard states](http://utf8everywhere.org/#faq.boms) that the use of a BOM is neither required nor recommended for UTF-8.
</option>
<option type="string" name="charset" default="null">
Character set to use in the file export. When `null` is used (default) the document's character set will be read and used (`document.characterSet`). The addition of a character set can be disabled by setting this property to `false`.
</option>
<option type="string" name="escapeChar" default='"'>
Character to use as the escape character for CSV data. This will be prefixed to any data found in the fields which matches that set by the `fieldBoundary` option. It is a configurable option as different applications can require different options - however the default matches [RFC4180](https://tools.ietf.org/html/rfc4180).
</option>
<option type="function" name="customize" default="undefined" since="1.1.1">
Function that can be used to modify the contents of the exported data. The function takes two parameters, the data as configured by the button and the button's configuration object. The value that the function returns is the value that will be used for the export.
This can be particularly useful if you wish to add a company header or footer, description data or any other information to the exported data.
</option>
<example title="DataTables initialisation: Use the HTML5 CSV button"><![CDATA[
$('#myTable').DataTable( {
buttons: [
'csv'
]
} );
]]></example>
<example title="DataTables initialisation: Use the `exportOptions` to save all data, regardless of filtering"><![CDATA[
$('#myTable').DataTable( {
buttons: [
{
extend: 'csv',
text: 'Copy all data',
exportOptions: {
modifier: {
search: 'none'
}
}
}
]
} );
]]></example>
</dt-button>
Mini Shell