Documentation / @ripl/charts / ColorLegendOptions
Interface: ColorLegendOptions
Defined in: charts/src/components/color-legend.ts:32
Visual options for a ColorLegend.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
font? | string | CSS font shorthand for the value labels. | charts/src/components/color-legend.ts:44 |
fontColor? | string | Colour of the value labels. | charts/src/components/color-legend.ts:46 |
format? | (value) => string | Formats a domain value into a label (defaults to formatNumber at 2 dp). | charts/src/components/color-legend.ts:42 |
labelGap? | number | Gap between the bar and its labels in pixels. | charts/src/components/color-legend.ts:48 |
orientation? | ColorLegendOrientation | Whether the colour bar runs horizontally or vertically. Defaults to horizontal. | charts/src/components/color-legend.ts:34 |
segments? | number | Number of solid segments used to approximate the gradient. | charts/src/components/color-legend.ts:38 |
thickness? | number | Thickness of the colour bar in pixels (height when horizontal, width when vertical). | charts/src/components/color-legend.ts:36 |
tickCount? | number | Number of value labels to render. | charts/src/components/color-legend.ts:40 |