new TableType( id )

Description
Defines a type of Datatable, with its Settings object.
Parameters
Name Type Description
id string The identifier of this datatable type
Details

Members


handler :Handler

Description
Handler associated with the table type
Details

settings :Settings

Description
Settings object used to get various values for the datatable & other components
Details

id

Description
Retrieves the Id of the table type
Returns
The ID if the table type

Methods


setFilterHandler( closure ) → {this}

Description
Defines the function used to filter data
Parameters
Name Type Description
closure function The function to use for sorting.
Returns
For chaining.

setSortHandler( closure ) → {this}

Description
Defines the function used to sort data
Parameters
Name Type Description
closure function The function to use for sorting.
Returns
For chaining.

setPaginateHandler( closure ) → {this}

Description
Defines the function used to paginate data
Parameters
Name Type Description
closure function The function to use for pagination.
Returns
For chaining.

setting( path [, value ] ) → {this|*}

Description
Get or set a Settings value at a specific path
Parameters
Name Type Attributes Description
path string | number | Array.<(string|number)> Path to the setting value to get/set
value * <optional>
If omitted, this method will *get* the value at the specified `path`. Otherwise, it will *set* the value.
Returns
In *get* mode, the value. In *set* mode, `this`, for chaining.

mergeSettings( settings ) → {this}

Description
Merge a settings object with the TableType#settings object of the instance.
Parameters
Name Type Description
settings SettingsProps Values to merge
Returns
For chaining.

getTableDefinition() → {VueDatatable}

Description
Factory function that copy the VueDatatable prototype, and configure as this type.
Returns
A new factored VueDatatable constructor.

getPagerDefinition() → {VueDatatablePager}

Description
Factory function that copy the VueDatatablePager prototype, and configure as this type.
Returns
A new factored VueDatatablePager constructor.

clone( obj ) → {*}

Description
Deep clone a value
Parameters
Name Type Description
obj * The value to clone
Returns
The clone of the original parameter.

setDisplayHandler( closure ) → {this}

Description
Defines the function used to paginate data
Parameters
Name Type Description
closure function The function to use to post-process processed steps & extract rows & total count.
Returns
For chaining.