nautobot 2.4.0b1__py3-none-any.whl → 2.4.1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of nautobot might be problematic. Click here for more details.
- nautobot/apps/__init__.py +1 -1
- nautobot/apps/api.py +8 -8
- nautobot/apps/change_logging.py +2 -2
- nautobot/apps/choices.py +4 -4
- nautobot/apps/events.py +3 -3
- nautobot/apps/factory.py +2 -2
- nautobot/apps/filters.py +1 -1
- nautobot/apps/forms.py +20 -20
- nautobot/apps/graphql.py +2 -2
- nautobot/apps/jobs.py +8 -8
- nautobot/apps/models.py +19 -19
- nautobot/apps/tables.py +1 -1
- nautobot/apps/testing.py +10 -10
- nautobot/apps/ui.py +2 -2
- nautobot/apps/utils.py +7 -7
- nautobot/apps/views.py +7 -7
- nautobot/circuits/api/serializers.py +1 -0
- nautobot/circuits/api/views.py +4 -8
- nautobot/circuits/tables.py +2 -1
- nautobot/circuits/templates/circuits/circuit_create.html +1 -7
- nautobot/circuits/views.py +3 -3
- nautobot/cloud/api/views.py +6 -10
- nautobot/cloud/models.py +1 -1
- nautobot/cloud/views.py +0 -16
- nautobot/core/api/constants.py +11 -0
- nautobot/core/api/fields.py +5 -5
- nautobot/core/api/filter_backends.py +3 -9
- nautobot/core/api/schema.py +13 -2
- nautobot/core/api/serializers.py +40 -34
- nautobot/core/api/views.py +56 -4
- nautobot/core/celery/log.py +4 -4
- nautobot/core/celery/schedulers.py +2 -2
- nautobot/core/choices.py +2 -2
- nautobot/core/events/__init__.py +3 -3
- nautobot/core/filters.py +67 -35
- nautobot/core/forms/__init__.py +19 -19
- nautobot/core/forms/fields.py +14 -11
- nautobot/core/forms/forms.py +33 -2
- nautobot/core/graphql/types.py +1 -1
- nautobot/core/jobs/__init__.py +28 -7
- nautobot/core/jobs/bulk_actions.py +285 -0
- nautobot/core/jobs/cleanup.py +48 -12
- nautobot/core/jobs/groups.py +1 -1
- nautobot/core/management/commands/validate_models.py +1 -1
- nautobot/core/models/__init__.py +3 -1
- nautobot/core/models/query_functions.py +2 -2
- nautobot/core/models/tree_queries.py +6 -3
- nautobot/core/settings.py +29 -2
- nautobot/core/settings.yaml +21 -0
- nautobot/core/tables.py +79 -61
- nautobot/core/templates/about.html +67 -0
- nautobot/core/templates/inc/media.html +3 -0
- nautobot/core/templates/inc/nav_menu.html +1 -0
- nautobot/core/templates/inc/tenancy_form_panel.html +9 -0
- nautobot/core/templates/inc/tenant_table_row.html +11 -0
- nautobot/core/templates/nautobot_config.py.j2 +13 -0
- nautobot/core/templates/search.html +7 -0
- nautobot/core/templates/utilities/render_jinja2.html +1 -1
- nautobot/core/templates/utilities/templatetags/tag.html +1 -1
- nautobot/core/templates/utilities/theme_preview.html +7 -0
- nautobot/core/templatetags/helpers.py +11 -2
- nautobot/core/testing/__init__.py +8 -8
- nautobot/core/testing/api.py +170 -15
- nautobot/core/testing/filters.py +45 -10
- nautobot/core/testing/forms.py +2 -0
- nautobot/core/testing/integration.py +86 -4
- nautobot/core/testing/mixins.py +7 -2
- nautobot/core/testing/views.py +44 -29
- nautobot/core/tests/integration/test_app_home.py +0 -1
- nautobot/core/tests/integration/test_app_navbar.py +0 -1
- nautobot/core/tests/integration/test_filters.py +0 -2
- nautobot/core/tests/integration/test_home.py +0 -1
- nautobot/core/tests/integration/test_navbar.py +0 -1
- nautobot/core/tests/integration/test_view_authentication.py +1 -0
- nautobot/core/tests/runner.py +1 -1
- nautobot/core/tests/test_api.py +98 -1
- nautobot/core/tests/test_csv.py +25 -3
- nautobot/core/tests/test_filters.py +209 -246
- nautobot/core/tests/test_forms.py +1 -0
- nautobot/core/tests/test_jobs.py +460 -1
- nautobot/core/tests/test_models.py +9 -0
- nautobot/core/tests/test_settings_schema.py +7 -0
- nautobot/core/tests/test_tables.py +100 -0
- nautobot/core/tests/test_utils.py +63 -1
- nautobot/core/tests/test_views.py +30 -3
- nautobot/core/ui/nav.py +1 -0
- nautobot/core/ui/object_detail.py +15 -1
- nautobot/core/urls.py +11 -0
- nautobot/core/utils/lookup.py +11 -8
- nautobot/core/utils/querysets.py +64 -0
- nautobot/core/utils/requests.py +24 -9
- nautobot/core/views/__init__.py +42 -0
- nautobot/core/views/generic.py +131 -197
- nautobot/core/views/mixins.py +126 -38
- nautobot/core/views/renderers.py +6 -6
- nautobot/dcim/api/serializers.py +56 -64
- nautobot/dcim/api/views.py +47 -113
- nautobot/dcim/constants.py +6 -13
- nautobot/dcim/factory.py +6 -1
- nautobot/dcim/filters/__init__.py +31 -2
- nautobot/dcim/forms.py +36 -17
- nautobot/dcim/graphql/types.py +2 -2
- nautobot/dcim/migrations/0067_controllermanageddevicegroup_tenant.py +25 -0
- nautobot/dcim/models/__init__.py +1 -1
- nautobot/dcim/models/device_component_templates.py +2 -2
- nautobot/dcim/models/device_components.py +22 -20
- nautobot/dcim/models/devices.py +10 -1
- nautobot/dcim/models/locations.py +3 -3
- nautobot/dcim/models/power.py +6 -5
- nautobot/dcim/models/racks.py +4 -4
- nautobot/dcim/tables/__init__.py +3 -3
- nautobot/dcim/tables/devices.py +7 -5
- nautobot/dcim/tables/devicetypes.py +2 -2
- nautobot/dcim/tables/racks.py +1 -1
- nautobot/dcim/templates/dcim/controller_create.html +1 -7
- nautobot/dcim/templates/dcim/controller_retrieve.html +1 -9
- nautobot/dcim/templates/dcim/controllermanageddevicegroup_create.html +2 -0
- nautobot/dcim/templates/dcim/controllermanageddevicegroup_retrieve.html +5 -0
- nautobot/dcim/templates/dcim/device.html +1 -9
- nautobot/dcim/templates/dcim/device_edit.html +36 -37
- nautobot/dcim/templates/dcim/location.html +1 -9
- nautobot/dcim/templates/dcim/location_edit.html +1 -7
- nautobot/dcim/templates/dcim/rack.html +1 -9
- nautobot/dcim/templates/dcim/rack_edit.html +1 -7
- nautobot/dcim/templates/dcim/rackreservation.html +1 -9
- nautobot/dcim/templates/dcim/virtualdevicecontext_retrieve.html +1 -9
- nautobot/dcim/templates/dcim/virtualdevicecontext_update.html +1 -7
- nautobot/dcim/tests/integration/test_controller.py +62 -0
- nautobot/dcim/tests/integration/test_controller_managed_device_group.py +71 -0
- nautobot/dcim/tests/integration/test_device_bulk_delete.py +189 -0
- nautobot/dcim/tests/integration/test_device_bulk_edit.py +181 -0
- nautobot/dcim/tests/test_api.py +16 -5
- nautobot/dcim/tests/test_filters.py +33 -0
- nautobot/dcim/tests/test_forms.py +51 -2
- nautobot/dcim/tests/test_graphql.py +52 -0
- nautobot/dcim/tests/test_jobs.py +118 -0
- nautobot/dcim/tests/test_models.py +52 -9
- nautobot/dcim/tests/test_views.py +21 -83
- nautobot/dcim/views.py +1 -13
- nautobot/extras/api/customfields.py +2 -2
- nautobot/extras/api/serializers.py +90 -85
- nautobot/extras/api/views.py +22 -27
- nautobot/extras/constants.py +2 -0
- nautobot/extras/filters/__init__.py +8 -6
- nautobot/extras/forms/base.py +2 -2
- nautobot/extras/forms/forms.py +139 -31
- nautobot/extras/forms/mixins.py +14 -6
- nautobot/extras/group_sync.py +3 -3
- nautobot/extras/health_checks.py +1 -2
- nautobot/extras/jobs.py +85 -18
- nautobot/extras/managers.py +3 -1
- nautobot/extras/migrations/0018_joblog_data_migration.py +7 -9
- nautobot/extras/migrations/0120_job_is_singleton_job_is_singleton_override.py +22 -0
- nautobot/extras/migrations/0121_alter_team_contacts.py +17 -0
- nautobot/extras/models/__init__.py +1 -1
- nautobot/extras/models/contacts.py +1 -1
- nautobot/extras/models/customfields.py +12 -11
- nautobot/extras/models/groups.py +11 -9
- nautobot/extras/models/jobs.py +23 -4
- nautobot/extras/models/models.py +2 -2
- nautobot/extras/plugins/__init__.py +13 -2
- nautobot/extras/plugins/marketplace_manifest.yml +84 -79
- nautobot/extras/plugins/tables.py +16 -14
- nautobot/extras/plugins/views.py +65 -69
- nautobot/extras/registry.py +1 -1
- nautobot/extras/secrets/__init__.py +2 -2
- nautobot/extras/tables.py +7 -5
- nautobot/extras/templates/extras/dynamicgroup.html +1 -9
- nautobot/extras/templates/extras/job_detail.html +16 -0
- nautobot/extras/templates/extras/job_edit.html +1 -0
- nautobot/extras/templates/extras/jobqueue_retrieve.html +1 -9
- nautobot/extras/templates/extras/marketplace.html +29 -11
- nautobot/extras/templates/extras/plugin_detail.html +32 -15
- nautobot/extras/templates/extras/plugins_tiles.html +21 -10
- nautobot/extras/templatetags/job_buttons.py +4 -4
- nautobot/extras/test_jobs/api_test_job.py +1 -1
- nautobot/extras/test_jobs/atomic_transaction.py +2 -2
- nautobot/extras/test_jobs/dry_run.py +1 -1
- nautobot/extras/test_jobs/fail.py +5 -5
- nautobot/extras/test_jobs/file_output.py +1 -1
- nautobot/extras/test_jobs/file_upload_fail.py +1 -1
- nautobot/extras/test_jobs/file_upload_pass.py +1 -1
- nautobot/extras/test_jobs/ipaddress_vars.py +3 -1
- nautobot/extras/test_jobs/jobs_module/jobs_submodule/jobs.py +1 -1
- nautobot/extras/test_jobs/location_with_custom_field.py +1 -1
- nautobot/extras/test_jobs/log_redaction.py +1 -1
- nautobot/extras/test_jobs/log_skip_db_logging.py +1 -1
- nautobot/extras/test_jobs/modify_db.py +1 -1
- nautobot/extras/test_jobs/object_var_optional.py +1 -1
- nautobot/extras/test_jobs/object_var_required.py +1 -1
- nautobot/extras/test_jobs/object_vars.py +1 -1
- nautobot/extras/test_jobs/pass.py +3 -3
- nautobot/extras/test_jobs/profiling.py +1 -1
- nautobot/extras/test_jobs/relative_import.py +3 -3
- nautobot/extras/test_jobs/singleton.py +16 -0
- nautobot/extras/test_jobs/soft_time_limit_greater_than_time_limit.py +1 -1
- nautobot/extras/test_jobs/task_queues.py +1 -1
- nautobot/extras/tests/integration/test_plugin_banner.py +0 -2
- nautobot/extras/tests/test_api.py +13 -13
- nautobot/extras/tests/test_customfields.py +1 -1
- nautobot/extras/tests/test_datasources.py +2 -1
- nautobot/extras/tests/test_dynamicgroups.py +1 -1
- nautobot/extras/tests/test_filters.py +6 -6
- nautobot/extras/tests/test_forms.py +33 -1
- nautobot/extras/tests/test_jobs.py +178 -32
- nautobot/extras/tests/test_models.py +16 -10
- nautobot/extras/tests/test_plugins.py +62 -9
- nautobot/extras/tests/test_relationships.py +120 -9
- nautobot/extras/tests/test_views.py +56 -194
- nautobot/extras/utils.py +3 -2
- nautobot/extras/views.py +30 -98
- nautobot/ipam/api/fields.py +3 -3
- nautobot/ipam/api/serializers.py +41 -33
- nautobot/ipam/api/views.py +68 -117
- nautobot/ipam/factory.py +1 -1
- nautobot/ipam/filters.py +3 -2
- nautobot/ipam/lookups.py +101 -62
- nautobot/ipam/models.py +66 -16
- nautobot/ipam/querysets.py +2 -2
- nautobot/ipam/tables.py +23 -7
- nautobot/ipam/templates/ipam/ipaddress.html +1 -9
- nautobot/ipam/templates/ipam/ipaddress_bulk_add.html +1 -7
- nautobot/ipam/templates/ipam/ipaddress_edit.html +1 -7
- nautobot/ipam/templates/ipam/prefix.html +1 -9
- nautobot/ipam/templates/ipam/prefix_edit.html +1 -7
- nautobot/ipam/templates/ipam/vlan.html +1 -9
- nautobot/ipam/templates/ipam/vlan_edit.html +1 -7
- nautobot/ipam/templates/ipam/vrf_edit.html +1 -7
- nautobot/ipam/tests/test_api.py +436 -3
- nautobot/ipam/tests/test_forms.py +49 -47
- nautobot/ipam/tests/test_migrations.py +30 -30
- nautobot/ipam/tests/test_models.py +95 -34
- nautobot/ipam/tests/test_querysets.py +63 -1
- nautobot/ipam/tests/test_views.py +3 -0
- nautobot/ipam/utils/__init__.py +36 -6
- nautobot/ipam/views.py +61 -87
- nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap-theme.css.map +1 -1
- nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap-theme.min.css.map +1 -1
- nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap.css +40 -2
- nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap.css.map +1 -1
- nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap.min.css +1 -1
- nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap.min.css.map +1 -1
- nautobot/project-static/docs/404.html +46 -4
- nautobot/project-static/docs/apps/index.html +46 -4
- nautobot/project-static/docs/apps/nautobot-apps.html +47 -6
- nautobot/project-static/docs/assets/_mkdocstrings.css +25 -1
- nautobot/project-static/docs/assets/javascripts/{bundle.83f73b43.min.js → bundle.88dd0f4e.min.js} +2 -2
- nautobot/project-static/docs/assets/javascripts/{bundle.83f73b43.min.js.map → bundle.88dd0f4e.min.js.map} +2 -2
- nautobot/project-static/docs/code-reference/nautobot/apps/__init__.html +62 -10
- nautobot/project-static/docs/code-reference/nautobot/apps/admin.html +59 -7
- nautobot/project-static/docs/code-reference/nautobot/apps/api.html +374 -122
- nautobot/project-static/docs/code-reference/nautobot/apps/change_logging.html +90 -18
- nautobot/project-static/docs/code-reference/nautobot/apps/choices.html +95 -21
- nautobot/project-static/docs/code-reference/nautobot/apps/config.html +53 -6
- nautobot/project-static/docs/code-reference/nautobot/apps/constants.html +52 -5
- nautobot/project-static/docs/code-reference/nautobot/apps/datasources.html +79 -17
- nautobot/project-static/docs/code-reference/nautobot/apps/events.html +102 -28
- nautobot/project-static/docs/code-reference/nautobot/apps/exceptions.html +108 -21
- nautobot/project-static/docs/code-reference/nautobot/apps/factory.html +131 -38
- nautobot/project-static/docs/code-reference/nautobot/apps/filters.html +239 -65
- nautobot/project-static/docs/code-reference/nautobot/apps/forms.html +581 -165
- nautobot/project-static/docs/code-reference/nautobot/apps/graphql.html +109 -36
- nautobot/project-static/docs/code-reference/nautobot/apps/jobs.html +453 -167
- nautobot/project-static/docs/code-reference/nautobot/apps/models.html +493 -211
- nautobot/project-static/docs/code-reference/nautobot/apps/querysets.html +60 -8
- nautobot/project-static/docs/code-reference/nautobot/apps/secrets.html +71 -15
- nautobot/project-static/docs/code-reference/nautobot/apps/tables.html +407 -55
- nautobot/project-static/docs/code-reference/nautobot/apps/testing.html +620 -205
- nautobot/project-static/docs/code-reference/nautobot/apps/ui.html +858 -412
- nautobot/project-static/docs/code-reference/nautobot/apps/urls.html +59 -7
- nautobot/project-static/docs/code-reference/nautobot/apps/utils.html +448 -186
- nautobot/project-static/docs/code-reference/nautobot/apps/views.html +365 -147
- nautobot/project-static/docs/development/apps/api/configuration-view.html +46 -4
- nautobot/project-static/docs/development/apps/api/database-backend-config.html +46 -4
- nautobot/project-static/docs/development/apps/api/models/django-admin.html +46 -4
- nautobot/project-static/docs/development/apps/api/models/global-search.html +46 -4
- nautobot/project-static/docs/development/apps/api/models/graphql.html +46 -4
- nautobot/project-static/docs/development/apps/api/models/index.html +46 -4
- nautobot/project-static/docs/development/apps/api/nautobot-app-config.html +46 -4
- nautobot/project-static/docs/development/apps/api/platform-features/custom-validators.html +46 -4
- nautobot/project-static/docs/development/apps/api/platform-features/filter-extensions.html +46 -4
- nautobot/project-static/docs/development/apps/api/platform-features/git-repository-content.html +46 -4
- nautobot/project-static/docs/development/apps/api/platform-features/index.html +46 -4
- nautobot/project-static/docs/development/apps/api/platform-features/jinja2-filters.html +46 -4
- nautobot/project-static/docs/development/apps/api/platform-features/jobs.html +46 -4
- nautobot/project-static/docs/development/apps/api/platform-features/populating-extensibility-features.html +46 -4
- nautobot/project-static/docs/development/apps/api/platform-features/secrets-providers.html +46 -4
- nautobot/project-static/docs/development/apps/api/platform-features/table-extensions.html +68 -7
- nautobot/project-static/docs/development/apps/api/platform-features/uniquely-identify-objects.html +46 -4
- nautobot/project-static/docs/development/apps/api/prometheus.html +46 -4
- nautobot/project-static/docs/development/apps/api/setup.html +46 -4
- nautobot/project-static/docs/development/apps/api/testing.html +46 -4
- nautobot/project-static/docs/development/apps/api/ui-extensions/banners.html +46 -4
- nautobot/project-static/docs/development/apps/api/ui-extensions/home-page.html +46 -4
- nautobot/project-static/docs/development/apps/api/ui-extensions/index.html +46 -4
- nautobot/project-static/docs/development/apps/api/ui-extensions/navigation.html +46 -4
- nautobot/project-static/docs/development/apps/api/ui-extensions/object-views.html +46 -4
- nautobot/project-static/docs/development/apps/api/views/base-template.html +46 -4
- nautobot/project-static/docs/development/apps/api/views/core-view-overrides.html +46 -4
- nautobot/project-static/docs/development/apps/api/views/django-generic-views.html +46 -4
- nautobot/project-static/docs/development/apps/api/views/help-documentation.html +46 -4
- nautobot/project-static/docs/development/apps/api/views/index.html +46 -4
- nautobot/project-static/docs/development/apps/api/views/nautobot-generic-views.html +46 -4
- nautobot/project-static/docs/development/apps/api/views/nautobotuiviewset.html +46 -4
- nautobot/project-static/docs/development/apps/api/views/nautobotuiviewsetrouter.html +46 -4
- nautobot/project-static/docs/development/apps/api/views/notes.html +46 -4
- nautobot/project-static/docs/development/apps/api/views/rest-api.html +52 -6
- nautobot/project-static/docs/development/apps/api/views/urls.html +46 -4
- nautobot/project-static/docs/development/apps/index.html +46 -4
- nautobot/project-static/docs/development/apps/migration/code-updates.html +46 -4
- nautobot/project-static/docs/development/apps/migration/dependency-updates.html +46 -4
- nautobot/project-static/docs/development/apps/migration/from-v1.html +46 -4
- nautobot/project-static/docs/development/apps/migration/model-updates/dcim.html +46 -4
- nautobot/project-static/docs/development/apps/migration/model-updates/extras.html +46 -4
- nautobot/project-static/docs/development/apps/migration/model-updates/global.html +46 -4
- nautobot/project-static/docs/development/apps/migration/model-updates/ipam.html +46 -4
- nautobot/project-static/docs/development/apps/migration/ui-component-framework/best-practices.html +50 -8
- nautobot/project-static/docs/development/apps/migration/ui-component-framework/custom-content.html +46 -4
- nautobot/project-static/docs/development/apps/migration/ui-component-framework/index.html +211 -14
- nautobot/project-static/docs/development/apps/migration/ui-component-framework/migration-steps.html +46 -4
- nautobot/project-static/docs/development/apps/porting-from-netbox.html +46 -4
- nautobot/project-static/docs/development/core/application-registry.html +46 -4
- nautobot/project-static/docs/development/core/best-practices.html +46 -4
- nautobot/project-static/docs/development/core/bootstrap-ui.html +46 -4
- nautobot/project-static/docs/development/core/caching.html +46 -4
- nautobot/project-static/docs/development/core/controllers.html +46 -4
- nautobot/project-static/docs/development/core/docker-compose-advanced-use-cases.html +73 -74
- nautobot/project-static/docs/development/core/generic-views.html +46 -4
- nautobot/project-static/docs/development/core/getting-started.html +249 -224
- nautobot/project-static/docs/development/core/homepage.html +49 -7
- nautobot/project-static/docs/development/core/index.html +46 -4
- nautobot/project-static/docs/development/core/{local-k8s.html → minikube-dev-environment-for-k8s-jobs.html} +469 -168
- nautobot/project-static/docs/development/core/model-checklist.html +56 -12
- nautobot/project-static/docs/development/core/model-features.html +46 -4
- nautobot/project-static/docs/development/core/natural-keys.html +46 -4
- nautobot/project-static/docs/development/core/navigation-menu.html +46 -4
- nautobot/project-static/docs/development/core/release-checklist.html +49 -7
- nautobot/project-static/docs/development/core/role-internals.html +46 -4
- nautobot/project-static/docs/development/core/settings.html +46 -4
- nautobot/project-static/docs/development/core/style-guide.html +49 -7
- nautobot/project-static/docs/development/core/templates.html +46 -4
- nautobot/project-static/docs/development/core/testing.html +46 -4
- nautobot/project-static/docs/development/core/ui-component-framework.html +369 -273
- nautobot/project-static/docs/development/core/user-preferences.html +46 -4
- nautobot/project-static/docs/development/index.html +46 -4
- nautobot/project-static/docs/development/jobs/index.html +216 -122
- nautobot/project-static/docs/development/jobs/migration/from-v1.html +46 -4
- nautobot/project-static/docs/index.html +54 -23
- nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_edit.png +0 -0
- nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_edit_button.png +0 -0
- nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_list_nav.png +0 -0
- nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_list_view.png +0 -0
- nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_queue.png +0 -0
- nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_queue_add.png +0 -0
- nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_queue_config.png +0 -0
- nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_result_completed.png +0 -0
- nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_result_nav.png +0 -0
- nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_result_pending.png +0 -0
- nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_run_form.png +0 -0
- nautobot/project-static/docs/media/development/core/kubernetes/k8s_nautobot_login.png +0 -0
- nautobot/project-static/docs/media/development/core/kubernetes/k8s_run_job.png +0 -0
- nautobot/project-static/docs/media/development/core/kubernetes/k8s_run_scheduled_job_form.png +0 -0
- nautobot/project-static/docs/media/development/core/kubernetes/k8s_scheduled_job_result.png +0 -0
- nautobot/project-static/docs/media/development/core/ui-component-framework/buttons-example.png +0 -0
- nautobot/project-static/docs/media/development/core/ui-component-framework/cluster-type-before-after-example.png +0 -0
- nautobot/project-static/docs/media/development/core/ui-component-framework/object-fields-panel-example_2.png +0 -0
- nautobot/project-static/docs/media/development/core/ui-component-framework/stats-panel-example-code.png +0 -0
- nautobot/project-static/docs/objects.inv +0 -0
- nautobot/project-static/docs/overview/application_stack.html +47 -7
- nautobot/project-static/docs/overview/design_philosophy.html +46 -4
- nautobot/project-static/docs/release-notes/index.html +52 -12
- nautobot/project-static/docs/release-notes/version-1.0.html +234 -193
- nautobot/project-static/docs/release-notes/version-1.1.html +231 -190
- nautobot/project-static/docs/release-notes/version-1.2.html +306 -265
- nautobot/project-static/docs/release-notes/version-1.3.html +332 -291
- nautobot/project-static/docs/release-notes/version-1.4.html +417 -377
- nautobot/project-static/docs/release-notes/version-1.5.html +605 -566
- nautobot/project-static/docs/release-notes/version-1.6.html +904 -447
- nautobot/project-static/docs/release-notes/version-2.0.html +528 -489
- nautobot/project-static/docs/release-notes/version-2.1.html +363 -324
- nautobot/project-static/docs/release-notes/version-2.2.html +356 -317
- nautobot/project-static/docs/release-notes/version-2.3.html +997 -352
- nautobot/project-static/docs/release-notes/version-2.4.html +525 -101
- nautobot/project-static/docs/requirements.txt +2 -2
- nautobot/project-static/docs/search/search_index.json +1 -1
- nautobot/project-static/docs/sitemap.xml +295 -287
- nautobot/project-static/docs/sitemap.xml.gz +0 -0
- nautobot/project-static/docs/user-guide/administration/configuration/authentication/ldap.html +46 -4
- nautobot/project-static/docs/user-guide/administration/configuration/authentication/remote.html +46 -4
- nautobot/project-static/docs/user-guide/administration/configuration/authentication/sso.html +48 -6
- nautobot/project-static/docs/user-guide/administration/configuration/index.html +46 -4
- nautobot/project-static/docs/user-guide/administration/configuration/redis.html +46 -4
- nautobot/project-static/docs/user-guide/administration/configuration/settings.html +110 -8
- nautobot/project-static/docs/user-guide/administration/configuration/time-zones.html +46 -4
- nautobot/project-static/docs/user-guide/administration/guides/celery-queues.html +46 -4
- nautobot/project-static/docs/user-guide/administration/guides/docker.html +46 -4
- nautobot/project-static/docs/user-guide/administration/guides/health-checks.html +46 -4
- nautobot/project-static/docs/user-guide/administration/guides/permissions.html +46 -4
- nautobot/project-static/docs/user-guide/administration/guides/prometheus-metrics.html +46 -4
- nautobot/project-static/docs/user-guide/administration/guides/replicating-nautobot.html +46 -4
- nautobot/project-static/docs/user-guide/administration/guides/request-profiling.html +46 -4
- nautobot/project-static/docs/user-guide/administration/guides/s3-django-storage.html +48 -6
- nautobot/project-static/docs/user-guide/administration/guides/selinux-troubleshooting.html +46 -4
- nautobot/project-static/docs/user-guide/administration/installation/app-install.html +46 -4
- nautobot/project-static/docs/user-guide/administration/installation/external-authentication.html +46 -4
- nautobot/project-static/docs/user-guide/administration/installation/http-server.html +66 -8
- nautobot/project-static/docs/user-guide/administration/installation/index.html +46 -4
- nautobot/project-static/docs/user-guide/administration/installation/install_system.html +47 -5
- nautobot/project-static/docs/user-guide/administration/installation/nautobot.html +46 -4
- nautobot/project-static/docs/user-guide/administration/installation/services.html +46 -4
- nautobot/project-static/docs/user-guide/administration/migration/migrating-from-netbox.html +46 -4
- nautobot/project-static/docs/user-guide/administration/migration/migrating-from-postgresql.html +46 -4
- nautobot/project-static/docs/user-guide/administration/tools/nautobot-server.html +46 -4
- nautobot/project-static/docs/user-guide/administration/tools/nautobot-shell.html +46 -4
- nautobot/project-static/docs/user-guide/administration/upgrading/database-backup.html +46 -4
- nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/after-you-upgrade.html +46 -4
- nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/before-you-upgrade.html +46 -4
- nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/for-developers.html +46 -4
- nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/index.html +46 -4
- nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/whats-changed.html +49 -8
- nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/region-and-site-data-migration-guide.html +46 -4
- nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/upgrading-from-nautobot-v1.html +46 -4
- nautobot/project-static/docs/user-guide/administration/upgrading/upgrading.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/circuits/circuit.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/circuits/circuittermination.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/circuits/circuittype.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/circuits/provider.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/circuits/providernetwork.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/cloud/cloud.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudaccount.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudnetwork.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudnetworkprefixassignment.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudresourcetype.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudservice.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudservicenetworkassignment.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/cable.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleport.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleporttemplate.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleserverport.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleserverporttemplate.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/controller.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/controllermanageddevicegroup.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/device.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/devicebay.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/devicebaytemplate.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/devicefamily.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/deviceredundancygroup.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/devicetype.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/frontport.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/frontporttemplate.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/interface.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/interfaceredundancygroup.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/interfacetemplate.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/inventoryitem.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/location.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/locationtype.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/manufacturer.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/module.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/modulebay.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/modulebaytemplate.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/moduletype.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/platform.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/powerfeed.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/poweroutlet.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/poweroutlettemplate.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/powerpanel.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/powerport.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/powerporttemplate.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/rack.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/rackgroup.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/rackreservation.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/rearport.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/rearporttemplate.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/softwareimagefile.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/softwareversion.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/virtualchassis.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/dcim/virtualdevicecontext.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/extras/configcontext.html +50 -12
- nautobot/project-static/docs/user-guide/core-data-model/extras/configcontextschema.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/extras/contact.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/extras/team.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/ipam/ipaddress.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/ipam/namespace.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/ipam/prefix.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/ipam/rir.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/ipam/routetarget.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/ipam/service.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/ipam/vlan.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/ipam/vlangroup.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/ipam/vrf.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/overview/introduction.html +49 -7
- nautobot/project-static/docs/user-guide/core-data-model/tenancy/tenant.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/tenancy/tenantgroup.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/virtualization/cluster.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/virtualization/clustergroup.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/virtualization/clustertype.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/virtualization/virtualmachine.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/virtualization/vminterface.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/wireless/index.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/wireless/radioprofile.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/wireless/supporteddatarate.html +46 -4
- nautobot/project-static/docs/user-guide/core-data-model/wireless/wirelessnetwork.html +46 -4
- nautobot/project-static/docs/user-guide/feature-guides/contacts-and-teams.html +46 -4
- nautobot/project-static/docs/user-guide/feature-guides/custom-fields.html +46 -4
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/creating-devices.html +46 -4
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/creating-location-types-and-locations.html +46 -4
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/index.html +46 -4
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/interfaces.html +46 -4
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/ipam.html +46 -4
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/platforms.html +46 -4
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/search-bar.html +46 -4
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/tenants.html +46 -4
- nautobot/project-static/docs/user-guide/feature-guides/getting-started/vlans-and-vlan-groups.html +46 -4
- nautobot/project-static/docs/user-guide/feature-guides/git-data-source.html +51 -7
- nautobot/project-static/docs/user-guide/feature-guides/graphql.html +46 -4
- nautobot/project-static/docs/user-guide/feature-guides/images/wireless/central-mode.png +0 -0
- nautobot/project-static/docs/user-guide/feature-guides/images/wireless/device-group-add.png +0 -0
- nautobot/project-static/docs/user-guide/feature-guides/images/wireless/device-group-create-1.png +0 -0
- nautobot/project-static/docs/user-guide/feature-guides/images/wireless/device-group-create-2.png +0 -0
- nautobot/project-static/docs/user-guide/feature-guides/images/wireless/radio-profile-add.png +0 -0
- nautobot/project-static/docs/user-guide/feature-guides/images/wireless/radio-profile-create.png +0 -0
- nautobot/project-static/docs/user-guide/feature-guides/images/wireless/supported-data-rate-add.png +0 -0
- nautobot/project-static/docs/user-guide/feature-guides/images/wireless/supported-data-rate-create.png +0 -0
- nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-controller-add.png +0 -0
- nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-controller-create-1.png +0 -0
- nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-controller-create-2.png +0 -0
- nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-network-add.png +0 -0
- nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-network-create.png +0 -0
- nautobot/project-static/docs/user-guide/feature-guides/ip-address-merge-tool.html +46 -4
- nautobot/project-static/docs/user-guide/feature-guides/relationships.html +46 -4
- nautobot/project-static/docs/user-guide/feature-guides/software-image-files-and-versions.html +49 -7
- nautobot/project-static/docs/user-guide/feature-guides/wireless-networks-and-controllers.html +9444 -0
- nautobot/project-static/docs/user-guide/index.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/change-logging.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/computedfield.html +50 -8
- nautobot/project-static/docs/user-guide/platform-functionality/customfield.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/customlink.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/dynamicgroup.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/events.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/exporttemplate.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/externalintegration.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/gitrepository.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/graphql.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/graphqlquery.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/imageattachment.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/jobs/index.html +50 -7
- nautobot/project-static/docs/user-guide/platform-functionality/jobs/job-scheduling-and-approvals.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/jobs/jobbutton.html +49 -7
- nautobot/project-static/docs/user-guide/platform-functionality/jobs/jobhook.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/jobs/jobqueue.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/jobs/kubernetes-job-support.html +9722 -0
- nautobot/project-static/docs/user-guide/platform-functionality/jobs/models.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/napalm.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/note.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/objectmetadata.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/relationship.html +47 -5
- nautobot/project-static/docs/user-guide/platform-functionality/rendering-jinja-templates.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/rest-api/authentication.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/rest-api/filtering.html +94 -25
- nautobot/project-static/docs/user-guide/platform-functionality/rest-api/overview.html +74 -5
- nautobot/project-static/docs/user-guide/platform-functionality/rest-api/ui-related-endpoints.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/role.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/savedview.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/secret.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/staticgroupassociation.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/status.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/tag.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/template-filters.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/users/objectpermission.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/users/token.html +46 -4
- nautobot/project-static/docs/user-guide/platform-functionality/webhook.html +46 -4
- nautobot/project-static/js/forms.js +1 -1
- nautobot/tenancy/api/views.py +9 -13
- nautobot/tenancy/views.py +4 -2
- nautobot/users/admin.py +1 -1
- nautobot/users/api/serializers.py +5 -4
- nautobot/users/api/views.py +3 -3
- nautobot/virtualization/api/serializers.py +4 -4
- nautobot/virtualization/api/views.py +5 -24
- nautobot/virtualization/filters.py +20 -3
- nautobot/virtualization/models.py +1 -1
- nautobot/virtualization/tables.py +2 -2
- nautobot/virtualization/templates/virtualization/cluster_edit.html +1 -7
- nautobot/virtualization/templates/virtualization/virtualmachine.html +1 -9
- nautobot/virtualization/templates/virtualization/virtualmachine_edit.html +2 -8
- nautobot/virtualization/tests/test_filters.py +17 -0
- nautobot/wireless/filters.py +2 -2
- nautobot/wireless/forms.py +1 -1
- nautobot/wireless/templates/wireless/wirelessnetwork_retrieve.html +1 -9
- nautobot/wireless/tests/integration/__init__.py +0 -0
- nautobot/wireless/tests/integration/test_radio_profile.py +42 -0
- nautobot/wireless/tests/test_filters.py +29 -1
- nautobot/wireless/tests/test_views.py +22 -1
- nautobot/wireless/views.py +0 -10
- {nautobot-2.4.0b1.dist-info → nautobot-2.4.1.dist-info}/METADATA +6 -6
- {nautobot-2.4.0b1.dist-info → nautobot-2.4.1.dist-info}/RECORD +600 -550
- {nautobot-2.4.0b1.dist-info → nautobot-2.4.1.dist-info}/WHEEL +1 -1
- nautobot/core/fixtures/user-data.json +0 -59
- {nautobot-2.4.0b1.dist-info → nautobot-2.4.1.dist-info}/LICENSE.txt +0 -0
- {nautobot-2.4.0b1.dist-info → nautobot-2.4.1.dist-info}/NOTICE +0 -0
- {nautobot-2.4.0b1.dist-info → nautobot-2.4.1.dist-info}/entry_points.txt +0 -0
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
|
|
19
19
|
|
|
20
20
|
<link rel="icon" href="../../../assets/favicon.ico">
|
|
21
|
-
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.
|
|
21
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
|
|
22
22
|
|
|
23
23
|
|
|
24
24
|
|
|
@@ -2112,6 +2112,27 @@
|
|
|
2112
2112
|
|
|
2113
2113
|
|
|
2114
2114
|
|
|
2115
|
+
|
|
2116
|
+
|
|
2117
|
+
|
|
2118
|
+
|
|
2119
|
+
|
|
2120
|
+
|
|
2121
|
+
<li class="md-nav__item">
|
|
2122
|
+
<a href="../../../user-guide/feature-guides/wireless-networks-and-controllers.html" class="md-nav__link">
|
|
2123
|
+
|
|
2124
|
+
|
|
2125
|
+
<span class="md-ellipsis">
|
|
2126
|
+
Wireless Networks and Controllers
|
|
2127
|
+
</span>
|
|
2128
|
+
|
|
2129
|
+
|
|
2130
|
+
</a>
|
|
2131
|
+
</li>
|
|
2132
|
+
|
|
2133
|
+
|
|
2134
|
+
|
|
2135
|
+
|
|
2115
2136
|
</ul>
|
|
2116
2137
|
</nav>
|
|
2117
2138
|
|
|
@@ -5131,6 +5152,27 @@
|
|
|
5131
5152
|
|
|
5132
5153
|
|
|
5133
5154
|
|
|
5155
|
+
<li class="md-nav__item">
|
|
5156
|
+
<a href="../../../user-guide/platform-functionality/jobs/kubernetes-job-support.html" class="md-nav__link">
|
|
5157
|
+
|
|
5158
|
+
|
|
5159
|
+
<span class="md-ellipsis">
|
|
5160
|
+
Kubernetes Job Support
|
|
5161
|
+
</span>
|
|
5162
|
+
|
|
5163
|
+
|
|
5164
|
+
</a>
|
|
5165
|
+
</li>
|
|
5166
|
+
|
|
5167
|
+
|
|
5168
|
+
|
|
5169
|
+
|
|
5170
|
+
|
|
5171
|
+
|
|
5172
|
+
|
|
5173
|
+
|
|
5174
|
+
|
|
5175
|
+
|
|
5134
5176
|
<li class="md-nav__item">
|
|
5135
5177
|
<a href="../../../user-guide/platform-functionality/jobs/jobbutton.html" class="md-nav__link">
|
|
5136
5178
|
|
|
@@ -9271,11 +9313,11 @@
|
|
|
9271
9313
|
|
|
9272
9314
|
|
|
9273
9315
|
<li class="md-nav__item">
|
|
9274
|
-
<a href="../../../development/core/
|
|
9316
|
+
<a href="../../../development/core/minikube-dev-environment-for-k8s-jobs.html" class="md-nav__link">
|
|
9275
9317
|
|
|
9276
9318
|
|
|
9277
9319
|
<span class="md-ellipsis">
|
|
9278
|
-
|
|
9320
|
+
Minikube Dev Environment for K8s Jobs
|
|
9279
9321
|
</span>
|
|
9280
9322
|
|
|
9281
9323
|
|
|
@@ -11388,7 +11430,12 @@
|
|
|
11388
11430
|
|
|
11389
11431
|
<div class="doc doc-contents first">
|
|
11390
11432
|
|
|
11391
|
-
|
|
11433
|
+
<p>Utilities for apps to integrate with and extend the existing Nautobot UI.</p>
|
|
11434
|
+
|
|
11435
|
+
|
|
11436
|
+
|
|
11437
|
+
|
|
11438
|
+
|
|
11392
11439
|
|
|
11393
11440
|
|
|
11394
11441
|
|
|
@@ -11415,7 +11462,12 @@
|
|
|
11415
11462
|
<div class="doc doc-contents ">
|
|
11416
11463
|
|
|
11417
11464
|
|
|
11418
|
-
|
|
11465
|
+
<p>Class that may be returned by a registered plugin_banners function.</p>
|
|
11466
|
+
|
|
11467
|
+
|
|
11468
|
+
|
|
11469
|
+
|
|
11470
|
+
|
|
11419
11471
|
|
|
11420
11472
|
|
|
11421
11473
|
|
|
@@ -11451,10 +11503,15 @@
|
|
|
11451
11503
|
|
|
11452
11504
|
<div class="doc doc-contents ">
|
|
11453
11505
|
<p class="doc doc-class-bases">
|
|
11454
|
-
Bases: <code><
|
|
11506
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.choices.ChoiceSet" href="choices.html#nautobot.apps.choices.ChoiceSet">ChoiceSet</a></code></p>
|
|
11507
|
+
|
|
11508
|
+
|
|
11509
|
+
<p>Styling choices for custom banners.</p>
|
|
11510
|
+
|
|
11511
|
+
|
|
11512
|
+
|
|
11455
11513
|
|
|
11456
11514
|
|
|
11457
|
-
<p>Styling choices for custom banners.</p>
|
|
11458
11515
|
|
|
11459
11516
|
|
|
11460
11517
|
|
|
@@ -11490,10 +11547,15 @@
|
|
|
11490
11547
|
|
|
11491
11548
|
<div class="doc doc-contents ">
|
|
11492
11549
|
<p class="doc doc-class-bases">
|
|
11493
|
-
Bases: <code><
|
|
11550
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Panel" href="#nautobot.apps.ui.Panel">Panel</a></code></p>
|
|
11551
|
+
|
|
11552
|
+
|
|
11553
|
+
<p>A panel that renders a single value as text, Markdown, JSON, or YAML.</p>
|
|
11554
|
+
|
|
11555
|
+
|
|
11556
|
+
|
|
11494
11557
|
|
|
11495
11558
|
|
|
11496
|
-
<p>A panel that renders a single value as text, Markdown, JSON, or YAML.</p>
|
|
11497
11559
|
|
|
11498
11560
|
|
|
11499
11561
|
|
|
@@ -11520,10 +11582,10 @@
|
|
|
11520
11582
|
|
|
11521
11583
|
<div class="doc doc-contents ">
|
|
11522
11584
|
<p class="doc doc-class-bases">
|
|
11523
|
-
Bases: <code><
|
|
11585
|
+
Bases: <code><span title="enum.Enum">Enum</span></code></p>
|
|
11524
11586
|
|
|
11525
11587
|
|
|
11526
|
-
|
|
11588
|
+
<p>Options available for text panels for different type of rendering a given input.</p>
|
|
11527
11589
|
|
|
11528
11590
|
|
|
11529
11591
|
<p><span class="doc-section-title">Attributes:</span></p>
|
|
@@ -11537,9 +11599,9 @@
|
|
|
11537
11599
|
</thead>
|
|
11538
11600
|
<tbody>
|
|
11539
11601
|
<tr class="doc-section-item">
|
|
11540
|
-
<td><code><
|
|
11602
|
+
<td><code><span title="nautobot.apps.ui.BaseTextPanel.RenderOptions.PLAINTEXT">PLAINTEXT</span></code></td>
|
|
11541
11603
|
<td>
|
|
11542
|
-
<code
|
|
11604
|
+
<code>str</code>
|
|
11543
11605
|
</td>
|
|
11544
11606
|
<td>
|
|
11545
11607
|
<div class="doc-md-description">
|
|
@@ -11548,9 +11610,9 @@
|
|
|
11548
11610
|
</td>
|
|
11549
11611
|
</tr>
|
|
11550
11612
|
<tr class="doc-section-item">
|
|
11551
|
-
<td><code><
|
|
11613
|
+
<td><code><span title="nautobot.apps.ui.BaseTextPanel.RenderOptions.JSON">JSON</span></code></td>
|
|
11552
11614
|
<td>
|
|
11553
|
-
<code
|
|
11615
|
+
<code>str</code>
|
|
11554
11616
|
</td>
|
|
11555
11617
|
<td>
|
|
11556
11618
|
<div class="doc-md-description">
|
|
@@ -11559,9 +11621,9 @@
|
|
|
11559
11621
|
</td>
|
|
11560
11622
|
</tr>
|
|
11561
11623
|
<tr class="doc-section-item">
|
|
11562
|
-
<td><code><
|
|
11624
|
+
<td><code><span title="nautobot.apps.ui.BaseTextPanel.RenderOptions.YAML">YAML</span></code></td>
|
|
11563
11625
|
<td>
|
|
11564
|
-
<code
|
|
11626
|
+
<code>str</code>
|
|
11565
11627
|
</td>
|
|
11566
11628
|
<td>
|
|
11567
11629
|
<div class="doc-md-description">
|
|
@@ -11570,9 +11632,9 @@
|
|
|
11570
11632
|
</td>
|
|
11571
11633
|
</tr>
|
|
11572
11634
|
<tr class="doc-section-item">
|
|
11573
|
-
<td><code><
|
|
11635
|
+
<td><code><span title="nautobot.apps.ui.BaseTextPanel.RenderOptions.MARKDOWN">MARKDOWN</span></code></td>
|
|
11574
11636
|
<td>
|
|
11575
|
-
<code
|
|
11637
|
+
<code>str</code>
|
|
11576
11638
|
</td>
|
|
11577
11639
|
<td>
|
|
11578
11640
|
<div class="doc-md-description">
|
|
@@ -11581,9 +11643,9 @@
|
|
|
11581
11643
|
</td>
|
|
11582
11644
|
</tr>
|
|
11583
11645
|
<tr class="doc-section-item">
|
|
11584
|
-
<td><code><
|
|
11646
|
+
<td><code><span title="nautobot.apps.ui.BaseTextPanel.RenderOptions.CODE">CODE</span></code></td>
|
|
11585
11647
|
<td>
|
|
11586
|
-
<code
|
|
11648
|
+
<code>str</code>
|
|
11587
11649
|
</td>
|
|
11588
11650
|
<td>
|
|
11589
11651
|
<div class="doc-md-description">
|
|
@@ -11597,6 +11659,11 @@
|
|
|
11597
11659
|
|
|
11598
11660
|
|
|
11599
11661
|
|
|
11662
|
+
|
|
11663
|
+
|
|
11664
|
+
|
|
11665
|
+
|
|
11666
|
+
|
|
11600
11667
|
<div class="doc doc-children">
|
|
11601
11668
|
|
|
11602
11669
|
|
|
@@ -11627,7 +11694,7 @@
|
|
|
11627
11694
|
|
|
11628
11695
|
<div class="doc doc-contents ">
|
|
11629
11696
|
|
|
11630
|
-
|
|
11697
|
+
<p>Instantiate BaseTextPanel.</p>
|
|
11631
11698
|
|
|
11632
11699
|
|
|
11633
11700
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -11642,9 +11709,11 @@
|
|
|
11642
11709
|
</thead>
|
|
11643
11710
|
<tbody>
|
|
11644
11711
|
<tr class="doc-section-item">
|
|
11645
|
-
<td><code>render_as</code></td>
|
|
11646
11712
|
<td>
|
|
11647
|
-
|
|
11713
|
+
<code>render_as</code>
|
|
11714
|
+
</td>
|
|
11715
|
+
<td>
|
|
11716
|
+
<code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.BaseTextPanel.RenderOptions" href="#nautobot.apps.ui.BaseTextPanel.RenderOptions">RenderOptions</a></code>
|
|
11648
11717
|
</td>
|
|
11649
11718
|
<td>
|
|
11650
11719
|
<div class="doc-md-description">
|
|
@@ -11652,13 +11721,15 @@
|
|
|
11652
11721
|
</div>
|
|
11653
11722
|
</td>
|
|
11654
11723
|
<td>
|
|
11655
|
-
<code><
|
|
11724
|
+
<code><span title="nautobot.core.ui.object_detail.BaseTextPanel.RenderOptions.MARKDOWN">MARKDOWN</span></code>
|
|
11656
11725
|
</td>
|
|
11657
11726
|
</tr>
|
|
11658
11727
|
<tr class="doc-section-item">
|
|
11659
|
-
<td><code>render_placeholder</code></td>
|
|
11660
11728
|
<td>
|
|
11661
|
-
|
|
11729
|
+
<code>render_placeholder</code>
|
|
11730
|
+
</td>
|
|
11731
|
+
<td>
|
|
11732
|
+
<code>bool</code>
|
|
11662
11733
|
</td>
|
|
11663
11734
|
<td>
|
|
11664
11735
|
<div class="doc-md-description">
|
|
@@ -11670,9 +11741,11 @@
|
|
|
11670
11741
|
</td>
|
|
11671
11742
|
</tr>
|
|
11672
11743
|
<tr class="doc-section-item">
|
|
11673
|
-
<td><code>body_content_template_path</code></td>
|
|
11674
11744
|
<td>
|
|
11675
|
-
|
|
11745
|
+
<code>body_content_template_path</code>
|
|
11746
|
+
</td>
|
|
11747
|
+
<td>
|
|
11748
|
+
<code>str</code>
|
|
11676
11749
|
</td>
|
|
11677
11750
|
<td>
|
|
11678
11751
|
<div class="doc-md-description">
|
|
@@ -11685,9 +11758,11 @@ Can be overridden for custom use cases.</p>
|
|
|
11685
11758
|
</td>
|
|
11686
11759
|
</tr>
|
|
11687
11760
|
<tr class="doc-section-item">
|
|
11688
|
-
<td><code>kwargs</code></td>
|
|
11689
11761
|
<td>
|
|
11690
|
-
|
|
11762
|
+
<code>kwargs</code>
|
|
11763
|
+
</td>
|
|
11764
|
+
<td>
|
|
11765
|
+
<code>dict</code>
|
|
11691
11766
|
</td>
|
|
11692
11767
|
<td>
|
|
11693
11768
|
<div class="doc-md-description">
|
|
@@ -11726,10 +11801,15 @@ Can be overridden for custom use cases.</p>
|
|
|
11726
11801
|
|
|
11727
11802
|
<div class="doc doc-contents ">
|
|
11728
11803
|
<p class="doc doc-class-bases">
|
|
11729
|
-
Bases: <code><
|
|
11804
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Component" href="#nautobot.apps.ui.Component">Component</a></code></p>
|
|
11805
|
+
|
|
11806
|
+
|
|
11807
|
+
<p>Base class for UI framework definition of a single button within an Object Detail (Object Retrieve) page.</p>
|
|
11808
|
+
|
|
11809
|
+
|
|
11810
|
+
|
|
11730
11811
|
|
|
11731
11812
|
|
|
11732
|
-
<p>Base class for UI framework definition of a single button within an Object Detail (Object Retrieve) page.</p>
|
|
11733
11813
|
|
|
11734
11814
|
|
|
11735
11815
|
|
|
@@ -11755,7 +11835,7 @@ Can be overridden for custom use cases.</p>
|
|
|
11755
11835
|
|
|
11756
11836
|
<div class="doc doc-contents ">
|
|
11757
11837
|
|
|
11758
|
-
|
|
11838
|
+
<p>Initialize a Button component.</p>
|
|
11759
11839
|
|
|
11760
11840
|
|
|
11761
11841
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -11770,9 +11850,11 @@ Can be overridden for custom use cases.</p>
|
|
|
11770
11850
|
</thead>
|
|
11771
11851
|
<tbody>
|
|
11772
11852
|
<tr class="doc-section-item">
|
|
11773
|
-
<td><code>label</code></td>
|
|
11774
11853
|
<td>
|
|
11775
|
-
|
|
11854
|
+
<code>label</code>
|
|
11855
|
+
</td>
|
|
11856
|
+
<td>
|
|
11857
|
+
<code>str</code>
|
|
11776
11858
|
</td>
|
|
11777
11859
|
<td>
|
|
11778
11860
|
<div class="doc-md-description">
|
|
@@ -11784,9 +11866,11 @@ Can be overridden for custom use cases.</p>
|
|
|
11784
11866
|
</td>
|
|
11785
11867
|
</tr>
|
|
11786
11868
|
<tr class="doc-section-item">
|
|
11787
|
-
<td><code>color</code></td>
|
|
11788
11869
|
<td>
|
|
11789
|
-
|
|
11870
|
+
<code>color</code>
|
|
11871
|
+
</td>
|
|
11872
|
+
<td>
|
|
11873
|
+
<code><a class="autorefs autorefs-internal" title="nautobot.core.choices.ButtonColorChoices" href="#nautobot.apps.ui.ButtonColorChoices">ButtonColorChoices</a></code>
|
|
11790
11874
|
</td>
|
|
11791
11875
|
<td>
|
|
11792
11876
|
<div class="doc-md-description">
|
|
@@ -11794,13 +11878,15 @@ Can be overridden for custom use cases.</p>
|
|
|
11794
11878
|
</div>
|
|
11795
11879
|
</td>
|
|
11796
11880
|
<td>
|
|
11797
|
-
<code><
|
|
11881
|
+
<code><span title="nautobot.core.choices.ButtonColorChoices.DEFAULT">DEFAULT</span></code>
|
|
11798
11882
|
</td>
|
|
11799
11883
|
</tr>
|
|
11800
11884
|
<tr class="doc-section-item">
|
|
11801
|
-
<td><code>link_name</code></td>
|
|
11802
11885
|
<td>
|
|
11803
|
-
|
|
11886
|
+
<code>link_name</code>
|
|
11887
|
+
</td>
|
|
11888
|
+
<td>
|
|
11889
|
+
<code>str</code>
|
|
11804
11890
|
</td>
|
|
11805
11891
|
<td>
|
|
11806
11892
|
<div class="doc-md-description">
|
|
@@ -11815,9 +11901,11 @@ and override the <code>get_link()</code> method.</p>
|
|
|
11815
11901
|
</td>
|
|
11816
11902
|
</tr>
|
|
11817
11903
|
<tr class="doc-section-item">
|
|
11818
|
-
<td><code>icon</code></td>
|
|
11819
11904
|
<td>
|
|
11820
|
-
|
|
11905
|
+
<code>icon</code>
|
|
11906
|
+
</td>
|
|
11907
|
+
<td>
|
|
11908
|
+
<code>str</code>
|
|
11821
11909
|
</td>
|
|
11822
11910
|
<td>
|
|
11823
11911
|
<div class="doc-md-description">
|
|
@@ -11829,9 +11917,11 @@ and override the <code>get_link()</code> method.</p>
|
|
|
11829
11917
|
</td>
|
|
11830
11918
|
</tr>
|
|
11831
11919
|
<tr class="doc-section-item">
|
|
11832
|
-
<td><code>template_path</code></td>
|
|
11833
11920
|
<td>
|
|
11834
|
-
|
|
11921
|
+
<code>template_path</code>
|
|
11922
|
+
</td>
|
|
11923
|
+
<td>
|
|
11924
|
+
<code>str</code>
|
|
11835
11925
|
</td>
|
|
11836
11926
|
<td>
|
|
11837
11927
|
<div class="doc-md-description">
|
|
@@ -11843,9 +11933,11 @@ and override the <code>get_link()</code> method.</p>
|
|
|
11843
11933
|
</td>
|
|
11844
11934
|
</tr>
|
|
11845
11935
|
<tr class="doc-section-item">
|
|
11846
|
-
<td><code>required_permissions</code></td>
|
|
11847
11936
|
<td>
|
|
11848
|
-
|
|
11937
|
+
<code>required_permissions</code>
|
|
11938
|
+
</td>
|
|
11939
|
+
<td>
|
|
11940
|
+
<code>list</code>
|
|
11849
11941
|
</td>
|
|
11850
11942
|
<td>
|
|
11851
11943
|
<div class="doc-md-description">
|
|
@@ -11858,9 +11950,11 @@ The button will only be rendered if the user has these permissions.</p>
|
|
|
11858
11950
|
</td>
|
|
11859
11951
|
</tr>
|
|
11860
11952
|
<tr class="doc-section-item">
|
|
11861
|
-
<td><code>javascript_template_path</code></td>
|
|
11862
11953
|
<td>
|
|
11863
|
-
|
|
11954
|
+
<code>javascript_template_path</code>
|
|
11955
|
+
</td>
|
|
11956
|
+
<td>
|
|
11957
|
+
<code>str</code>
|
|
11864
11958
|
</td>
|
|
11865
11959
|
<td>
|
|
11866
11960
|
<div class="doc-md-description">
|
|
@@ -11873,9 +11967,11 @@ Does not need to include the wrapping <code><script>...</script></co
|
|
|
11873
11967
|
</td>
|
|
11874
11968
|
</tr>
|
|
11875
11969
|
<tr class="doc-section-item">
|
|
11876
|
-
<td><code>attributes</code></td>
|
|
11877
11970
|
<td>
|
|
11878
|
-
|
|
11971
|
+
<code>attributes</code>
|
|
11972
|
+
</td>
|
|
11973
|
+
<td>
|
|
11974
|
+
<code>dict</code>
|
|
11879
11975
|
</td>
|
|
11880
11976
|
<td>
|
|
11881
11977
|
<div class="doc-md-description">
|
|
@@ -11904,7 +12000,7 @@ Does not need to include the wrapping <code><script>...</script></co
|
|
|
11904
12000
|
|
|
11905
12001
|
<div class="doc doc-contents ">
|
|
11906
12002
|
|
|
11907
|
-
|
|
12003
|
+
<p>Add the relevant attributes of this Button to the context.</p>
|
|
11908
12004
|
|
|
11909
12005
|
</div>
|
|
11910
12006
|
|
|
@@ -11921,7 +12017,7 @@ Does not need to include the wrapping <code><script>...</script></co
|
|
|
11921
12017
|
|
|
11922
12018
|
<div class="doc doc-contents ">
|
|
11923
12019
|
|
|
11924
|
-
|
|
12020
|
+
<p>Get the hyperlink URL (if any) for this button.</p>
|
|
11925
12021
|
<p>Defaults to reversing <code>self.link_name</code> with <code>pk: obj.pk</code> as a kwarg, but subclasses may override this for
|
|
11926
12022
|
more advanced link construction.</p>
|
|
11927
12023
|
|
|
@@ -11940,7 +12036,7 @@ more advanced link construction.</p>
|
|
|
11940
12036
|
|
|
11941
12037
|
<div class="doc doc-contents ">
|
|
11942
12038
|
|
|
11943
|
-
|
|
12039
|
+
<p>Render this button to HTML, possibly including any associated JavaScript.</p>
|
|
11944
12040
|
|
|
11945
12041
|
</div>
|
|
11946
12042
|
|
|
@@ -11957,7 +12053,7 @@ more advanced link construction.</p>
|
|
|
11957
12053
|
|
|
11958
12054
|
<div class="doc doc-contents ">
|
|
11959
12055
|
|
|
11960
|
-
|
|
12056
|
+
<p>Render if and only if the requesting user has appropriate permissions (if any).</p>
|
|
11961
12057
|
|
|
11962
12058
|
</div>
|
|
11963
12059
|
|
|
@@ -11984,10 +12080,15 @@ more advanced link construction.</p>
|
|
|
11984
12080
|
|
|
11985
12081
|
<div class="doc doc-contents ">
|
|
11986
12082
|
<p class="doc doc-class-bases">
|
|
11987
|
-
Bases: <code><
|
|
12083
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.choices.ChoiceSet" href="choices.html#nautobot.apps.choices.ChoiceSet">ChoiceSet</a></code></p>
|
|
12084
|
+
|
|
12085
|
+
|
|
12086
|
+
<p>Map standard button color choices to Bootstrap color classes</p>
|
|
12087
|
+
|
|
12088
|
+
|
|
12089
|
+
|
|
11988
12090
|
|
|
11989
12091
|
|
|
11990
|
-
<p>Map standard button color choices to Bootstrap color classes</p>
|
|
11991
12092
|
|
|
11992
12093
|
|
|
11993
12094
|
|
|
@@ -12024,7 +12125,12 @@ more advanced link construction.</p>
|
|
|
12024
12125
|
<div class="doc doc-contents ">
|
|
12025
12126
|
|
|
12026
12127
|
|
|
12027
|
-
|
|
12128
|
+
<p>Common base class for renderable components (tabs, panels, etc.).</p>
|
|
12129
|
+
|
|
12130
|
+
|
|
12131
|
+
|
|
12132
|
+
|
|
12133
|
+
|
|
12028
12134
|
|
|
12029
12135
|
|
|
12030
12136
|
|
|
@@ -12050,7 +12156,7 @@ more advanced link construction.</p>
|
|
|
12050
12156
|
|
|
12051
12157
|
<div class="doc doc-contents ">
|
|
12052
12158
|
|
|
12053
|
-
|
|
12159
|
+
<p>Initialize common Component properties.</p>
|
|
12054
12160
|
|
|
12055
12161
|
|
|
12056
12162
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -12065,9 +12171,11 @@ more advanced link construction.</p>
|
|
|
12065
12171
|
</thead>
|
|
12066
12172
|
<tbody>
|
|
12067
12173
|
<tr class="doc-section-item">
|
|
12068
|
-
<td><code>weight</code></td>
|
|
12069
12174
|
<td>
|
|
12070
|
-
|
|
12175
|
+
<code>weight</code>
|
|
12176
|
+
</td>
|
|
12177
|
+
<td>
|
|
12178
|
+
<code>int</code>
|
|
12071
12179
|
</td>
|
|
12072
12180
|
<td>
|
|
12073
12181
|
<div class="doc-md-description">
|
|
@@ -12097,7 +12205,7 @@ rendered "first", usually towards the top left of the page.</p>
|
|
|
12097
12205
|
|
|
12098
12206
|
<div class="doc doc-contents ">
|
|
12099
12207
|
|
|
12100
|
-
|
|
12208
|
+
<p>Provide additional data to include in the rendering context, based on the configuration of this component.</p>
|
|
12101
12209
|
|
|
12102
12210
|
|
|
12103
12211
|
<p><span class="doc-section-title">Returns:</span></p>
|
|
@@ -12111,7 +12219,7 @@ rendered "first", usually towards the top left of the page.</p>
|
|
|
12111
12219
|
<tbody>
|
|
12112
12220
|
<tr class="doc-section-item">
|
|
12113
12221
|
<td>
|
|
12114
|
-
<code
|
|
12222
|
+
<code>dict</code>
|
|
12115
12223
|
</td>
|
|
12116
12224
|
<td>
|
|
12117
12225
|
<div class="doc-md-description">
|
|
@@ -12137,7 +12245,7 @@ rendered "first", usually towards the top left of the page.</p>
|
|
|
12137
12245
|
|
|
12138
12246
|
<div class="doc doc-contents ">
|
|
12139
12247
|
|
|
12140
|
-
|
|
12248
|
+
<p>Render this component to HTML.</p>
|
|
12141
12249
|
<p>Note that not all Components are fully or solely rendered by their <code>render()</code> method alone, for example,
|
|
12142
12250
|
a Tab has a separate "label" that must be rendered by calling its <code>render_label_wrapper()</code> API instead.</p>
|
|
12143
12251
|
|
|
@@ -12153,7 +12261,7 @@ a Tab has a separate "label" that must be rendered by calling its <code>render_l
|
|
|
12153
12261
|
<tbody>
|
|
12154
12262
|
<tr class="doc-section-item">
|
|
12155
12263
|
<td>
|
|
12156
|
-
<code
|
|
12264
|
+
<code>str</code>
|
|
12157
12265
|
</td>
|
|
12158
12266
|
<td>
|
|
12159
12267
|
<div class="doc-md-description">
|
|
@@ -12179,7 +12287,7 @@ a Tab has a separate "label" that must be rendered by calling its <code>render_l
|
|
|
12179
12287
|
|
|
12180
12288
|
<div class="doc doc-contents ">
|
|
12181
12289
|
|
|
12182
|
-
|
|
12290
|
+
<p>Check whether this component should be rendered at all.</p>
|
|
12183
12291
|
<p>This API is designed to provide "short-circuit" logic for skipping what otherwise might be expensive rendering.
|
|
12184
12292
|
In general most Components may also return an empty string when actually rendered, which is typically also a
|
|
12185
12293
|
means to specify that they do not need to be rendered, but may be more expensive to derive.</p>
|
|
@@ -12196,7 +12304,7 @@ means to specify that they do not need to be rendered, but may be more expensive
|
|
|
12196
12304
|
<tbody>
|
|
12197
12305
|
<tr class="doc-section-item">
|
|
12198
12306
|
<td>
|
|
12199
|
-
<code
|
|
12307
|
+
<code>bool</code>
|
|
12200
12308
|
</td>
|
|
12201
12309
|
<td>
|
|
12202
12310
|
<div class="doc-md-description">
|
|
@@ -12232,10 +12340,15 @@ means to specify that they do not need to be rendered, but may be more expensive
|
|
|
12232
12340
|
|
|
12233
12341
|
<div class="doc doc-contents ">
|
|
12234
12342
|
<p class="doc doc-class-bases">
|
|
12235
|
-
Bases: <code><
|
|
12343
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Panel" href="#nautobot.apps.ui.Panel">Panel</a></code></p>
|
|
12344
|
+
|
|
12345
|
+
|
|
12346
|
+
<p>A panel that renders a table generated directly from a list of dicts, without using a django_tables2 Table class.</p>
|
|
12347
|
+
|
|
12348
|
+
|
|
12349
|
+
|
|
12236
12350
|
|
|
12237
12351
|
|
|
12238
|
-
<p>A panel that renders a table generated directly from a list of dicts, without using a django_tables2 Table class.</p>
|
|
12239
12352
|
|
|
12240
12353
|
|
|
12241
12354
|
|
|
@@ -12261,7 +12374,7 @@ means to specify that they do not need to be rendered, but may be more expensive
|
|
|
12261
12374
|
|
|
12262
12375
|
<div class="doc doc-contents ">
|
|
12263
12376
|
|
|
12264
|
-
|
|
12377
|
+
<p>Instantiate a DataDictTablePanel.</p>
|
|
12265
12378
|
|
|
12266
12379
|
|
|
12267
12380
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -12276,9 +12389,11 @@ means to specify that they do not need to be rendered, but may be more expensive
|
|
|
12276
12389
|
</thead>
|
|
12277
12390
|
<tbody>
|
|
12278
12391
|
<tr class="doc-section-item">
|
|
12279
|
-
<td><code>context_data_key</code></td>
|
|
12280
12392
|
<td>
|
|
12281
|
-
|
|
12393
|
+
<code>context_data_key</code>
|
|
12394
|
+
</td>
|
|
12395
|
+
<td>
|
|
12396
|
+
<code>str</code>
|
|
12282
12397
|
</td>
|
|
12283
12398
|
<td>
|
|
12284
12399
|
<div class="doc-md-description">
|
|
@@ -12290,9 +12405,11 @@ means to specify that they do not need to be rendered, but may be more expensive
|
|
|
12290
12405
|
</td>
|
|
12291
12406
|
</tr>
|
|
12292
12407
|
<tr class="doc-section-item">
|
|
12293
|
-
<td><code>columns</code></td>
|
|
12294
12408
|
<td>
|
|
12295
|
-
|
|
12409
|
+
<code>columns</code>
|
|
12410
|
+
</td>
|
|
12411
|
+
<td>
|
|
12412
|
+
<code>list</code>
|
|
12296
12413
|
</td>
|
|
12297
12414
|
<td>
|
|
12298
12415
|
<div class="doc-md-description">
|
|
@@ -12306,9 +12423,11 @@ If neither are specified, the keys of the first dict in the data will be used.</
|
|
|
12306
12423
|
</td>
|
|
12307
12424
|
</tr>
|
|
12308
12425
|
<tr class="doc-section-item">
|
|
12309
|
-
<td><code>context_columns_key</code></td>
|
|
12310
12426
|
<td>
|
|
12311
|
-
|
|
12427
|
+
<code>context_columns_key</code>
|
|
12428
|
+
</td>
|
|
12429
|
+
<td>
|
|
12430
|
+
<code>str</code>
|
|
12312
12431
|
</td>
|
|
12313
12432
|
<td>
|
|
12314
12433
|
<div class="doc-md-description">
|
|
@@ -12322,9 +12441,11 @@ If neither are specified, the keys of the first dict in the data will be used.</
|
|
|
12322
12441
|
</td>
|
|
12323
12442
|
</tr>
|
|
12324
12443
|
<tr class="doc-section-item">
|
|
12325
|
-
<td><code>column_headers</code></td>
|
|
12326
12444
|
<td>
|
|
12327
|
-
|
|
12445
|
+
<code>column_headers</code>
|
|
12446
|
+
</td>
|
|
12447
|
+
<td>
|
|
12448
|
+
<code>list</code>
|
|
12328
12449
|
</td>
|
|
12329
12450
|
<td>
|
|
12330
12451
|
<div class="doc-md-description">
|
|
@@ -12337,9 +12458,11 @@ Mutually exclusive with <code>context_column_headers_key</code>.</p>
|
|
|
12337
12458
|
</td>
|
|
12338
12459
|
</tr>
|
|
12339
12460
|
<tr class="doc-section-item">
|
|
12340
|
-
<td><code>context_column_headers_key</code></td>
|
|
12341
12461
|
<td>
|
|
12342
|
-
|
|
12462
|
+
<code>context_column_headers_key</code>
|
|
12463
|
+
</td>
|
|
12464
|
+
<td>
|
|
12465
|
+
<code>str</code>
|
|
12343
12466
|
</td>
|
|
12344
12467
|
<td>
|
|
12345
12468
|
<div class="doc-md-description">
|
|
@@ -12379,10 +12502,15 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12379
12502
|
|
|
12380
12503
|
<div class="doc doc-contents ">
|
|
12381
12504
|
<p class="doc doc-class-bases">
|
|
12382
|
-
Bases: <code><
|
|
12505
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Tab" href="#nautobot.apps.ui.Tab">Tab</a></code></p>
|
|
12506
|
+
|
|
12507
|
+
|
|
12508
|
+
<p>A Tab that doesn't render inline on the same page, but instead links to a distinct view of its own when clicked.</p>
|
|
12509
|
+
|
|
12510
|
+
|
|
12511
|
+
|
|
12383
12512
|
|
|
12384
12513
|
|
|
12385
|
-
<p>A Tab that doesn't render inline on the same page, but instead links to a distinct view of its own when clicked.</p>
|
|
12386
12514
|
|
|
12387
12515
|
|
|
12388
12516
|
|
|
@@ -12418,10 +12546,15 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12418
12546
|
|
|
12419
12547
|
<div class="doc doc-contents ">
|
|
12420
12548
|
<p class="doc doc-class-bases">
|
|
12421
|
-
Bases: <code><
|
|
12549
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Button" href="#nautobot.apps.ui.Button">Button</a></code></p>
|
|
12550
|
+
|
|
12551
|
+
|
|
12552
|
+
<p>A Button that has one or more other buttons as <code>children</code>, which it renders into a dropdown menu.</p>
|
|
12553
|
+
|
|
12554
|
+
|
|
12555
|
+
|
|
12422
12556
|
|
|
12423
12557
|
|
|
12424
|
-
<p>A Button that has one or more other buttons as <code>children</code>, which it renders into a dropdown menu.</p>
|
|
12425
12558
|
|
|
12426
12559
|
|
|
12427
12560
|
|
|
@@ -12447,7 +12580,7 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12447
12580
|
|
|
12448
12581
|
<div class="doc doc-contents ">
|
|
12449
12582
|
|
|
12450
|
-
|
|
12583
|
+
<p>Initialize a DropdownButton component.</p>
|
|
12451
12584
|
|
|
12452
12585
|
|
|
12453
12586
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -12462,9 +12595,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12462
12595
|
</thead>
|
|
12463
12596
|
<tbody>
|
|
12464
12597
|
<tr class="doc-section-item">
|
|
12465
|
-
<td><code>children</code></td>
|
|
12466
12598
|
<td>
|
|
12467
|
-
|
|
12599
|
+
<code>children</code>
|
|
12600
|
+
</td>
|
|
12601
|
+
<td>
|
|
12602
|
+
<code>list[<a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Button" href="#nautobot.apps.ui.Button">Button</a>]</code>
|
|
12468
12603
|
</td>
|
|
12469
12604
|
<td>
|
|
12470
12605
|
<div class="doc-md-description">
|
|
@@ -12476,9 +12611,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12476
12611
|
</td>
|
|
12477
12612
|
</tr>
|
|
12478
12613
|
<tr class="doc-section-item">
|
|
12479
|
-
<td><code>template_path</code></td>
|
|
12480
12614
|
<td>
|
|
12481
|
-
|
|
12615
|
+
<code>template_path</code>
|
|
12616
|
+
</td>
|
|
12617
|
+
<td>
|
|
12618
|
+
<code>str</code>
|
|
12482
12619
|
</td>
|
|
12483
12620
|
<td>
|
|
12484
12621
|
<div class="doc-md-description">
|
|
@@ -12507,7 +12644,7 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12507
12644
|
|
|
12508
12645
|
<div class="doc doc-contents ">
|
|
12509
12646
|
|
|
12510
|
-
|
|
12647
|
+
<p>Add the children of this DropdownButton to the other Button context.</p>
|
|
12511
12648
|
|
|
12512
12649
|
</div>
|
|
12513
12650
|
|
|
@@ -12534,16 +12671,21 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12534
12671
|
|
|
12535
12672
|
<div class="doc doc-contents ">
|
|
12536
12673
|
<p class="doc doc-class-bases">
|
|
12537
|
-
Bases: <code><
|
|
12674
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.KeyValueTablePanel" href="#nautobot.apps.ui.KeyValueTablePanel">KeyValueTablePanel</a></code></p>
|
|
12538
12675
|
|
|
12539
12676
|
|
|
12540
|
-
|
|
12677
|
+
<p>A KeyValueTablePanel that displays its data within collapsible accordion groupings, such as object custom fields.</p>
|
|
12541
12678
|
<p>Expects data in the form <code>{grouping1: {key1: value1, key2: value2, ...}, grouping2: {...}, ...}</code>.</p>
|
|
12542
12679
|
<p>The special grouping <code>""</code> may be used to indicate top-level key/value pairs that don't belong to a group.</p>
|
|
12543
12680
|
|
|
12544
12681
|
|
|
12545
12682
|
|
|
12546
12683
|
|
|
12684
|
+
|
|
12685
|
+
|
|
12686
|
+
|
|
12687
|
+
|
|
12688
|
+
|
|
12547
12689
|
<div class="doc doc-children">
|
|
12548
12690
|
|
|
12549
12691
|
|
|
@@ -12565,7 +12707,7 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12565
12707
|
|
|
12566
12708
|
<div class="doc doc-contents ">
|
|
12567
12709
|
|
|
12568
|
-
|
|
12710
|
+
<p>Render groups of key-value pairs to HTML.</p>
|
|
12569
12711
|
|
|
12570
12712
|
</div>
|
|
12571
12713
|
|
|
@@ -12582,7 +12724,7 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12582
12724
|
|
|
12583
12725
|
<div class="doc doc-contents ">
|
|
12584
12726
|
|
|
12585
|
-
|
|
12727
|
+
<p>Add a "Collapse All" button to the header.</p>
|
|
12586
12728
|
|
|
12587
12729
|
</div>
|
|
12588
12730
|
|
|
@@ -12609,10 +12751,15 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12609
12751
|
|
|
12610
12752
|
<div class="doc doc-contents ">
|
|
12611
12753
|
<p class="doc doc-class-bases">
|
|
12612
|
-
Bases: <code><
|
|
12754
|
+
Bases: <code><span title="abc.ABC">ABC</span></code></p>
|
|
12755
|
+
|
|
12756
|
+
|
|
12757
|
+
<p>Base class for homepage layout classes.</p>
|
|
12758
|
+
|
|
12759
|
+
|
|
12760
|
+
|
|
12613
12761
|
|
|
12614
12762
|
|
|
12615
|
-
<p>Base class for homepage layout classes.</p>
|
|
12616
12763
|
|
|
12617
12764
|
|
|
12618
12765
|
|
|
@@ -12648,10 +12795,15 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12648
12795
|
|
|
12649
12796
|
<div class="doc doc-contents ">
|
|
12650
12797
|
<p class="doc doc-class-bases">
|
|
12651
|
-
Bases: <code><
|
|
12798
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.homepage.HomePageBase" href="#nautobot.apps.ui.HomePageBase">HomePageBase</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.base.PermissionsMixin" href="#nautobot.apps.ui.PermissionsMixin">PermissionsMixin</a></code></p>
|
|
12799
|
+
|
|
12800
|
+
|
|
12801
|
+
<p>Defines properties that can be used for a panel group.</p>
|
|
12802
|
+
|
|
12803
|
+
|
|
12804
|
+
|
|
12652
12805
|
|
|
12653
12806
|
|
|
12654
|
-
<p>Defines properties that can be used for a panel group.</p>
|
|
12655
12807
|
|
|
12656
12808
|
|
|
12657
12809
|
|
|
@@ -12677,7 +12829,7 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12677
12829
|
|
|
12678
12830
|
<div class="doc doc-contents ">
|
|
12679
12831
|
|
|
12680
|
-
|
|
12832
|
+
<p>Ensure group properties.</p>
|
|
12681
12833
|
|
|
12682
12834
|
|
|
12683
12835
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -12692,9 +12844,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12692
12844
|
</thead>
|
|
12693
12845
|
<tbody>
|
|
12694
12846
|
<tr class="doc-section-item">
|
|
12695
|
-
<td><code>name</code></td>
|
|
12696
12847
|
<td>
|
|
12697
|
-
|
|
12848
|
+
<code>name</code>
|
|
12849
|
+
</td>
|
|
12850
|
+
<td>
|
|
12851
|
+
<code>str</code>
|
|
12698
12852
|
</td>
|
|
12699
12853
|
<td>
|
|
12700
12854
|
<div class="doc-md-description">
|
|
@@ -12706,9 +12860,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12706
12860
|
</td>
|
|
12707
12861
|
</tr>
|
|
12708
12862
|
<tr class="doc-section-item">
|
|
12709
|
-
<td><code>permissions</code></td>
|
|
12710
12863
|
<td>
|
|
12711
|
-
|
|
12864
|
+
<code>permissions</code>
|
|
12865
|
+
</td>
|
|
12866
|
+
<td>
|
|
12867
|
+
<code>list</code>
|
|
12712
12868
|
</td>
|
|
12713
12869
|
<td>
|
|
12714
12870
|
<div class="doc-md-description">
|
|
@@ -12720,9 +12876,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12720
12876
|
</td>
|
|
12721
12877
|
</tr>
|
|
12722
12878
|
<tr class="doc-section-item">
|
|
12723
|
-
<td><code>items</code></td>
|
|
12724
12879
|
<td>
|
|
12725
|
-
|
|
12880
|
+
<code>items</code>
|
|
12881
|
+
</td>
|
|
12882
|
+
<td>
|
|
12883
|
+
<code>list</code>
|
|
12726
12884
|
</td>
|
|
12727
12885
|
<td>
|
|
12728
12886
|
<div class="doc-md-description">
|
|
@@ -12734,9 +12892,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12734
12892
|
</td>
|
|
12735
12893
|
</tr>
|
|
12736
12894
|
<tr class="doc-section-item">
|
|
12737
|
-
<td><code>weight</code></td>
|
|
12738
12895
|
<td>
|
|
12739
|
-
|
|
12896
|
+
<code>weight</code>
|
|
12897
|
+
</td>
|
|
12898
|
+
<td>
|
|
12899
|
+
<code>int</code>
|
|
12740
12900
|
</td>
|
|
12741
12901
|
<td>
|
|
12742
12902
|
<div class="doc-md-description">
|
|
@@ -12775,10 +12935,15 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12775
12935
|
|
|
12776
12936
|
<div class="doc doc-contents ">
|
|
12777
12937
|
<p class="doc doc-class-bases">
|
|
12778
|
-
Bases: <code><
|
|
12938
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.homepage.HomePageBase" href="#nautobot.apps.ui.HomePageBase">HomePageBase</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.base.PermissionsMixin" href="#nautobot.apps.ui.PermissionsMixin">PermissionsMixin</a></code></p>
|
|
12939
|
+
|
|
12940
|
+
|
|
12941
|
+
<p>Defines properties that can be used for a panel item.</p>
|
|
12942
|
+
|
|
12943
|
+
|
|
12944
|
+
|
|
12779
12945
|
|
|
12780
12946
|
|
|
12781
|
-
<p>Defines properties that can be used for a panel item.</p>
|
|
12782
12947
|
|
|
12783
12948
|
|
|
12784
12949
|
|
|
@@ -12804,7 +12969,7 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12804
12969
|
|
|
12805
12970
|
<div class="doc doc-contents ">
|
|
12806
12971
|
|
|
12807
|
-
|
|
12972
|
+
<p>Ensure item properties.</p>
|
|
12808
12973
|
|
|
12809
12974
|
|
|
12810
12975
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -12819,9 +12984,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12819
12984
|
</thead>
|
|
12820
12985
|
<tbody>
|
|
12821
12986
|
<tr class="doc-section-item">
|
|
12822
|
-
<td><code>name</code></td>
|
|
12823
12987
|
<td>
|
|
12824
|
-
|
|
12988
|
+
<code>name</code>
|
|
12989
|
+
</td>
|
|
12990
|
+
<td>
|
|
12991
|
+
<code>str</code>
|
|
12825
12992
|
</td>
|
|
12826
12993
|
<td>
|
|
12827
12994
|
<div class="doc-md-description">
|
|
@@ -12833,9 +13000,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12833
13000
|
</td>
|
|
12834
13001
|
</tr>
|
|
12835
13002
|
<tr class="doc-section-item">
|
|
12836
|
-
<td><code>link</code></td>
|
|
12837
13003
|
<td>
|
|
12838
|
-
|
|
13004
|
+
<code>link</code>
|
|
13005
|
+
</td>
|
|
13006
|
+
<td>
|
|
13007
|
+
<code>str</code>
|
|
12839
13008
|
</td>
|
|
12840
13009
|
<td>
|
|
12841
13010
|
<div class="doc-md-description">
|
|
@@ -12847,9 +13016,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12847
13016
|
</td>
|
|
12848
13017
|
</tr>
|
|
12849
13018
|
<tr class="doc-section-item">
|
|
12850
|
-
<td><code>model</code></td>
|
|
12851
13019
|
<td>
|
|
12852
|
-
|
|
13020
|
+
<code>model</code>
|
|
13021
|
+
</td>
|
|
13022
|
+
<td>
|
|
13023
|
+
<code>str</code>
|
|
12853
13024
|
</td>
|
|
12854
13025
|
<td>
|
|
12855
13026
|
<div class="doc-md-description">
|
|
@@ -12861,9 +13032,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12861
13032
|
</td>
|
|
12862
13033
|
</tr>
|
|
12863
13034
|
<tr class="doc-section-item">
|
|
12864
|
-
<td><code>custom_template</code></td>
|
|
12865
13035
|
<td>
|
|
12866
|
-
|
|
13036
|
+
<code>custom_template</code>
|
|
13037
|
+
</td>
|
|
13038
|
+
<td>
|
|
13039
|
+
<code>str</code>
|
|
12867
13040
|
</td>
|
|
12868
13041
|
<td>
|
|
12869
13042
|
<div class="doc-md-description">
|
|
@@ -12875,9 +13048,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12875
13048
|
</td>
|
|
12876
13049
|
</tr>
|
|
12877
13050
|
<tr class="doc-section-item">
|
|
12878
|
-
<td><code>custom_data</code></td>
|
|
12879
13051
|
<td>
|
|
12880
|
-
|
|
13052
|
+
<code>custom_data</code>
|
|
13053
|
+
</td>
|
|
13054
|
+
<td>
|
|
13055
|
+
<code>dict</code>
|
|
12881
13056
|
</td>
|
|
12882
13057
|
<td>
|
|
12883
13058
|
<div class="doc-md-description">
|
|
@@ -12916,10 +13091,15 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12916
13091
|
|
|
12917
13092
|
<div class="doc doc-contents ">
|
|
12918
13093
|
<p class="doc doc-class-bases">
|
|
12919
|
-
Bases: <code><
|
|
13094
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.homepage.HomePageBase" href="#nautobot.apps.ui.HomePageBase">HomePageBase</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.base.PermissionsMixin" href="#nautobot.apps.ui.PermissionsMixin">PermissionsMixin</a></code></p>
|
|
13095
|
+
|
|
13096
|
+
|
|
13097
|
+
<p>Defines properties that can be used for a panel.</p>
|
|
13098
|
+
|
|
13099
|
+
|
|
13100
|
+
|
|
12920
13101
|
|
|
12921
13102
|
|
|
12922
|
-
<p>Defines properties that can be used for a panel.</p>
|
|
12923
13103
|
|
|
12924
13104
|
|
|
12925
13105
|
|
|
@@ -12945,7 +13125,7 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12945
13125
|
|
|
12946
13126
|
<div class="doc doc-contents ">
|
|
12947
13127
|
|
|
12948
|
-
|
|
13128
|
+
<p>Ensure panel properties.</p>
|
|
12949
13129
|
|
|
12950
13130
|
|
|
12951
13131
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -12960,9 +13140,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12960
13140
|
</thead>
|
|
12961
13141
|
<tbody>
|
|
12962
13142
|
<tr class="doc-section-item">
|
|
12963
|
-
<td><code>name</code></td>
|
|
12964
13143
|
<td>
|
|
12965
|
-
|
|
13144
|
+
<code>name</code>
|
|
13145
|
+
</td>
|
|
13146
|
+
<td>
|
|
13147
|
+
<code>str</code>
|
|
12966
13148
|
</td>
|
|
12967
13149
|
<td>
|
|
12968
13150
|
<div class="doc-md-description">
|
|
@@ -12974,9 +13156,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12974
13156
|
</td>
|
|
12975
13157
|
</tr>
|
|
12976
13158
|
<tr class="doc-section-item">
|
|
12977
|
-
<td><code>permissions</code></td>
|
|
12978
13159
|
<td>
|
|
12979
|
-
|
|
13160
|
+
<code>permissions</code>
|
|
13161
|
+
</td>
|
|
13162
|
+
<td>
|
|
13163
|
+
<code>list</code>
|
|
12980
13164
|
</td>
|
|
12981
13165
|
<td>
|
|
12982
13166
|
<div class="doc-md-description">
|
|
@@ -12988,9 +13172,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
12988
13172
|
</td>
|
|
12989
13173
|
</tr>
|
|
12990
13174
|
<tr class="doc-section-item">
|
|
12991
|
-
<td><code>custom_data</code></td>
|
|
12992
13175
|
<td>
|
|
12993
|
-
|
|
13176
|
+
<code>custom_data</code>
|
|
13177
|
+
</td>
|
|
13178
|
+
<td>
|
|
13179
|
+
<code>dict</code>
|
|
12994
13180
|
</td>
|
|
12995
13181
|
<td>
|
|
12996
13182
|
<div class="doc-md-description">
|
|
@@ -13002,9 +13188,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
13002
13188
|
</td>
|
|
13003
13189
|
</tr>
|
|
13004
13190
|
<tr class="doc-section-item">
|
|
13005
|
-
<td><code>custom_template</code></td>
|
|
13006
13191
|
<td>
|
|
13007
|
-
|
|
13192
|
+
<code>custom_template</code>
|
|
13193
|
+
</td>
|
|
13194
|
+
<td>
|
|
13195
|
+
<code>str</code>
|
|
13008
13196
|
</td>
|
|
13009
13197
|
<td>
|
|
13010
13198
|
<div class="doc-md-description">
|
|
@@ -13016,9 +13204,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
13016
13204
|
</td>
|
|
13017
13205
|
</tr>
|
|
13018
13206
|
<tr class="doc-section-item">
|
|
13019
|
-
<td><code>items</code></td>
|
|
13020
13207
|
<td>
|
|
13021
|
-
|
|
13208
|
+
<code>items</code>
|
|
13209
|
+
</td>
|
|
13210
|
+
<td>
|
|
13211
|
+
<code>list</code>
|
|
13022
13212
|
</td>
|
|
13023
13213
|
<td>
|
|
13024
13214
|
<div class="doc-md-description">
|
|
@@ -13030,9 +13220,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
13030
13220
|
</td>
|
|
13031
13221
|
</tr>
|
|
13032
13222
|
<tr class="doc-section-item">
|
|
13033
|
-
<td><code>weight</code></td>
|
|
13034
13223
|
<td>
|
|
13035
|
-
|
|
13224
|
+
<code>weight</code>
|
|
13225
|
+
</td>
|
|
13226
|
+
<td>
|
|
13227
|
+
<code>int</code>
|
|
13036
13228
|
</td>
|
|
13037
13229
|
<td>
|
|
13038
13230
|
<div class="doc-md-description">
|
|
@@ -13071,10 +13263,15 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
13071
13263
|
|
|
13072
13264
|
<div class="doc doc-contents ">
|
|
13073
13265
|
<p class="doc doc-class-bases">
|
|
13074
|
-
Bases: <code><
|
|
13266
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Panel" href="#nautobot.apps.ui.Panel">Panel</a></code></p>
|
|
13267
|
+
|
|
13268
|
+
|
|
13269
|
+
<p>A panel that displays a two-column table of keys and values, as seen in most object detail views.</p>
|
|
13270
|
+
|
|
13271
|
+
|
|
13272
|
+
|
|
13075
13273
|
|
|
13076
13274
|
|
|
13077
|
-
<p>A panel that displays a two-column table of keys and values, as seen in most object detail views.</p>
|
|
13078
13275
|
|
|
13079
13276
|
|
|
13080
13277
|
|
|
@@ -13100,7 +13297,7 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
13100
13297
|
|
|
13101
13298
|
<div class="doc doc-contents ">
|
|
13102
13299
|
|
|
13103
|
-
|
|
13300
|
+
<p>Instantiate a KeyValueTablePanel.</p>
|
|
13104
13301
|
|
|
13105
13302
|
|
|
13106
13303
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -13115,9 +13312,11 @@ Mutually exclusive with <code>column_headers</code>.</p>
|
|
|
13115
13312
|
</thead>
|
|
13116
13313
|
<tbody>
|
|
13117
13314
|
<tr class="doc-section-item">
|
|
13118
|
-
<td><code>data</code></td>
|
|
13119
13315
|
<td>
|
|
13120
|
-
|
|
13316
|
+
<code>data</code>
|
|
13317
|
+
</td>
|
|
13318
|
+
<td>
|
|
13319
|
+
<code>dict</code>
|
|
13121
13320
|
</td>
|
|
13122
13321
|
<td>
|
|
13123
13322
|
<div class="doc-md-description">
|
|
@@ -13130,9 +13329,11 @@ May be <code>None</code> if it will be derived dynamically by <code>get_data()</
|
|
|
13130
13329
|
</td>
|
|
13131
13330
|
</tr>
|
|
13132
13331
|
<tr class="doc-section-item">
|
|
13133
|
-
<td><code>context_data_key</code></td>
|
|
13134
13332
|
<td>
|
|
13135
|
-
|
|
13333
|
+
<code>context_data_key</code>
|
|
13334
|
+
</td>
|
|
13335
|
+
<td>
|
|
13336
|
+
<code>str</code>
|
|
13136
13337
|
</td>
|
|
13137
13338
|
<td>
|
|
13138
13339
|
<div class="doc-md-description">
|
|
@@ -13144,9 +13345,11 @@ May be <code>None</code> if it will be derived dynamically by <code>get_data()</
|
|
|
13144
13345
|
</td>
|
|
13145
13346
|
</tr>
|
|
13146
13347
|
<tr class="doc-section-item">
|
|
13147
|
-
<td><code>hide_if_unset</code></td>
|
|
13148
13348
|
<td>
|
|
13149
|
-
|
|
13349
|
+
<code>hide_if_unset</code>
|
|
13350
|
+
</td>
|
|
13351
|
+
<td>
|
|
13352
|
+
<code>list</code>
|
|
13150
13353
|
</td>
|
|
13151
13354
|
<td>
|
|
13152
13355
|
<div class="doc-md-description">
|
|
@@ -13159,9 +13362,11 @@ instead of displaying the usual em-dash placeholder text.</p>
|
|
|
13159
13362
|
</td>
|
|
13160
13363
|
</tr>
|
|
13161
13364
|
<tr class="doc-section-item">
|
|
13162
|
-
<td><code>value_transforms</code></td>
|
|
13163
13365
|
<td>
|
|
13164
|
-
|
|
13366
|
+
<code>value_transforms</code>
|
|
13367
|
+
</td>
|
|
13368
|
+
<td>
|
|
13369
|
+
<code>dict</code>
|
|
13165
13370
|
</td>
|
|
13166
13371
|
<td>
|
|
13167
13372
|
<div class="doc-md-description">
|
|
@@ -13196,7 +13401,7 @@ Many of the <code>templatetags.helpers</code> functions are suitable for this pu
|
|
|
13196
13401
|
|
|
13197
13402
|
<div class="doc doc-contents ">
|
|
13198
13403
|
|
|
13199
|
-
|
|
13404
|
+
<p>Get the data for this panel, by default from <code>self.data</code> or the key <code>"data"</code> in the provided context.</p>
|
|
13200
13405
|
<p>Subclasses may need to override this method if the derivation of the data is more involved.</p>
|
|
13201
13406
|
|
|
13202
13407
|
|
|
@@ -13211,7 +13416,7 @@ Many of the <code>templatetags.helpers</code> functions are suitable for this pu
|
|
|
13211
13416
|
<tbody>
|
|
13212
13417
|
<tr class="doc-section-item">
|
|
13213
13418
|
<td>
|
|
13214
|
-
<code
|
|
13419
|
+
<code>dict</code>
|
|
13215
13420
|
</td>
|
|
13216
13421
|
<td>
|
|
13217
13422
|
<div class="doc-md-description">
|
|
@@ -13237,7 +13442,7 @@ Many of the <code>templatetags.helpers</code> functions are suitable for this pu
|
|
|
13237
13442
|
|
|
13238
13443
|
<div class="doc doc-contents ">
|
|
13239
13444
|
|
|
13240
|
-
|
|
13445
|
+
<p>Get a filter parameter to use when hyperlinking queryset data to an object list URL to provide filtering.</p>
|
|
13241
13446
|
|
|
13242
13447
|
|
|
13243
13448
|
<p><span class="doc-section-title">Returns:</span></p>
|
|
@@ -13251,7 +13456,7 @@ Many of the <code>templatetags.helpers</code> functions are suitable for this pu
|
|
|
13251
13456
|
<tbody>
|
|
13252
13457
|
<tr class="doc-section-item">
|
|
13253
13458
|
<td>
|
|
13254
|
-
<code
|
|
13459
|
+
<code>str</code>
|
|
13255
13460
|
</td>
|
|
13256
13461
|
<td>
|
|
13257
13462
|
<div class="doc-md-description">
|
|
@@ -13261,7 +13466,7 @@ Many of the <code>templatetags.helpers</code> functions are suitable for this pu
|
|
|
13261
13466
|
</tr>
|
|
13262
13467
|
</tbody>
|
|
13263
13468
|
</table>
|
|
13264
|
-
|
|
13469
|
+
<p>The default implementation returns <code>""</code>, which means "no appropriate filter parameter is known,
|
|
13265
13470
|
do not hyperlink the queryset text." Subclasses may wish to override this to provide appropriate intelligence.</p>
|
|
13266
13471
|
|
|
13267
13472
|
|
|
@@ -13291,7 +13496,7 @@ do not hyperlink the queryset text." Subclasses may wish to override this to pro
|
|
|
13291
13496
|
|
|
13292
13497
|
<div class="doc doc-contents ">
|
|
13293
13498
|
|
|
13294
|
-
|
|
13499
|
+
<p>Render key-value pairs as table rows, using <code>render_key()</code> and <code>render_value()</code> methods as applicable.</p>
|
|
13295
13500
|
|
|
13296
13501
|
</div>
|
|
13297
13502
|
|
|
@@ -13308,7 +13513,7 @@ do not hyperlink the queryset text." Subclasses may wish to override this to pro
|
|
|
13308
13513
|
|
|
13309
13514
|
<div class="doc doc-contents ">
|
|
13310
13515
|
|
|
13311
|
-
|
|
13516
|
+
<p>Render the provided key in human-readable form.</p>
|
|
13312
13517
|
<p>The default implementation simply replaces underscores with spaces and title-cases it with <code>bettertitle()</code>.</p>
|
|
13313
13518
|
|
|
13314
13519
|
</div>
|
|
@@ -13326,7 +13531,7 @@ do not hyperlink the queryset text." Subclasses may wish to override this to pro
|
|
|
13326
13531
|
|
|
13327
13532
|
<div class="doc doc-contents ">
|
|
13328
13533
|
|
|
13329
|
-
|
|
13534
|
+
<p>Render the provided value in human-readable form.</p>
|
|
13330
13535
|
|
|
13331
13536
|
|
|
13332
13537
|
<p><span class="doc-section-title">Returns:</span></p>
|
|
@@ -13340,7 +13545,7 @@ do not hyperlink the queryset text." Subclasses may wish to override this to pro
|
|
|
13340
13545
|
<tbody>
|
|
13341
13546
|
<tr class="doc-section-item">
|
|
13342
13547
|
<td>
|
|
13343
|
-
<code
|
|
13548
|
+
<code>str</code>
|
|
13344
13549
|
</td>
|
|
13345
13550
|
<td>
|
|
13346
13551
|
<div class="doc-md-description">
|
|
@@ -13352,7 +13557,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13352
13557
|
</tr>
|
|
13353
13558
|
</tbody>
|
|
13354
13559
|
</table>
|
|
13355
|
-
|
|
13560
|
+
<p>Behavior is influenced by:</p>
|
|
13356
13561
|
<ul>
|
|
13357
13562
|
<li><code>self.value_transforms</code> - if it has an entry for the given <code>key</code>, then the given functions provided there
|
|
13358
13563
|
will be used to render the <code>value</code>, in place of any default processing and rendering for this data type.</li>
|
|
@@ -13396,10 +13601,10 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13396
13601
|
|
|
13397
13602
|
<div class="doc doc-contents ">
|
|
13398
13603
|
<p class="doc doc-class-bases">
|
|
13399
|
-
Bases: <code><
|
|
13604
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.choices.ChoiceSet" href="choices.html#nautobot.apps.choices.ChoiceSet">ChoiceSet</a></code></p>
|
|
13400
13605
|
|
|
13401
13606
|
|
|
13402
|
-
|
|
13607
|
+
<p>Page (or more properly tab) column layout choices.</p>
|
|
13403
13608
|
|
|
13404
13609
|
|
|
13405
13610
|
<p><span class="doc-section-title">Attributes:</span></p>
|
|
@@ -13413,9 +13618,9 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13413
13618
|
</thead>
|
|
13414
13619
|
<tbody>
|
|
13415
13620
|
<tr class="doc-section-item">
|
|
13416
|
-
<td><code><
|
|
13621
|
+
<td><code><span title="nautobot.apps.ui.LayoutChoices.TWO_OVER_ONE">TWO_OVER_ONE</span></code></td>
|
|
13417
13622
|
<td>
|
|
13418
|
-
<code
|
|
13623
|
+
<code>str</code>
|
|
13419
13624
|
</td>
|
|
13420
13625
|
<td>
|
|
13421
13626
|
<div class="doc-md-description">
|
|
@@ -13424,9 +13629,9 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13424
13629
|
</td>
|
|
13425
13630
|
</tr>
|
|
13426
13631
|
<tr class="doc-section-item">
|
|
13427
|
-
<td><code><
|
|
13632
|
+
<td><code><span title="nautobot.apps.ui.LayoutChoices.ONE_OVER_TWO">ONE_OVER_TWO</span></code></td>
|
|
13428
13633
|
<td>
|
|
13429
|
-
<code
|
|
13634
|
+
<code>str</code>
|
|
13430
13635
|
</td>
|
|
13431
13636
|
<td>
|
|
13432
13637
|
<div class="doc-md-description">
|
|
@@ -13435,9 +13640,9 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13435
13640
|
</td>
|
|
13436
13641
|
</tr>
|
|
13437
13642
|
<tr class="doc-section-item">
|
|
13438
|
-
<td><code><
|
|
13643
|
+
<td><code><span title="nautobot.apps.ui.LayoutChoices.DEFAULT">DEFAULT</span></code></td>
|
|
13439
13644
|
<td>
|
|
13440
|
-
<code
|
|
13645
|
+
<code>str</code>
|
|
13441
13646
|
</td>
|
|
13442
13647
|
<td>
|
|
13443
13648
|
<div class="doc-md-description">
|
|
@@ -13451,6 +13656,11 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13451
13656
|
|
|
13452
13657
|
|
|
13453
13658
|
|
|
13659
|
+
|
|
13660
|
+
|
|
13661
|
+
|
|
13662
|
+
|
|
13663
|
+
|
|
13454
13664
|
<div class="doc doc-children">
|
|
13455
13665
|
|
|
13456
13666
|
|
|
@@ -13482,10 +13692,15 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13482
13692
|
|
|
13483
13693
|
<div class="doc doc-contents ">
|
|
13484
13694
|
<p class="doc doc-class-bases">
|
|
13485
|
-
Bases: <code><
|
|
13695
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.nav.NavMenuButton" href="#nautobot.apps.ui.NavMenuButton">NavMenuButton</a></code></p>
|
|
13696
|
+
|
|
13697
|
+
|
|
13698
|
+
<p>Add button subclass.</p>
|
|
13699
|
+
|
|
13700
|
+
|
|
13701
|
+
|
|
13486
13702
|
|
|
13487
13703
|
|
|
13488
|
-
<p>Add button subclass.</p>
|
|
13489
13704
|
|
|
13490
13705
|
|
|
13491
13706
|
|
|
@@ -13511,7 +13726,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13511
13726
|
|
|
13512
13727
|
<div class="doc doc-contents ">
|
|
13513
13728
|
|
|
13514
|
-
|
|
13729
|
+
<p>Ensure button properties.</p>
|
|
13515
13730
|
|
|
13516
13731
|
</div>
|
|
13517
13732
|
|
|
@@ -13538,10 +13753,15 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13538
13753
|
|
|
13539
13754
|
<div class="doc doc-contents ">
|
|
13540
13755
|
<p class="doc doc-class-bases">
|
|
13541
|
-
Bases: <code><
|
|
13756
|
+
Bases: <code><span title="abc.ABC">ABC</span></code></p>
|
|
13757
|
+
|
|
13758
|
+
|
|
13759
|
+
<p>Base class for navigation classes.</p>
|
|
13760
|
+
|
|
13761
|
+
|
|
13762
|
+
|
|
13542
13763
|
|
|
13543
13764
|
|
|
13544
|
-
<p>Base class for navigation classes.</p>
|
|
13545
13765
|
|
|
13546
13766
|
|
|
13547
13767
|
|
|
@@ -13559,7 +13779,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13559
13779
|
|
|
13560
13780
|
|
|
13561
13781
|
<h3 id="nautobot.apps.ui.NavMenuBase.fixed_fields" class="doc doc-heading">
|
|
13562
|
-
<code class="highlight language-python"><span class="n">fixed_fields</span
|
|
13782
|
+
<code class="highlight language-python"><span class="n">fixed_fields</span></code>
|
|
13563
13783
|
|
|
13564
13784
|
<span class="doc doc-labels">
|
|
13565
13785
|
<small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
|
|
@@ -13571,7 +13791,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13571
13791
|
|
|
13572
13792
|
<div class="doc doc-contents ">
|
|
13573
13793
|
|
|
13574
|
-
|
|
13794
|
+
<p>Tuple of (name, attribute) entries describing fields that may not be altered after declaration.</p>
|
|
13575
13795
|
</div>
|
|
13576
13796
|
|
|
13577
13797
|
</div>
|
|
@@ -13581,7 +13801,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13581
13801
|
|
|
13582
13802
|
|
|
13583
13803
|
<h3 id="nautobot.apps.ui.NavMenuBase.initial_dict" class="doc doc-heading">
|
|
13584
|
-
<code class="highlight language-python"><span class="n">initial_dict</span
|
|
13804
|
+
<code class="highlight language-python"><span class="n">initial_dict</span></code>
|
|
13585
13805
|
|
|
13586
13806
|
<span class="doc doc-labels">
|
|
13587
13807
|
<small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small>
|
|
@@ -13593,7 +13813,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13593
13813
|
|
|
13594
13814
|
<div class="doc doc-contents ">
|
|
13595
13815
|
|
|
13596
|
-
|
|
13816
|
+
<p>Attributes to be stored when adding this item to the nav menu data for the first time.</p>
|
|
13597
13817
|
</div>
|
|
13598
13818
|
|
|
13599
13819
|
</div>
|
|
@@ -13621,10 +13841,15 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13621
13841
|
|
|
13622
13842
|
<div class="doc doc-contents ">
|
|
13623
13843
|
<p class="doc doc-class-bases">
|
|
13624
|
-
Bases: <code><
|
|
13844
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.nav.NavMenuBase" href="#nautobot.apps.ui.NavMenuBase">NavMenuBase</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.base.PermissionsMixin" href="#nautobot.apps.ui.PermissionsMixin">PermissionsMixin</a></code></p>
|
|
13845
|
+
|
|
13846
|
+
|
|
13847
|
+
<p>This class represents a button within a NavMenuItem.</p>
|
|
13848
|
+
|
|
13849
|
+
|
|
13850
|
+
|
|
13625
13851
|
|
|
13626
13852
|
|
|
13627
|
-
<p>This class represents a button within a NavMenuItem.</p>
|
|
13628
13853
|
|
|
13629
13854
|
|
|
13630
13855
|
|
|
@@ -13642,7 +13867,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13642
13867
|
|
|
13643
13868
|
|
|
13644
13869
|
<h3 id="nautobot.apps.ui.NavMenuButton.fixed_fields" class="doc doc-heading">
|
|
13645
|
-
<code class="highlight language-python"><span class="n">fixed_fields</span
|
|
13870
|
+
<code class="highlight language-python"><span class="n">fixed_fields</span></code>
|
|
13646
13871
|
|
|
13647
13872
|
<span class="doc doc-labels">
|
|
13648
13873
|
<small class="doc doc-label doc-label-property"><code>property</code></small>
|
|
@@ -13653,7 +13878,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13653
13878
|
|
|
13654
13879
|
<div class="doc doc-contents ">
|
|
13655
13880
|
|
|
13656
|
-
|
|
13881
|
+
<p>Tuple of (name, attribute) entries describing fields that may not be altered after declaration.</p>
|
|
13657
13882
|
</div>
|
|
13658
13883
|
|
|
13659
13884
|
</div>
|
|
@@ -13663,7 +13888,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13663
13888
|
|
|
13664
13889
|
|
|
13665
13890
|
<h3 id="nautobot.apps.ui.NavMenuButton.initial_dict" class="doc doc-heading">
|
|
13666
|
-
<code class="highlight language-python"><span class="n">initial_dict</span
|
|
13891
|
+
<code class="highlight language-python"><span class="n">initial_dict</span></code>
|
|
13667
13892
|
|
|
13668
13893
|
<span class="doc doc-labels">
|
|
13669
13894
|
<small class="doc doc-label doc-label-property"><code>property</code></small>
|
|
@@ -13674,7 +13899,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13674
13899
|
|
|
13675
13900
|
<div class="doc doc-contents ">
|
|
13676
13901
|
|
|
13677
|
-
|
|
13902
|
+
<p>Attributes to be stored when adding this item to the nav menu data for the first time.</p>
|
|
13678
13903
|
</div>
|
|
13679
13904
|
|
|
13680
13905
|
</div>
|
|
@@ -13692,7 +13917,7 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13692
13917
|
|
|
13693
13918
|
<div class="doc doc-contents ">
|
|
13694
13919
|
|
|
13695
|
-
|
|
13920
|
+
<p>Ensure button properties.</p>
|
|
13696
13921
|
|
|
13697
13922
|
|
|
13698
13923
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -13707,9 +13932,11 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13707
13932
|
</thead>
|
|
13708
13933
|
<tbody>
|
|
13709
13934
|
<tr class="doc-section-item">
|
|
13710
|
-
<td><code>link</code></td>
|
|
13711
13935
|
<td>
|
|
13712
|
-
|
|
13936
|
+
<code>link</code>
|
|
13937
|
+
</td>
|
|
13938
|
+
<td>
|
|
13939
|
+
<code>str</code>
|
|
13713
13940
|
</td>
|
|
13714
13941
|
<td>
|
|
13715
13942
|
<div class="doc-md-description">
|
|
@@ -13721,9 +13948,11 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13721
13948
|
</td>
|
|
13722
13949
|
</tr>
|
|
13723
13950
|
<tr class="doc-section-item">
|
|
13724
|
-
<td><code>title</code></td>
|
|
13725
13951
|
<td>
|
|
13726
|
-
|
|
13952
|
+
<code>title</code>
|
|
13953
|
+
</td>
|
|
13954
|
+
<td>
|
|
13955
|
+
<code>str</code>
|
|
13727
13956
|
</td>
|
|
13728
13957
|
<td>
|
|
13729
13958
|
<div class="doc-md-description">
|
|
@@ -13735,9 +13964,11 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13735
13964
|
</td>
|
|
13736
13965
|
</tr>
|
|
13737
13966
|
<tr class="doc-section-item">
|
|
13738
|
-
<td><code>icon_class</code></td>
|
|
13739
13967
|
<td>
|
|
13740
|
-
|
|
13968
|
+
<code>icon_class</code>
|
|
13969
|
+
</td>
|
|
13970
|
+
<td>
|
|
13971
|
+
<code>str</code>
|
|
13741
13972
|
</td>
|
|
13742
13973
|
<td>
|
|
13743
13974
|
<div class="doc-md-description">
|
|
@@ -13749,9 +13980,11 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13749
13980
|
</td>
|
|
13750
13981
|
</tr>
|
|
13751
13982
|
<tr class="doc-section-item">
|
|
13752
|
-
<td><code>button_class</code></td>
|
|
13753
13983
|
<td>
|
|
13754
|
-
|
|
13984
|
+
<code>button_class</code>
|
|
13985
|
+
</td>
|
|
13986
|
+
<td>
|
|
13987
|
+
<code>str</code>
|
|
13755
13988
|
</td>
|
|
13756
13989
|
<td>
|
|
13757
13990
|
<div class="doc-md-description">
|
|
@@ -13759,13 +13992,15 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13759
13992
|
</div>
|
|
13760
13993
|
</td>
|
|
13761
13994
|
<td>
|
|
13762
|
-
<code><
|
|
13995
|
+
<code><span title="nautobot.core.choices.ButtonActionColorChoices.DEFAULT">DEFAULT</span></code>
|
|
13763
13996
|
</td>
|
|
13764
13997
|
</tr>
|
|
13765
13998
|
<tr class="doc-section-item">
|
|
13766
|
-
<td><code>permissions</code></td>
|
|
13767
13999
|
<td>
|
|
13768
|
-
|
|
14000
|
+
<code>permissions</code>
|
|
14001
|
+
</td>
|
|
14002
|
+
<td>
|
|
14003
|
+
<code>list</code>
|
|
13769
14004
|
</td>
|
|
13770
14005
|
<td>
|
|
13771
14006
|
<div class="doc-md-description">
|
|
@@ -13777,9 +14012,11 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13777
14012
|
</td>
|
|
13778
14013
|
</tr>
|
|
13779
14014
|
<tr class="doc-section-item">
|
|
13780
|
-
<td><code>weight</code></td>
|
|
13781
14015
|
<td>
|
|
13782
|
-
|
|
14016
|
+
<code>weight</code>
|
|
14017
|
+
</td>
|
|
14018
|
+
<td>
|
|
14019
|
+
<code>int</code>
|
|
13783
14020
|
</td>
|
|
13784
14021
|
<td>
|
|
13785
14022
|
<div class="doc-md-description">
|
|
@@ -13791,9 +14028,11 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13791
14028
|
</td>
|
|
13792
14029
|
</tr>
|
|
13793
14030
|
<tr class="doc-section-item">
|
|
13794
|
-
<td><code>query_params</code></td>
|
|
13795
14031
|
<td>
|
|
13796
|
-
|
|
14032
|
+
<code>query_params</code>
|
|
14033
|
+
</td>
|
|
14034
|
+
<td>
|
|
14035
|
+
<code>dict</code>
|
|
13797
14036
|
</td>
|
|
13798
14037
|
<td>
|
|
13799
14038
|
<div class="doc-md-description">
|
|
@@ -13832,16 +14071,21 @@ May return <code>placeholder(value)</code> to display a consistent placeholder r
|
|
|
13832
14071
|
|
|
13833
14072
|
<div class="doc doc-contents ">
|
|
13834
14073
|
<p class="doc doc-class-bases">
|
|
13835
|
-
Bases: <code><
|
|
14074
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.nav.NavMenuBase" href="#nautobot.apps.ui.NavMenuBase">NavMenuBase</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.base.PermissionsMixin" href="#nautobot.apps.ui.PermissionsMixin">PermissionsMixin</a></code></p>
|
|
13836
14075
|
|
|
13837
14076
|
|
|
13838
|
-
|
|
14077
|
+
<p>Ths class represents a navigation menu group. This is built up from a name and a weight value. The name is
|
|
13839
14078
|
the display text and the weight defines its position in the navbar.</p>
|
|
13840
14079
|
<p>Items are each specified as a list of NavMenuItem instances.</p>
|
|
13841
14080
|
|
|
13842
14081
|
|
|
13843
14082
|
|
|
13844
14083
|
|
|
14084
|
+
|
|
14085
|
+
|
|
14086
|
+
|
|
14087
|
+
|
|
14088
|
+
|
|
13845
14089
|
<div class="doc doc-children">
|
|
13846
14090
|
|
|
13847
14091
|
|
|
@@ -13855,7 +14099,7 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
13855
14099
|
|
|
13856
14100
|
|
|
13857
14101
|
<h3 id="nautobot.apps.ui.NavMenuGroup.fixed_fields" class="doc doc-heading">
|
|
13858
|
-
<code class="highlight language-python"><span class="n">fixed_fields</span
|
|
14102
|
+
<code class="highlight language-python"><span class="n">fixed_fields</span></code>
|
|
13859
14103
|
|
|
13860
14104
|
<span class="doc doc-labels">
|
|
13861
14105
|
<small class="doc doc-label doc-label-property"><code>property</code></small>
|
|
@@ -13866,7 +14110,7 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
13866
14110
|
|
|
13867
14111
|
<div class="doc doc-contents ">
|
|
13868
14112
|
|
|
13869
|
-
|
|
14113
|
+
<p>Tuple of (name, attribute) entries describing fields that may not be altered after declaration.</p>
|
|
13870
14114
|
</div>
|
|
13871
14115
|
|
|
13872
14116
|
</div>
|
|
@@ -13876,7 +14120,7 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
13876
14120
|
|
|
13877
14121
|
|
|
13878
14122
|
<h3 id="nautobot.apps.ui.NavMenuGroup.initial_dict" class="doc doc-heading">
|
|
13879
|
-
<code class="highlight language-python"><span class="n">initial_dict</span
|
|
14123
|
+
<code class="highlight language-python"><span class="n">initial_dict</span></code>
|
|
13880
14124
|
|
|
13881
14125
|
<span class="doc doc-labels">
|
|
13882
14126
|
<small class="doc doc-label doc-label-property"><code>property</code></small>
|
|
@@ -13887,7 +14131,7 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
13887
14131
|
|
|
13888
14132
|
<div class="doc doc-contents ">
|
|
13889
14133
|
|
|
13890
|
-
|
|
14134
|
+
<p>Attributes to be stored when adding this item to the nav menu data for the first time.</p>
|
|
13891
14135
|
</div>
|
|
13892
14136
|
|
|
13893
14137
|
</div>
|
|
@@ -13905,7 +14149,7 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
13905
14149
|
|
|
13906
14150
|
<div class="doc doc-contents ">
|
|
13907
14151
|
|
|
13908
|
-
|
|
14152
|
+
<p>Ensure group properties.</p>
|
|
13909
14153
|
|
|
13910
14154
|
|
|
13911
14155
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -13920,9 +14164,11 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
13920
14164
|
</thead>
|
|
13921
14165
|
<tbody>
|
|
13922
14166
|
<tr class="doc-section-item">
|
|
13923
|
-
<td><code>name</code></td>
|
|
13924
14167
|
<td>
|
|
13925
|
-
|
|
14168
|
+
<code>name</code>
|
|
14169
|
+
</td>
|
|
14170
|
+
<td>
|
|
14171
|
+
<code>str</code>
|
|
13926
14172
|
</td>
|
|
13927
14173
|
<td>
|
|
13928
14174
|
<div class="doc-md-description">
|
|
@@ -13934,9 +14180,11 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
13934
14180
|
</td>
|
|
13935
14181
|
</tr>
|
|
13936
14182
|
<tr class="doc-section-item">
|
|
13937
|
-
<td><code>items</code></td>
|
|
13938
14183
|
<td>
|
|
13939
|
-
|
|
14184
|
+
<code>items</code>
|
|
14185
|
+
</td>
|
|
14186
|
+
<td>
|
|
14187
|
+
<code>list</code>
|
|
13940
14188
|
</td>
|
|
13941
14189
|
<td>
|
|
13942
14190
|
<div class="doc-md-description">
|
|
@@ -13948,9 +14196,11 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
13948
14196
|
</td>
|
|
13949
14197
|
</tr>
|
|
13950
14198
|
<tr class="doc-section-item">
|
|
13951
|
-
<td><code>weight</code></td>
|
|
13952
14199
|
<td>
|
|
13953
|
-
|
|
14200
|
+
<code>weight</code>
|
|
14201
|
+
</td>
|
|
14202
|
+
<td>
|
|
14203
|
+
<code>int</code>
|
|
13954
14204
|
</td>
|
|
13955
14205
|
<td>
|
|
13956
14206
|
<div class="doc-md-description">
|
|
@@ -13989,10 +14239,15 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
13989
14239
|
|
|
13990
14240
|
<div class="doc doc-contents ">
|
|
13991
14241
|
<p class="doc doc-class-bases">
|
|
13992
|
-
Bases: <code><
|
|
14242
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.nav.NavMenuButton" href="#nautobot.apps.ui.NavMenuButton">NavMenuButton</a></code></p>
|
|
14243
|
+
|
|
14244
|
+
|
|
14245
|
+
<p>Import button subclass.</p>
|
|
14246
|
+
|
|
14247
|
+
|
|
14248
|
+
|
|
13993
14249
|
|
|
13994
14250
|
|
|
13995
|
-
<p>Import button subclass.</p>
|
|
13996
14251
|
|
|
13997
14252
|
|
|
13998
14253
|
|
|
@@ -14018,7 +14273,7 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14018
14273
|
|
|
14019
14274
|
<div class="doc doc-contents ">
|
|
14020
14275
|
|
|
14021
|
-
|
|
14276
|
+
<p>Ensure button properties.</p>
|
|
14022
14277
|
|
|
14023
14278
|
</div>
|
|
14024
14279
|
|
|
@@ -14045,10 +14300,10 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14045
14300
|
|
|
14046
14301
|
<div class="doc doc-contents ">
|
|
14047
14302
|
<p class="doc doc-class-bases">
|
|
14048
|
-
Bases: <code><
|
|
14303
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.nav.NavMenuBase" href="#nautobot.apps.ui.NavMenuBase">NavMenuBase</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.base.PermissionsMixin" href="#nautobot.apps.ui.PermissionsMixin">PermissionsMixin</a></code></p>
|
|
14049
14304
|
|
|
14050
14305
|
|
|
14051
|
-
|
|
14306
|
+
<p>This class represents a navigation menu item. This constitutes primary link and its text, but also allows for
|
|
14052
14307
|
specifying additional link buttons that appear to the right of the item in the nav menu.</p>
|
|
14053
14308
|
<p>Links are specified as Django reverse URL strings.
|
|
14054
14309
|
Buttons are each specified as a list of NavMenuButton instances.</p>
|
|
@@ -14056,6 +14311,11 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
|
|
|
14056
14311
|
|
|
14057
14312
|
|
|
14058
14313
|
|
|
14314
|
+
|
|
14315
|
+
|
|
14316
|
+
|
|
14317
|
+
|
|
14318
|
+
|
|
14059
14319
|
<div class="doc doc-children">
|
|
14060
14320
|
|
|
14061
14321
|
|
|
@@ -14069,7 +14329,7 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
|
|
|
14069
14329
|
|
|
14070
14330
|
|
|
14071
14331
|
<h3 id="nautobot.apps.ui.NavMenuItem.fixed_fields" class="doc doc-heading">
|
|
14072
|
-
<code class="highlight language-python"><span class="n">fixed_fields</span
|
|
14332
|
+
<code class="highlight language-python"><span class="n">fixed_fields</span></code>
|
|
14073
14333
|
|
|
14074
14334
|
<span class="doc doc-labels">
|
|
14075
14335
|
<small class="doc doc-label doc-label-property"><code>property</code></small>
|
|
@@ -14080,7 +14340,7 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
|
|
|
14080
14340
|
|
|
14081
14341
|
<div class="doc doc-contents ">
|
|
14082
14342
|
|
|
14083
|
-
|
|
14343
|
+
<p>Tuple of (name, attribute) entries describing fields that may not be altered after declaration.</p>
|
|
14084
14344
|
</div>
|
|
14085
14345
|
|
|
14086
14346
|
</div>
|
|
@@ -14090,7 +14350,7 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
|
|
|
14090
14350
|
|
|
14091
14351
|
|
|
14092
14352
|
<h3 id="nautobot.apps.ui.NavMenuItem.initial_dict" class="doc doc-heading">
|
|
14093
|
-
<code class="highlight language-python"><span class="n">initial_dict</span
|
|
14353
|
+
<code class="highlight language-python"><span class="n">initial_dict</span></code>
|
|
14094
14354
|
|
|
14095
14355
|
<span class="doc doc-labels">
|
|
14096
14356
|
<small class="doc doc-label doc-label-property"><code>property</code></small>
|
|
@@ -14101,7 +14361,7 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
|
|
|
14101
14361
|
|
|
14102
14362
|
<div class="doc doc-contents ">
|
|
14103
14363
|
|
|
14104
|
-
|
|
14364
|
+
<p>Attributes to be stored when adding this item to the nav menu data for the first time.</p>
|
|
14105
14365
|
</div>
|
|
14106
14366
|
|
|
14107
14367
|
</div>
|
|
@@ -14119,7 +14379,7 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
|
|
|
14119
14379
|
|
|
14120
14380
|
<div class="doc doc-contents ">
|
|
14121
14381
|
|
|
14122
|
-
|
|
14382
|
+
<p>Ensure item properties.</p>
|
|
14123
14383
|
|
|
14124
14384
|
|
|
14125
14385
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -14134,9 +14394,11 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
|
|
|
14134
14394
|
</thead>
|
|
14135
14395
|
<tbody>
|
|
14136
14396
|
<tr class="doc-section-item">
|
|
14137
|
-
<td><code>link</code></td>
|
|
14138
14397
|
<td>
|
|
14139
|
-
|
|
14398
|
+
<code>link</code>
|
|
14399
|
+
</td>
|
|
14400
|
+
<td>
|
|
14401
|
+
<code>str</code>
|
|
14140
14402
|
</td>
|
|
14141
14403
|
<td>
|
|
14142
14404
|
<div class="doc-md-description">
|
|
@@ -14148,9 +14410,11 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
|
|
|
14148
14410
|
</td>
|
|
14149
14411
|
</tr>
|
|
14150
14412
|
<tr class="doc-section-item">
|
|
14151
|
-
<td><code>name</code></td>
|
|
14152
14413
|
<td>
|
|
14153
|
-
|
|
14414
|
+
<code>name</code>
|
|
14415
|
+
</td>
|
|
14416
|
+
<td>
|
|
14417
|
+
<code>str</code>
|
|
14154
14418
|
</td>
|
|
14155
14419
|
<td>
|
|
14156
14420
|
<div class="doc-md-description">
|
|
@@ -14162,9 +14426,11 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
|
|
|
14162
14426
|
</td>
|
|
14163
14427
|
</tr>
|
|
14164
14428
|
<tr class="doc-section-item">
|
|
14165
|
-
<td><code>args</code></td>
|
|
14166
14429
|
<td>
|
|
14167
|
-
|
|
14430
|
+
<code>args</code>
|
|
14431
|
+
</td>
|
|
14432
|
+
<td>
|
|
14433
|
+
<code>list</code>
|
|
14168
14434
|
</td>
|
|
14169
14435
|
<td>
|
|
14170
14436
|
<div class="doc-md-description">
|
|
@@ -14176,9 +14442,11 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
|
|
|
14176
14442
|
</td>
|
|
14177
14443
|
</tr>
|
|
14178
14444
|
<tr class="doc-section-item">
|
|
14179
|
-
<td><code>kwargs</code></td>
|
|
14180
14445
|
<td>
|
|
14181
|
-
|
|
14446
|
+
<code>kwargs</code>
|
|
14447
|
+
</td>
|
|
14448
|
+
<td>
|
|
14449
|
+
<code>dict</code>
|
|
14182
14450
|
</td>
|
|
14183
14451
|
<td>
|
|
14184
14452
|
<div class="doc-md-description">
|
|
@@ -14190,9 +14458,11 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
|
|
|
14190
14458
|
</td>
|
|
14191
14459
|
</tr>
|
|
14192
14460
|
<tr class="doc-section-item">
|
|
14193
|
-
<td><code>query_params</code></td>
|
|
14194
14461
|
<td>
|
|
14195
|
-
|
|
14462
|
+
<code>query_params</code>
|
|
14463
|
+
</td>
|
|
14464
|
+
<td>
|
|
14465
|
+
<code>dict</code>
|
|
14196
14466
|
</td>
|
|
14197
14467
|
<td>
|
|
14198
14468
|
<div class="doc-md-description">
|
|
@@ -14204,9 +14474,11 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
|
|
|
14204
14474
|
</td>
|
|
14205
14475
|
</tr>
|
|
14206
14476
|
<tr class="doc-section-item">
|
|
14207
|
-
<td><code>permissions</code></td>
|
|
14208
14477
|
<td>
|
|
14209
|
-
|
|
14478
|
+
<code>permissions</code>
|
|
14479
|
+
</td>
|
|
14480
|
+
<td>
|
|
14481
|
+
<code>list</code>
|
|
14210
14482
|
</td>
|
|
14211
14483
|
<td>
|
|
14212
14484
|
<div class="doc-md-description">
|
|
@@ -14218,9 +14490,11 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
|
|
|
14218
14490
|
</td>
|
|
14219
14491
|
</tr>
|
|
14220
14492
|
<tr class="doc-section-item">
|
|
14221
|
-
<td><code>buttons</code></td>
|
|
14222
14493
|
<td>
|
|
14223
|
-
|
|
14494
|
+
<code>buttons</code>
|
|
14495
|
+
</td>
|
|
14496
|
+
<td>
|
|
14497
|
+
<code>list</code>
|
|
14224
14498
|
</td>
|
|
14225
14499
|
<td>
|
|
14226
14500
|
<div class="doc-md-description">
|
|
@@ -14232,9 +14506,11 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
|
|
|
14232
14506
|
</td>
|
|
14233
14507
|
</tr>
|
|
14234
14508
|
<tr class="doc-section-item">
|
|
14235
|
-
<td><code>weight</code></td>
|
|
14236
14509
|
<td>
|
|
14237
|
-
|
|
14510
|
+
<code>weight</code>
|
|
14511
|
+
</td>
|
|
14512
|
+
<td>
|
|
14513
|
+
<code>int</code>
|
|
14238
14514
|
</td>
|
|
14239
14515
|
<td>
|
|
14240
14516
|
<div class="doc-md-description">
|
|
@@ -14273,16 +14549,21 @@ Buttons are each specified as a list of NavMenuButton instances.</p>
|
|
|
14273
14549
|
|
|
14274
14550
|
<div class="doc doc-contents ">
|
|
14275
14551
|
<p class="doc doc-class-bases">
|
|
14276
|
-
Bases: <code><
|
|
14552
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.nav.NavMenuBase" href="#nautobot.apps.ui.NavMenuBase">NavMenuBase</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.base.PermissionsMixin" href="#nautobot.apps.ui.PermissionsMixin">PermissionsMixin</a></code></p>
|
|
14277
14553
|
|
|
14278
14554
|
|
|
14279
|
-
|
|
14555
|
+
<p>Ths class represents a navigation menu tab. This is built up from a name and a weight value. The name is
|
|
14280
14556
|
the display text and the weight defines its position in the navbar.</p>
|
|
14281
14557
|
<p>Groups are each specified as a list of NavMenuGroup instances.</p>
|
|
14282
14558
|
|
|
14283
14559
|
|
|
14284
14560
|
|
|
14285
14561
|
|
|
14562
|
+
|
|
14563
|
+
|
|
14564
|
+
|
|
14565
|
+
|
|
14566
|
+
|
|
14286
14567
|
<div class="doc doc-children">
|
|
14287
14568
|
|
|
14288
14569
|
|
|
@@ -14296,7 +14577,7 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14296
14577
|
|
|
14297
14578
|
|
|
14298
14579
|
<h3 id="nautobot.apps.ui.NavMenuTab.fixed_fields" class="doc doc-heading">
|
|
14299
|
-
<code class="highlight language-python"><span class="n">fixed_fields</span
|
|
14580
|
+
<code class="highlight language-python"><span class="n">fixed_fields</span></code>
|
|
14300
14581
|
|
|
14301
14582
|
<span class="doc doc-labels">
|
|
14302
14583
|
<small class="doc doc-label doc-label-property"><code>property</code></small>
|
|
@@ -14307,7 +14588,7 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14307
14588
|
|
|
14308
14589
|
<div class="doc doc-contents ">
|
|
14309
14590
|
|
|
14310
|
-
|
|
14591
|
+
<p>Tuple of (name, attribute) entries describing fields that may not be altered after declaration.</p>
|
|
14311
14592
|
</div>
|
|
14312
14593
|
|
|
14313
14594
|
</div>
|
|
@@ -14317,7 +14598,7 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14317
14598
|
|
|
14318
14599
|
|
|
14319
14600
|
<h3 id="nautobot.apps.ui.NavMenuTab.initial_dict" class="doc doc-heading">
|
|
14320
|
-
<code class="highlight language-python"><span class="n">initial_dict</span
|
|
14601
|
+
<code class="highlight language-python"><span class="n">initial_dict</span></code>
|
|
14321
14602
|
|
|
14322
14603
|
<span class="doc doc-labels">
|
|
14323
14604
|
<small class="doc doc-label doc-label-property"><code>property</code></small>
|
|
@@ -14328,7 +14609,7 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14328
14609
|
|
|
14329
14610
|
<div class="doc doc-contents ">
|
|
14330
14611
|
|
|
14331
|
-
|
|
14612
|
+
<p>Attributes to be stored when adding this item to the nav menu data for the first time.</p>
|
|
14332
14613
|
</div>
|
|
14333
14614
|
|
|
14334
14615
|
</div>
|
|
@@ -14346,7 +14627,7 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14346
14627
|
|
|
14347
14628
|
<div class="doc doc-contents ">
|
|
14348
14629
|
|
|
14349
|
-
|
|
14630
|
+
<p>Ensure tab properties.</p>
|
|
14350
14631
|
|
|
14351
14632
|
|
|
14352
14633
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -14361,9 +14642,11 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14361
14642
|
</thead>
|
|
14362
14643
|
<tbody>
|
|
14363
14644
|
<tr class="doc-section-item">
|
|
14364
|
-
<td><code>name</code></td>
|
|
14365
14645
|
<td>
|
|
14366
|
-
|
|
14646
|
+
<code>name</code>
|
|
14647
|
+
</td>
|
|
14648
|
+
<td>
|
|
14649
|
+
<code>str</code>
|
|
14367
14650
|
</td>
|
|
14368
14651
|
<td>
|
|
14369
14652
|
<div class="doc-md-description">
|
|
@@ -14375,9 +14658,11 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14375
14658
|
</td>
|
|
14376
14659
|
</tr>
|
|
14377
14660
|
<tr class="doc-section-item">
|
|
14378
|
-
<td><code>permissions</code></td>
|
|
14379
14661
|
<td>
|
|
14380
|
-
|
|
14662
|
+
<code>permissions</code>
|
|
14663
|
+
</td>
|
|
14664
|
+
<td>
|
|
14665
|
+
<code>list</code>
|
|
14381
14666
|
</td>
|
|
14382
14667
|
<td>
|
|
14383
14668
|
<div class="doc-md-description">
|
|
@@ -14389,9 +14674,11 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14389
14674
|
</td>
|
|
14390
14675
|
</tr>
|
|
14391
14676
|
<tr class="doc-section-item">
|
|
14392
|
-
<td><code>groups</code></td>
|
|
14393
14677
|
<td>
|
|
14394
|
-
|
|
14678
|
+
<code>groups</code>
|
|
14679
|
+
</td>
|
|
14680
|
+
<td>
|
|
14681
|
+
<code>list</code>
|
|
14395
14682
|
</td>
|
|
14396
14683
|
<td>
|
|
14397
14684
|
<div class="doc-md-description">
|
|
@@ -14403,9 +14690,11 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14403
14690
|
</td>
|
|
14404
14691
|
</tr>
|
|
14405
14692
|
<tr class="doc-section-item">
|
|
14406
|
-
<td><code>weight</code></td>
|
|
14407
14693
|
<td>
|
|
14408
|
-
|
|
14694
|
+
<code>weight</code>
|
|
14695
|
+
</td>
|
|
14696
|
+
<td>
|
|
14697
|
+
<code>int</code>
|
|
14409
14698
|
</td>
|
|
14410
14699
|
<td>
|
|
14411
14700
|
<div class="doc-md-description">
|
|
@@ -14445,7 +14734,7 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14445
14734
|
<div class="doc doc-contents ">
|
|
14446
14735
|
|
|
14447
14736
|
|
|
14448
|
-
|
|
14737
|
+
<p>Base class for UI framework definition of the contents of an Object Detail (Object Retrieve) page.</p>
|
|
14449
14738
|
<p>This currently defines the tabs and their panel contents, but does NOT describe the page title, breadcrumbs, etc.</p>
|
|
14450
14739
|
<p>Basic usage for a <code>NautobotUIViewSet</code> looks like:</p>
|
|
14451
14740
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="kn">from</span> <span class="nn">nautobot.apps.ui</span> <span class="kn">import</span> <span class="n">ObjectDetailContent</span><span class="p">,</span> <span class="n">ObjectFieldsPanel</span><span class="p">,</span> <span class="n">SectionChoices</span>
|
|
@@ -14462,6 +14751,11 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14462
14751
|
|
|
14463
14752
|
|
|
14464
14753
|
|
|
14754
|
+
|
|
14755
|
+
|
|
14756
|
+
|
|
14757
|
+
|
|
14758
|
+
|
|
14465
14759
|
<div class="doc doc-children">
|
|
14466
14760
|
|
|
14467
14761
|
|
|
@@ -14487,7 +14781,7 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14487
14781
|
|
|
14488
14782
|
<div class="doc doc-contents ">
|
|
14489
14783
|
|
|
14490
|
-
|
|
14784
|
+
<p>The extra buttons defined for this detail view, ordered by their <code>weight</code>.</p>
|
|
14491
14785
|
</div>
|
|
14492
14786
|
|
|
14493
14787
|
</div>
|
|
@@ -14509,7 +14803,7 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14509
14803
|
|
|
14510
14804
|
<div class="doc doc-contents ">
|
|
14511
14805
|
|
|
14512
|
-
|
|
14806
|
+
<p>The tabs defined for this detail view, ordered by their <code>weight</code>.</p>
|
|
14513
14807
|
</div>
|
|
14514
14808
|
|
|
14515
14809
|
</div>
|
|
@@ -14527,7 +14821,7 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14527
14821
|
|
|
14528
14822
|
<div class="doc doc-contents ">
|
|
14529
14823
|
|
|
14530
|
-
|
|
14824
|
+
<p>Create an ObjectDetailContent with a "main" tab and all standard "extras" tabs (advanced, contacts, etc.).</p>
|
|
14531
14825
|
|
|
14532
14826
|
|
|
14533
14827
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -14542,9 +14836,11 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14542
14836
|
</thead>
|
|
14543
14837
|
<tbody>
|
|
14544
14838
|
<tr class="doc-section-item">
|
|
14545
|
-
<td><code>panels</code></td>
|
|
14546
14839
|
<td>
|
|
14547
|
-
|
|
14840
|
+
<code>panels</code>
|
|
14841
|
+
</td>
|
|
14842
|
+
<td>
|
|
14843
|
+
<code>list</code>
|
|
14548
14844
|
</td>
|
|
14549
14845
|
<td>
|
|
14550
14846
|
<div class="doc-md-description">
|
|
@@ -14557,9 +14853,11 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14557
14853
|
</td>
|
|
14558
14854
|
</tr>
|
|
14559
14855
|
<tr class="doc-section-item">
|
|
14560
|
-
<td><code>layout</code></td>
|
|
14561
14856
|
<td>
|
|
14562
|
-
|
|
14857
|
+
<code>layout</code>
|
|
14858
|
+
</td>
|
|
14859
|
+
<td>
|
|
14860
|
+
<code>str</code>
|
|
14563
14861
|
</td>
|
|
14564
14862
|
<td>
|
|
14565
14863
|
<div class="doc-md-description">
|
|
@@ -14567,13 +14865,15 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14567
14865
|
</div>
|
|
14568
14866
|
</td>
|
|
14569
14867
|
<td>
|
|
14570
|
-
<code><
|
|
14868
|
+
<code><span title="nautobot.core.ui.choices.LayoutChoices.DEFAULT">DEFAULT</span></code>
|
|
14571
14869
|
</td>
|
|
14572
14870
|
</tr>
|
|
14573
14871
|
<tr class="doc-section-item">
|
|
14574
|
-
<td><code>extra_buttons</code></td>
|
|
14575
14872
|
<td>
|
|
14576
|
-
|
|
14873
|
+
<code>extra_buttons</code>
|
|
14874
|
+
</td>
|
|
14875
|
+
<td>
|
|
14876
|
+
<code>list</code>
|
|
14577
14877
|
</td>
|
|
14578
14878
|
<td>
|
|
14579
14879
|
<div class="doc-md-description">
|
|
@@ -14586,9 +14886,11 @@ the display text and the weight defines its position in the navbar.</p>
|
|
|
14586
14886
|
</td>
|
|
14587
14887
|
</tr>
|
|
14588
14888
|
<tr class="doc-section-item">
|
|
14589
|
-
<td><code>extra_tabs</code></td>
|
|
14590
14889
|
<td>
|
|
14591
|
-
|
|
14890
|
+
<code>extra_tabs</code>
|
|
14891
|
+
</td>
|
|
14892
|
+
<td>
|
|
14893
|
+
<code>list</code>
|
|
14592
14894
|
</td>
|
|
14593
14895
|
<td>
|
|
14594
14896
|
<div class="doc-md-description">
|
|
@@ -14628,10 +14930,15 @@ dynamic-groups, metadata, etc.) do not need to be specified as they will be auto
|
|
|
14628
14930
|
|
|
14629
14931
|
<div class="doc doc-contents ">
|
|
14630
14932
|
<p class="doc doc-class-bases">
|
|
14631
|
-
Bases: <code><
|
|
14933
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.KeyValueTablePanel" href="#nautobot.apps.ui.KeyValueTablePanel">KeyValueTablePanel</a></code></p>
|
|
14934
|
+
|
|
14935
|
+
|
|
14936
|
+
<p>A panel that renders a table of object instance attributes and their values.</p>
|
|
14937
|
+
|
|
14938
|
+
|
|
14939
|
+
|
|
14632
14940
|
|
|
14633
14941
|
|
|
14634
|
-
<p>A panel that renders a table of object instance attributes and their values.</p>
|
|
14635
14942
|
|
|
14636
14943
|
|
|
14637
14944
|
|
|
@@ -14657,7 +14964,7 @@ dynamic-groups, metadata, etc.) do not need to be specified as they will be auto
|
|
|
14657
14964
|
|
|
14658
14965
|
<div class="doc doc-contents ">
|
|
14659
14966
|
|
|
14660
|
-
|
|
14967
|
+
<p>Instantiate an ObjectFieldsPanel.</p>
|
|
14661
14968
|
|
|
14662
14969
|
|
|
14663
14970
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -14672,9 +14979,11 @@ dynamic-groups, metadata, etc.) do not need to be specified as they will be auto
|
|
|
14672
14979
|
</thead>
|
|
14673
14980
|
<tbody>
|
|
14674
14981
|
<tr class="doc-section-item">
|
|
14675
|
-
<td><code>fields</code></td>
|
|
14676
14982
|
<td>
|
|
14677
|
-
|
|
14983
|
+
<code>fields</code>
|
|
14984
|
+
</td>
|
|
14985
|
+
<td>
|
|
14986
|
+
<code>(str, list)</code>
|
|
14678
14987
|
</td>
|
|
14679
14988
|
<td>
|
|
14680
14989
|
<div class="doc-md-description">
|
|
@@ -14688,9 +14997,11 @@ are any hidden fields, nor the specially handled <code>id</code>, <code>created<
|
|
|
14688
14997
|
</td>
|
|
14689
14998
|
</tr>
|
|
14690
14999
|
<tr class="doc-section-item">
|
|
14691
|
-
<td><code>exclude_fields</code></td>
|
|
14692
15000
|
<td>
|
|
14693
|
-
|
|
15001
|
+
<code>exclude_fields</code>
|
|
15002
|
+
</td>
|
|
15003
|
+
<td>
|
|
15004
|
+
<code>list</code>
|
|
14694
15005
|
</td>
|
|
14695
15006
|
<td>
|
|
14696
15007
|
<div class="doc-md-description">
|
|
@@ -14702,9 +15013,11 @@ are any hidden fields, nor the specially handled <code>id</code>, <code>created<
|
|
|
14702
15013
|
</td>
|
|
14703
15014
|
</tr>
|
|
14704
15015
|
<tr class="doc-section-item">
|
|
14705
|
-
<td><code>context_object_key</code></td>
|
|
14706
15016
|
<td>
|
|
14707
|
-
|
|
15017
|
+
<code>context_object_key</code>
|
|
15018
|
+
</td>
|
|
15019
|
+
<td>
|
|
15020
|
+
<code>str</code>
|
|
14708
15021
|
</td>
|
|
14709
15022
|
<td>
|
|
14710
15023
|
<div class="doc-md-description">
|
|
@@ -14716,9 +15029,11 @@ are any hidden fields, nor the specially handled <code>id</code>, <code>created<
|
|
|
14716
15029
|
</td>
|
|
14717
15030
|
</tr>
|
|
14718
15031
|
<tr class="doc-section-item">
|
|
14719
|
-
<td><code>ignore_nonexistent_fields</code></td>
|
|
14720
15032
|
<td>
|
|
14721
|
-
|
|
15033
|
+
<code>ignore_nonexistent_fields</code>
|
|
15034
|
+
</td>
|
|
15035
|
+
<td>
|
|
15036
|
+
<code>bool</code>
|
|
14722
15037
|
</td>
|
|
14723
15038
|
<td>
|
|
14724
15039
|
<div class="doc-md-description">
|
|
@@ -14731,9 +15046,11 @@ exist on the provided object; otherwise an exception will be raised at render ti
|
|
|
14731
15046
|
</td>
|
|
14732
15047
|
</tr>
|
|
14733
15048
|
<tr class="doc-section-item">
|
|
14734
|
-
<td><code>label</code></td>
|
|
14735
15049
|
<td>
|
|
14736
|
-
|
|
15050
|
+
<code>label</code>
|
|
15051
|
+
</td>
|
|
15052
|
+
<td>
|
|
15053
|
+
<code>str</code>
|
|
14737
15054
|
</td>
|
|
14738
15055
|
<td>
|
|
14739
15056
|
<div class="doc-md-description">
|
|
@@ -14763,7 +15080,7 @@ exist on the provided object; otherwise an exception will be raised at render ti
|
|
|
14763
15080
|
|
|
14764
15081
|
<div class="doc doc-contents ">
|
|
14765
15082
|
|
|
14766
|
-
|
|
15083
|
+
<p>Load data from the object provided in the render context based on the given set of <code>fields</code>.</p>
|
|
14767
15084
|
|
|
14768
15085
|
|
|
14769
15086
|
<p><span class="doc-section-title">Returns:</span></p>
|
|
@@ -14777,7 +15094,7 @@ exist on the provided object; otherwise an exception will be raised at render ti
|
|
|
14777
15094
|
<tbody>
|
|
14778
15095
|
<tr class="doc-section-item">
|
|
14779
15096
|
<td>
|
|
14780
|
-
<code
|
|
15097
|
+
<code>dict</code>
|
|
14781
15098
|
</td>
|
|
14782
15099
|
<td>
|
|
14783
15100
|
<div class="doc-md-description">
|
|
@@ -14803,7 +15120,7 @@ exist on the provided object; otherwise an exception will be raised at render ti
|
|
|
14803
15120
|
|
|
14804
15121
|
<div class="doc doc-contents ">
|
|
14805
15122
|
|
|
14806
|
-
|
|
15123
|
+
<p>Render the <code>verbose_name</code> of the model field whose name corresponds to the given key, if applicable.</p>
|
|
14807
15124
|
|
|
14808
15125
|
</div>
|
|
14809
15126
|
|
|
@@ -14820,7 +15137,7 @@ exist on the provided object; otherwise an exception will be raised at render ti
|
|
|
14820
15137
|
|
|
14821
15138
|
<div class="doc doc-contents ">
|
|
14822
15139
|
|
|
14823
|
-
|
|
15140
|
+
<p>Default to rendering the provided object's <code>verbose_name</code> if no more specific <code>label</code> was defined.</p>
|
|
14824
15141
|
|
|
14825
15142
|
</div>
|
|
14826
15143
|
|
|
@@ -14847,10 +15164,10 @@ exist on the provided object; otherwise an exception will be raised at render ti
|
|
|
14847
15164
|
|
|
14848
15165
|
<div class="doc doc-contents ">
|
|
14849
15166
|
<p class="doc doc-class-bases">
|
|
14850
|
-
Bases: <code><
|
|
15167
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.BaseTextPanel" href="#nautobot.apps.ui.BaseTextPanel">BaseTextPanel</a></code></p>
|
|
14851
15168
|
|
|
14852
15169
|
|
|
14853
|
-
|
|
15170
|
+
<p>Panel that renders text, Markdown, JSON or YAML from the given field on the given object in the context.</p>
|
|
14854
15171
|
|
|
14855
15172
|
|
|
14856
15173
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -14865,9 +15182,11 @@ exist on the provided object; otherwise an exception will be raised at render ti
|
|
|
14865
15182
|
</thead>
|
|
14866
15183
|
<tbody>
|
|
14867
15184
|
<tr class="doc-section-item">
|
|
14868
|
-
<td><code>object_field</code></td>
|
|
14869
15185
|
<td>
|
|
14870
|
-
|
|
15186
|
+
<code>object_field</code>
|
|
15187
|
+
</td>
|
|
15188
|
+
<td>
|
|
15189
|
+
<code>str</code>
|
|
14871
15190
|
</td>
|
|
14872
15191
|
<td>
|
|
14873
15192
|
<div class="doc-md-description">
|
|
@@ -14879,9 +15198,11 @@ exist on the provided object; otherwise an exception will be raised at render ti
|
|
|
14879
15198
|
</td>
|
|
14880
15199
|
</tr>
|
|
14881
15200
|
<tr class="doc-section-item">
|
|
14882
|
-
<td><code>kwargs</code></td>
|
|
14883
15201
|
<td>
|
|
14884
|
-
|
|
15202
|
+
<code>kwargs</code>
|
|
15203
|
+
</td>
|
|
15204
|
+
<td>
|
|
15205
|
+
<code>dict</code>
|
|
14885
15206
|
</td>
|
|
14886
15207
|
<td>
|
|
14887
15208
|
<div class="doc-md-description">
|
|
@@ -14898,6 +15219,11 @@ exist on the provided object; otherwise an exception will be raised at render ti
|
|
|
14898
15219
|
|
|
14899
15220
|
|
|
14900
15221
|
|
|
15222
|
+
|
|
15223
|
+
|
|
15224
|
+
|
|
15225
|
+
|
|
15226
|
+
|
|
14901
15227
|
<div class="doc doc-children">
|
|
14902
15228
|
|
|
14903
15229
|
|
|
@@ -14929,10 +15255,23 @@ exist on the provided object; otherwise an exception will be raised at render ti
|
|
|
14929
15255
|
|
|
14930
15256
|
<div class="doc doc-contents ">
|
|
14931
15257
|
<p class="doc doc-class-bases">
|
|
14932
|
-
Bases: <code><
|
|
15258
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Panel" href="#nautobot.apps.ui.Panel">Panel</a></code></p>
|
|
15259
|
+
|
|
15260
|
+
|
|
15261
|
+
<p>A panel that renders a Table of objects (typically related objects, rather than the "main" object of a view).
|
|
15262
|
+
Has built-in pagination support and "Add" button at bottom of the Table.</p>
|
|
15263
|
+
<p>It renders the django-tables2 classes with Nautobot additions. You can pass the instance of Table Class
|
|
15264
|
+
already configured in context and set the <code>context_table_key</code> or pass a Table Class to <code>__init__</code> via <code>table_class</code>.</p>
|
|
15265
|
+
<p>When <code>table_class</code> is set, you need to pass <code>table_filter</code> or <code>table_attribute</code> for fetching data purpose.</p>
|
|
15266
|
+
<p>Data fetching can be optimized by using <code>select_related_fields</code>, <code>prefetch_related_fields</code>.</p>
|
|
15267
|
+
<p>How Table is displayed can be changed by using <code>include_columns</code>, <code>exclude_columns</code>, <code>table_title</code>,
|
|
15268
|
+
<code>hide_hierarchy_ui</code>, <code>related_field_name</code> or <code>enable_bulk_actions</code>.</p>
|
|
15269
|
+
<p>Please check the Args list for further details.</p>
|
|
15270
|
+
|
|
15271
|
+
|
|
15272
|
+
|
|
14933
15273
|
|
|
14934
15274
|
|
|
14935
|
-
<p>A panel that renders a Table of objects (typically related objects, rather than the "main" object of a view).</p>
|
|
14936
15275
|
|
|
14937
15276
|
|
|
14938
15277
|
|
|
@@ -14958,7 +15297,7 @@ exist on the provided object; otherwise an exception will be raised at render ti
|
|
|
14958
15297
|
|
|
14959
15298
|
<div class="doc doc-contents ">
|
|
14960
15299
|
|
|
14961
|
-
|
|
15300
|
+
<p>Instantiate an ObjectsTable panel.</p>
|
|
14962
15301
|
|
|
14963
15302
|
|
|
14964
15303
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -14973,9 +15312,11 @@ exist on the provided object; otherwise an exception will be raised at render ti
|
|
|
14973
15312
|
</thead>
|
|
14974
15313
|
<tbody>
|
|
14975
15314
|
<tr class="doc-section-item">
|
|
14976
|
-
<td><code>context_table_key</code></td>
|
|
14977
15315
|
<td>
|
|
14978
|
-
|
|
15316
|
+
<code>context_table_key</code>
|
|
15317
|
+
</td>
|
|
15318
|
+
<td>
|
|
15319
|
+
<code>str</code>
|
|
14979
15320
|
</td>
|
|
14980
15321
|
<td>
|
|
14981
15322
|
<div class="doc-md-description">
|
|
@@ -14988,9 +15329,11 @@ Table (<code>BaseTable</code>) instance. Mutually exclusive with <code>table_cla
|
|
|
14988
15329
|
</td>
|
|
14989
15330
|
</tr>
|
|
14990
15331
|
<tr class="doc-section-item">
|
|
14991
|
-
<td><code>table_class</code></td>
|
|
14992
15332
|
<td>
|
|
14993
|
-
|
|
15333
|
+
<code>table_class</code>
|
|
15334
|
+
</td>
|
|
15335
|
+
<td>
|
|
15336
|
+
<code>obj</code>
|
|
14994
15337
|
</td>
|
|
14995
15338
|
<td>
|
|
14996
15339
|
<div class="doc-md-description">
|
|
@@ -15003,9 +15346,11 @@ Mutually exclusive with <code>context_table_key</code>.</p>
|
|
|
15003
15346
|
</td>
|
|
15004
15347
|
</tr>
|
|
15005
15348
|
<tr class="doc-section-item">
|
|
15006
|
-
<td><code>table_filter</code></td>
|
|
15007
15349
|
<td>
|
|
15008
|
-
|
|
15350
|
+
<code>table_filter</code>
|
|
15351
|
+
</td>
|
|
15352
|
+
<td>
|
|
15353
|
+
<code>str</code>
|
|
15009
15354
|
</td>
|
|
15010
15355
|
<td>
|
|
15011
15356
|
<div class="doc-md-description">
|
|
@@ -15020,9 +15365,11 @@ Mutually exclusive with <code>table_attribute</code>.</p>
|
|
|
15020
15365
|
</td>
|
|
15021
15366
|
</tr>
|
|
15022
15367
|
<tr class="doc-section-item">
|
|
15023
|
-
<td><code>table_attribute</code></td>
|
|
15024
15368
|
<td>
|
|
15025
|
-
|
|
15369
|
+
<code>table_attribute</code>
|
|
15370
|
+
</td>
|
|
15371
|
+
<td>
|
|
15372
|
+
<code>str</code>
|
|
15026
15373
|
</td>
|
|
15027
15374
|
<td>
|
|
15028
15375
|
<div class="doc-md-description">
|
|
@@ -15036,9 +15383,11 @@ Mutually exclusive with <code>table_filter</code>.</p>
|
|
|
15036
15383
|
</td>
|
|
15037
15384
|
</tr>
|
|
15038
15385
|
<tr class="doc-section-item">
|
|
15039
|
-
<td><code>select_related_fields</code></td>
|
|
15040
15386
|
<td>
|
|
15041
|
-
|
|
15387
|
+
<code>select_related_fields</code>
|
|
15388
|
+
</td>
|
|
15389
|
+
<td>
|
|
15390
|
+
<code>list</code>
|
|
15042
15391
|
</td>
|
|
15043
15392
|
<td>
|
|
15044
15393
|
<div class="doc-md-description">
|
|
@@ -15050,9 +15399,11 @@ Mutually exclusive with <code>table_filter</code>.</p>
|
|
|
15050
15399
|
</td>
|
|
15051
15400
|
</tr>
|
|
15052
15401
|
<tr class="doc-section-item">
|
|
15053
|
-
<td><code>prefetch_related_fields</code></td>
|
|
15054
15402
|
<td>
|
|
15055
|
-
|
|
15403
|
+
<code>prefetch_related_fields</code>
|
|
15404
|
+
</td>
|
|
15405
|
+
<td>
|
|
15406
|
+
<code>list</code>
|
|
15056
15407
|
</td>
|
|
15057
15408
|
<td>
|
|
15058
15409
|
<div class="doc-md-description">
|
|
@@ -15065,9 +15416,11 @@ method.</p>
|
|
|
15065
15416
|
</td>
|
|
15066
15417
|
</tr>
|
|
15067
15418
|
<tr class="doc-section-item">
|
|
15068
|
-
<td><code>order_by_fields</code></td>
|
|
15069
15419
|
<td>
|
|
15070
|
-
|
|
15420
|
+
<code>order_by_fields</code>
|
|
15421
|
+
</td>
|
|
15422
|
+
<td>
|
|
15423
|
+
<code>list</code>
|
|
15071
15424
|
</td>
|
|
15072
15425
|
<td>
|
|
15073
15426
|
<div class="doc-md-description">
|
|
@@ -15079,9 +15432,11 @@ method.</p>
|
|
|
15079
15432
|
</td>
|
|
15080
15433
|
</tr>
|
|
15081
15434
|
<tr class="doc-section-item">
|
|
15082
|
-
<td><code>max_display_count</code></td>
|
|
15083
15435
|
<td>
|
|
15084
|
-
|
|
15436
|
+
<code>max_display_count</code>
|
|
15437
|
+
</td>
|
|
15438
|
+
<td>
|
|
15439
|
+
<code>int</code>
|
|
15085
15440
|
</td>
|
|
15086
15441
|
<td>
|
|
15087
15442
|
<div class="doc-md-description">
|
|
@@ -15094,9 +15449,11 @@ If None, defaults to the <code>get_paginate_count()</code> (which is user's pref
|
|
|
15094
15449
|
</td>
|
|
15095
15450
|
</tr>
|
|
15096
15451
|
<tr class="doc-section-item">
|
|
15097
|
-
<td><code>table_title</code></td>
|
|
15098
15452
|
<td>
|
|
15099
|
-
|
|
15453
|
+
<code>table_title</code>
|
|
15454
|
+
</td>
|
|
15455
|
+
<td>
|
|
15456
|
+
<code>str</code>
|
|
15100
15457
|
</td>
|
|
15101
15458
|
<td>
|
|
15102
15459
|
<div class="doc-md-description">
|
|
@@ -15109,9 +15466,11 @@ If None, defaults to the plural verbose name of the table model.</p>
|
|
|
15109
15466
|
</td>
|
|
15110
15467
|
</tr>
|
|
15111
15468
|
<tr class="doc-section-item">
|
|
15112
|
-
<td><code>include_columns</code></td>
|
|
15113
15469
|
<td>
|
|
15114
|
-
|
|
15470
|
+
<code>include_columns</code>
|
|
15471
|
+
</td>
|
|
15472
|
+
<td>
|
|
15473
|
+
<code>list</code>
|
|
15115
15474
|
</td>
|
|
15116
15475
|
<td>
|
|
15117
15476
|
<div class="doc-md-description">
|
|
@@ -15124,9 +15483,11 @@ If provided, only these fields will be displayed in the table.</p>
|
|
|
15124
15483
|
</td>
|
|
15125
15484
|
</tr>
|
|
15126
15485
|
<tr class="doc-section-item">
|
|
15127
|
-
<td><code>exclude_columns</code></td>
|
|
15128
15486
|
<td>
|
|
15129
|
-
|
|
15487
|
+
<code>exclude_columns</code>
|
|
15488
|
+
</td>
|
|
15489
|
+
<td>
|
|
15490
|
+
<code>list</code>
|
|
15130
15491
|
</td>
|
|
15131
15492
|
<td>
|
|
15132
15493
|
<div class="doc-md-description">
|
|
@@ -15139,9 +15500,11 @@ Mutually exclusive with <code>include_columns</code>.</p>
|
|
|
15139
15500
|
</td>
|
|
15140
15501
|
</tr>
|
|
15141
15502
|
<tr class="doc-section-item">
|
|
15142
|
-
<td><code>add_button_route</code></td>
|
|
15143
15503
|
<td>
|
|
15144
|
-
|
|
15504
|
+
<code>add_button_route</code>
|
|
15505
|
+
</td>
|
|
15506
|
+
<td>
|
|
15507
|
+
<code>str</code>
|
|
15145
15508
|
</td>
|
|
15146
15509
|
<td>
|
|
15147
15510
|
<div class="doc-md-description">
|
|
@@ -15154,9 +15517,11 @@ which uses the default table's model <code>add</code> route.</p>
|
|
|
15154
15517
|
</td>
|
|
15155
15518
|
</tr>
|
|
15156
15519
|
<tr class="doc-section-item">
|
|
15157
|
-
<td><code>add_permissions</code></td>
|
|
15158
15520
|
<td>
|
|
15159
|
-
|
|
15521
|
+
<code>add_permissions</code>
|
|
15522
|
+
</td>
|
|
15523
|
+
<td>
|
|
15524
|
+
<code>list</code>
|
|
15160
15525
|
</td>
|
|
15161
15526
|
<td>
|
|
15162
15527
|
<div class="doc-md-description">
|
|
@@ -15169,9 +15534,11 @@ If not provided, permissions are determined by default based on the model.</p>
|
|
|
15169
15534
|
</td>
|
|
15170
15535
|
</tr>
|
|
15171
15536
|
<tr class="doc-section-item">
|
|
15172
|
-
<td><code>hide_hierarchy_ui</code></td>
|
|
15173
15537
|
<td>
|
|
15174
|
-
|
|
15538
|
+
<code>hide_hierarchy_ui</code>
|
|
15539
|
+
</td>
|
|
15540
|
+
<td>
|
|
15541
|
+
<code>bool</code>
|
|
15175
15542
|
</td>
|
|
15176
15543
|
<td>
|
|
15177
15544
|
<div class="doc-md-description">
|
|
@@ -15183,9 +15550,11 @@ If not provided, permissions are determined by default based on the model.</p>
|
|
|
15183
15550
|
</td>
|
|
15184
15551
|
</tr>
|
|
15185
15552
|
<tr class="doc-section-item">
|
|
15186
|
-
<td><code>related_field_name</code></td>
|
|
15187
15553
|
<td>
|
|
15188
|
-
|
|
15554
|
+
<code>related_field_name</code>
|
|
15555
|
+
</td>
|
|
15556
|
+
<td>
|
|
15557
|
+
<code>str</code>
|
|
15189
15558
|
</td>
|
|
15190
15559
|
<td>
|
|
15191
15560
|
<div class="doc-md-description">
|
|
@@ -15198,9 +15567,11 @@ to the base model. Defaults to the same as <code>table_filter</code> if unset. U
|
|
|
15198
15567
|
</td>
|
|
15199
15568
|
</tr>
|
|
15200
15569
|
<tr class="doc-section-item">
|
|
15201
|
-
<td><code>enable_bulk_actions</code></td>
|
|
15202
15570
|
<td>
|
|
15203
|
-
|
|
15571
|
+
<code>enable_bulk_actions</code>
|
|
15572
|
+
</td>
|
|
15573
|
+
<td>
|
|
15574
|
+
<code>bool</code>
|
|
15204
15575
|
</td>
|
|
15205
15576
|
<td>
|
|
15206
15577
|
<div class="doc-md-description">
|
|
@@ -15230,7 +15601,7 @@ appropriate permissions.</p>
|
|
|
15230
15601
|
|
|
15231
15602
|
<div class="doc doc-contents ">
|
|
15232
15603
|
|
|
15233
|
-
|
|
15604
|
+
<p>Add additional context for rendering the table panel.</p>
|
|
15234
15605
|
<p>This method processes the table data, configures pagination, and generates URLs
|
|
15235
15606
|
for listing and adding objects. It also handles field inclusion/exclusion and
|
|
15236
15607
|
displays the appropriate table title if provided.</p>
|
|
@@ -15260,10 +15631,15 @@ displays the appropriate table title if provided.</p>
|
|
|
15260
15631
|
|
|
15261
15632
|
<div class="doc doc-contents ">
|
|
15262
15633
|
<p class="doc doc-class-bases">
|
|
15263
|
-
Bases: <code><
|
|
15634
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Component" href="#nautobot.apps.ui.Component">Component</a></code></p>
|
|
15635
|
+
|
|
15636
|
+
|
|
15637
|
+
<p>Base class for defining an individual display panel within a Layout within a Tab.</p>
|
|
15638
|
+
|
|
15639
|
+
|
|
15640
|
+
|
|
15264
15641
|
|
|
15265
15642
|
|
|
15266
|
-
<p>Base class for defining an individual display panel within a Layout within a Tab.</p>
|
|
15267
15643
|
|
|
15268
15644
|
|
|
15269
15645
|
|
|
@@ -15289,7 +15665,7 @@ displays the appropriate table title if provided.</p>
|
|
|
15289
15665
|
|
|
15290
15666
|
<div class="doc doc-contents ">
|
|
15291
15667
|
|
|
15292
|
-
|
|
15668
|
+
<p>Initialize a Panel component that can be rendered as a self-contained HTML fragment.</p>
|
|
15293
15669
|
|
|
15294
15670
|
|
|
15295
15671
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -15304,9 +15680,11 @@ displays the appropriate table title if provided.</p>
|
|
|
15304
15680
|
</thead>
|
|
15305
15681
|
<tbody>
|
|
15306
15682
|
<tr class="doc-section-item">
|
|
15307
|
-
<td><code>label</code></td>
|
|
15308
15683
|
<td>
|
|
15309
|
-
|
|
15684
|
+
<code>label</code>
|
|
15685
|
+
</td>
|
|
15686
|
+
<td>
|
|
15687
|
+
<code>str</code>
|
|
15310
15688
|
</td>
|
|
15311
15689
|
<td>
|
|
15312
15690
|
<div class="doc-md-description">
|
|
@@ -15318,9 +15696,11 @@ displays the appropriate table title if provided.</p>
|
|
|
15318
15696
|
</td>
|
|
15319
15697
|
</tr>
|
|
15320
15698
|
<tr class="doc-section-item">
|
|
15321
|
-
<td><code>section</code></td>
|
|
15322
15699
|
<td>
|
|
15323
|
-
|
|
15700
|
+
<code>section</code>
|
|
15701
|
+
</td>
|
|
15702
|
+
<td>
|
|
15703
|
+
<code>str</code>
|
|
15324
15704
|
</td>
|
|
15325
15705
|
<td>
|
|
15326
15706
|
<div class="doc-md-description">
|
|
@@ -15328,13 +15708,15 @@ displays the appropriate table title if provided.</p>
|
|
|
15328
15708
|
</div>
|
|
15329
15709
|
</td>
|
|
15330
15710
|
<td>
|
|
15331
|
-
<code><
|
|
15711
|
+
<code><span title="nautobot.core.ui.choices.SectionChoices.FULL_WIDTH">FULL_WIDTH</span></code>
|
|
15332
15712
|
</td>
|
|
15333
15713
|
</tr>
|
|
15334
15714
|
<tr class="doc-section-item">
|
|
15335
|
-
<td><code>body_id</code></td>
|
|
15336
15715
|
<td>
|
|
15337
|
-
|
|
15716
|
+
<code>body_id</code>
|
|
15717
|
+
</td>
|
|
15718
|
+
<td>
|
|
15719
|
+
<code>str</code>
|
|
15338
15720
|
</td>
|
|
15339
15721
|
<td>
|
|
15340
15722
|
<div class="doc-md-description">
|
|
@@ -15346,9 +15728,11 @@ displays the appropriate table title if provided.</p>
|
|
|
15346
15728
|
</td>
|
|
15347
15729
|
</tr>
|
|
15348
15730
|
<tr class="doc-section-item">
|
|
15349
|
-
<td><code>body_content_template_path</code></td>
|
|
15350
15731
|
<td>
|
|
15351
|
-
|
|
15732
|
+
<code>body_content_template_path</code>
|
|
15733
|
+
</td>
|
|
15734
|
+
<td>
|
|
15735
|
+
<code>str</code>
|
|
15352
15736
|
</td>
|
|
15353
15737
|
<td>
|
|
15354
15738
|
<div class="doc-md-description">
|
|
@@ -15360,9 +15744,11 @@ displays the appropriate table title if provided.</p>
|
|
|
15360
15744
|
</td>
|
|
15361
15745
|
</tr>
|
|
15362
15746
|
<tr class="doc-section-item">
|
|
15363
|
-
<td><code>header_extra_content_template_path</code></td>
|
|
15364
15747
|
<td>
|
|
15365
|
-
|
|
15748
|
+
<code>header_extra_content_template_path</code>
|
|
15749
|
+
</td>
|
|
15750
|
+
<td>
|
|
15751
|
+
<code>str</code>
|
|
15366
15752
|
</td>
|
|
15367
15753
|
<td>
|
|
15368
15754
|
<div class="doc-md-description">
|
|
@@ -15375,9 +15761,11 @@ if any, not including its label if any.</p>
|
|
|
15375
15761
|
</td>
|
|
15376
15762
|
</tr>
|
|
15377
15763
|
<tr class="doc-section-item">
|
|
15378
|
-
<td><code>footer_content_template_path</code></td>
|
|
15379
15764
|
<td>
|
|
15380
|
-
|
|
15765
|
+
<code>footer_content_template_path</code>
|
|
15766
|
+
</td>
|
|
15767
|
+
<td>
|
|
15768
|
+
<code>str</code>
|
|
15381
15769
|
</td>
|
|
15382
15770
|
<td>
|
|
15383
15771
|
<div class="doc-md-description">
|
|
@@ -15389,9 +15777,11 @@ if any, not including its label if any.</p>
|
|
|
15389
15777
|
</td>
|
|
15390
15778
|
</tr>
|
|
15391
15779
|
<tr class="doc-section-item">
|
|
15392
|
-
<td><code>template_path</code></td>
|
|
15393
15780
|
<td>
|
|
15394
|
-
|
|
15781
|
+
<code>template_path</code>
|
|
15782
|
+
</td>
|
|
15783
|
+
<td>
|
|
15784
|
+
<code>str</code>
|
|
15395
15785
|
</td>
|
|
15396
15786
|
<td>
|
|
15397
15787
|
<div class="doc-md-description">
|
|
@@ -15403,9 +15793,11 @@ if any, not including its label if any.</p>
|
|
|
15403
15793
|
</td>
|
|
15404
15794
|
</tr>
|
|
15405
15795
|
<tr class="doc-section-item">
|
|
15406
|
-
<td><code>body_wrapper_template_path</code></td>
|
|
15407
15796
|
<td>
|
|
15408
|
-
|
|
15797
|
+
<code>body_wrapper_template_path</code>
|
|
15798
|
+
</td>
|
|
15799
|
+
<td>
|
|
15800
|
+
<code>str</code>
|
|
15409
15801
|
</td>
|
|
15410
15802
|
<td>
|
|
15411
15803
|
<div class="doc-md-description">
|
|
@@ -15435,7 +15827,7 @@ if any, not including its label if any.</p>
|
|
|
15435
15827
|
|
|
15436
15828
|
<div class="doc doc-contents ">
|
|
15437
15829
|
|
|
15438
|
-
|
|
15830
|
+
<p>Render the panel as a whole.</p>
|
|
15439
15831
|
<p>Default implementation calls <code>render_label()</code>, <code>render_header_extra_content()</code>, <code>render_body()</code>,
|
|
15440
15832
|
and <code>render_footer_extra_content()</code>, then wraps them all into the templated defined by <code>self.template_path</code>.</p>
|
|
15441
15833
|
<p>Typically you'll override one or more of the aforementioned methods in a subclass, rather than replacing this
|
|
@@ -15456,7 +15848,7 @@ entire method as a whole.</p>
|
|
|
15456
15848
|
|
|
15457
15849
|
<div class="doc doc-contents ">
|
|
15458
15850
|
|
|
15459
|
-
|
|
15851
|
+
<p>Render the panel body <em>including its HTML wrapper element(s)</em>.</p>
|
|
15460
15852
|
<p>Default implementation calls <code>render_body_content()</code> and wraps that in the template defined at
|
|
15461
15853
|
<code>self.body_wrapper_template_path</code>.</p>
|
|
15462
15854
|
<p>Normally you won't want to override this method in a subclass, instead overriding <code>render_body_content()</code>.</p>
|
|
@@ -15476,7 +15868,7 @@ entire method as a whole.</p>
|
|
|
15476
15868
|
|
|
15477
15869
|
<div class="doc doc-contents ">
|
|
15478
15870
|
|
|
15479
|
-
|
|
15871
|
+
<p>Render the content to include in this panel's body.</p>
|
|
15480
15872
|
<p>Default implementation renders the template from <code>self.body_content_template_path</code> if any.</p>
|
|
15481
15873
|
|
|
15482
15874
|
</div>
|
|
@@ -15494,7 +15886,7 @@ entire method as a whole.</p>
|
|
|
15494
15886
|
|
|
15495
15887
|
<div class="doc doc-contents ">
|
|
15496
15888
|
|
|
15497
|
-
|
|
15889
|
+
<p>Render any non-default content to include in this panel's footer.</p>
|
|
15498
15890
|
<p>Default implementation renders the template from <code>self.footer_content_template_path</code> if any.</p>
|
|
15499
15891
|
|
|
15500
15892
|
</div>
|
|
@@ -15512,7 +15904,7 @@ entire method as a whole.</p>
|
|
|
15512
15904
|
|
|
15513
15905
|
<div class="doc doc-contents ">
|
|
15514
15906
|
|
|
15515
|
-
|
|
15907
|
+
<p>Render any additional (non-label) content to include in this panel's header.</p>
|
|
15516
15908
|
<p>Default implementation renders the template from <code>self.header_extra_content_template_path</code> if any.</p>
|
|
15517
15909
|
|
|
15518
15910
|
</div>
|
|
@@ -15530,7 +15922,7 @@ entire method as a whole.</p>
|
|
|
15530
15922
|
|
|
15531
15923
|
<div class="doc doc-contents ">
|
|
15532
15924
|
|
|
15533
|
-
|
|
15925
|
+
<p>Render the label of this panel, if any.</p>
|
|
15534
15926
|
|
|
15535
15927
|
</div>
|
|
15536
15928
|
|
|
@@ -15558,7 +15950,12 @@ entire method as a whole.</p>
|
|
|
15558
15950
|
<div class="doc doc-contents ">
|
|
15559
15951
|
|
|
15560
15952
|
|
|
15561
|
-
|
|
15953
|
+
<p>Ensure permissions through init.</p>
|
|
15954
|
+
|
|
15955
|
+
|
|
15956
|
+
|
|
15957
|
+
|
|
15958
|
+
|
|
15562
15959
|
|
|
15563
15960
|
|
|
15564
15961
|
|
|
@@ -15584,7 +15981,7 @@ entire method as a whole.</p>
|
|
|
15584
15981
|
|
|
15585
15982
|
<div class="doc doc-contents ">
|
|
15586
15983
|
|
|
15587
|
-
|
|
15984
|
+
<p>Ensure permissions.</p>
|
|
15588
15985
|
|
|
15589
15986
|
</div>
|
|
15590
15987
|
|
|
@@ -15611,10 +16008,10 @@ entire method as a whole.</p>
|
|
|
15611
16008
|
|
|
15612
16009
|
<div class="doc doc-contents ">
|
|
15613
16010
|
<p class="doc doc-class-bases">
|
|
15614
|
-
Bases: <code><
|
|
16011
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.choices.ChoiceSet" href="choices.html#nautobot.apps.choices.ChoiceSet">ChoiceSet</a></code></p>
|
|
15615
16012
|
|
|
15616
16013
|
|
|
15617
|
-
|
|
16014
|
+
<p>Sections of a Layout to assign panels to. Placement of panels is determined by <a href="ui.html#nautobot.apps.ui.LayoutChoices"><code>LayoutChoices</code></a> set on <code>Tab.layout</code></p>
|
|
15618
16015
|
|
|
15619
16016
|
|
|
15620
16017
|
<p><span class="doc-section-title">Attributes:</span></p>
|
|
@@ -15628,9 +16025,9 @@ entire method as a whole.</p>
|
|
|
15628
16025
|
</thead>
|
|
15629
16026
|
<tbody>
|
|
15630
16027
|
<tr class="doc-section-item">
|
|
15631
|
-
<td><code><
|
|
16028
|
+
<td><code><span title="nautobot.apps.ui.SectionChoices.LEFT_HALF">LEFT_HALF</span></code></td>
|
|
15632
16029
|
<td>
|
|
15633
|
-
<code
|
|
16030
|
+
<code>str</code>
|
|
15634
16031
|
</td>
|
|
15635
16032
|
<td>
|
|
15636
16033
|
<div class="doc-md-description">
|
|
@@ -15639,9 +16036,9 @@ entire method as a whole.</p>
|
|
|
15639
16036
|
</td>
|
|
15640
16037
|
</tr>
|
|
15641
16038
|
<tr class="doc-section-item">
|
|
15642
|
-
<td><code><
|
|
16039
|
+
<td><code><span title="nautobot.apps.ui.SectionChoices.RIGHT_HALF">RIGHT_HALF</span></code></td>
|
|
15643
16040
|
<td>
|
|
15644
|
-
<code
|
|
16041
|
+
<code>str</code>
|
|
15645
16042
|
</td>
|
|
15646
16043
|
<td>
|
|
15647
16044
|
<div class="doc-md-description">
|
|
@@ -15650,9 +16047,9 @@ entire method as a whole.</p>
|
|
|
15650
16047
|
</td>
|
|
15651
16048
|
</tr>
|
|
15652
16049
|
<tr class="doc-section-item">
|
|
15653
|
-
<td><code><
|
|
16050
|
+
<td><code><span title="nautobot.apps.ui.SectionChoices.FULL_WIDTH">FULL_WIDTH</span></code></td>
|
|
15654
16051
|
<td>
|
|
15655
|
-
<code
|
|
16052
|
+
<code>str</code>
|
|
15656
16053
|
</td>
|
|
15657
16054
|
<td>
|
|
15658
16055
|
<div class="doc-md-description">
|
|
@@ -15666,6 +16063,11 @@ entire method as a whole.</p>
|
|
|
15666
16063
|
|
|
15667
16064
|
|
|
15668
16065
|
|
|
16066
|
+
|
|
16067
|
+
|
|
16068
|
+
|
|
16069
|
+
|
|
16070
|
+
|
|
15669
16071
|
<div class="doc doc-children">
|
|
15670
16072
|
|
|
15671
16073
|
|
|
@@ -15697,7 +16099,12 @@ entire method as a whole.</p>
|
|
|
15697
16099
|
|
|
15698
16100
|
<div class="doc doc-contents ">
|
|
15699
16101
|
<p class="doc doc-class-bases">
|
|
15700
|
-
Bases: <code><
|
|
16102
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Panel" href="#nautobot.apps.ui.Panel">Panel</a></code></p>
|
|
16103
|
+
|
|
16104
|
+
|
|
16105
|
+
|
|
16106
|
+
|
|
16107
|
+
|
|
15701
16108
|
|
|
15702
16109
|
|
|
15703
16110
|
|
|
@@ -15724,7 +16131,7 @@ entire method as a whole.</p>
|
|
|
15724
16131
|
|
|
15725
16132
|
<div class="doc doc-contents ">
|
|
15726
16133
|
|
|
15727
|
-
|
|
16134
|
+
<p>Instantiate a <code>StatsPanel</code>.
|
|
15728
16135
|
filter_name (str) is a valid query filter append to the anchor tag for each stat button.
|
|
15729
16136
|
e.g. the <code>tenant</code> query parameter in the url <code>/circuits/circuits/?tenant=f4b48e9d-56fc-4090-afa5-dcbe69775b13</code>.
|
|
15730
16137
|
related_models is a list of model classes and/or tuples of (model_class, query_string).
|
|
@@ -15745,7 +16152,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
|
|
|
15745
16152
|
|
|
15746
16153
|
<div class="doc doc-contents ">
|
|
15747
16154
|
|
|
15748
|
-
|
|
16155
|
+
<p>Transform self.related_models to a dictionary with key, value pairs as follows:
|
|
15749
16156
|
{
|
|
15750
16157
|
<related_object_model_class_1>: [related_object_model_class_list_url_1, related_object_count_1, related_object_title_1],
|
|
15751
16158
|
<related_object_model_class_2>: [related_object_model_class_list_url_2, related_object_count_2, related_object_title_2],
|
|
@@ -15768,7 +16175,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
|
|
|
15768
16175
|
|
|
15769
16176
|
<div class="doc doc-contents ">
|
|
15770
16177
|
|
|
15771
|
-
|
|
16178
|
+
<p>Always should render this panel as the permission is reinforced in python with .restrict(request.user, "view")</p>
|
|
15772
16179
|
|
|
15773
16180
|
</div>
|
|
15774
16181
|
|
|
@@ -15795,10 +16202,15 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
|
|
|
15795
16202
|
|
|
15796
16203
|
<div class="doc doc-contents ">
|
|
15797
16204
|
<p class="doc doc-class-bases">
|
|
15798
|
-
Bases: <code><
|
|
16205
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Component" href="#nautobot.apps.ui.Component">Component</a></code></p>
|
|
16206
|
+
|
|
16207
|
+
|
|
16208
|
+
<p>Base class for UI framework definition of a single tabbed pane within an Object Detail (Object Retrieve) page.</p>
|
|
16209
|
+
|
|
16210
|
+
|
|
16211
|
+
|
|
15799
16212
|
|
|
15800
16213
|
|
|
15801
|
-
<p>Base class for UI framework definition of a single tabbed pane within an Object Detail (Object Retrieve) page.</p>
|
|
15802
16214
|
|
|
15803
16215
|
|
|
15804
16216
|
|
|
@@ -15824,7 +16236,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
|
|
|
15824
16236
|
|
|
15825
16237
|
<div class="doc doc-contents ">
|
|
15826
16238
|
|
|
15827
|
-
|
|
16239
|
+
<p>Initialize a Tab component.</p>
|
|
15828
16240
|
|
|
15829
16241
|
|
|
15830
16242
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -15839,9 +16251,11 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
|
|
|
15839
16251
|
</thead>
|
|
15840
16252
|
<tbody>
|
|
15841
16253
|
<tr class="doc-section-item">
|
|
15842
|
-
<td><code>tab_id</code></td>
|
|
15843
16254
|
<td>
|
|
15844
|
-
|
|
16255
|
+
<code>tab_id</code>
|
|
16256
|
+
</td>
|
|
16257
|
+
<td>
|
|
16258
|
+
<code>str</code>
|
|
15845
16259
|
</td>
|
|
15846
16260
|
<td>
|
|
15847
16261
|
<div class="doc-md-description">
|
|
@@ -15853,9 +16267,11 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
|
|
|
15853
16267
|
</td>
|
|
15854
16268
|
</tr>
|
|
15855
16269
|
<tr class="doc-section-item">
|
|
15856
|
-
<td><code>label</code></td>
|
|
15857
16270
|
<td>
|
|
15858
|
-
|
|
16271
|
+
<code>label</code>
|
|
16272
|
+
</td>
|
|
16273
|
+
<td>
|
|
16274
|
+
<code>str</code>
|
|
15859
16275
|
</td>
|
|
15860
16276
|
<td>
|
|
15861
16277
|
<div class="doc-md-description">
|
|
@@ -15867,9 +16283,11 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
|
|
|
15867
16283
|
</td>
|
|
15868
16284
|
</tr>
|
|
15869
16285
|
<tr class="doc-section-item">
|
|
15870
|
-
<td><code>panels</code></td>
|
|
15871
16286
|
<td>
|
|
15872
|
-
|
|
16287
|
+
<code>panels</code>
|
|
16288
|
+
</td>
|
|
16289
|
+
<td>
|
|
16290
|
+
<code>tuple</code>
|
|
15873
16291
|
</td>
|
|
15874
16292
|
<td>
|
|
15875
16293
|
<div class="doc-md-description">
|
|
@@ -15881,9 +16299,11 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
|
|
|
15881
16299
|
</td>
|
|
15882
16300
|
</tr>
|
|
15883
16301
|
<tr class="doc-section-item">
|
|
15884
|
-
<td><code>layout</code></td>
|
|
15885
16302
|
<td>
|
|
15886
|
-
|
|
16303
|
+
<code>layout</code>
|
|
16304
|
+
</td>
|
|
16305
|
+
<td>
|
|
16306
|
+
<code>str</code>
|
|
15887
16307
|
</td>
|
|
15888
16308
|
<td>
|
|
15889
16309
|
<div class="doc-md-description">
|
|
@@ -15891,13 +16311,15 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
|
|
|
15891
16311
|
</div>
|
|
15892
16312
|
</td>
|
|
15893
16313
|
<td>
|
|
15894
|
-
<code><
|
|
16314
|
+
<code><span title="nautobot.core.ui.choices.LayoutChoices.DEFAULT">DEFAULT</span></code>
|
|
15895
16315
|
</td>
|
|
15896
16316
|
</tr>
|
|
15897
16317
|
<tr class="doc-section-item">
|
|
15898
|
-
<td><code>label_wrapper_template_path</code></td>
|
|
15899
16318
|
<td>
|
|
15900
|
-
|
|
16319
|
+
<code>label_wrapper_template_path</code>
|
|
16320
|
+
</td>
|
|
16321
|
+
<td>
|
|
16322
|
+
<code>str</code>
|
|
15901
16323
|
</td>
|
|
15902
16324
|
<td>
|
|
15903
16325
|
<div class="doc-md-description">
|
|
@@ -15909,9 +16331,11 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
|
|
|
15909
16331
|
</td>
|
|
15910
16332
|
</tr>
|
|
15911
16333
|
<tr class="doc-section-item">
|
|
15912
|
-
<td><code>content_wrapper_template_path</code></td>
|
|
15913
16334
|
<td>
|
|
15914
|
-
|
|
16335
|
+
<code>content_wrapper_template_path</code>
|
|
16336
|
+
</td>
|
|
16337
|
+
<td>
|
|
16338
|
+
<code>str</code>
|
|
15915
16339
|
</td>
|
|
15916
16340
|
<td>
|
|
15917
16341
|
<div class="doc-md-description">
|
|
@@ -15940,7 +16364,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
|
|
|
15940
16364
|
|
|
15941
16365
|
<div class="doc doc-contents ">
|
|
15942
16366
|
|
|
15943
|
-
|
|
16367
|
+
<p>Get the subset of this tab's panels that apply to the given layout section, ordered by their <code>weight</code>.</p>
|
|
15944
16368
|
|
|
15945
16369
|
|
|
15946
16370
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -15955,9 +16379,11 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
|
|
|
15955
16379
|
</thead>
|
|
15956
16380
|
<tbody>
|
|
15957
16381
|
<tr class="doc-section-item">
|
|
15958
|
-
<td><code>section</code></td>
|
|
15959
16382
|
<td>
|
|
15960
|
-
|
|
16383
|
+
<code>section</code>
|
|
16384
|
+
</td>
|
|
16385
|
+
<td>
|
|
16386
|
+
<code>str</code>
|
|
15961
16387
|
</td>
|
|
15962
16388
|
<td>
|
|
15963
16389
|
<div class="doc-md-description">
|
|
@@ -15983,7 +16409,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
|
|
|
15983
16409
|
<tbody>
|
|
15984
16410
|
<tr class="doc-section-item">
|
|
15985
16411
|
<td>
|
|
15986
|
-
<code
|
|
16412
|
+
<code>list[<a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.Panel" href="#nautobot.apps.ui.Panel">Panel</a>]</code>
|
|
15987
16413
|
</td>
|
|
15988
16414
|
<td>
|
|
15989
16415
|
<div class="doc-md-description">
|
|
@@ -16009,7 +16435,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
|
|
|
16009
16435
|
|
|
16010
16436
|
<div class="doc doc-contents ">
|
|
16011
16437
|
|
|
16012
|
-
|
|
16438
|
+
<p>Render the tab's contents (layout and panels) to HTML.</p>
|
|
16013
16439
|
|
|
16014
16440
|
</div>
|
|
16015
16441
|
|
|
@@ -16026,7 +16452,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
|
|
|
16026
16452
|
|
|
16027
16453
|
<div class="doc doc-contents ">
|
|
16028
16454
|
|
|
16029
|
-
|
|
16455
|
+
<p>Render the tab's label text in a form suitable for display to the user.</p>
|
|
16030
16456
|
<p>Defaults to just returning <code>self.label</code>, but may be overridden if context-specific formatting is needed.</p>
|
|
16031
16457
|
|
|
16032
16458
|
</div>
|
|
@@ -16044,7 +16470,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
|
|
|
16044
16470
|
|
|
16045
16471
|
<div class="doc doc-contents ">
|
|
16046
16472
|
|
|
16047
|
-
|
|
16473
|
+
<p>Render the tab's label (as opposed to its contents) and wrapping HTML elements.</p>
|
|
16048
16474
|
<p>In most cases you should not need to override this method; override <code>render_label()</code> instead.</p>
|
|
16049
16475
|
|
|
16050
16476
|
</div>
|
|
@@ -16073,7 +16499,7 @@ e.g. [Device, Prefix, (Circuit, "circuit_terminations__location__in"), (VirtualM
|
|
|
16073
16499
|
<div class="doc doc-contents ">
|
|
16074
16500
|
|
|
16075
16501
|
|
|
16076
|
-
|
|
16502
|
+
<p>This class is used to register App content to be injected into core Nautobot templates.</p>
|
|
16077
16503
|
<p>It contains methods and attributes that may be overridden by App authors to return template content.</p>
|
|
16078
16504
|
<p>The <code>model</code> attribute on the class defines the which model detail/list pages this class renders content for.
|
|
16079
16505
|
It should be set as a string in the form <code><app_label>.<model_name></code>.</p>
|
|
@@ -16081,6 +16507,11 @@ It should be set as a string in the form <code><app_label>.<model_name&
|
|
|
16081
16507
|
|
|
16082
16508
|
|
|
16083
16509
|
|
|
16510
|
+
|
|
16511
|
+
|
|
16512
|
+
|
|
16513
|
+
|
|
16514
|
+
|
|
16084
16515
|
<div class="doc doc-children">
|
|
16085
16516
|
|
|
16086
16517
|
|
|
@@ -16094,7 +16525,7 @@ It should be set as a string in the form <code><app_label>.<model_name&
|
|
|
16094
16525
|
|
|
16095
16526
|
|
|
16096
16527
|
<h3 id="nautobot.apps.ui.TemplateExtension.model" class="doc doc-heading">
|
|
16097
|
-
<code class="highlight language-python"><span class="n">model</span
|
|
16528
|
+
<code class="highlight language-python"><span class="n">model</span> <span class="o">=</span> <span class="kc">None</span></code>
|
|
16098
16529
|
|
|
16099
16530
|
<span class="doc doc-labels">
|
|
16100
16531
|
<small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small>
|
|
@@ -16106,7 +16537,7 @@ It should be set as a string in the form <code><app_label>.<model_name&
|
|
|
16106
16537
|
|
|
16107
16538
|
<div class="doc doc-contents ">
|
|
16108
16539
|
|
|
16109
|
-
|
|
16540
|
+
<p>The model (as a string in the form <code><app_label>.<model></code>) that this TemplateExtension subclass applies to.</p>
|
|
16110
16541
|
</div>
|
|
16111
16542
|
|
|
16112
16543
|
</div>
|
|
@@ -16128,7 +16559,7 @@ It should be set as a string in the form <code><app_label>.<model_name&
|
|
|
16128
16559
|
|
|
16129
16560
|
<div class="doc doc-contents ">
|
|
16130
16561
|
|
|
16131
|
-
|
|
16562
|
+
<p>List of Button instances to add to the specified model's detail view.</p>
|
|
16132
16563
|
</div>
|
|
16133
16564
|
|
|
16134
16565
|
</div>
|
|
@@ -16150,7 +16581,7 @@ It should be set as a string in the form <code><app_label>.<model_name&
|
|
|
16150
16581
|
|
|
16151
16582
|
<div class="doc doc-contents ">
|
|
16152
16583
|
|
|
16153
|
-
|
|
16584
|
+
<p>List of Panel instances to add to the specified model's detail view.</p>
|
|
16154
16585
|
</div>
|
|
16155
16586
|
|
|
16156
16587
|
</div>
|
|
@@ -16172,7 +16603,7 @@ It should be set as a string in the form <code><app_label>.<model_name&
|
|
|
16172
16603
|
|
|
16173
16604
|
<div class="doc doc-contents ">
|
|
16174
16605
|
|
|
16175
|
-
|
|
16606
|
+
<p>List of Tab instances to add to the specified model's detail view.</p>
|
|
16176
16607
|
</div>
|
|
16177
16608
|
|
|
16178
16609
|
</div>
|
|
@@ -16190,7 +16621,7 @@ It should be set as a string in the form <code><app_label>.<model_name&
|
|
|
16190
16621
|
|
|
16191
16622
|
<div class="doc doc-contents ">
|
|
16192
16623
|
|
|
16193
|
-
|
|
16624
|
+
<p>Called automatically to instantiate a TemplateExtension with render context before calling <code>left_page()</code>, etc.</p>
|
|
16194
16625
|
<p>The provided context typically includes the following keys:</p>
|
|
16195
16626
|
<ul>
|
|
16196
16627
|
<li>object - The object being viewed</li>
|
|
@@ -16214,7 +16645,7 @@ It should be set as a string in the form <code><app_label>.<model_name&
|
|
|
16214
16645
|
|
|
16215
16646
|
<div class="doc doc-contents ">
|
|
16216
16647
|
|
|
16217
|
-
|
|
16648
|
+
<p>(Deprecated) Provide content that will be added to the existing list of buttons on the detail page view.</p>
|
|
16218
16649
|
<p>In Nautobot v2.4.0 and later, Apps can (should) instead register <code>Button</code> instances in <code>object_detail_buttons</code>,
|
|
16219
16650
|
instead of implementing a <code>.buttons()</code> method.</p>
|
|
16220
16651
|
<p>Content should be returned as an HTML string.
|
|
@@ -16235,7 +16666,7 @@ Note that content does not need to be marked as safe because this is automatical
|
|
|
16235
16666
|
|
|
16236
16667
|
<div class="doc doc-contents ">
|
|
16237
16668
|
|
|
16238
|
-
|
|
16669
|
+
<p>(Deprecated) Provide a dict of tabs and associated views that will be added to the detail page view.</p>
|
|
16239
16670
|
<p>In Nautobot v2.4.0 and later, Apps can (should) instead implement the <code>object_detail_tabs</code> attribute instead.</p>
|
|
16240
16671
|
<p>Tabs will be ordered by their position in the list.</p>
|
|
16241
16672
|
<p>Content should be returned as a list of dicts in the following format:
|
|
@@ -16266,7 +16697,7 @@ Note that content does not need to be marked as safe because this is automatical
|
|
|
16266
16697
|
|
|
16267
16698
|
<div class="doc doc-contents ">
|
|
16268
16699
|
|
|
16269
|
-
|
|
16700
|
+
<p>(Deprecated) Provide content that will be rendered within the full width of the detail page view.</p>
|
|
16270
16701
|
<p>In Nautobot v2.4.0 and later, Apps can (should) instead register <code>Panel</code> instances in <code>object_detail_panels</code>,
|
|
16271
16702
|
instead of implementing a <code>.full_width_page()</code> method.</p>
|
|
16272
16703
|
<p>Content should be returned as an HTML string.
|
|
@@ -16287,7 +16718,7 @@ Note that content does not need to be marked as safe because this is automatical
|
|
|
16287
16718
|
|
|
16288
16719
|
<div class="doc doc-contents ">
|
|
16289
16720
|
|
|
16290
|
-
|
|
16721
|
+
<p>(Deprecated) Provide content that will be rendered on the left of the detail page view.</p>
|
|
16291
16722
|
<p>In Nautobot v2.4.0 and later, Apps can (should) instead register <code>Panel</code> instances in <code>object_detail_panels</code>,
|
|
16292
16723
|
instead of implementing a <code>.left_page()</code> method.</p>
|
|
16293
16724
|
<p>Content should be returned as an HTML string.
|
|
@@ -16308,7 +16739,7 @@ Note that content does not need to be marked as safe because this is automatical
|
|
|
16308
16739
|
|
|
16309
16740
|
<div class="doc doc-contents ">
|
|
16310
16741
|
|
|
16311
|
-
|
|
16742
|
+
<p>Buttons that will be rendered and added to the existing list of buttons on the list page view. Content
|
|
16312
16743
|
should be returned as an HTML string. Note that content does not need to be marked as safe because this is
|
|
16313
16744
|
automatically handled.</p>
|
|
16314
16745
|
|
|
@@ -16327,7 +16758,7 @@ automatically handled.</p>
|
|
|
16327
16758
|
|
|
16328
16759
|
<div class="doc doc-contents ">
|
|
16329
16760
|
|
|
16330
|
-
|
|
16761
|
+
<p>Convenience method for rendering the specified Django template using the default context data. An additional
|
|
16331
16762
|
context dictionary may be passed as <code>extra_context</code>.</p>
|
|
16332
16763
|
|
|
16333
16764
|
</div>
|
|
@@ -16345,7 +16776,7 @@ context dictionary may be passed as <code>extra_context</code>.</p>
|
|
|
16345
16776
|
|
|
16346
16777
|
<div class="doc doc-contents ">
|
|
16347
16778
|
|
|
16348
|
-
|
|
16779
|
+
<p>(Deprecated) Provide content that will be rendered on the right of the detail page view.</p>
|
|
16349
16780
|
<p>In Nautobot v2.4.0 and later, Apps can (should) instead register <code>Panel</code> instances in <code>object_detail_panels</code>,
|
|
16350
16781
|
instead of implementing a <code>.right_page()</code> method.</p>
|
|
16351
16782
|
<p>Content should be returned as an HTML string.
|
|
@@ -16376,10 +16807,10 @@ Note that content does not need to be marked as safe because this is automatical
|
|
|
16376
16807
|
|
|
16377
16808
|
<div class="doc doc-contents ">
|
|
16378
16809
|
<p class="doc doc-class-bases">
|
|
16379
|
-
Bases: <code><
|
|
16810
|
+
Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.ui.object_detail.BaseTextPanel" href="#nautobot.apps.ui.BaseTextPanel">BaseTextPanel</a></code></p>
|
|
16380
16811
|
|
|
16381
16812
|
|
|
16382
|
-
|
|
16813
|
+
<p>Panel that renders text, Markdown, JSON or YAML from the given value in the context.</p>
|
|
16383
16814
|
|
|
16384
16815
|
|
|
16385
16816
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -16394,9 +16825,11 @@ Note that content does not need to be marked as safe because this is automatical
|
|
|
16394
16825
|
</thead>
|
|
16395
16826
|
<tbody>
|
|
16396
16827
|
<tr class="doc-section-item">
|
|
16397
|
-
<td><code>context_field</code></td>
|
|
16398
16828
|
<td>
|
|
16399
|
-
|
|
16829
|
+
<code>context_field</code>
|
|
16830
|
+
</td>
|
|
16831
|
+
<td>
|
|
16832
|
+
<code>str</code>
|
|
16400
16833
|
</td>
|
|
16401
16834
|
<td>
|
|
16402
16835
|
<div class="doc-md-description">
|
|
@@ -16408,9 +16841,11 @@ Note that content does not need to be marked as safe because this is automatical
|
|
|
16408
16841
|
</td>
|
|
16409
16842
|
</tr>
|
|
16410
16843
|
<tr class="doc-section-item">
|
|
16411
|
-
<td><code>kwargs</code></td>
|
|
16412
16844
|
<td>
|
|
16413
|
-
|
|
16845
|
+
<code>kwargs</code>
|
|
16846
|
+
</td>
|
|
16847
|
+
<td>
|
|
16848
|
+
<code>dict</code>
|
|
16414
16849
|
</td>
|
|
16415
16850
|
<td>
|
|
16416
16851
|
<div class="doc-md-description">
|
|
@@ -16427,6 +16862,11 @@ Note that content does not need to be marked as safe because this is automatical
|
|
|
16427
16862
|
|
|
16428
16863
|
|
|
16429
16864
|
|
|
16865
|
+
|
|
16866
|
+
|
|
16867
|
+
|
|
16868
|
+
|
|
16869
|
+
|
|
16430
16870
|
<div class="doc doc-children">
|
|
16431
16871
|
|
|
16432
16872
|
|
|
@@ -16457,7 +16897,7 @@ Note that content does not need to be marked as safe because this is automatical
|
|
|
16457
16897
|
|
|
16458
16898
|
<div class="doc doc-contents ">
|
|
16459
16899
|
|
|
16460
|
-
|
|
16900
|
+
<p>Render the template located at the given path with the given context, possibly augmented via additional kwargs.</p>
|
|
16461
16901
|
|
|
16462
16902
|
|
|
16463
16903
|
<p><span class="doc-section-title">Parameters:</span></p>
|
|
@@ -16472,9 +16912,11 @@ Note that content does not need to be marked as safe because this is automatical
|
|
|
16472
16912
|
</thead>
|
|
16473
16913
|
<tbody>
|
|
16474
16914
|
<tr class="doc-section-item">
|
|
16475
|
-
<td><code>template_path</code></td>
|
|
16476
16915
|
<td>
|
|
16477
|
-
|
|
16916
|
+
<code>template_path</code>
|
|
16917
|
+
</td>
|
|
16918
|
+
<td>
|
|
16919
|
+
<code>str</code>
|
|
16478
16920
|
</td>
|
|
16479
16921
|
<td>
|
|
16480
16922
|
<div class="doc-md-description">
|
|
@@ -16486,9 +16928,11 @@ Note that content does not need to be marked as safe because this is automatical
|
|
|
16486
16928
|
</td>
|
|
16487
16929
|
</tr>
|
|
16488
16930
|
<tr class="doc-section-item">
|
|
16489
|
-
<td><code>context</code></td>
|
|
16490
16931
|
<td>
|
|
16491
|
-
|
|
16932
|
+
<code>context</code>
|
|
16933
|
+
</td>
|
|
16934
|
+
<td>
|
|
16935
|
+
<code><span title="django.template.Context">Context</span></code>
|
|
16492
16936
|
</td>
|
|
16493
16937
|
<td>
|
|
16494
16938
|
<div class="doc-md-description">
|
|
@@ -16500,9 +16944,11 @@ Note that content does not need to be marked as safe because this is automatical
|
|
|
16500
16944
|
</td>
|
|
16501
16945
|
</tr>
|
|
16502
16946
|
<tr class="doc-section-item">
|
|
16503
|
-
<td><code>**kwargs</code></td>
|
|
16504
16947
|
<td>
|
|
16505
|
-
|
|
16948
|
+
<code>**kwargs</code>
|
|
16949
|
+
</td>
|
|
16950
|
+
<td>
|
|
16951
|
+
<code>dict</code>
|
|
16506
16952
|
</td>
|
|
16507
16953
|
<td>
|
|
16508
16954
|
<div class="doc-md-description">
|
|
@@ -16678,7 +17124,7 @@ Note that content does not need to be marked as safe because this is automatical
|
|
|
16678
17124
|
<script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.annotate", "content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
|
|
16679
17125
|
|
|
16680
17126
|
|
|
16681
|
-
<script src="../../../assets/javascripts/bundle.
|
|
17127
|
+
<script src="../../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
|
|
16682
17128
|
|
|
16683
17129
|
<script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
|
|
16684
17130
|
|