Skip to main content

GroupBy Spec

Defines grouping of SmallMultiples.

Compatible Specs

GroupBy goes hand-in-hand with SmallMultiples spec to define a faceted chart.

Supported chart types include:

Overrides

  • chartType -> ChartType.Global
  • specType -> SpecType.IndexOrder

Props

All props can be found via GroupByProps type.

Spec Props

Inherits Spec props

by

  • Type: by: GroupByAccessor<D>

Function to return a unique value by which to group the data

sort

  • Type: sort: GroupBySort

Sort predicate used to sort grouped data

format

  • Type: format?: GroupByFormatter<D>

Formatter used on all by values.

info

Only for displayed values, not used in sorting or other internal computations.