Version 6.5.0 Released!

Click to checkout the new features
Old Documentation
You are browsing documentation for an old release of Tabulator. Consider upgrading your project to Tabulator 6.x (latest 6.5.0)

Deprecated Functionality

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

v4.9 Deprecations

No functionality was deprecated in this release.

v4.8 Deprecations

Callbacks

Data Edited Callback

The dataEdited setup option has now been renamed to dataChanged to better describe its updated functionality

Anywhere you used the dataEdited property

var table = new Tabulator("#example-table", {
    dataEdited:function(data){},
});

You should now use the dataChanged property

var table = new Tabulator("#example-table", {
    dataChanged:function(data){},
});

v4.7 Deprecations

Downloads

Column Header Title

The downloadTitle column definition property has now been renamed to titleDownload to bring it inline with other export functionality

Anywhere you used the downloadTitle property

var table = new Tabulator("#example-table", {
    columns:[
        {title:"Age", downloadTitle:"User Age", field:"age"},
    ]
});

You should now use the titleDownload property

var table = new Tabulator("#example-table", {
    columns:[
        {title:"Age", titleDownload:"User Age", field:"age"},
    ]
});

Data Formatter

The downloadDataFormatter option has been depricated and is no longer available.

where you used to use the downloadDataFormatter option to alter data being downloaded, you should now use the accessorDownload on the columns to be altered.

Columns

Check Visibility

The getVisibility function has now been renamed to isVisible to bring it inline with other funcnctions

Anywhere you used the getVisibility function

var visible = column.isVisible();

You should now use the isVisible function

var visible = column.isVisible();

Group

Check Visibility

The getVisibility function has now been renamed to isVisible to bring it inline with other funcnctions

Anywhere you used the getVisibility function

var visible = group.isVisible();

You should now use the isVisible function

var visible = group.isVisible();

v4.6 Deprecations

Clipboard

Copy Selector

The clipboardCopySelector option has been depricated an has been replaced with a property in the new clipboardCopyRowRange option.

where you used to use the clipboardCopySelector option to set which rows would be visible in the clipboard output.

var table = new Tabulator("#example-table", {
    clipboardCopySelector:"table", //change default selector to active
});

You should now use the clipboardCopyRowRange option which takes any valid Row Range Lookup value:

var table = new Tabulator("#example-table", {
    clipboardCopyRowRange:"all", //copy all rows to the clipboard even if they are filtered out
});

Printing

Styled Printing Option

The printCopyStyle option has been renamed to printStyled to improve naming consistency accross export options

Where you used to use the printCopyStyle option:

var table = new Tabulator("#example-table", {
    printCopyStyle:true, //copy Tabulator styling to HTML table
});

You should now use the printStyled option:

var table = new Tabulator("#example-table", {
    printStyled:true, //copy Tabulator styling to HTML table
});

Print Visible Rows

The printVisibleRows option has been replaced with the printRowRange which allows for a great range of rows to be shown

Where you used to use the printVisibleRows option:

var table = new Tabulator("#example-table", {
    printVisibleRows:false, //print all rows in the table
});

You should now use the printRowRange option:

var table = new Tabulator("#example-table", {
    printRowRange:"all", //print all rows in the table
});

Cell Alignment

The align column definition property has been renamed to hozAlign to improve clarity with the new vertical alignment options

Where you used to set the horizontal alignment of a cell by using the align column definition property:

{title:"Name", field:"name", align:"center"} //center align cell

You should now use the param hozAlign property:

{title:"Name", field:"name", hozAlign:"center"} //center align cell

v4.5 Deprecations

Persistent Config

Several updates have been made to the persistance module in this update

Sort Persistence

The persistentSort option has been depricated an has been replaced with a property in the new persistence option.

Where you used to set persistentSort to true:

var table = new Tabulator("#example-table", {
    persistentSort:true, //Enable sort persistence
});

You should now set the sort property to true on the persistence option:

var table = new Tabulator("#example-table", {
    persistence:{
    	sort:true //Enable sort persistence
    }
});
Filter Persistence

