API

eztables – Main package

eztables.forms – DataTables pagination form processing

class eztables.forms.DatatablesForm(*args, **kwargs)

Bases: django.forms.forms.Form

Datatables server side processing Form

See: http://www.datatables.net/usage/server-side

bRegex = None

True if the global filter should be treated as a regular expression for advanced filtering, false if not.

iColumns = None

Number of columns being displayed (useful for getting individual column search info)

iDisplayLength = None

Number of records that the table can display in the current draw. It is expected that the number of records returned will be equal to this number, unless the server has fewer records to return.

iDisplayStart = None

Display start point in the current data set.

iSortingCols = None

Number of columns to sort on

sEcho = None

Information for DataTables to use for rendering.

sSearch = None

Global search field

eztables.views – DataTables server-side processing view

class eztables.views.DatatablesView(**kwargs)

Bases: django.views.generic.list.MultipleObjectMixin, django.views.generic.base.View

Render a paginated server-side Datatables JSON view.

See: http://www.datatables.net/usage/server-side

column_search(queryset)

Filter a queryset with column search

get_orders()

Get ordering fields for QuerySet.order_by

get_page(form)

Get the requested page

get_queryset()

Apply Datatables sort and search criterion to QuerySet

get_row(row)

Format a single row (if necessary)

get_rows(rows)

Format all rows

global_search(queryset)

Filter a queryset with global search

render_to_response(form, **kwargs)

Render Datatables expected JSON format

eztables.templatetags.eztables – Template tags