RayCraftDocs
v1.0.3
fr
raycraft.dev
Sur cette page

DataGrid

Complete

Tableau avec tri (clic sur un en-tête : croissant, décroissant, désactivé), filtres par colonne, pagination, sélection de lignes et modèles.

Exemple

Contrôle DataGrid

Paramètres

DataGrid

ParamètreTypeDescription
AdaptiveboolAffiche chaque ligne sous forme de carte sur les écrans étroits.
AllowAddboolAffiche un bouton Add qui crée un nouvel élément (voir NewItemFactory).
AllowCardViewboolAjoute à la barre d'outils un bouton qui bascule entre le tableau et l'affichage en cartes.
AllowDeleteboolAffiche la commande Delete dans la colonne des commandes (demande confirmation).
AllowEditboolAffiche la commande Edit dans la colonne des commandes.
AllowPasteboolMode par lot : ajoute un bouton Paste qui remplit les cellules modifiables à partir d'un texte du presse-papiers séparé par des tabulations.
AllowViewboolAjoute une commande View qui affiche la ligne en lecture seule dans une boîte de dialogue.
CardViewboolAffiche chaque ligne sous forme de carte au lieu d'une ligne de tableau. À utiliser avec @bind-CardView.
CellNavigationboolFait de la grille une grille au clavier : les flèches, Origine, Fin, Page précédente et Page suivante se déplacent entre les cellules ; Entrée, F2 ou Espace activent le contrôle de la cellule.
ClassstringClasses CSS supplémentaires ajoutées à l'élément racine.
ColumnMenuboolAjoute à chaque en-tête un bouton de menu avec des commandes de tri et de masquage de colonne.
ColumnsRenderFragmentDéfinitions de colonnes : éléments DataGridColumn.
DataProviderFunc<DataGridRequest, ValueTask<DataGridResult<TItem>>>Charge des lignes de votre côté : reçoit le début, le nombre, le tri, les filtres, la recherche, les groupes et les agrégats ainsi qu'un jeton d'annulation (annulé quand une requête plus récente démarre ou que la grille est retirée), et renvoie un DataGridResult.
DenseboolUtilise un remplissage de cellule plus serré.
DetailTemplateRenderFragment<TItem>Contenu affiché sous une ligne quand son bouton de développement est actionné.
EditModeDataGridEditModeNone, Row (en ligne), Dialog ou Batch (toutes les lignes d'un coup).
EmptyContentRenderFragmentAffiché quand il n'y a aucune ligne.
ExportChoicesboolTransforme Export en menu : CSV ou JSON, vue actuelle, lignes sélectionnées, toutes les lignes, colonnes masquées.
ExportFileNamestringNom du fichier de l'export CSV, sans extension.
FilterOperatorsboolAjoute au-dessus de chaque zone de filtre une liste d'opérateurs (contient, commence par, égale, supérieur à, est vide...).
FormatRulesIEnumerable<DataGridFormatRule>Règles qui colorent des cellules ou des lignes : champ, opérateur de filtre, valeur, gravité et Cell ou Row. La première règle qui correspond l'emporte.
FreezeFirstColumnboolMaintient la première colonne visible pendant le défilement latéral.
FrozenColumnsintNombre de colonnes de tête qui restent visibles pendant que le reste défile latéralement.
FrozenEndColumnsintNombre de colonnes au bord droit qui restent visibles pendant le défilement latéral du tableau.
FrozenRowsintNombre de lignes qui restent sous l'en-tête pendant que le corps défile (nécessite Height).
GroupByFunc<TItem, Object>Groupe les lignes selon la valeur renvoyée ; chaque groupe a un en-tête repliable.
GroupPanelboolAjoute au-dessus du tableau une bande où les utilisateurs regroupent les lignes en glissant des en-têtes ou en choisissant des colonnes.
GroupSummaryboolAffiche les agrégats des colonnes dans les lignes de groupe (calculés localement, ou repris de DataGridResult.Groups avec un DataProvider).
GroupTitlestringTexte avant la valeur du groupe dans l'en-tête.
HeightstringHauteur maximale du corps de la grille, par exemple 24rem (28rem par défaut avec VirtualScroll).
ItemKeyFunc<TItem, Object>Renvoie une clé stable par élément, afin que la sélection et les détails ouverts survivent aux rechargements.
ItemsIEnumerable<TItem>Les options à choisir.
KeyboardShortcutsboolCtrl+A tout sélectionner, Ctrl+C copier les lignes sélectionnées, Échap effacer la sélection, Alt+flèches changer de page.
LabelstringTexte d'étiquette visible (graphiques : nom accessible ; IconButton : nom accessible et info-bulle).
LoadingboolAffiche une barre de progression au-dessus des lignes.
LoadingSkeletonboolAffiche des lignes indicatives pendant le premier chargement.
LoadMoreboolRemplace la pagination par un bouton Load more qui ajoute la page suivante.
MultiSortboolMaj+clic sur les en-têtes trie selon plusieurs colonnes ; les en-têtes montrent l'ordre.
NewItemFactoryFunc<TItem>Crée l'élément d'une nouvelle ligne ; par défaut le constructeur sans paramètre.
NoMatchContentRenderFragmentContenu affiché quand les filtres ou la recherche ne laissent aucune ligne (par défaut : un texte avec Clear filters).
PageSizeintLignes par page.
PageSizeOptionsIEnumerable<int>Nombres de lignes proposés dans une liste déroulante sous le tableau.
PagingboolAffiche la barre de pagination (true par défaut).
PastePreviewboolMode par lot : montre ce qu'un collage va modifier et demande avant de l'appliquer (activé par défaut).
PersistKeystringMémorise la position et la taille (Window), la division (Splitter) ou la disposition d'un DataGrid (tri, filtres, colonnes, largeurs, page) dans le stockage local sous ce nom et les restaure la fois suivante.
ReorderableboolPermet aux utilisateurs de déplacer des colonnes en glissant les en-têtes ou avec le menu Columns.
ResizableboolAjoute une poignée de glissement (et des flèches) pour redimensionner chaque colonne.
RowClassFunc<TItem, string>Renvoie une classe CSS supplémentaire pour une ligne.
RowHeightintHauteur de ligne en pixels quand VirtualScroll est activé (44 par défaut).
RowMenuFunc<TItem, IEnumerable<MenuCommand>>Renvoie les commandes du menu contextuel d'une ligne.
RowReorderboolPermet de glisser des lignes les unes sur les autres ; gérez RowMoved pour modifier votre liste.
RowSeverityFunc<TItem, Severity?>Renvoie une gravité pour teinter une ligne, ou null.
RowValidatorFunc<TItem, IEnumerable<string>>Vérifie toute la ligne après l'application de la modification ; renvoie des textes d'erreur.
SelectedItemsIEnumerable<TItem>Lignes sélectionnées. À utiliser avec @bind-SelectedItems.
SelectionSelectionModeNone (par défaut), Single ou Multiple.
SelectionActionsRenderFragment<IReadOnlyList<TItem>>Boutons dans la barre de sélection ; reçoit les éléments sélectionnés.
ServerBulkLimitintAvec DataProvider : le plus grand nombre de lignes que la grille demande en une requête pour sélectionner toutes les lignes filtrées ou les exporter (10000 par défaut). Au-delà, seules les lignes de la page sont utilisées.
ShowCopyboolAffiche le bouton de copie.
ShowFiltersboolAffiche une zone de filtre sous l'en-tête de chaque colonne filtrable.
ShowPrintboolAjoute un bouton Print qui imprime le tableau.
ShowSearchboolAjoute une zone de recherche qui trouve du texte dans toutes les colonnes et le met en évidence dans les cellules.
ShowSelectionBarboolAffiche la barre avec le nombre de lignes sélectionnées, sélectionner toutes les lignes et effacer la sélection (sélection Multiple).
ShowToolbarboolAffiche la barre d'outils avec le sélecteur de colonnes et l'export CSV.
StripedboolOmbre une ligne sur deux.
StylestringStyle en ligne ajouté à l'élément racine.
ToolbarContentRenderFragmentContenu supplémentaire dans la barre d'outils d'une grille avec ShowToolbar, par exemple DataGridSpreadsheetButton.
TypedFiltersboolUtilise des zones de filtre pour nombre, date et oui/non selon le type des valeurs de la colonne (activé par défaut).
UndoRedoboolAjoute Annuler et Rétablir pour les modifications de lignes enregistrées, les lignes ajoutées et supprimées (boutons et Ctrl+Z / Ctrl+Y).
ValueFiltersboolAjoute à chaque en-tête filtrable un filtre par liste de valeurs (recherche, tout sélectionner, effacer) ; fonctionne sur les éléments en mémoire.
VirtualScrollboolNe dessine que les lignes visibles (les lignes doivent avoir la RowHeight fixe).

DataGridColumn

ParamètreTypeDescription
AggregateDataGridAggregateAjoute une valeur à la ligne de synthèse : Sum, Average, Min, Max ou Count.
AlignTextAlignLeft (par défaut), Center ou Right.
BadgeSeveritiesIReadOnlyDictionary<string, Severity>Couleur d'une colonne Badge par valeur.
CellSeverityFunc<TItem, Severity?>Renvoie une gravité pour teinter une cellule, ou null.
ColumnSpanFunc<TItem, int>Renvoie le nombre de colonnes couvertes par la cellule d'un élément.
DataBarboolDessine une barre derrière les nombres relativement à la plus grande valeur de la colonne.
EditableboolPermet aux utilisateurs de modifier les cellules de la colonne en cliquant dessus.
EditOnDataGridEditOnAlways, Create (nouvelles lignes seulement) ou Update (lignes existantes seulement).
EditorOptionsIEnumerable<KeyValuePair<string, string>>Paires valeur et étiquette ; l'éditeur devient une liste.
FieldstringNom de propriété de l'élément (les noms imbriqués comme Address.City fonctionnent). Il lit la cellule, trie et filtre quand Value n'est pas défini, et il est envoyé à DataProvider comme identifiant de colonne (Title par défaut).
FilterableboolAffiche une zone de filtre pour cette colonne (true par défaut).
FormatstringChaîne de format pour les nombres et les dates, p. ex. N0 ou d.
GroupstringTexte de l'en-tête empilé au-dessus de cette colonne ; les voisines avec le même texte partagent une cellule.
HelpTextstringUne indication affichée sous le champ dans la boîte de dialogue de modification.
HiddenboolMasque d'abord la colonne ; les utilisateurs peuvent l'afficher depuis la barre d'outils.
ImageAltFunc<TItem, string>Texte alternatif d'une colonne Image par ligne.
ImageHeightintHauteur de l'image en pixels (32 par défaut).
LinkHrefFunc<TItem, string>Adresse d'une colonne Link par ligne (par défaut : la valeur).
LinkTargetstringCible du lien, par exemple _blank.
MaxDouble?Plus grande valeur autorisée (ProgressBar : la valeur qui signifie 100 % ; Rating : nombre d'étoiles).
MaxLengthint?Plus grand nombre de caractères autorisé.
MaxWidthstringContainer : largeur maximale fixe à partir d'un point de rupture (Xs à Xxl). DataGridColumn : largeur maximale en longueur CSS ; la poignée de redimensionnement s'y arrête.
MergeRowsboolFusionne verticalement les cellules voisines qui ont le même texte.
MinDouble?Plus petite valeur autorisée.
MinLengthint?Plus petit nombre de caractères accepté lors de l'enregistrement d'une modification.
PatternstringExpression régulière que le texte modifié doit respecter.
PatternMessagestringTexte d'erreur affiché quand Pattern ne correspond pas.
ProgressMaxDoubleValeur qui remplit une colonne Progress (100 par défaut).
RequiredboolL'éditeur refuse une valeur vide.
SortableboolAutorise le tri par cette colonne (true par défaut).
TemplateRenderFragment<TItem>Contenu personnalisé de la cellule. La ligne est disponible comme contexte.
TitlestringTexte du titre (en-tête de tiroir, légende d'onglet, en-tête de colonne, légende d'étape).
TypeDataGridColumnTypeComment la cellule est dessinée : Text, Check, Image, Progress, Link, Badge ou Dropdown.
ValidateFunc<TItem, Object, string>Étape de Stepper : s'exécute avant de passer à la suivante, renvoyez false pour rester sur l'étape. Colonne de DataGrid : reçoit l'élément et la valeur analysée et renvoie un texte d'erreur ou null.
ValueFunc<TItem, Object>Renvoie la valeur de la cellule. Utilisée pour l'affichage, le tri et le filtrage.
WidthstringSkeleton : toute longueur CSS. Charts : largeur du dessin en unités SVG (le graphique s'adapte toujours à son conteneur).

Événements

DataGrid

ÉvénementTypeDescription
CardViewChangedEventCallback<bool>Déclenché quand l'utilisateur bascule entre le tableau et les cartes.
OnLoadErrorEventCallback<Exception>Déclenché avec l'exception quand DataProvider échoue ; la grille n'affiche alors aucune ligne. Sans gestionnaire, l'erreur va à la limite d'erreur.
OnRowDeletingEventCallback<DataGridRowChange<TItem>>S'exécute après la confirmation ; définissez Error sur l'argument pour annuler la suppression.
OnRowSavingEventCallback<DataGridRowChange<TItem>>S'exécute avant qu'une ligne soit conservée ; définissez Error sur l'argument pour annuler et afficher le texte.
PageSizeChangedEventCallback<int>Déclenché quand une autre taille de page est choisie.
RowAddedEventCallback<TItem>Déclenché avec le nouvel élément après son enregistrement ; ajoutez-le à votre liste.
RowDeletedEventCallback<TItem>Déclenché avec l'élément après la confirmation de la suppression ; retirez-le de votre liste.
RowMovedEventCallback<DataGridRowMove<TItem>>Déclenché quand une ligne est déposée sur une autre : l'élément, les index de page (FromIndex, ToIndex), les index dans toute la liste triée et filtrée (AbsoluteFromIndex, AbsoluteToIndex ; PageOffset est la différence) et l'élément sur lequel elle a été déposée (TargetItem).
RowSavedEventCallback<TItem>Déclenché avec l'élément après l'application d'une modification valide.
RowsPastedEventCallback<int>Déclenché avec le nombre de lignes remplies par Paste.
SelectedItemsChangedEventCallback<IEnumerable<TItem>>Déclenché quand la sélection change.
StateChangedEventCallback<DataGridState>Signale le DataGridState après chaque changement de tri, de filtres, de colonnes, de largeurs ou de page.

DataGridColumn

ÉvénementTypeDescription
EditedEventCallback<DataGridEdit<TItem>>Déclenché avec l'élément et le nouveau texte quand une modification est confirmée.

Paquet

DataGrid fait partie de RayCraft Complete. Paquet : RayCraft.Blazor.Complete. Il provient du flux privé RayCraft et nécessite une licence active. Voir Premiers pas.