columnVisibility

Since: Buttons 1.0.0

A single button that controls the visibility of one or more columns.
Please note - this property requires the Buttons extension for DataTables.

Description

This button type creates a single button that can control the visibility of one or more columns in a DataTale (its counterpart columnsVisibility will be expanded to a single button for each column). This provides the ability to have show all / hide all buttons that control all of the table's columns or a subset of those columns.

For multiple columns, the button should be given a title using the buttons.buttons.text option, which can also be used for a single column control button, although it will automatically be given the column's title text if not otherwise supplied.

Options

This button can have the following options set in its configuration object to customise its actions and display, in addition to those options which are available for all buttons (e.g. buttons.buttons.text):

Name	Type	Default
`columns`		undefined
Columns selector that defines the column(s) to include in the column visibility button set. By default this is `undefined` which results in all columns being selected, but any of the `column-selector` options can be used to define a custom button set.
`visibility`		undefined
Control if the columns should be shown or hidden when the button is activated.

Example

DataTables initialisation: Show all / hide all buttons:

new DataTable('#myTable', {
	layout: {
		topStart: {
			buttons: [
				{
					extend: 'columnVisibility',
					text: 'Show all',
					visibility: true
				},
				{
					extend: 'columnVisibility',
					text: 'Hide all',
					visibility: false
				}
			]
		}
	}
});