{hero}

searchPanes.panes.header

Since: SearchPanes 1.0.0

Define the header for custom panes.
Please note - this property requires the SearchPanes extension for DataTables.

Description

This option is an alias to searchPanes.panes.header, which should be preferred when using DataTables 2+. It can be used to configure SearchPanes regardless of how the panes are inserted into the document (layout or searchPanes).

Please refer to the documentation for searchPanes.panes.header for full details of this option.

Type

string

Description:

The searchPanes.panes.header string allows a custom header to be set for custom panes.

Default

  • Value: Custom Pane

The default value of searchPanes.panes.header is the string Custom Pane to make it clear that it is a custom Pane for developers. It is expected this value will be changed. For standard panes, use columns.searchPanes.header.

Example

Define custom pane header:

new DataTable('#myTable', {
	layout: {
		top1: 'searchPanes'
	},
	searchPanes: {
		panes: [
			{
				header: 'My Pane',
				options: [
					{
						label: 'Accountants in Tokyo',
						value: function (rowData, rowIdx) {
							return rowData[2] === 'Accountant' && rowData[3] === 'Tokyo';
						}
					}
				]
			}
		]
	}
});