Skip to content

LegendFieldConfig

Example

ts
{
  output: 'k',
  label: '%K',
  color: '#1a1a1a'
}

Properties

output

  • Type: string

The output key of the layer value to display in the legend (e.g. 'k', 'd', 'close', 'value').

label

  • Type: string

A text label to display alongside the value. Defaults to the layer's own label for the given output.

color

  • Type: string
  • Default: '#1a1a1a'

Specify the field's text color using a CSS color string.

TypeScript

ts
interface LegendFieldConfig {
  output: string;
  label?: string;
  color?: string;
}

React Candlesticks is available on npm and GitHub under the MIT License.