Options

DataTables and its extensions are extremely configurable libraries and almost every aspect of the enhancements they make to HTML tables can be customised. Features can be enabled, disabled or customised to meet your exact needs for your table implementations. Customisation of these options are performed by defining options in the new DataTable() constructor (or $().DataTable() if you are using jQuery based code) - for example, in the following code the scrollY and paging options are used to enable scrolling and disable pagination:

new DataTable('#myTable', {
    scrollY: 300,
    paging: false
} );

There are a huge range of options to customise your tables, which are all fully documented below. For general information about how DataTables' initialisation options can be used, please refer to the options manual.

Library Name Summary
DataTables - Features

autoWidth

Feature control DataTables' smart column width handling

DataTables - Features

caption

Set a caption for the table

DataTables - Features

deferRender

Feature control deferred rendering for additional speed of initialisation.

DataTables - Features

info

Feature control table information display field

DataTables - Features

lengthChange

Feature control the end user's ability to change the paging display length of the table.

DataTables - Features

ordering

Feature control ordering (sorting) abilities in DataTables.

DataTables - Features

paging

Enable or disable table pagination.

DataTables - Features

processing

Feature control the processing indicator.

DataTables - Features

scrollX

Horizontal scrolling

DataTables - Features

scrollY

Vertical scrolling

DataTables - Features

searching

Feature control search (filtering) abilities

DataTables - Features

serverSide

Feature control DataTables' server-side processing mode.

DataTables - Features

stateSave

State saving - restore table state on page reload

DataTables - Data

ajax

Load data for the table's content from an Ajax source

DataTables - Data

ajax.data

Add or modify data submitted to the server upon an Ajax request

DataTables - Data

ajax.dataSrc

Data property or manipulation method for table data

DataTables - Data

data

Data to use as the display data for the table.

DataTables - Callbacks

createdRow

Callback for whenever a TR element is created for the table's body.

DataTables - Callbacks

drawCallback

Function that is called every time DataTables performs a draw.

DataTables - Callbacks

footerCallback

Footer display callback function.

DataTables - Callbacks

formatNumber

Number formatting callback function.

DataTables - Callbacks

headerCallback

Header display callback function.

DataTables - Callbacks

infoCallback

Table summary information display callback.

DataTables - Callbacks

initComplete

Initialisation complete callback.

DataTables - Callbacks

preDrawCallback

Pre-draw callback.

DataTables - Callbacks

rowCallback

Row draw callback.

DataTables - Callbacks

stateLoadCallback

Callback that defines where and how a saved state should be loaded.

DataTables - Callbacks

stateLoadParams

State loaded - data manipulation callback

DataTables - Callbacks

stateLoaded

State loaded callback.

DataTables - Callbacks

stateSaveCallback

Callback that defines how the table state is stored and where.

DataTables - Callbacks

stateSaveParams

State save - data manipulation callback

DataTables - Options

deferLoading

Delay the loading of server-side data until second draw

DataTables - Options

destroy

Destroy any existing table matching the selector and replace with the new options.

DataTables - Options

detectType

Ability to enable / disable auto type detection

DataTables - Options

displayStart

Initial paging start point

DataTables - Options

dom

Define the table control elements to appear on the page and in what order

DataTables - Options

layout

Define and position the table control elements to appear on the page

DataTables - Options

lengthMenu

Change the options in the page length select list.

DataTables - Options

order

Initial order (sort) to apply to the table

DataTables - Options

orderCellsTop

Control which cell the order event handler will be applied to in a column

DataTables - Options

orderClasses

Highlight the columns being ordered in the table's body

DataTables - Options

orderDescReverse

Control if the initial data order is reversed when desc ordering

DataTables - Options

orderFixed

Ordering to always be applied to the table

DataTables - Options

orderMulti

Multiple column ordering ability control.

DataTables - Options

pageLength

Change the initial page length (number of rows per page)

