グループカスタマイズ構文リファレンス

[アーティクル]
04/08/2023

groupProps

関連するカスタマイズオプションをグループ化します。「リスト」、「コンパクトリスト」および「ギャラリー」レイアウトで有効です。

headerFormatter

グループヘッダーの書式設定を定義する JSON オブジェクトです。この JSON オブジェクトのスキーマは、列の書式設定のスキーマと同じです。このスキーマとその機能の詳細については、「書式設定構文リファレンス」を参照してください。「リスト」、「コンパクトリスト」および「ギャラリー」レイアウトで有効です。

footerFormatter

グループフッターおよびリストのフッターの書式設定を定義する JSON オブジェクトです。この JSON オブジェクトのスキーマは、列の書式設定のスキーマ (および rowFormatter のスキーマ) と同じです。このスキーマとその機能の詳細については、「書式設定構文リファレンス」を参照してください。「リスト」および「コンパクトリスト」レイアウトで有効です。

hideFooter

省略可能な要素です。ビュー内のリストのフッターまたはグループフッターを非表示にするかどうかを指定します。既定では、false になっています (フッターは表示されます)。 true は、ビュー内でフッターが表示されないことを示します。「リスト」および「コンパクトリスト」レイアウトで有効です。

「リスト」および「コンパクトリスト」レイアウトでは、hideFooter が footerFormatter を上書きします。

特別な文字列値

txtContent、スタイル、および属性の値には文字列または式オブジェクトを指定できます。グループと集計から値を取得するためのいくつかの特別な文字列パターンがサポートされています。

"@group"

グループ化された列のデータ、表示名、アイテム数にアクセスできるようにします。「リスト」、「コンパクトリスト」および「ギャラリー」レイアウトで有効です。 groupProps 内でのみ使用できる機能です。

この @group オブジェクトには次のプロパティ (値の例) があります。

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

「書式設定の特別な文字列値」で説明するように、ユーザーフィールドなど、リッチデータを使用したフィールドのサブプロパティにアクセスすることもできます。

{
  "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"

集計された列の値、表示名、集計の種類にアクセスできるようにします。「リスト」および「コンパクトリスト」レイアウトで有効です。 footerFormatter 内でのみ使用できる機能です。

この @columnAggregate オブジェクトには次のプロパティ (値の例) があります。

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

"@aggregates"

集計された列の値の配列、表示名、集計の種類にアクセスできるようにします。「リスト」、「コンパクトリスト」および「ギャラリー」レイアウトで有効です。 groupProps 内でのみ使用できる機能です。

この @aggregates オブジェクトには次のプロパティ (値の例) があります。書式設定 forEach プロパティを使用して反復処理を行います。

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

グループ カスタマイズ構文リファレンス