The persistentFilter option has been depricated an has been replaced with a property in the new persistence option.

Where you used to set persistentFilter to true:

var table = new Tabulator("#example-table", {
    persistentFilter:true, //Enable filter persistence
});

You should now set the filter property to true on the persistence option:

var table = new Tabulator("#example-table", {
    persistence:{
    	filter:true //Enable filter persistence
    }
});
Column Layout Persistence

The persistentLayout option has been depricated an has been replaced with a property in the new persistence option.

Where you used to set persistentLayout to true:

var table = new Tabulator("#example-table", {
    persistentLayout:true, //Enable column layout persistence
});

You should now set the columns property to true on the persistence option:

var table = new Tabulator("#example-table", {
    persistence:{
    	columns:true //Enable column layout persistence
    }
});

Active Row Retrieval

Get Active Rows

Passing a boolean of true to the getRows function to retrieve an array of filtered row componets has been depricated, a string of "active" should be passed in instead.

Where you used to pass a value of true to the getRows function:

var rows = table.getRows(true);

You should now pass a value of "active" to the getRows function:

var rows = table.getRows("active");

Get Active Row Data

Passing a boolean of true to the getData function to retrieve an array of filtered row data objects has been depricated, a string of "active" should be passed in instead.

Where you used to pass a value of true to the getData function:

var rows = table.getData(true);

You should now pass a value of "active" to the getData function:

var rows = table.getData("active");

Get Active Row Data Count

Passing a boolean of true to the getDataCount function to retrieve an count of the filtered rows in the table has been depricated, a string of "active" should be passed in instead.

Where you used to pass a value of true to the getDataCount function:

var rows = table.getDataCount(true);

You should now pass a value of "active" to the getDataCount function:

var rows = table.getDataCount("active");

Column Headers

Vertical Alignment

The columnVertAlign option has been renamed to columnHeaderVertAlign to make it clearer that it only affects the column headers

Where you used to set alignment with the columnVertAlign option:

var table = new Tabulator("#example-table", {
    columnVertAlign:"bottom", //align header contents to bottom of cell
});

You should now use the columnHeaderVertAlign option:

var table = new Tabulator("#example-table", {
    columnHeaderVertAlign:"bottom", //align header contents to bottom of cell
});

Row Selection

Passing a boolean of true to the selectRow function to select all the active row has been depricated, a string of "active" should be passed in instead.

Where you used to pass a boolean of true to the selectRow function to select all the active rows:

table.selectRow(true); //select active rows

You should now upass a string of active to the selectRow function:

table.selectRow("active"); //select active rows

v4.4 Deprecations

No functionality has been depricated in this release

v4.3 Deprecations

The following functionality is depricated and will be removed in version 5.0

Clipboard

Include Column Headers In Clipboard Output

Deprecated Function

Preventing headers being included in the clipboard output using the clipboardCopyHeader property:

var table = new Tabulator("#example-table", {
    clipboardCopyHeader:false, //disable header titles in copied data
});
Replacement Function

Use the columnHeaders property in the clipboardCopyConfig option:

var table = new Tabulator("#example-table", {
    clipboardCopyConfig:{
        columnHeaders:false, //don't include column headers in clipboard output
    },
});

Formatters

Tick Formatter

Deprecated Function

Assigning tick to the formatter column definition property:

{title:"Driver", field:"driver", formatter:"tick"},
Replacement Function

Use the tickCross formatter with the crossElement param set to false:

{title:"Driver", field:"driver", formatter:"tickCross", formatterParams:{
	crossElement:false,
}},

Editors

Tick Editor

Deprecated Function

Assigning tick to the editor column definition property:

{title:"Driver", field:"driver", editor:"tick"},
Replacement Function

Use the tickCross editor:

{title:"Driver", field:"driver", editor:"tickCross"},

Select Editor Value

Deprecated Function

Passing values directly into the select editors editorParams object:

