RayCraftDocs
v1.0.3
es
raycraft.dev
En esta página

DataGrid

Complete

Tabla con ordenación (clic en un encabezado: ascendente, descendente, desactivada), filtros por columna, paginación, selección de filas y plantillas.

Ejemplo

Control DataGrid

Parámetros

DataGrid

ParámetroTipoDescripción
AdaptiveboolMuestra cada fila como una tarjeta en pantallas estrechas.
AllowAddboolMuestra un botón Add que crea un elemento nuevo (vea NewItemFactory).
AllowCardViewboolAgrega a la barra de herramientas un botón que alterna entre la tabla y la vista de tarjetas.
AllowDeleteboolMuestra el comando Delete en la columna de comandos (pide confirmación).
AllowEditboolMuestra el comando Edit en la columna de comandos.
AllowPasteboolModo por lotes: agrega un botón Paste que rellena las celdas editables a partir de texto del portapapeles separado por tabulaciones.
AllowViewboolAgrega un comando View que muestra la fila de solo lectura en un cuadro de diálogo.
CardViewboolMuestra cada fila como una tarjeta en lugar de una fila de tabla. Úselo con @bind-CardView.
CellNavigationboolConvierte la cuadrícula en una cuadrícula de teclado: las flechas, Inicio, Fin, Re Pág y Av Pág se mueven entre celdas; Intro, F2 o Espacio activan el control de la celda.
ClassstringClases CSS adicionales que se agregan al elemento raíz.
ColumnMenuboolAgrega a cada encabezado un botón de menú con comandos para ordenar y ocultar la columna.
ColumnsRenderFragmentDefiniciones de columnas: elementos DataGridColumn.
DataProviderFunc<DataGridRequest, ValueTask<DataGridResult<TItem>>>Carga filas desde su lado: recibe el inicio, el número, la ordenación, los filtros, la búsqueda, los grupos y los agregados y un token de cancelación (cancelado cuando empieza una solicitud más reciente o se quita la cuadrícula), y devuelve un DataGridResult.
DenseboolUsa un relleno de celda más ajustado.
DetailTemplateRenderFragment<TItem>Contenido que se muestra bajo una fila cuando se pulsa su botón de expansión.
EditModeDataGridEditModeNone, Row (en línea), Dialog o Batch (todas las filas a la vez).
EmptyContentRenderFragmentSe muestra cuando no hay filas.
ExportChoicesboolConvierte Export en un menú: CSV o JSON, vista actual, filas seleccionadas, todas las filas, columnas ocultas.
ExportFileNamestringNombre de archivo de la exportación CSV, sin la extensión.
FilterOperatorsboolAgrega sobre cada cuadro de filtro una lista de operadores (contiene, empieza por, es igual a, mayor que, está vacío...).
FormatRulesIEnumerable<DataGridFormatRule>Reglas que colorean celdas o filas: campo, operador de filtro, valor, gravedad y Cell o Row. Gana la primera regla que coincide.
FreezeFirstColumnboolMantiene visible la primera columna al desplazarse lateralmente.
FrozenColumnsintNúmero de columnas iniciales que permanecen a la vista mientras el resto se desplaza lateralmente.
FrozenEndColumnsintNúmero de columnas del borde derecho que permanecen a la vista mientras la tabla se desplaza lateralmente.
FrozenRowsintNúmero de filas que permanecen bajo el encabezado mientras el cuerpo se desplaza (requiere Height).
GroupByFunc<TItem, Object>Agrupa filas por el valor devuelto; cada grupo tiene un encabezado contraíble.
GroupPanelboolAgrega sobre la tabla una franja donde los usuarios agrupan filas arrastrando encabezados o eligiendo columnas.
GroupSummaryboolMuestra los agregados de las columnas en las filas de grupo (calculados localmente o tomados de DataGridResult.Groups con un DataProvider).
GroupTitlestringTexto antes del valor del grupo en el encabezado.
HeightstringAltura máxima del cuerpo de la cuadrícula, por ejemplo 24rem (28rem de forma predeterminada con VirtualScroll).
ItemKeyFunc<TItem, Object>Devuelve una clave estable por elemento, para que la selección y los detalles abiertos sobrevivan a las recargas.
ItemsIEnumerable<TItem>Las opciones entre las que elegir.
KeyboardShortcutsboolCtrl+A seleccionar todo, Ctrl+C copiar las filas seleccionadas, Esc borrar la selección, Alt+flechas cambiar de página.
LabelstringTexto visible de la etiqueta (gráficos: nombre accesible; IconButton: nombre accesible y sugerencia).
LoadingboolMuestra una barra de progreso sobre las filas.
LoadingSkeletonboolMuestra filas de marcador de posición durante la primera carga.
LoadMoreboolReemplaza el paginador por un botón Load more que agrega la página siguiente.
MultiSortboolMayús+clic en los encabezados ordena por varias columnas; los encabezados muestran el orden.
NewItemFactoryFunc<TItem>Crea el elemento para una fila nueva; de forma predeterminada es el constructor sin parámetros.
NoMatchContentRenderFragmentContenido que se muestra cuando los filtros o la búsqueda no dejan filas (de forma predeterminada: un texto con Clear filters).
PageSizeintFilas por página.
PageSizeOptionsIEnumerable<int>Números de filas ofrecidos en una lista desplegable bajo la tabla.
PagingboolMuestra la barra de paginación (true de forma predeterminada).
PastePreviewboolModo por lotes: muestra qué cambiará un pegado y pregunta antes de aplicarlo (activado de forma predeterminada).
PersistKeystringRecuerda la posición y el tamaño (Window), la división (Splitter) o el diseño de un DataGrid (ordenación, filtros, columnas, anchos, página) en el almacenamiento local con este nombre y los restaura la próxima vez.
ReorderableboolPermite que los usuarios muevan columnas arrastrando los encabezados o con el menú Columns.
ResizableboolAgrega un tirador de arrastre (y flechas) para cambiar el ancho de cada columna.
RowClassFunc<TItem, string>Devuelve una clase CSS adicional para una fila.
RowHeightintAltura de fila en píxeles cuando VirtualScroll está activado (44 de forma predeterminada).
RowMenuFunc<TItem, IEnumerable<MenuCommand>>Devuelve los comandos del menú contextual de una fila.
RowReorderboolPermite arrastrar filas unas sobre otras; gestione RowMoved para cambiar su lista.
RowSeverityFunc<TItem, Severity?>Devuelve una gravedad para teñir una fila, o null.
RowValidatorFunc<TItem, IEnumerable<string>>Comprueba toda la fila después de aplicar la edición; devuelve textos de error.
SelectedItemsIEnumerable<TItem>Filas seleccionadas. Úselo con @bind-SelectedItems.
SelectionSelectionModeNone (predeterminado), Single o Multiple.
SelectionActionsRenderFragment<IReadOnlyList<TItem>>Botones en la barra de selección; recibe los elementos seleccionados.
ServerBulkLimitintCon DataProvider: el mayor número de filas que la cuadrícula pide en una solicitud para seleccionar todas las filas filtradas o exportarlas (10000 de forma predeterminada). Por encima solo se usan las filas de la página.
ShowCopyboolMuestra el botón de copiar.
ShowFiltersboolMuestra un cuadro de filtro bajo el encabezado de cada columna filtrable.
ShowPrintboolAgrega un botón Print que imprime la tabla.
ShowSearchboolAgrega un cuadro de búsqueda que encuentra texto en todas las columnas y lo marca en las celdas.
ShowSelectionBarboolMuestra la barra con el recuento de seleccionados, seleccionar todas las filas y borrar la selección (selección Multiple).
ShowToolbarboolMuestra la barra de herramientas con el selector de columnas y la exportación CSV.
StripedboolSombrea una de cada dos filas.
StylestringEstilo en línea agregado al elemento raíz.
ToolbarContentRenderFragmentContenido adicional en la barra de herramientas de una cuadrícula con ShowToolbar, por ejemplo DataGridSpreadsheetButton.
TypedFiltersboolUsa cuadros de filtro de número, fecha y sí/no según el tipo de los valores de la columna (activado de forma predeterminada).
UndoRedoboolAgrega Deshacer y Rehacer para las ediciones de filas guardadas, las filas agregadas y las eliminadas (botones y Ctrl+Z / Ctrl+Y).
ValueFiltersboolAgrega a cada encabezado filtrable un filtro de lista de valores (buscar, seleccionar todo, borrar); funciona con elementos en memoria.
VirtualScrollboolDibuja solo las filas visibles (las filas deben tener la RowHeight fija).

