Skip to content

BarConfig

Example

ts
{
  width: 0.6,
  backgroundColor: '#777',
  borderColor: '#777',
  borderWidth: 0
}

Properties

width

  • Type: number
  • Default: 0.6

The width of each bar as a ratio of the available column width, where 1 fills the full column width. For example, 0.6 renders bars at 60% of the available width.

backgroundColor

  • Type: string
  • Default: '#777'

Specify the bar fill color using a CSS color string.

borderColor

  • Type: string
  • Default: '#777'

Specify the bar border color using a CSS color string.

borderWidth

  • Type: number
  • Default: 0

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

TypeScript

ts
interface BarConfig {
  width?: number;
  backgroundColor?: string;
  borderColor?: string;
  borderWidth?: number;
}

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