{title:"Name", field:"name", editor:"select", editorParams:{
    "steve":"Steve Boberson",
    "bob":"Bob Jimmerson",
    "jim":"Jim Stevenson",
}}
Replacement Function

Pass values into the values property of the editorParams object:

{title:"Name", field:"name", editor:"select", editorParams:{
    values:{
        "steve":"Steve Boberson",
        "bob":"Bob Jimmerson",
        "jim":"Jim Stevenson",
    }
}}

v4.2 Deprecations

The following functionality is depricated and will be removed in version 5.0

Clipboard

Include Column Headers In Clipboard Output

Deprecated Function

Preventing headers being included in the clipboard output using the clipboardCopyHeader property:

var table = new Tabulator("#example-table", {
    clipboardCopyHeader:false, //disable header titles in copied data
});
Replacement Function

Use the columnHeaders property in the clipboardCopyConfig option:

var table = new Tabulator("#example-table", {
    clipboardCopyConfig:{
        columnHeaders:false, //don't include column headers in clipboard output
    },
});

Formatters

Tick Formatter

Deprecated Function

Assigning tick to the formatter column definition property:

{title:"Driver", field:"driver", formatter:"tick"},
Replacement Function

Use the tickCross formatter with the crossElement param set to false:

{title:"Driver", field:"driver", formatter:"tickCross", formatterParams:{
	crossElement:false,
}},

Editors

Tick Editor

Deprecated Function

Assigning tick to the editor column definition property:

{title:"Driver", field:"driver", editor:"tick"},
Replacement Function

Use the tickCross editor:

{title:"Driver", field:"driver", editor:"tickCross"},

Select Editor Value

Deprecated Function

Passing values directly into the select editors editorParams object:

{title:"Name", field:"name", editor:"select", editorParams:{
    "steve":"Steve Boberson",
    "bob":"Bob Jimmerson",
    "jim":"Jim Stevenson",
}}
Replacement Function

Pass values into the values property of the editorParams object:

{title:"Name", field:"name", editor:"select", editorParams:{
    values:{
        "steve":"Steve Boberson",
        "bob":"Bob Jimmerson",
        "jim":"Jim Stevenson",
    }
}}

v4.1 Deprecations

The following functionality is depricated and will be removed in version 5.0

Clipboard

Include Column Headers In Clipboard Output

Deprecated Function

Preventing headers being included in the clipboard output using the clipboardCopyHeader property:

var table = new Tabulator("#example-table", {
    clipboardCopyHeader:false, //disable header titles in copied data
});
Replacement Function

Use the columnHeaders property in the clipboardCopyConfig option:

var table = new Tabulator("#example-table", {
    clipboardCopyConfig:{
        columnHeaders:false, //don't include column headers in clipboard output
    },
});

Formatters

Tick Formatter

Deprecated Function

Assigning tick to the formatter column definition property:

{title:"Driver", field:"driver", formatter:"tick"},
Replacement Function

Use the tickCross formatter with the crossElement param set to false:

{title:"Driver", field:"driver", formatter:"tickCross", formatterParams:{
	crossElement:false,
}},

Editors

Tick Editor

Deprecated Function

Assigning tick to the editor column definition property:

{title:"Driver", field:"driver", editor:"tick"},
Replacement Function

Use the tickCross editor:

{title:"Driver", field:"driver", editor:"tickCross"},

Select Editor Value

Deprecated Function

Passing values directly into the select editors editorParams object:

{title:"Name", field:"name", editor:"select", editorParams:{
    "steve":"Steve Boberson",
    "bob":"Bob Jimmerson",
    "jim":"Jim Stevenson",
}}
Replacement Function

Pass values into the values property of the editorParams object:

{title:"Name", field:"name", editor:"select", editorParams:{
    values:{
        "steve":"Steve Boberson",
        "bob":"Bob Jimmerson",
        "jim":"Jim Stevenson",
    }
}}

v4.0 Deprecations

There is currently no deprecated functionality. All deprecated functionality from version 3.x has now been removed