RayCraftDocs
v1.0.3
pt-BR
raycraft.dev
Nesta página

DataGrid

Complete

Tabela com ordenação (clique em um cabeçalho: crescente, decrescente, desligado), filtros por coluna, paginação, seleção de linhas e modelos.

Exemplo

Controle DataGrid

Parâmetros

DataGrid

ParâmetroTipoDescrição
AdaptiveboolMostra cada linha como um cartão em telas estreitas.
AllowAddboolMostra um botão Add que cria um novo item (veja NewItemFactory).
AllowCardViewboolAdiciona à barra de ferramentas um botão que alterna entre a tabela e a visualização em cartões.
AllowDeleteboolMostra o comando Delete na coluna de comandos (pede confirmação).
AllowEditboolMostra o comando Edit na coluna de comandos.
AllowPasteboolModo em lote: adiciona um botão Paste que preenche as células editáveis a partir de texto da área de transferência separado por tabulações.
AllowViewboolAdiciona um comando View que mostra a linha somente para leitura em uma caixa de diálogo.
CardViewboolMostra cada linha como um cartão em vez de uma linha de tabela. Use com @bind-CardView.
CellNavigationboolFaz da grade uma grade de teclado: as setas, Home, End, Page Up e Page Down movem entre células; Enter, F2 ou Espaço ativam o controle da célula.
ClassstringClasses CSS extras adicionadas ao elemento raiz.
ColumnMenuboolAdiciona a cada cabeçalho um botão de menu com comandos de ordenação e de ocultar coluna.
ColumnsRenderFragmentDefinições de colunas: elementos DataGridColumn.
DataProviderFunc<DataGridRequest, ValueTask<DataGridResult<TItem>>>Carrega linhas do seu lado: recebe o início, a quantidade, a ordenação, os filtros, a pesquisa, os grupos e os agregados e um token de cancelamento (cancelado quando uma solicitação mais nova começa ou a grade é removida), e devolve um DataGridResult.
DenseboolUsa um preenchimento de célula mais justo.
DetailTemplateRenderFragment<TItem>Conteúdo mostrado sob uma linha quando o botão de expandir dela é pressionado.
EditModeDataGridEditModeNone, Row (em linha), Dialog ou Batch (todas as linhas de uma vez).
EmptyContentRenderFragmentMostrado quando não há linhas.
ExportChoicesboolTransforma Export em um menu: CSV ou JSON, visualização atual, linhas selecionadas, todas as linhas, colunas ocultas.
ExportFileNamestringNome do arquivo da exportação CSV, sem a extensão.
FilterOperatorsboolAdiciona acima de cada caixa de filtro uma lista de operadores (contém, começa com, é igual a, maior que, está vazio...).
FormatRulesIEnumerable<DataGridFormatRule>Regras que colorem células ou linhas: campo, operador de filtro, valor, gravidade e Cell ou Row. A primeira regra que corresponde vence.
FreezeFirstColumnboolMantém a primeira coluna visível na rolagem lateral.
FrozenColumnsintNúmero de colunas iniciais que permanecem à vista enquanto o restante rola para o lado.
FrozenEndColumnsintNúmero de colunas na borda direita que permanecem à vista enquanto a tabela rola para o lado.
FrozenRowsintNúmero de linhas que permanecem sob o cabeçalho enquanto o corpo rola (requer Height).
GroupByFunc<TItem, Object>Agrupa linhas pelo valor retornado; cada grupo tem um cabeçalho recolhível.
GroupPanelboolAdiciona uma faixa acima da tabela onde os usuários agrupam linhas arrastando cabeçalhos ou escolhendo colunas.
GroupSummaryboolMostra os agregados das colunas nas linhas de grupo (calculados localmente ou tomados de DataGridResult.Groups com um DataProvider).
GroupTitlestringTexto antes do valor do grupo no cabeçalho.
HeightstringAltura máxima do corpo da grade, por exemplo 24rem (28rem por padrão com VirtualScroll).
ItemKeyFunc<TItem, Object>Devolve uma chave estável por item, para que a seleção e os detalhes abertos sobrevivam a recarregamentos.
ItemsIEnumerable<TItem>As opções entre as quais escolher.
KeyboardShortcutsboolCtrl+A selecionar tudo, Ctrl+C copiar linhas selecionadas, Esc limpar a seleção, Alt+setas mudar de página.
LabelstringTexto visível do rótulo (gráficos: nome acessível; IconButton: nome acessível e dica de ferramenta).
LoadingboolMostra uma barra de progresso acima das linhas.
LoadingSkeletonboolMostra linhas de espaço reservado durante o primeiro carregamento.
LoadMoreboolSubstitui o paginador por um botão Load more que acrescenta a próxima página.
MultiSortboolShift+clique nos cabeçalhos ordena por várias colunas; os cabeçalhos mostram a ordem.
NewItemFactoryFunc<TItem>Cria o item para uma nova linha; por padrão é o construtor sem parâmetros.
NoMatchContentRenderFragmentConteúdo mostrado quando filtros ou pesquisa não deixam linhas (por padrão: um texto com Clear filters).
PageSizeintLinhas por página.
PageSizeOptionsIEnumerable<int>Quantidades de linhas oferecidas em uma lista suspensa sob a tabela.
PagingboolMostra a barra de paginação (true por padrão).
PastePreviewboolModo em lote: mostra o que uma colagem vai alterar e pergunta antes de aplicá-la (ativado por padrão).
PersistKeystringLembra a posição e o tamanho (Window), a divisão (Splitter) ou o layout de um DataGrid (ordenação, filtros, colunas, larguras, página) no armazenamento local com este nome e os restaura da próxima vez.
ReorderableboolPermite que os usuários movam colunas arrastando os cabeçalhos ou com o menu Columns.
ResizableboolAdiciona uma alça de arrasto (e setas) para redimensionar cada coluna.
RowClassFunc<TItem, string>Devolve uma classe CSS extra para uma linha.
RowHeightintAltura da linha em pixels quando VirtualScroll está ativado (44 por padrão).
RowMenuFunc<TItem, IEnumerable<MenuCommand>>Devolve os comandos do menu de contexto de uma linha.
RowReorderboolPermite arrastar linhas umas sobre as outras; trate RowMoved para alterar a sua lista.
RowSeverityFunc<TItem, Severity?>Devolve uma gravidade para tingir uma linha, ou null.
RowValidatorFunc<TItem, IEnumerable<string>>Verifica a linha inteira depois que a edição é aplicada; devolve textos de erro.
SelectedItemsIEnumerable<TItem>Linhas selecionadas. Use com @bind-SelectedItems.
SelectionSelectionModeNone (padrão), Single ou Multiple.
SelectionActionsRenderFragment<IReadOnlyList<TItem>>Botões na barra de seleção; recebe os itens selecionados.
ServerBulkLimitintCom DataProvider: o maior número de linhas que a grade pede em uma solicitação para selecionar todas as linhas filtradas ou exportá-las (10000 por padrão). Acima disso, só as linhas da página são usadas.
ShowCopyboolMostra o botão de copiar.
ShowFiltersboolMostra uma caixa de filtro sob o cabeçalho de cada coluna filtrável.
ShowPrintboolAdiciona um botão Print que imprime a tabela.
ShowSearchboolAdiciona uma caixa de pesquisa que encontra texto em todas as colunas e o marca nas células.
ShowSelectionBarboolMostra a barra com a contagem de selecionados, selecionar todas as linhas e limpar a seleção (seleção Multiple).
ShowToolbarboolMostra a barra de ferramentas com o seletor de colunas e a exportação CSV.
StripedboolSombreia uma linha sim, outra não.
StylestringEstilo embutido adicionado ao elemento raiz.
ToolbarContentRenderFragmentConteúdo extra na barra de ferramentas de uma grade com ShowToolbar, por exemplo DataGridSpreadsheetButton.
TypedFiltersboolUsa caixas de filtro de número, data e sim/não conforme o tipo dos valores da coluna (ativado por padrão).
UndoRedoboolAdiciona Desfazer e Refazer para edições de linhas salvas, linhas adicionadas e linhas excluídas (botões e Ctrl+Z / Ctrl+Y).
ValueFiltersboolAdiciona a cada cabeçalho filtrável um filtro de lista de valores (pesquisar, selecionar tudo, limpar); funciona com itens na memória.
VirtualScrollboolDesenha apenas as linhas visíveis (as linhas devem ter a RowHeight fixa).