DataGridColumn

ParámetroTipoDescripción
AggregateDataGridAggregateAgrega un valor a la fila de resumen: Sum, Average, Min, Max o Count.
AlignTextAlignLeft (predeterminado), Center o Right.
BadgeSeveritiesIReadOnlyDictionary<string, Severity>Color de una columna Badge por valor.
CellSeverityFunc<TItem, Severity?>Devuelve una gravedad para teñir una celda, o null.
ColumnSpanFunc<TItem, int>Devuelve cuántas columnas abarca la celda de un elemento.
DataBarboolDibuja una barra detrás de los números en relación con el mayor valor de la columna.
EditableboolPermite que los usuarios editen las celdas de la columna haciendo clic en ellas.
EditOnDataGridEditOnAlways, Create (solo filas nuevas) o Update (solo filas existentes).
EditorOptionsIEnumerable<KeyValuePair<string, string>>Pares de valor y etiqueta; el editor pasa a ser una lista.
FieldstringNombre de propiedad del elemento (también funcionan nombres anidados como Address.City). Lee la celda, ordena y filtra cuando Value no está definido, y se envía a DataProvider como identificador de la columna (Title de forma predeterminada).
FilterableboolMuestra un cuadro de filtro para esta columna (true de forma predeterminada).
FormatstringCadena de formato para números y fechas, p. ej. N0 o d.
GroupstringTexto del encabezado apilado sobre esta columna; las vecinas con el mismo texto comparten una celda.
HelpTextstringUna indicación que se muestra bajo el campo en el cuadro de diálogo de edición.
HiddenboolOculta la columna al principio; los usuarios pueden mostrarla desde la barra de herramientas.
ImageAltFunc<TItem, string>Texto alternativo de una columna Image por fila.
ImageHeightintAltura de la imagen en píxeles (32 de forma predeterminada).
LinkHrefFunc<TItem, string>Dirección de una columna Link por fila (de forma predeterminada: el valor).
LinkTargetstringDestino del enlace, por ejemplo _blank.
MaxDouble?Mayor valor permitido (ProgressBar: el valor que significa 100 %; Rating: número de estrellas).
MaxLengthint?Mayor número de caracteres permitido.
MaxWidthstringContainer: ancho máximo fijo desde un punto de interrupción (Xs a Xxl). DataGridColumn: ancho máximo como longitud CSS; el tirador de redimensionado se detiene en él.
MergeRowsboolCombina verticalmente las celdas vecinas que tienen el mismo texto.
MinDouble?Menor valor permitido.
MinLengthint?Menor número de caracteres aceptado al guardar una edición.
PatternstringExpresión regular con la que debe coincidir el texto editado.
PatternMessagestringTexto de error que se muestra cuando Pattern no coincide.
ProgressMaxDoubleValor que llena una columna Progress (100 de forma predeterminada).
RequiredboolEl editor rechaza un valor vacío.
SortableboolPermite ordenar por esta columna (true de forma predeterminada).
TemplateRenderFragment<TItem>Contenido personalizado de la celda. La fila está disponible como contexto.
TitlestringTexto del título (encabezado del panel lateral, rótulo de pestaña, encabezado de columna, rótulo de paso).
TypeDataGridColumnTypeCómo se dibuja la celda: Text, Check, Image, Progress, Link, Badge o Dropdown.
ValidateFunc<TItem, Object, string>Paso de Stepper: se ejecuta antes de continuar, devuelva false para quedarse en el paso. Columna de DataGrid: recibe el elemento y el valor analizado y devuelve un texto de error o null.
ValueFunc<TItem, Object>Devuelve el valor de la celda. Se usa para mostrar, ordenar y filtrar.
WidthstringSkeleton: cualquier longitud CSS. Charts: ancho del dibujo en unidades SVG (el gráfico sigue adaptándose a su contenedor).

