Plugin de grille de données et d'arbre jQuery EasyUI -Treegrid


jQuery EasyUI 插件jQuery EasyUI Plugin

Hérite de $.fn.datagrid.defaults. Surchargez les valeurs par défaut via $.fn.treegrid.defaults.

Le treegrid est utilisé pour afficher des données hiérarchiques au format grille. Il est basé sur le datagrid et combine le treeview et la grille modifiable. Le treegrid vous permet de créer des lignes personnalisables et extensibles de manière asynchrone et d'afficher des données hiérarchiques sur plusieurs colonnes.

Dépendances

  • datagrid

Utilisation

Créez un treegrid à partir de balisage HTML. Dans la plupart des cas, le treegrid suit la même structure et le même format que le datagrid.

<table id="tt" class="easyui-treegrid" style="width:600px;height:400px"
    data-options="url:'get_data.php',idField:'id',treeField:'name'">
    <thead>
        <tr>
            <th data-options="field:'name',width:180">Task Name</th>
            <th data-options="field:'persons',width:60,align:'right'">Persons</th>
            <th data-options="field:'begin',width:80">Begin Date</th>
            <th data-options="field:'end',width:80">End Date</th>
        </tr>
    </thead>
</table>

Créez un treegrid avec JavaScript.

<table id="tt" style="width:600px;height:400px"></table>
$('#tt').treegrid({
    url:'get_data.php',
    idField:'id',
    treeField:'name',
    columns:[[
        {title:'Task Name',field:'name',width:180},
        {field:'persons',title:'Persons',width:60,align:'right'},
        {field:'begin',title:'Begin Date',width:80},
        {field:'end',title:'End Date',width:80}
    ]]
});

Propriétés

Les propriétés héritent du datagrid. Voici les propriétés ajoutées pour le treegrid.

Name Type Description Valeur par défaut
idField string Définit le champ du nom de clé qui identifie le nœud d'arbre. Obligatoire. null
treeField string Définit le champ du nœud d'arbre. Obligatoire. null
animer booléen Définit s'il faut afficher un effet d'animation lorsque le nœud se développe ou se réduit. false
loader function(param,success,error) Définit comment charger les données depuis un serveur distant. Retournez false pour annuler l'action. Cette fonction possède les paramètres suivants :
param : L'objet de paramètres à transmettre au serveur distant.
success(data) : La fonction de rappel appelée lorsque les données sont récupérées avec succès.
error() : La fonction de rappel appelée lorsque la récupération des données échoue.
chargeur json
loadFilter function(data,parentId) Renvoie les données filtrées à afficher.

Événements

Les événements héritent de la datagrid. Voici les événements ajoutés pour le treegrid.

Name Parameters Description
onClickRow row Déclenché lorsque l'utilisateur clique sur un nœud.
onDblClickRow row Déclenché lorsque l'utilisateur double-clique sur un nœud.
onClickCell field,row Déclenché lorsque l'utilisateur clique sur une cellule.
onDblClickCell field,row Déclenché lorsque l'utilisateur double-clique sur une cellule.
onBeforeLoad row, param Déclenché avant qu'une requête de chargement de données ne soit envoyée. Retournez false pour annuler l'action de chargement.
onLoadSuccess row, data Déclenché lorsque les données sont chargées avec succès.
onLoadError arguments Déclenché lorsque le chargement des données échoue. Le paramètre arguments est identique à la méthode 'error' de jQuery.ajax.
onBeforeExpand row Déclenché avant qu'un nœud ne se développe. Retournez false pour annuler l'action d'expansion.
onExpand row Déclenché lorsqu'un nœud est développé.
onBeforeCollapse row Déclenché avant qu'un nœud ne se réduise. Retournez false pour annuler l'action de réduction.
onCollapse row Déclenché lorsqu'un nœud est réduit.
onContextMenu e, row Déclenché lorsqu'un nœud est cliqué avec le bouton droit.
onBeforeEdit row Déclenché lorsque l'utilisateur commence à modifier un nœud.
onAfterEdit row,changes Déclenché lorsque l'utilisateur termine la modification.
onCancelEdit row Déclenché lorsque l'utilisateur annule la modification d'un nœud.

Méthodes

De nombreuses méthodes nécessitent un paramètre nommé 'id', qui représente la valeur du nœud de l'arbre.