DataGridColumn

ParâmetroTipoDescrição
AggregateDataGridAggregateAdiciona um valor à linha de resumo: Sum, Average, Min, Max ou Count.
AlignTextAlignLeft (padrão), Center ou Right.
BadgeSeveritiesIReadOnlyDictionary<string, Severity>Cor de uma coluna Badge por valor.
CellSeverityFunc<TItem, Severity?>Devolve uma gravidade para tingir uma célula, ou null.
ColumnSpanFunc<TItem, int>Devolve quantas colunas a célula de um item cobre.
DataBarboolDesenha uma barra atrás dos números em relação ao maior valor da coluna.
EditableboolPermite que os usuários editem as células da coluna clicando nelas.
EditOnDataGridEditOnAlways, Create (somente linhas novas) ou Update (somente linhas existentes).
EditorOptionsIEnumerable<KeyValuePair<string, string>>Pares de valor e rótulo; o editor vira uma lista.
FieldstringNome da propriedade do item (nomes aninhados como Address.City funcionam). Ele lê a célula, ordena e filtra quando Value não está definido, e é enviado ao DataProvider como identificador da coluna (Title por padrão).
FilterableboolMostra uma caixa de filtro para esta coluna (true por padrão).
FormatstringString de formato para números e datas, p. ex. N0 ou d.
GroupstringTexto do cabeçalho empilhado acima desta coluna; vizinhas com o mesmo texto compartilham uma célula.
HelpTextstringUma dica mostrada sob o campo na caixa de diálogo de edição.
HiddenboolOculta a coluna no início; os usuários podem mostrá-la pela barra de ferramentas.
ImageAltFunc<TItem, string>Texto alternativo de uma coluna Image por linha.
ImageHeightintAltura da imagem em pixels (32 por padrão).
LinkHrefFunc<TItem, string>Endereço de uma coluna Link por linha (por padrão: o valor).
LinkTargetstringDestino do link, por exemplo _blank.
MaxDouble?Maior valor permitido (ProgressBar: o valor que significa 100%; Rating: número de estrelas).
MaxLengthint?Maior número de caracteres permitido.
MaxWidthstringContainer: largura máxima fixa a partir de um ponto de interrupção (Xs a Xxl). DataGridColumn: maior largura como comprimento CSS; a alça de redimensionamento para nela.
MergeRowsboolMescla verticalmente células vizinhas que têm o mesmo texto.
MinDouble?Menor valor permitido.
MinLengthint?Menor número de caracteres aceito ao salvar uma edição.
PatternstringExpressão regular com a qual o texto editado deve corresponder.
PatternMessagestringTexto de erro mostrado quando Pattern não corresponde.
ProgressMaxDoubleValor que preenche uma coluna Progress (100 por padrão).
RequiredboolO editor recusa um valor vazio.
SortableboolPermite ordenar por esta coluna (true por padrão).
TemplateRenderFragment<TItem>Conteúdo personalizado da célula. A linha está disponível como contexto.
TitlestringTexto de título (cabeçalho da gaveta, legenda de guia, título de coluna, legenda de etapa).
TypeDataGridColumnTypeComo a célula é desenhada: Text, Check, Image, Progress, Link, Badge ou Dropdown.
ValidateFunc<TItem, Object, string>Etapa do Stepper: executada antes de avançar, devolva false para permanecer na etapa. Coluna do DataGrid: recebe o item e o valor interpretado e devolve um texto de erro ou null.
ValueFunc<TItem, Object>Devolve o valor da célula. Usado para exibição, ordenação e filtragem.
WidthstringSkeleton: qualquer comprimento CSS. Charts: largura do desenho em unidades SVG (o gráfico continua se ajustando ao seu contêiner).

