summaryrefslogtreecommitdiff
path: root/doc/source/ref/tables.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/ref/tables.rst')
-rw-r--r--doc/source/ref/tables.rst82
1 files changed, 0 insertions, 82 deletions
diff --git a/doc/source/ref/tables.rst b/doc/source/ref/tables.rst
deleted file mode 100644
index 4b74d5e3..00000000
--- a/doc/source/ref/tables.rst
+++ /dev/null
@@ -1,82 +0,0 @@
-==================
-Horizon DataTables
-==================
-
-.. module:: horizon.tables
-
-Horizon includes a componentized API for programmatically creating tables
-in the UI. Why would you want this? It means that every table renders
-correctly and consistently, table- and row-level actions all have a consistent
-API and appearance, and generally you don't have to reinvent the wheel or
-copy-and-paste every time you need a new table!
-
-DataTable
-=========
-
-The core class which defines the high-level structure of the table being
-represented. Example::
-
- class MyTable(DataTable):
- name = Column('name')
- email = Column('email')
-
- class Meta:
- name = "my_table"
- table_actions = (MyAction, MyOtherAction)
- row_actions - (MyAction)
-
-A full reference is included below:
-
-.. autoclass:: DataTable
- :members:
-
-DataTable Options
-=================
-
-The following options can be defined in a ``Meta`` class inside a
-:class:`.DataTable` class. Example::
-
- class MyTable(DataTable):
- class Meta:
- name = "my_table"
- verbose_name = "My Table"
-
-.. autoclass:: horizon.tables.base.DataTableOptions
- :members:
-
-Table Components
-================
-
-.. autoclass:: Column
- :members:
-
-.. autoclass:: Row
- :members:
-
-Actions
-=======
-
-.. autoclass:: Action
- :members:
-
-.. autoclass:: LinkAction
- :members:
-
-.. autoclass:: FilterAction
- :members:
-
-.. autoclass:: BatchAction
- :members:
-
-.. autoclass:: DeleteAction
- :members:
-
-Class-Based Views
-=================
-
-Several class-based views are provided to make working with DataTables
-easier in your UI.
-
-.. autoclass:: DataTableView
-
-.. autoclass:: MultiTableView