Table¶

Base class: Part

Describe a table. Example:

class AlbumTable(Table):
    name = Column()
    artist = Column()

    class Meta:
        sortable = False

▼ Hide result

Toggle structure

Refinable members¶

`action_class`¶

Type: type[Action]

Cookbook:: How do I use custom classes for a table’s internal parts?

`actions`¶

Type: dict[str, Action]

Cookbook:: How do I add custom actions/links to a table?

`actions_below` (evaluated)¶

Type: bool

Default: False

Cookbook:: How do I render the table actions below the table?

`actions_template` (evaluated)¶

Type: str | Template

Default: iommi/form/actions.html

Cookbook:: How do I render the table actions below the table?

`after` (evaluated)¶

Type: int | str

See after

`assets`¶

Type: Namespace

See assets

`attrs` (evaluated)¶

dict of strings to string/callable of HTML attributes to apply to the table

Type: Attrs

See attributes

Cookbook:: How do I make a freetext search field?

`auto`¶

Type: TableAutoConfig

See auto

Cookbook:

How do I show nested foreign key relationships?

How do I access foreign key related data in a column?

`bulk` (evaluated)¶

Type: Form | None

Cookbook:

How do I enable bulk delete?

How do I make a custom bulk action?

`bulk_container`¶

Type: Fragment

Cookbook:: How do I run code after a bulk edit, or limit which rows it touches?

`bulk_exclude` (evaluated)¶

exclude filters to apply to the QuerySet before performing the bulk operation

Type: Namespace

Default: {}

Cookbook:: How do I run code after a bulk edit, or limit which rows it touches?

`bulk_filter` (evaluated)¶

filters to apply to the QuerySet before performing the bulk operation

Type: Namespace

Default: {}

Cookbook:: How do I run code after a bulk edit, or limit which rows it touches?

`cell` (evaluated)¶

Type: CellConfig

Cookbook:: How do I render a Table as divs?

`cells_class`¶

Type: type[Cells]

Cookbook:: How do I use custom classes for a table’s internal parts?

`columns`¶

(use this only when not using the declarative style) a list of Column objects

Type: dict[str, Column]

Cookbook:

How do I reorder columns?

How do I create a column based on computed data (i.e. a column not based on an attribute of the row)?

How do I make a link in a cell?

`container` (evaluated)¶

Type: Fragment

Cookbook:: How do I insert arbitrary html into a Table?

`default_sort_order`¶

Type: str

Cookbook:: How do I set the default sorting column of a table?

`empty_message` (evaluated)¶

Type: str

Cookbook:: How do I render a Table as divs?

`endpoints`¶

Type: Namespace

See endpoints

`extra`¶

Type: dict[str, Any]

See extra

`extra_evaluated`¶

Type: dict[str, Any]

See extra

`extra_params`¶

See extra_params

`form_class`¶

Type: type[Form]

Cookbook:: How do I use a custom class for the columns/fields/filters of a component?

`h_tag` (evaluated)¶

Type: Fragment | str

See title

`include` (evaluated)¶

Type: bool

See include

`invalid_form_message` (evaluated)¶

Type: str

Cookbook:: How do I customize the message shown for an invalid filter?

`iommi_style`¶

Type: str | Style | None

See iommi_style

`member_class`¶

Type: type[Column]

Cookbook:: How do I use a custom class for the columns/fields/filters of a component?

`model` (evaluated)¶

Type: type[Model] | None

Cookbook:: How do I read the model information iommi found?

`outer` (evaluated)¶

Type: Fragment

Cookbook:: How do I insert arbitrary html into a Table?

`page_class`¶

Type: type[Page]

Cookbook:: How do I use custom classes for a table’s internal parts?

`page_size` (evaluated)¶

Type: int

Default: 16

Cookbook:: How do you turn off pagination?

`parts`¶

Type: Namespace

Cookbook:: How do you turn off pagination?

`query`¶

Type: Query | None

Cookbook:: How do I set an initial filter to a table?

`query_class`¶

Type: type[Query]

Cookbook:: How do I use a custom class for the columns/fields/filters of a component?

`query_from_indexes`¶

Type: bool

Cookbook:: How do I automatically create filters for indexed fields?

`row` (evaluated)¶

Type: RowConfig

Cookbook:: How do I customize the rendering of a row?

`row_group_class`¶

Type: type[RowGroup]

Cookbook:: How do I use custom classes for a table’s internal parts?

`rows` (evaluated)¶

a list or QuerySet of objects

Cookbook:: How do I render additional rows?

`sortable` (evaluated)¶

set this to False to turn off sorting for all columns

Type: bool

Default: True

Cookbook:: How do I turn off sorting? (on a column or table wide)

`sorter`¶

