Skip to content

BoxedValueLabelConfig ​

Example ​

ts
{
  color: '#555',
  fontFamily: 'Arial',
  fontSize: 12,
  backgroundColor: 'white',
  borderWidth: 1,
  borderColor: '#1a1a1a',
  hPadding: 8,
  vPadding: 6
}

Properties ​

Base Props ​

ValueLabelConfig

backgroundColor ​

  • Type: string
  • Default: 'white'

Specify the label background color using a CSS color string.

borderWidth ​

  • Type: number
  • Default: 1

Width of the border in pixels. Set to 0 for no border.

borderColor ​

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

Specify the label border color using a CSS color string.

hPadding ​

  • Type: number
  • Default: 8

Horizontal padding inside the label box in pixels.

vPadding ​

  • Type: number
  • Default: 6

Vertical padding inside the label box in pixels.

TypeScript ​

ts
interface BoxedValueLabelConfig extends ValueLabelConfig {
  backgroundColor?: string;
  borderWidth?: number;
  borderColor?: string;
  hPadding?: number;
  vPadding?: number;
}

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