RelationshipLegend
Name: Relationship Legend
Description: Legend used for Relationship data type (default corresponds to
categoryLabels
)
params$
Type:
Partial<RelationshipLegendParams>
Fields:
Name Description Type placement Placement position Placement
padding Padding from the border number
backgroundFill Background color type ColorType
backgroundStroke Border color type ColorType
gap Legend gap distance number
listRectWidth List icon width number
listRectHeight List icon height number
listRectRadius List icon border radius number
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: 'right-end',
padding: 28,
backgroundFill: 'none',
backgroundStroke: 'none',
gap: 10,
listRectWidth: 14,
listRectHeight: 14,
listRectRadius: 0,
textColorType: 'primary'
}