Name Parameters Description
options none Retourne les options du treegrid.
resize options Définit la taille du treegrid. Le paramètre options contient deux propriétés :
width : La nouvelle largeur du treegrid.
height : La nouvelle hauteur du treegrid.
fixRowHeight id Fixe la hauteur de la ligne spécifiée.
loadData data Charge les données du treegrid.
load param Charge et affiche la première page. Cette méthode est disponible depuis la version 1.3.4.
Exemple de code :
// load and send some request parameters
$('#tg').treegrid('load', {
    q: 'abc',
    name: 'name1'
});
reload id Recharge les données du treegrid. Si le paramètre 'id' est passé, il recharge la ligne spécifiée de l'arbre ; sinon, il recharge toutes les lignes de l'arbre.
Exemple de code :
$('#tt').treegrid('reload', 2);    // reload the row which value is equals to 2
$('#tt').treegrid('reload');    // reload the all rows
$('#tt').treegrid('reload', {id:2, q:'abc'});  // reload the specified row with 'q' parameter passing to server
reloadFooter footer Recharge les données de pied de page.
getData none Récupère les données chargées.
getFooterRows none Récupère les données de pied de page.
getRoot none Obtient le nœud racine et renvoie l'objet nœud.
getRoots none Obtient les nœuds racine et renvoie un tableau de nœuds.
getParent id Obtient le nœud parent.
getChildren id Obtient les nœuds enfants.
getSelected none Obtient le nœud sélectionné et le renvoie. Renvoie null si aucun nœud n'est sélectionné.
getSelections none Obtient tous les nœuds sélectionnés.
getLevel id Obtient le niveau du nœud spécifié.
trouver id Trouve le nœud spécifié et renvoie les données du nœud.
select id Sélectionne un nœud.
unselect id Désélectionne un nœud.
selectAll none Sélectionne tous les nœuds.
unselectAll none Désélectionne tous les nœuds.
collapse id Réduit un nœud.
expand id Développe un nœud.
collapseAll id Réduit tous les nœuds.
expandAll id Développe tous les nœuds.
expandTo id Développe un nœud spécifié à partir de la racine.
toggle id Bascule l'état développé/réduit d'un nœud.
append param Ajoute des nœuds enfants à un nœud parent. Le paramètre 'param' inclut les propriétés suivantes :
parent : L'id du nœud parent. S'il n'est pas attribué, il est ajouté en tant que nœud racine.
data : Un tableau de données de nœud.

Exemple de code :
// append some nodes to the selected row
var node = $('#tt').treegrid('getSelected');
$('#tt').treegrid('append',{
    parent: node.id,  // the node has a 'id' value that defined through 'idField' property
    data: [{
        id: '073',
        name: 'name73'
    }]
});
insert param Insère un nœud avant ou après le nœud spécifié. Le paramètre 'param' inclut les propriétés suivantes :
before : La valeur d'id du nœud avant lequel insérer.
after: La valeur id du nœud après lequel insérer.
data: Les données du nouveau nœud.

Exemple de code :
// insert a new node before the selected node
var node = $('#tt').treegrid('getSelected');
if (node){
    $('#tt').treegrid('insert', {
        before: node.id,
        data: {
            id: 38,
            name: 'name38'
        }
    });
}
Cette méthode est disponible depuis la version 1.3.1.
supprimer id Supprime le nœud et ses nœuds enfants.
pop id Extrait un nœud et renvoie les données du nœud, y compris ses nœuds enfants, après avoir supprimé le nœud. Cette méthode est disponible depuis la version 1.3.1.
refresh id Rafraîchit le nœud spécifié.
update param Met à jour le nœud spécifié. Le paramètre 'param' comprend les propriétés suivantes :
id: L'id du nœud à mettre à jour.
row: Les données de la nouvelle ligne.

Exemple de code :
$('#tt').treegrid('update',{
    id: 2,
    row: {
        name: 'new name',
        iconCls: 'icon-save'
    }
});
Cette méthode est disponible depuis la version 1.3.1.
beginEdit id Commence l'édition d'un nœud.
endEdit id Termine l'édition d'un nœud.
cancelEdit id Annule l'édition d'un nœud.
getEditors id Obtient l'éditeur de la ligne spécifiée. Chaque éditeur possède les propriétés suivantes :
actions: Les actions que l'éditeur peut effectuer.
target : L'objet jQuery de l'éditeur cible.
field : Le nom du champ.
type: Le type de l'éditeur.
getEditor param Obtient l'éditeur spécifié. Le paramètre param contient deux propriétés :
id: L'id du nœud de ligne.
field : Le nom du champ.

jQuery EasyUI 插件jQuery EasyUI Plugin Autres extensions