corrade-nucleus-nucleons – Blame information for rev 20
?pathlinks?
Rev | Author | Line No. | Line |
---|---|---|---|
20 | office | 1 | # Print |
2 | |||
3 | Adds a button to the toolbar for printing the table in a predefined configurable format. |
||
4 | |||
5 | ## Usage |
||
6 | |||
7 | ```html |
||
8 | <script src="extensions/print/bootstrap-table-print.js"></script> |
||
9 | ``` |
||
10 | |||
11 | ## Options |
||
12 | |||
13 | ### showPrint |
||
14 | |||
15 | * type: Boolean |
||
16 | * description: Set true to show the Print button on the toolbar. |
||
17 | * default: `false` |
||
18 | |||
19 | ### printAsFilteredAndSortedOnUI |
||
20 | |||
21 | * type: Boolean |
||
22 | * description: 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 |
||
23 | * default: `true` |
||
24 | |||
25 | ### printSortColumn |
||
26 | |||
27 | * type: String |
||
28 | * description: set column field name to sort by for the printed table |
||
29 | * default: `undefined` |
||
30 | |||
31 | ### printSortOrder |
||
32 | |||
33 | * type: String |
||
34 | * description: Valid values: 'asc', 'desc'. Relevant only if printSortColumn is set |
||
35 | * default: `'asc'` |
||
36 | |||
37 | ### printPageBuilder |
||
38 | |||
39 | * type: Function |
||
40 | * description: Receive html `<table>` element as string parameter, returns html string for printing. Used for styling and adding header or footer. |
||
41 | * default: `function(table){return printPageBuilderDefault(table)}` |
||
42 | |||
43 | ## Column options |
||
44 | |||
45 | ### printFilter |
||
46 | |||
47 | * type: String |
||
48 | * description: set value to filter the printed data by this column. |
||
49 | * default: `undefined` |
||
50 | |||
51 | ### printIgnore |
||
52 | |||
53 | * type: Boolean |
||
54 | * description: set true to hide this column in the printed page. |
||
55 | * default: `false` |
||
56 | |||
57 | ### printFormatter |
||
58 | |||
59 | * type: Function |
||
60 | * description: 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 |
||
61 | * default: `undefined` |
||
62 | |||
63 | ## Icons |
||
64 | |||
65 | * print: `'glyphicon-print icon-share'` |