MultiGridLegend

• Name: MultiGrid Legend

• Description: Legend used in MultiGrid data type, similar to GridLegend in Grid data type. It also corresponds to rowLabels, but the difference is that rowLabels in MultiGrid data type's dataFormatter$ is under the gridList field (there are multiple sets).

• Playground Example

params$

• Type: Partial<MultiGridLegendParams>

• Fields:

  Name	Description	Type
  placement	Placement	Placement
  padding	Margin	number
  backgroundFill	Background color type	ColorType
  backgroundStroke	Border color type	ColorType
  gap	Legend interval	number
  listRectWidth	List icon width	number
  listRectHeight	List icon height	number
  listRectRadius	List icon border radius	number
  gridList	Individual Grid index settings for each group of data (overrides default settings)	Object[]
  textColorType	Text color type	ColorType

Detailed Types

type ColorType = 'none' | 'label' | 'labelContrast' | 'primary' | 'secondary' | 'background'

type Placement = 'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end' | 'right' | 'right-start' | 'right-end'

• Default values:

{
  placement: 'bottom',
  padding: 28,
  backgroundFill: 'none',
  backgroundStroke: 'none',
  gap: 10,
  listRectWidth: 14,
  listRectHeight: 14,
  listRectRadius: 0,
  gridList: [
    {
      listRectWidth: 14,
      listRectHeight: 14,
      listRectRadius: 0,
    }
  ],
  textColorType: 'primary'
}