DataTables - Options

pagingType

Pagination button display options

DataTables - Options

renderer

Display component renderer types

DataTables - Options

retrieve

Retrieve an existing DataTables instance

DataTables - Options

rowId

Data property name that DataTables will use to set tr element DOM IDs

DataTables - Options

scrollCollapse

Allow the table to reduce in height when a limited number of rows are shown.

DataTables - Options

search

Set an initial search in DataTables and / or search options.

DataTables - Options

search.caseInsensitive

Control case-sensitive filtering option.

DataTables - Options

search.regex

Enable / disable escaping of regular expression characters in the search term.

DataTables - Options

search.return

Enable / disable DataTables' search on return

DataTables - Options

search.search

Set an initial filtering condition on the table.

DataTables - Options

search.smart

Enable / disable DataTables' smart filtering

DataTables - Options

searchCols

Define an initial search for individual columns.

DataTables - Options

searchDelay

Set a delay for search operations

DataTables - Options

stateDuration

Saved state validity duration

DataTables - Options

tabIndex

Tab index control for keyboard navigation

DataTables - Columns

columnDefs

Set column definition initialisation properties.

DataTables - Columns

columnDefs.target

Alias of targets.

DataTables - Columns

columnDefs.targets

Assign a column definition to one or more columns.

DataTables - Columns

columns

Set column specific initialisation properties.

DataTables - Columns

columns.ariaTitle

Set the columns' aria-label attribute value

DataTables - Columns

columns.cellType

Cell type to be created for a column

DataTables - Columns

columns.className

Class to assign to each cell in the column

DataTables - Columns

columns.contentPadding

Add padding to the text content used when calculating the optimal width for a table.

DataTables - Columns

columns.createdCell

Cell created callback to allow DOM manipulation

DataTables - Columns

columns.data

Set the data source for the column from the rows data object / array

DataTables - Columns

columns.defaultContent

Set default, static, content for a column

DataTables - Columns

columns.footer

Set the column footer text

DataTables - Columns

columns.name

Set a descriptive name for a column

DataTables - Columns

columns.orderData

Define multiple column ordering as the default order for a column

DataTables - Columns

columns.orderDataType

Live DOM sorting type assignment

DataTables - Columns

columns.orderSequence

Order direction application sequence

DataTables - Columns

columns.orderable

Enable or disable ordering on this column

DataTables - Columns

columns.render

Render (process) the data for use in the table

DataTables - Columns

columns.searchable

Enable or disable search on the data in this column

DataTables - Columns

columns.title

Set the column title

DataTables - Columns

columns.type

Set the column type - used for filtering and sorting string processing

DataTables - Columns

columns.visible

Enable or disable the display of this column

DataTables - Columns

columns.width

Column width assignment

DataTables - Internationalisation

language

Language configuration options for DataTables

DataTables - Internationalisation

language.aria

Language strings used for WAI-ARIA specific attributes

DataTables - Internationalisation

language.aria.orderable

Language string used for WAI-ARIA column orderable label

DataTables - Internationalisation

language.aria.orderableRemove

Language string used for WAI-ARIA column label to alter column's ordering

DataTables - Internationalisation

language.aria.orderableReverse

Language string used for WAI-ARIA column label to alter column's ordering

DataTables - Internationalisation

language.aria.paginate

WAI-ARIA labels for pagination buttons

DataTables - Internationalisation

language.aria.paginate.first

WAI-ARIA label for the first pagination button

DataTables - Internationalisation

language.aria.paginate.last

WAI-ARIA label for the last pagination button

DataTables - Internationalisation

language.aria.paginate.next

WAI-ARIA label for the next pagination button

DataTables - Internationalisation

language.aria.paginate.number

WAI-ARIA label for the number pagination buttons

DataTables - Internationalisation

language.aria.paginate.previous

WAI-ARIA label for the previous pagination button

DataTables - Internationalisation

