Xadmin⽂档(⼀)
快速开始 Xadmin
For using Xadmin, needs to be installed and an has to be activated.
安装
使⽤ pip:
pip install django-xadmin
源码安装
pip install -
注解
在执⾏前您可以先编辑⽂件 , 其中 xlwt 不是必选的, 如果您不需要导出 excel 的功能, 可以删除这项
运⾏ Demo
如果您下载的是 Xadmin 的源码包, 您会在项⽬⽬录下到 demo_app ⽬录, 执⾏⼀下命令可以迅速开启⼀个 Xadmin 的演⽰实例:
cd demo_app
python manage.py runserver
使⽤在⾃⼰的项⽬中
Xadmin 作为 Django 的模块, 可以很⽅便的使⽤在 Django 的⽹站中.
⾸先编辑 settings.py 添加 Xadmin 的模块到 INSTALLED_APPS 中 (注意, 安装 Django admin 所需要的 APP 也要安装, 但是django.admin 可以不安装):
INSTALLED_APPS = (
...
'xadmin',
'crispy_forms',
'reversion',
...
)
然后添加 URL-patterns 以及 autodiscover 操作:
import xadmin
xadmin.autodiscover()
# version模块⾃动注册需要版本控制的 Model
from xadmin.plugins import xversion
urlpatterns = patterns('',
url(r'xadmin/', include(xadmin.site.urls)),
)
收集 media ⽂件:
python manage.py collectstatic
Xadmin 的插件
插件概述
内置插件
Action
功能
Action 插件在数据列表页⾯提供了数据选择功能, 选择后的数据可以经过 Action 做特殊的处理. 默认提供的 Action 为批量删除功能.
截图
使⽤
开发者可以设置 Model OptionClass 的 actions 属性, 该属性是⼀个列表, 包含您想启⽤的 Action 的类. 系统已经默认内置了删除数据的Action,当然您可以⾃⼰制作 Action 来实现特定的功能, 制作 Action 的实例如下.
API
class xadmin.plugins.actions.ActionPlugin(admin_view)
数据过滤器
功能
在数据列表页⾯提供数据过滤功能, 包括: 模糊搜索, 数字范围搜索, ⽇期搜索等等
截图
使⽤
在 Model OptionClass 中设置以下属性:
使⽤过滤器的例⼦:
django admin 自定义页面class UserAdmin(object):
list_filter = ('is_staff', 'is_superuser', 'is_active')
search_fields = ('username', 'first_name', 'last_name', 'email')
版本
暂⽆
制作过滤器
您也可以制作⾃⼰的过滤器, ⽤来进⾏⼀些特定的过滤. 过滤器需要继承 xadmin.filters.BaseFilter 类, 并使⽤ xadmin.filters.manager 注册过滤器.
图表插件
功能
在数据列表页⾯, 跟列表数据⽣成图表. 可以指定多个数据列, ⽣成多个图表.
截图
使⽤
在 Model OptionClass 中设定 data_charts 属性, 该属性为 dict 类型, key 是图表的标⽰名称, value 是图表的具体设置属性. 使⽤⽰例:
class RecordAdmin(object):
data_charts = {
"user_count": {'title': u"User Report", "x-field": "date", "y-field": ("user_count", "view_count"), "order": ('date',)},
"avg_count": {'title': u"Avg Report", "x-field": "date", "y-field": ('avg_count',), "order": ('date',)}
}
图表的主要属性为:
title : 图表的显⽰名称
x-field : 图表的 X 轴数据列, ⼀般是⽇期, 时间等
y-field : 图表的 Y 轴数据列, 该项是⼀个 list, 可以同时设定多个列, 这样多个列的数据会在同⼀个图表
中显⽰
order : 排序信息, 如果不写则使⽤数据列表的排序
版本
暂⽆
API
class xadmin.plugins.chart.ChartsPlugin(admin_view)
class xadmin.plugins.chart.ChartsView(request, *args, **kwargs)
书签
功能
记录数据列表页⾯特定的数据过滤, 排序等结果. 添加的书签还可以在⾸页仪表盘中作为⼩组件添加
截图
使⽤
在 Model OptionClass 中设定如下属性:
版本
暂⽆
数据导出
功能
该插件在数据列表页⾯提供了数据导出功能, 可以导出 Excel, CSV, XML, json 格式.
截图
使⽤
注解
如果想要导出 Excel 数据, 需要安装 .
默认情况下, xadmin 会提供 Excel, CSV, XML, json 四种格式的数据导出. 您可以通过设置 OptionClass 的 list_export 属性来指定使⽤哪些导出格式 (四种各使⽤分别⽤ xls, csv, xml, json 表⽰), 或是将 list_export 设置为 None 来禁⽤数据导出功能. ⽰例如下:
class MyModelAdmin(object):
list_export = ('xls', xml', 'json')
列表定时刷新
功能
该插件在数据列表页⾯提供了定时刷新功能, 对于需要实时刷新列表页⾯查看即时数据的情况⾮常有⽤.
截图
使⽤
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论