Deprecated Functionality

This page lists every Tabulator option, callback, or feature deprecated across the 5.x release line. Newest releases first.

• v5.6
• v5.5
• v5.4
• v5.3
• v5.2
• v5.1
• v5.0

v5.6 Deprecations

Row Selection

With the addition of the range selection module, all row selection options have now been renamed for clarity.

Enable Row Selection

Anywhere you used the selectable option:

var table = new Tabulator("#example-table", {
    selectable:true, //make rows selectable
});

You should now use the selectableRows option:

var table = new Tabulator("#example-table", {
    selectableRows:true, //make rows selectable
});

Rolling Row Selection

Anywhere you used the selectableRollingSelection option:

var table = new Tabulator("#example-table", {
    selectableRollingSelection:false, //disable rolling selection
});

You should now use the selectableRowsRollingSelection option:

var table = new Tabulator("#example-table", {
    selectableRowsRollingSelection:false, //disable rolling selection
});

Range Mode

Anywhere you used the selectableRangeMode option:

var table = new Tabulator("#example-table", {
    selectableRangeMode:"click", //select row range on click
});

You should now use the selectableRowsRangeMode option:

var table = new Tabulator("#example-table", {
    selectableRowsRangeMode:"click", //select row range on click
});

Persistent Selection

Anywhere you used the selectablePersistence option:

var table = new Tabulator("#example-table", {
    selectablePersistence:false, //disable selection peristence
});

You should now use the selectableRowsPersistence option:

var table = new Tabulator("#example-table", {
    selectableRowsPersistence:false, //disable selection peristence
});

Persistent Selection

Anywhere you used the selectableCheck option:

var table = new Tabulator("#example-table", {
    selectableCheck:function(row){
        //row - row component
        return row.getData().age > 18; //allow selection of rows where the age is greater than 18
    },
});

You should now use the selectableRowsCheck option:

var table = new Tabulator("#example-table", {
    selectableRowsCheck:function(row){
        //row - row component
        return row.getData().age > 18; //allow selection of rows where the age is greater than 18
    }
});

v5.5 Deprecations

No functionality was deprecated in this release.

v5.4 Deprecations

No functionality was deprecated in this release.

v5.3 Deprecations

Download

Download Ready

The downloadReady callback has been replaced with the downloadEncoder callback, which provides more synchronous control of the output file.

Anywhere you used to use the downloadReady option:

var table = new Tabulator("#example-table", {
    downloadReady:function(fileContents, blob){
        //fileContents - the unencoded contents of the file
        //blob - the blob object for the download

        //custom action to send blob to server could be included here

        return blob; //must return a blob to proceed with the download, return false to abort download
    }
});

You should now use the downloadEncoder option, taking care that the new function must actually encode the blob, it can no longer be passed through from the function arguments.

var table = new Tabulator("#example-table", {
    downloadEncoder:function(fileContents, mimeType){
        //fileContents - the unencoded contents of the file
        //mimeType - the suggested mime type for the output

        //custom action to send blob to server could be included here

        return new Blob([fileContents], {type:mimeType}); //must return a blob to proceed with the download, return false to abort download
    }
});

v5.2 Deprecations

Menu Containter

As a result of the introduction of the built in popup functionality in this release, the menu module is no longer responsible for creation of its own popups.

For this reason the module specific menuContainer has been deprecated and replaced with the table wide popupContainer option.

Anywhere you used to use the menuContainer option:

var table = new Tabulator("#example-table", {
    menuContainer:true, //show menus relative to the table element
});

You should now use the popupContainer option:

var table = new Tabulator("#example-table", {
    popupContainer:true, //show menus and other popups relative to the table element
});

Tooltips

With the migration of tooltip functionality to the new Tooltip module the tooltipGenerationMode has become redundant and can be removed.

You should remove any use of the tooltipGenerationMode option:

var table = new Tabulator("#example-table", {
    tooltipGenerationMode:"hover",
});

Editors

Select Editor

The select editor has been removed in this release and replaced with the more configurable list editor.

Column definitions using the select editor

{title:"Example", field:"example", editor:"select"}

Should be replaced with the list editor

{title:"Example", field:"example", editor:"list"}

Autocomplete Editor

The autocomplete editor has been removed in this release and replaced with the more configurable list editor.

Column definitions using the autocomplete editor

{title:"Example", field:"example", editor:"autocomplete"}

Should be replaced with the list editor

{title:"Example", field:"example", editor:"list", editorParams:{autocomplete:true}}

v5.1 Deprecations

No functionality was deprecated in this release.

v5.0 Deprecations

All previously deprecated functionality since version 4.0 has been removed in this release