Eventos

DataGrid

EventoTipoDescrição
CardViewChangedEventCallback<bool>Gerado quando o usuário alterna entre a tabela e os cartões.
OnLoadErrorEventCallback<Exception>Gerado com a exceção quando DataProvider falha; a grade então não mostra linhas. Sem um tratador, o erro vai para o limite de erro.
OnRowDeletingEventCallback<DataGridRowChange<TItem>>Executado após a confirmação; defina Error no argumento para cancelar a exclusão.
OnRowSavingEventCallback<DataGridRowChange<TItem>>Executado antes de uma linha ser mantida; defina Error no argumento para cancelar e mostrar o texto.
PageSizeChangedEventCallback<int>Gerado quando outro tamanho de página é escolhido.
RowAddedEventCallback<TItem>Gerado com o novo item depois que ele foi salvo; adicione-o à sua lista.
RowDeletedEventCallback<TItem>Gerado com o item depois que a exclusão foi confirmada; remova-o da sua lista.
RowMovedEventCallback<DataGridRowMove<TItem>>Gerado quando uma linha é solta sobre outra: o item, os índices da página (FromIndex, ToIndex), os índices em toda a lista ordenada e filtrada (AbsoluteFromIndex, AbsoluteToIndex; PageOffset é a diferença) e o item sobre o qual foi solta (TargetItem).
RowSavedEventCallback<TItem>Gerado com o item depois que uma edição válida foi aplicada a ele.
RowsPastedEventCallback<int>Gerado com o número de linhas preenchidas por Paste.
SelectedItemsChangedEventCallback<IEnumerable<TItem>>Gerado quando a seleção muda.
StateChangedEventCallback<DataGridState>Informa o DataGridState após cada mudança de ordenação, filtros, colunas, larguras ou página.

DataGridColumn

EventoTipoDescrição
EditedEventCallback<DataGridEdit<TItem>>Gerado com o item e o novo texto quando uma edição é confirmada.

Pacote

DataGrid faz parte do RayCraft Complete. Pacote: RayCraft.Blazor.Complete. Vem do feed privado do RayCraft e requer uma licença ativa. Veja Primeiros passos.