Skip to content

BordersConfig

Example

ts
{
  left: false,
  right: false,
  top: { color: '#ccc', width: 2 },
  bottom: { color: '#ddd', width: 1, style: 'solid' }
}

Properties

Each border side accepts either false or a LineConfig object. When set to false, the border is hidden. When set to a LineConfig object, the border is shown with the specified configuration.

left

  • Type: false | LineConfig
  • Default: { color: '#ddd', style: 'solid', width: 1, dashes: [5, 5], endDotSize: 0 }
  • Type: false | LineConfig
  • Default: { color: '#ddd', style: 'solid', width: 1, dashes: [5, 5], endDotSize: 0 }

top

  • Type: false | LineConfig
  • Default: { color: '#ddd', style: 'solid', width: 1, dashes: [5, 5], endDotSize: 0 }

bottom

  • Type: false | LineConfig
  • Default: { color: '#ddd', style: 'solid', width: 1, dashes: [5, 5], endDotSize: 0 }

TypeScript

ts
interface BordersConfig {
  left?: false | LineConfig;
  right?: false | LineConfig;
  top?: false | LineConfig;
  bottom?: false | LineConfig;
}

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