language.aria.sortAscending

Language strings used for WAI-ARIA specific attributes

DataTables - Internationalisation

language.aria.sortDescending

Language strings used for WAI-ARIA specific attributes

DataTables - Internationalisation

language.decimal

Decimal place character

DataTables - Internationalisation

language.emptyTable

Table has no records string

DataTables - Internationalisation

language.entries

Replacement pluralisation for table data type

DataTables - Internationalisation

language.info

Table summary information display string

DataTables - Internationalisation

language.infoEmpty

Table summary information string used when the table is empty of records

DataTables - Internationalisation

language.infoFiltered

Appended string to the summary information when the table is filtered

DataTables - Internationalisation

language.infoPostFix

String to append to all other summary information strings

DataTables - Internationalisation

language.lengthMenu

Page length options string

DataTables - Internationalisation

language.loadingRecords

Loading information display string - shown when Ajax loading data

DataTables - Internationalisation

language.paginate

Pagination specific language strings

DataTables - Internationalisation

language.paginate.first

Pagination 'first' button string

DataTables - Internationalisation

language.paginate.last

Pagination 'last' button string

DataTables - Internationalisation

language.paginate.next

Pagination 'next' button string

DataTables - Internationalisation

language.paginate.previous

Pagination 'previous' button string

DataTables - Internationalisation

language.processing

Processing indicator string

DataTables - Internationalisation

language.search

Search input string

DataTables - Internationalisation

language.searchPlaceholder

Search input element placeholder attribute

DataTables - Internationalisation

language.thousands

Thousands separator

DataTables - Internationalisation

language.url

Load language information from remote file

DataTables - Internationalisation

language.zeroRecords

Table empty as a result of filtering string

DataTables - Static

DataTable.ext.errMode

Set how DataTables will report detected errors

AutoFill

autoFill

Enable and configure the AutoFill extension for DataTables

AutoFill

autoFill.alwaysAsk

Always ask the end user if an action should be taken or not

AutoFill

autoFill.columns

Select the columns that can be auto filled

AutoFill

autoFill.editor

Attach an Editor instance for database updating

AutoFill

autoFill.enable

Initial enablement state of AutoFill

AutoFill

autoFill.focus

Action that will cause the auto fill drag handle to appear in a cell

AutoFill

autoFill.horizontal

Enable / disable user ability to horizontally drag and fill

AutoFill

autoFill.update

Control automatic update of data when a fill drag is completed

AutoFill

autoFill.vertical

Enable / disable user ability to vertically drag and fill

AutoFill

language.autoFill

Container object for language strings used by AutoFill

AutoFill

language.autoFill.button

Multi-fill selector button text

AutoFill

language.autoFill.cancel

Multi-fill selector cancel option message

AutoFill

language.autoFill.fill

Multi-fill selector message for the full fill fill type

AutoFill

language.autoFill.fillHorizontal

Multi-fill selector message for the horizontal fill fill type

AutoFill

language.autoFill.fillVertical

Multi-fill selector message for the vertical fill fill type

AutoFill

language.autoFill.increment

Multi-fill selector message for the increment fill type

AutoFill

language.autoFill.info

Information message shown at the top of the fill type selector

Buttons

buttons

Buttons configuration object

Buttons

buttons.buttons

List of buttons to be created

Buttons

buttons.buttons.action

Action to take when the button is activated

Buttons

buttons.buttons.async

Indicate that a button's action processing should be performed asynchronously.

Buttons

buttons.buttons.attr

Collection of attribute key / values to set for a button

Buttons

buttons.buttons.available

Ensure that any requirements have been satisfied before initialising a button

Buttons

buttons.buttons.className

Set the class name for the button

Buttons

buttons.buttons.destroy

Function that is called when the button is destroyed

Buttons

buttons.buttons.enabled

Set a button's initial enabled state

Buttons

buttons.buttons.extend

Define which button type the button should be based on