Eventos

DataGrid

EventoTipoDescripción
CardViewChangedEventCallback<bool>Se genera cuando el usuario alterna entre la tabla y las tarjetas.
OnLoadErrorEventCallback<Exception>Se genera con la excepción cuando DataProvider falla; la cuadrícula no muestra entonces ninguna fila. Sin un controlador, el error va al límite de errores.
OnRowDeletingEventCallback<DataGridRowChange<TItem>>Se ejecuta después de la confirmación; defina Error en el argumento para cancelar la eliminación.
OnRowSavingEventCallback<DataGridRowChange<TItem>>Se ejecuta antes de conservar una fila; defina Error en el argumento para cancelar y mostrar el texto.
PageSizeChangedEventCallback<int>Se genera cuando se elige otro tamaño de página.
RowAddedEventCallback<TItem>Se genera con el nuevo elemento tras guardarlo; agréguelo a su lista.
RowDeletedEventCallback<TItem>Se genera con el elemento tras confirmar la eliminación; quítelo de su lista.
RowMovedEventCallback<DataGridRowMove<TItem>>Se genera cuando una fila se suelta sobre otra: el elemento, los índices de página (FromIndex, ToIndex), los índices en toda la lista ordenada y filtrada (AbsoluteFromIndex, AbsoluteToIndex; PageOffset es la diferencia) y el elemento sobre el que se soltó (TargetItem).
RowSavedEventCallback<TItem>Se genera con el elemento después de aplicarle una edición válida.
RowsPastedEventCallback<int>Se genera con el número de filas rellenadas por Paste.
SelectedItemsChangedEventCallback<IEnumerable<TItem>>Se genera cuando cambia la selección.
StateChangedEventCallback<DataGridState>Informa del DataGridState tras cada cambio de ordenación, filtros, columnas, anchos o página.

DataGridColumn

EventoTipoDescripción
EditedEventCallback<DataGridEdit<TItem>>Se genera con el elemento y el nuevo texto cuando se confirma una edición.

Paquete

DataGrid forma parte de RayCraft Complete. Paquete: RayCraft.Blazor.Complete. Se obtiene del feed privado de RayCraft y requiere una licencia activa. Consulte Primeros pasos.