mirror of
https://github.com/netbox-community/netbox.git
synced 2024-05-10 07:54:54 +00:00
92 lines
2.3 KiB
Markdown
92 lines
2.3 KiB
Markdown
# Generic Views
|
|
|
|
NetBox provides several generic view classes to facilitate common operations, such as creating, viewing, modifying, and deleting objects. Plugins can subclass these views for their own use.
|
|
|
|
| View Class | Description |
|
|
|------------|-------------|
|
|
| `ObjectView` | View a single object |
|
|
| `ObjectEditView` | Create or edit a single object |
|
|
| `ObjectDeleteView` | Delete a single object |
|
|
| `ObjectListView` | View a list of objects |
|
|
| `BulkImportView` | Import a set of new objects |
|
|
| `BulkEditView` | Edit multiple objects |
|
|
| `BulkDeleteView` | Delete multiple objects |
|
|
|
|
### Example Usage
|
|
|
|
```python
|
|
# views.py
|
|
from netbox.views.generic import ObjectEditView
|
|
from .models import Thing
|
|
|
|
class ThingEditView(ObjectEditView):
|
|
queryset = Thing.objects.all()
|
|
template_name = 'myplugin/thing.html'
|
|
...
|
|
```
|
|
|
|
## Generic Views Reference
|
|
|
|
Below is the class definition for NetBox's base GenericView. The attributes and methods defined here are available on all generic views.
|
|
|
|
::: netbox.views.generic.base.GenericView
|
|
rendering:
|
|
show_source: false
|
|
|
|
!!! note
|
|
Please note that only the classes which appear in this documentation are currently supported. Although other classes may be present within the `views.generic` module, they are not yet supported for use by plugins.
|
|
|
|
::: netbox.views.generic.ObjectView
|
|
selection:
|
|
members:
|
|
- get_object
|
|
- get_template_name
|
|
- get_extra_context
|
|
rendering:
|
|
show_source: false
|
|
|
|
::: netbox.views.generic.ObjectEditView
|
|
selection:
|
|
members:
|
|
- get_object
|
|
- alter_object
|
|
rendering:
|
|
show_source: false
|
|
|
|
::: netbox.views.generic.ObjectDeleteView
|
|
selection:
|
|
members:
|
|
- get_object
|
|
rendering:
|
|
show_source: false
|
|
|
|
::: netbox.views.generic.ObjectListView
|
|
selection:
|
|
members:
|
|
- get_table
|
|
- get_extra_context
|
|
- export_yaml
|
|
- export_table
|
|
- export_template
|
|
rendering:
|
|
show_source: false
|
|
|
|
::: netbox.views.generic.BulkImportView
|
|
selection:
|
|
members: false
|
|
rendering:
|
|
show_source: false
|
|
|
|
::: netbox.views.generic.BulkEditView
|
|
selection:
|
|
members: false
|
|
rendering:
|
|
show_source: false
|
|
|
|
::: netbox.views.generic.BulkDeleteView
|
|
selection:
|
|
members:
|
|
- get_form
|
|
rendering:
|
|
show_source: false
|