Buttons

buttons.buttons.init

Initialisation function that can be used to add events specific to this button

Buttons

buttons.buttons.key

Define an activation key for a button

Buttons

buttons.buttons.name

Set a name for each selection

Buttons

buttons.buttons.namespace

Unique namespace for every button

Buttons

buttons.buttons.split

Split dropdown buttons

Buttons

buttons.buttons.tag

Set the tag for the button

Buttons

buttons.buttons.text

The text to show in the button

Buttons

buttons.buttons.titleAttr

Button title attribute text

Buttons

buttons.name

Set a name for the instance for the group selector

ColReorder

colReorder

Enable and configure the ColReorder extension for DataTables

ColReorder

colReorder.columns

Select which columns can be reordered

ColReorder

colReorder.enable

Initial enablement state of ColReorder

ColReorder

colReorder.order

Set a default order for the columns in the table

Editor

columns.editField

Define which field a column should trigger editing on

FixedColumns

fixedColumns

Enable and configure the FixedColumns extension for DataTables

FixedColumns

fixedColumns.end

Number of columns to fix to the end of the table

FixedColumns

fixedColumns.left

Number of columns to fix to the left of the table

FixedColumns

fixedColumns.leftColumns

Number of columns to fix to the left of the table

FixedColumns

fixedColumns.right

Number of columns to fix to the right of the table

FixedColumns

fixedColumns.rightColumns

Number of columns to fix to the right of the table

FixedColumns

fixedColumns.start

Number of columns to fix to the start of the table

FixedColumns

language.fixedColumns.button

Set FixedColumns button text

FixedHeader

fixedHeader

FixedHeader configuration object

FixedHeader

fixedHeader.footer

Enable / disable fixed footer

FixedHeader

fixedHeader.footerOffset

Offset the table's fixed footer

FixedHeader

fixedHeader.header

Enable / disable fixed header

FixedHeader

fixedHeader.headerOffset

Offset the table's fixed header

KeyTable

keys

Enable and configure the KeyTable extension for DataTables

KeyTable

keys.blurable

Allow KeyTable's focus to be blurred (removed) from a table

KeyTable

keys.className

Set the class name used for the focused cell

KeyTable

keys.clipboard

Enable / disable clipboard interaction with KeyTable

KeyTable

keys.clipboardOrthogonal

Set the orthogonal data to copy to clipboard

KeyTable

keys.columns

Select the columns that can gain focus

KeyTable

keys.editOnFocus

Control if editing should be activated immediately upon focus

KeyTable

keys.editor

Attach an Editor instance for Excel like editing

KeyTable

keys.focus

Cell to receive initial focus in the table

KeyTable

keys.keys

Limit the keys that KeyTable will listen for and take action on

KeyTable

keys.tabIndex

Set the table's tab index for when it will receive focus

Responsive

columns.responsivePriority

Set column's visibility priority

Responsive

responsive

Enable and configure the Responsive extension for DataTables

Responsive

responsive.breakpoints

Set the breakpoints for a Responsive instance

Responsive

responsive.details

Enable and configure the child rows shown by Responsive for collapsed tables

Responsive

responsive.details.display

Define how the hidden information should be displayed to the end user

Responsive

responsive.details.renderer

Define the renderer used to display the child rows

Responsive

responsive.details.target

Column / selector for child row display control when using column details type

Responsive

responsive.details.type

Set the child row display control type

Responsive

responsive.orthogonal

Set the orthogonal data request type for the hidden information display

RowGroup

rowGroup

Enable and configure the RowGroup extension for DataTables

RowGroup

rowGroup.className

Set the class name to be used for the grouping rows

RowGroup

rowGroup.dataSrc

Set the data point to use as the grouping data source

RowGroup

rowGroup.emptyDataGroup

Text to show for rows which have null, undefined or empty string group data

RowGroup

rowGroup.enable

