bootstrap-table
Version:
An extended Bootstrap table with radio, checkbox, sort, pagination, and other added features. (supports twitter bootstrap v2 and v3).
104 lines (56 loc) • 2.15 kB
Markdown
---
layout: docs
title: Table Print
description: Table Print extension of Bootstrap Table.
group: extensions
toc: true
---
Adds a button to the toolbar for printing the table in a predefined configurable format.
## Usage
{% highlight html %}
<script src="extensions/print/bootstrap-table-print.js"></script>
{% endhighlight %}
## Options
### showPrint
- **type:** `Boolean`
- **Detail:**
Set true to show the Print button on the toolbar.
- **Default:** `false`
### printAsFilteredAndSortedOnUI
- **type:** `Boolean`
- **Detail:**
When true - print table as sorted and filtered on UI. Please note that if true is set, along with explicit predefined print options for filtering and sorting (printFilter, printSortOrder, printSortColumn)- then they will be applied on data already filtered and sorted by UI controls. For printing data as filtered and sorted on UI - do not set these 3 options: printFilter, printSortOrder, printSortColumn
- **Default:** `true`
### printSortColumn
- **type:** `String`
- **Detail:**
set column field name to sort by for the printed table
- **Default:** `undefined`
### printSortOrder
- **type:** `String`
- **Detail:**
Valid values: 'asc', 'desc'. Relevant only if printSortColumn is set
- **Default:** `'asc'`
### printPageBuilder
- **type:** `Function`
- **Detail:**
Receive html `<table>` element as string parameter, returns html string for printing. Used for styling and adding header or footer.
- **Default:** `function(table){return printPageBuilderDefault(table)}`
## Column options
### printFilter
- **type:** `String`
- **Detail:**
set value to filter the printed data by this column.
- **Default:** `undefined`
### printIgnore
- **type:** `Boolean`
- **Detail:**
set true to hide this column in the printed page.
- **Default:** `false`
### printFormatter
- **type:** `Function`
- **Detail:**
function(value, row, index) - returns a string. Formats the cell values for this column in the printed table. Function behaviour is similar to the 'formatter' column option
- **Default:** `undefined`
## Icons
* print: `'glyphicon-print icon-share'`