Cookbook:: How do I change what a column sorts by?

`superheader`¶

Type: Namespace

Cookbook:: How do I group columns under a superheader?

`table_tag_wrapper` (evaluated)¶

Type: Fragment

Cookbook:: How do I wrap just the table tag (e.g. for responsive scrolling)?

`tag` (evaluated)¶

Type: str

Default: table: See tag
Cookbook:: How do I render a Table as divs?

`tbody` (evaluated)¶

Type: Fragment

Cookbook:: How do I render a Table as divs?

`template` (evaluated)¶

Type: str | Template

Default: iommi/table/table.html: See template

`title` (evaluated)¶

Type: str | None

See title

Shortcuts¶

`Table.div`¶

Defaults¶

tag
- div
tbody__tag
- div
cell__tag
- None
row__tag
- div
header__template
- None

Methods¶

`as_view`¶

`bulk_queryset`¶

Return the queryset that contains only the selected rows with

bulk_filter and bulk_exclude applied.

For use in post_handlers. Only valid when rows was a queryset.

`cells_for_rows`¶

Yield a Cells instance for each visible row on the screen.

`get_visible_rows`¶

`on_bind`¶

`on_refine_done`¶

`own_evaluate_parameters`¶

`selection`¶

Return the selected rows.

For use in post_handlers. It’s a queryset if rows is a queryset and a list otherwise. Unlike bulk_queryset neither bulk_filter nor bulk_exclude are applied.

Table¶

Refinable members¶

action_class¶

actions¶

actions_below (evaluated)¶

actions_template (evaluated)¶

after (evaluated)¶

assets¶

attrs (evaluated)¶

auto¶

bulk (evaluated)¶

bulk_container¶

bulk_exclude (evaluated)¶

bulk_filter (evaluated)¶

cell (evaluated)¶

cells_class¶

columns¶

container (evaluated)¶

default_sort_order¶

empty_message (evaluated)¶

endpoints¶

extra¶

extra_evaluated¶

extra_params¶

form_class¶

h_tag (evaluated)¶

header¶

include (evaluated)¶

invalid_form_message (evaluated)¶

iommi_style¶

member_class¶

model (evaluated)¶

outer (evaluated)¶

page_class¶

page_size (evaluated)¶

parts¶

post_bulk_edit¶

preprocess_row¶

preprocess_rows¶

query¶

query_class¶

query_from_indexes¶

row (evaluated)¶

row_group_class¶

rows (evaluated)¶

sortable (evaluated)¶

sorter¶

superheader¶

table_tag_wrapper (evaluated)¶

tag (evaluated)¶

tbody (evaluated)¶

template (evaluated)¶

title (evaluated)¶

Shortcuts¶

Table.div¶

Defaults¶

Methods¶

as_view¶

bulk_queryset¶

cells_for_rows¶

get_visible_rows¶

on_bind¶

on_refine_done¶

own_evaluate_parameters¶

selection¶

should_render_form_tag¶

Class methods¶

columns_from_model¶

`action_class`¶

`actions`¶

`actions_below` (evaluated)¶

`actions_template` (evaluated)¶

`after` (evaluated)¶

`assets`¶

`attrs` (evaluated)¶

`auto`¶

`bulk` (evaluated)¶

`bulk_container`¶

`bulk_exclude` (evaluated)¶

`bulk_filter` (evaluated)¶

`cell` (evaluated)¶

`cells_class`¶

`columns`¶

`container` (evaluated)¶

`default_sort_order`¶

`empty_message` (evaluated)¶

`endpoints`¶

`extra`¶

`extra_evaluated`¶

`extra_params`¶

`form_class`¶

`h_tag` (evaluated)¶

`header`¶

`include` (evaluated)¶

`invalid_form_message` (evaluated)¶

`iommi_style`¶

`member_class`¶

`model` (evaluated)¶

`outer` (evaluated)¶

`page_class`¶

`page_size` (evaluated)¶

`parts`¶

`post_bulk_edit`¶

`preprocess_row`¶

`preprocess_rows`¶

`query`¶

`query_class`¶

`query_from_indexes`¶

`row` (evaluated)¶

`row_group_class`¶

`rows` (evaluated)¶

`sortable` (evaluated)¶

`sorter`¶

`superheader`¶

`table_tag_wrapper` (evaluated)¶

`tag` (evaluated)¶

`tbody` (evaluated)¶

`template` (evaluated)¶

`title` (evaluated)¶

`Table.div`¶

`as_view`¶

`bulk_queryset`¶

`cells_for_rows`¶

`get_visible_rows`¶

`on_bind`¶

`on_refine_done`¶

`own_evaluate_parameters`¶

`selection`¶

`should_render_form_tag`¶

`columns_from_model`¶