Provides the ability to disable row grouping at initialisation

RowGroup

rowGroup.endClassName

Set the class name to be used for the grouping end rows

RowGroup

rowGroup.endRender

Provide a function that can be used to control the data shown in the end grouping row.

RowGroup

rowGroup.startClassName

Set the class name to be used for the grouping start rows

RowGroup

rowGroup.startRender

Provide a function that can be used to control the data shown in the start grouping row.

RowReorder

rowReorder

Enable and configure the RowReorder extension for DataTables

RowReorder

rowReorder.cancelable

Enable / disable the canceling of the drag and drop interaction

RowReorder

rowReorder.dataSrc

Configure the data point that will be used for the reordering data

RowReorder

rowReorder.editor

Attach an Editor instance for database updating

RowReorder

rowReorder.enable

Enable / disable RowReorder's user interaction

RowReorder

rowReorder.formOptions

Set the options for the Editor form when submitting data

RowReorder

rowReorder.selector

Define the selector used to pick the elements that will start a drag

RowReorder

rowReorder.snapX

Horizontal position control of the row being dragged

RowReorder

rowReorder.update

Control automatic of data when a row is dropped

Scroller

scroller

Enable and configure the Scroller extension for DataTables

Scroller

scroller.boundaryScale

Set the point at which new data will be loaded and drawn

Scroller

scroller.displayBuffer

The amount of data that Scroller should pre-buffer to ensure smooth scrolling

Scroller

scroller.rowHeight

Set the row height, or how the row height is calculated

Scroller

scroller.serverWait

Time delay before new data is requested when server-side processing is enabled

SearchBuilder

button.searchBuilder

Button that is enabled when SearchBuilder is to be used through a button

SearchBuilder

columns.searchBuilder.defaultCondition

Set a default condition for this column

SearchBuilder

columns.searchBuilder.orthogonal

Set values of orthogonal data for rendering functions

SearchBuilder

columns.searchBuilderTitle

Set a custom title for a column in SearchBuilder

SearchBuilder

columns.searchBuilderType

Set the SearchBuilder type to use for a column

SearchBuilder

language.searchBuilder.add

Set the message to be displayed in the SearchBuilder add button

SearchBuilder

language.searchBuilder.button

Set SearchBuilder button text

SearchBuilder

language.searchBuilder.clearAll

Text to be displayed in the SearchBuilder clear all button

SearchBuilder

language.searchBuilder.condition

Set the placeholder text for the SearchBuilder condition select element

SearchBuilder

language.searchBuilder.conditions

Define custom condition names for SearchBuilder conditions

SearchBuilder

language.searchBuilder.conditions.array

Set the condition names for columns that use arrays

SearchBuilder

language.searchBuilder.conditions.date

Set the condition names for the date column type

SearchBuilder

language.searchBuilder.conditions.number

Set the condition names for the number column type

SearchBuilder

language.searchBuilder.conditions.string

Set the condition names for the string column type

SearchBuilder

language.searchBuilder.conditions[type]

The object containing the condition names for a specific type

SearchBuilder

language.searchBuilder.data

Set the placeholder text for the SearchBuilder data select element

SearchBuilder

language.searchBuilder.delete

Set the html of the SearchBuilder delete criteria button

SearchBuilder

language.searchBuilder.deleteTitle

Set the title attribute of the SearchBuilder delete criteria button

SearchBuilder

language.searchBuilder.left

Set the text of the SearchBuilder left button

SearchBuilder

language.searchBuilder.leftTitle

Set the title attribute of the SearchBuilder left button

SearchBuilder

language.searchBuilder.logicAnd

Message to display when AND logic is in place

SearchBuilder

language.searchBuilder.logicOr

Message to display when OR logic is in place

SearchBuilder

language.searchBuilder.right

Set the text of the SearchBuilder right button

SearchBuilder

language.searchBuilder.rightTitle

Set the title attribute of the SearchBuilder right button

