DataGrid HowTo

Introduzione

Questo howto mostra come usare DataGrid

Immaginiamo di avere una classe Person di questo tipo:

class CompanyDataGrid(KiDataGrid):
    full_name = Column("Name", sortable=True, link=True)
    website = UrlColumn("Website", sortable=True)
    vat_number = Columt_numbern("VAT", sortable=True)

Creiamo la DataTable

class CompanyDataGrid(KiDataGrid):
    full_name = Column("Name", sortable=True, link=True)
    website = UrlColumn("Website", sortable=True)
    vat_number = Column("VAT", sortable=True)
    codice_fiscale = Column("Codice Fiscale", sortable=True)

def __init__(self, request, queryset=Company.objects.all(), title="", extra_context={}, optimize_sorts=True):
    KiDataGrid.__init__(self, request, queryset, "Company", extra_context, optimize_sorts)
    self.default_sort = ['full_name']
    self.default_columns = ['full_name', 'website', 'vat_number', ]

... la relativa view:

def company_list(request):
    return CompanyDataGrid(request).render_to_response('crm/company/list.html')

... ed il template da utilizzare ('crm/company/list.html')

{% load datagrid %}
{% block extrahead %}
{{block.super}}
{% datagridmedia %}
{% endblock %}

{% block main %}
{% grid  %}
{% endblock %}

Warning

DataGrid necessita del KiUserProfile

Colonne collegate

Se si ha la necessita di visualizzare una colonna relativa ad una ForeignKey è possibile farlo con l'utilizzo del parametro field_name nella dichiarazione della colonna:

full_name = Column('Nome', field_name='contact__full_name', sortable=True, link=True)

Campi di ricrerca

Per abilitare il form di ricerca è necessario indicare l'elenco dei campi da ricercare:

search_fields = ('person__full_name',)

Ogni nome può essere preceduto da un marcatore che indica il tipo di ricerca da effettuare, in caso di assenza verrà usato '__icontains'

marker funzione di ricerca ====== =================== ^ __istartswith = __iexact @ __search

Personalizzare il css

Poichè DataGrid effettua delle chiamate ajax in varie occasioni la personalizzazione dei css tramite jQuery deve essere ripetuta ogni volta:

<script type="text/javascript" language="javascript">
$(document).ready(function() {

    function datagridconfig(){
        $(".datagrid tr.odd *").addClass('ui-border-reset ui-state-active ui-bg-reset ui-font-reset');
        $(".datagrid tr.even *").addClass('ui-border-reset ui-state-highlight ui-font-reset');
        $(".datagrid tr:hover").addClass('ui-border-reset ui-state-highlight');
    }

    $("div.datagrid-wrapper").datagrid();
    datagridconfig();

    $(document).ajaxStop(datagridconfig);
});

</script>