{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

As standard, Custom panes will be titled with the string "Custom Pane".

Setting searchPanes.panes.header to any other string value will cause that string to be displayed in the title of the Pane.

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: {
				panes: [
					{
						header: 'My Pane',
						options: [
							{
								label: 'Accountants in Tokyo',
								value: function (rowData, rowIdx) {
									return rowData[2] === 'Accountant' && rowData[3] === 'Tokyo';
								}
							}
						]
					}
				]
			}
		}
	}
});