SearchBuilder

language.searchBuilder.title

Set the SearchBuilder Title text

SearchBuilder

language.searchBuilder.value

Set the placeholder text for the SearchBuilder value select element

SearchBuilder

language.searchBuilder.valueJoiner

Set the text between the value input elements where two are required

SearchBuilder

searchBuilder

Enable and configure the SearchBuilder extension for DataTables

SearchBuilder

searchBuilder.columns

Restrict which columns can be filtered on

SearchBuilder

searchBuilder.conditions

Define custom conditions for SearchBuilder

SearchBuilder

searchBuilder.depthLimit

Impose a limit on the depth of the groups

SearchBuilder

searchBuilder.enterSearch

Trigger a search on the enter key rather than every keypress

SearchBuilder

searchBuilder.filterChanged

Function to update title text when selections are made.

SearchBuilder

searchBuilder.greyscale

Removes the colours from SearchBuilder

SearchBuilder

searchBuilder.liveSearch

Control live search operation

SearchBuilder

searchBuilder.logic

Set the default logic operator

SearchBuilder

searchBuilder.preDefined

Set a predefined search query

SearchPanes

button.searchPanes

Enable SearchPanes through a button

SearchPanes

columns.searchPanes

Container for options for individual columns

SearchPanes

columns.searchPanes.className

Add a custom class name to a pane

SearchPanes

columns.searchPanes.collapse

Allow the SearchPanes to be collapsed for specific columns

SearchPanes

columns.searchPanes.combiner

Set the type of logic to be implemented on the pane

SearchPanes

columns.searchPanes.controls

Hide the Control buttons and disable searching in the pane of a specific column

SearchPanes

columns.searchPanes.dtOpts

Define properties of the DataTables being used for an individual pane

SearchPanes

columns.searchPanes.emptyMessage

Set custom empty messages for specific panes

SearchPanes

columns.searchPanes.header

Set the title of the SearchPane

SearchPanes

columns.searchPanes.hideCount

Deprecated. Hide the count column in the pane of a specific column

SearchPanes

columns.searchPanes.initCollapsed

Collapse Specific SearchPanes on initialisation

SearchPanes

columns.searchPanes.name

Set the name of the SearchPane

SearchPanes

columns.searchPanes.options

Define custom search options

SearchPanes

columns.searchPanes.orderable

Hide the ordering buttons in the pane of a specific column

SearchPanes

columns.searchPanes.orthogonal

Set values of orthogonal data for rendering functions

SearchPanes

columns.searchPanes.preSelect

Deprecated. Pre-selected options in a pane

SearchPanes

columns.searchPanes.show

Force Panes to hide or show

SearchPanes

columns.searchPanes.threshold

Set the minimum number of unique values needed in a specific column to display that pane

SearchPanes

columns.searchPanes.viewCount

Hide the count column in the pane of a specific column

SearchPanes

language.searchPanes

Container for options for language

SearchPanes

language.searchPanes.clearMessage

Set the message to be displayed in the Clear button

SearchPanes

language.searchPanes.collapse

Set the message to be displayed in the SearchPanes Button

SearchPanes

language.searchPanes.collapseMessage

Set the message to be displayed in the Collapse button

SearchPanes

language.searchPanes.count

Set the message to be displayed in the count column when not searching

SearchPanes

language.searchPanes.countFiltered

Set the message to be displayed in the count column when searching

SearchPanes

language.searchPanes.emptyMessage

Add internationalisation to the empty message displayed as a pane option

SearchPanes

language.searchPanes.emptyPanes

Add internationalisation to the message shown when no panes are displayed

SearchPanes

language.searchPanes.loadMessage

Add internationalisation to the message shown when the panes are loading

SearchPanes

language.searchPanes.showMessage

Set the message to be displayed in the Show button

SearchPanes

language.searchPanes.title

Add internationalisation to the title showing how many panes are selected

