Referência de sintaxe de personalização de grupo

Artigo
01/12/2024

groupProps

Agrupa as opções de personalização relacionadas ao grupo. Válido nos layouts de 'Lista', 'Lista compacta' e 'Galeria'.

headerFormatter

Objeto JSON que define o formato do cabeçalho de grupo. O esquema deste objeto JSON é idêntico ao esquema de um formato de coluna. Para obter detalhes sobre esse esquema e suas funcionalidades, consulte a Referência de sintaxe de formatação. Válido nos layouts de 'Lista', 'Lista compacta' e 'Galeria'.

footerFormatter

Objeto JSON que define o formato do rodapé de grupo e de lista. O esquema deste objeto JSON é idêntico ao esquema de um formato de coluna (e do rowFormatter). Para obter detalhes sobre esse esquema e suas funcionalidades, consulte a Referência de sintaxe de formatação. Válida nos layouts de 'Lista' e 'Lista Compacta'.

hideFooter

Elemento opcional. Especifica se os rodapés de lista ou os rodapés de grupo na exibição estão ocultos ou não. false é o comportamento padrão (ou seja, rodapés ficarão visíveis) true significa que o modo de exibição não exibirá os rodapés. Válida nos layouts de 'Lista' e 'Lista Compacta'.

Em relação a layout de lista e lista compacta, hideFooter substitui o footerFormatter, se presente.

Valores de cadeias de caracteres especiais

Os valores para txtContent, estilos e atributos podem ser cadeias de caracteres ou objetos de expressão. Há suporte para alguns padrões de cadeias de caracteres especiais para recuperar valores de grupo e de agregados.

"@group"

Fornece acesso aos dados da coluna agrupada, ao nome de exibição e à contagem de itens. Válido nos layouts de 'Lista', 'Lista compacta' e 'Galeria'. Disponível apenas dentro das groupProps.

O objeto @group tem as seguintes propriedades (com valores de exemplo):

{
    "fieldData": "California",
    "columnDisplayName": "City",
    "count": 3
}

Você também pode acessar subpropriedades para campos com dados avançados, por exemplo, campo Pessoas, conforme mencionado em Formatando valores da cadeia de caracteres especiais.

{
  "fieldData": {
    "id": "122",
    "title": "Kalya Tucker",
    "email": "kaylat@contoso.com",
    "sip": "kaylat@contoso.com",
    "picture": "https://contoso.sharepoint.com/kaylat_contoso_com_MThumb.jpg?t=63576928822",
    "department": "Human Resources",
    "jobTitle": "HR Manager"
  },
  "columnDisplayName": "Author",
  "count": 5
}

"@columnAggregate"

Fornece acesso ao valor da coluna agregada, ao nome de exibição e ao tipo de agregação. Válida nos layouts de 'Lista' e 'Lista Compacta'. Disponível apenas dentro do footerFormatter.

O objeto @columnAggregate tem as seguintes propriedades (com valores de exemplo):

{
  "value": "3",
  "columnDisplayName": "Approved",
  "type": "Count"
}

"@aggregates"

Fornece acesso à matriz de valor da coluna agregada, nome de exibição e tipo de agregação. Válido nos layouts de 'Lista', 'Lista compacta' e 'Galeria'. Disponível apenas dentro das groupProps.

O objeto @aggregates tem as seguintes propriedades (com valor de exemplo) e pode ser iterado ao usar a propriedade Formato forEach .

[
  {
    "value": "3",
    "columnDisplayName": "Approved",
    "type": "Count"
  },
  {
    "value": "1.2",
    "columnDisplayName": "Growth",
    "type": "Average"
  },
  {
    "value": "0.33%",
    "columnDisplayName": "Rate of change",
    "type": "Variance"
  }
]

Compartilhar via