SearchPanes

searchPanes

Enable Search Panes

SearchPanes

searchPanes.cascadePanes

Allow panes to cascade under selection

SearchPanes

searchPanes.clear

Disable buttons to allow quick clearing of selections in panes

SearchPanes

searchPanes.collapse

Allow the SearchPanes to be collapsed

SearchPanes

searchPanes.columns

Select which columns should be considered when displaying panes

SearchPanes

searchPanes.controls

Hide the control buttons and disable searching in all panes

SearchPanes

searchPanes.dtOpts

Define properties of the DataTables being used as Panes

SearchPanes

searchPanes.emptyMessage

Deprecated. Set custom empty message

SearchPanes

searchPanes.filterChanged

Function to update title text when selections are made.

SearchPanes

searchPanes.hideCount

Hide the count column in all panes

SearchPanes

searchPanes.i18n

Container for options for language

SearchPanes

searchPanes.i18n.clearMessage

Set the message to be displayed in the Clear button

SearchPanes

searchPanes.i18n.collapse

Set the message to be displayed in the SearchPanes Button

SearchPanes

searchPanes.i18n.collapseMessage

Set the message to be displayed in the Collapse button

SearchPanes

searchPanes.i18n.count

Set the message to be displayed in the count column when not searching

SearchPanes

searchPanes.i18n.countFiltered

Set the message to be displayed in the count column when searching

SearchPanes

searchPanes.i18n.emptyMessage

Add internationalisation to the empty message displayed as a pane option

SearchPanes

searchPanes.i18n.emptyPanes

Add internationalisation to the message shown when no panes are displayed

SearchPanes

searchPanes.i18n.loadMessage

Add internationalisation to the message shown when the panes are loading

SearchPanes

searchPanes.i18n.showMessage

Set the message to be displayed in the Show button

SearchPanes

searchPanes.i18n.title

Add internationalisation to the title showing how many panes are selected

SearchPanes

searchPanes.initCollapsed

Collapse the SearchPanes on initialisation

SearchPanes

searchPanes.layout

Set the layout of how the panes are displayed on the page

SearchPanes

searchPanes.order

Set the order of the Panes

SearchPanes

searchPanes.orderable

Hide the ordering buttons in all panes

SearchPanes

searchPanes.panes

Define custom panes to filter across all columns

SearchPanes

searchPanes.panes.className

Add a custom class for a custom pane

SearchPanes

searchPanes.panes.dtOpts

Define the DataTables options for a custom pane

SearchPanes

searchPanes.panes.header

Define the header for custom panes

SearchPanes

searchPanes.panes.options

Define the options for custom panes

SearchPanes

searchPanes.panes.options.className

Add classes to specific options of a custom pane

SearchPanes

searchPanes.panes.options.label

Define the label for an option of a custom pane

SearchPanes

searchPanes.panes.options.value

Define the value for an option of a custom pane

SearchPanes

searchPanes.panes.preSelect

Deprecated. Define any preSelections for the custom panes

SearchPanes

searchPanes.preSelect

Pre-selected options in a pane

SearchPanes

searchPanes.threshold

Set the minimum ratio of unique values to total values needed in a column to display it's pane

SearchPanes

searchPanes.viewCount

Show the count column in all panes

SearchPanes

searchPanes.viewTotal

Update the count column when searching to show visible count

Select

language.select

Container object for language strings used by Select

Select

language.select.aria.headerCheckbox

Text to use as the aria-label for the header checkbox

Select

language.select.aria.rowCheckbox

Text to use as the aria-label for the row selection checkboxs

Select

language.select.cells

Table information summary string for the number of cells selected

Select

language.select.columns

Table information summary string for the number of columns selected

Select

language.select.rows

Table information summary string for the number of rows selected

Select

select

Select configuration object

Select

select.blurable

Indicate if the selected items will be removed when clicking outside of the table

Select

select.className

Set the class name that will be applied to selected items

Select

select.headerCheckbox

Control automatic addition of header checkbox

Select

select.info

Enable / disable the display for item selection information in the table summary.

Select

select.items

Set which table items to select (rows, columns or cells)

Select

select.selectable

Set a function that will determine if a row should be selectable.

Select

select.selector

Set the element selector used for mouse event capture to select items

Select

select.style

Set the selection style for end user interaction with the table

Select

select.toggleable

Disable the deselection of selected rows when clicked

StateRestore

language.buttons.createState

Set the text within the StateRestore creation button

StateRestore

language.buttons.removeAllStates

Set the text within the StateRestore remove all button

StateRestore

language.buttons.removeState

Set the text within the StateRestore remove button

StateRestore

language.buttons.renameState

Set the text within the StateRestore rename button

StateRestore

language.buttons.savedStates

Set the text within the StateRestore savedStates button

StateRestore

language.buttons.stateRestore

Set the text within the StateRestore stateRestore split dropdown button

StateRestore

language.buttons.updateState

Set the text within the StateRestore update button

StateRestore

language.stateRestore

Container for options for language

StateRestore

language.stateRestore.creationModal

Set the text for the elements that are shown within the creation modal

StateRestore

language.stateRestore.creationModal.button

Set the text within the StateRestore creation modal button

StateRestore

language.stateRestore.creationModal.columns.search

Set the text for the label of the columns search checkbox within the creation modal

StateRestore

language.stateRestore.creationModal.columns.visible

Set the text for the label of the column visibility checkbox within the creation modal

StateRestore

language.stateRestore.creationModal.length

Set the text for the label of the page length checkbox within the creation modal

StateRestore

language.stateRestore.creationModal.name

Set the text for the label of the name input within the creation modal

StateRestore

language.stateRestore.creationModal.order

Set the text for the label of the order checkbox within the creation modal

StateRestore

language.stateRestore.creationModal.paging

Set the text for the label of the paging checkbox within the creation modal

StateRestore

language.stateRestore.creationModal.scroller

Set the text for the label of the scroller checkbox within the creation modal

StateRestore

language.stateRestore.creationModal.search

Set the text for the label of the search checkbox within the creation modal

StateRestore

language.stateRestore.creationModal.searchBuilder

Set the text for the label of the searchBuilder checkbox within the creation modal

StateRestore

language.stateRestore.creationModal.searchPanes

Set the text for the label of the searchPanes checkbox within the creation modal

StateRestore

language.stateRestore.creationModal.select

Set the text for the label of the select checkbox within the creation modal

StateRestore

language.stateRestore.creationModal.title

Set the text for the title of the creation modal

StateRestore

language.stateRestore.creationModal.toggleLabel

Set the label text shown beside the toggle check boxes

StateRestore

language.stateRestore.duplicateError

Set the error message shown when attempting to rename a state to one that already exists

StateRestore

language.stateRestore.emptyError

Set the error message shown when incorrectly renaming a state to an empty string

StateRestore

language.stateRestore.emptyStates

Set the text that is shown in the savedStates collection when there are no saved states

StateRestore

language.stateRestore.removeConfirm

Set the confirmation message shown within the StateRestore remove modal

StateRestore

language.stateRestore.removeError

Set the error message shown when incorrectly removing a state

StateRestore

language.stateRestore.removeJoiner

Set the joiner used between states within the StateRestore remove modal

StateRestore

language.stateRestore.removeSubmit

Set the text within the StateRestore remove button

StateRestore

language.stateRestore.removeTitle

Set the title shown in the StateRestore remove modal

StateRestore

language.stateRestore.renameButton

Set the text within the StateRestore remove button

StateRestore

language.stateRestore.renameLabel

Set the label next to the input element within the StateRestore rename modal

StateRestore

language.stateRestore.renameTitle

Set the title shown in the StateRestore rename modal