---
id: "packages/active-charts/all-exports/candlestick-series-options"
title: "CandlestickSeriesOptions"
description: "CandlestickSeriesOptions: generated from the source of active-charts."
url: "/packages/active-charts/all-exports/candlestick-series-options"
locale: "en"
revision: "g0mvjxwj5c-88bdbe1c:candlestick-series-options"
---

# CandlestickSeriesOptions

Exported by `@workspace/active-charts`. Generated from the package source; part of [the index of every export](/packages/active-charts/all-exports).

## Types

**CandlestickSeriesOptions**

```ts
interface CandlestickSeriesOptions {
  type: 'candlestick';
  xKey: string;
  openKey: string;
  highKey: string;
  lowKey: string;
  closeKey: string;
  id?: string;
  name?: string;
  visible?: boolean;
  showInLegend?: boolean;
  yAxisId?: string;
  highlightStyle?: HighlightStyleOptions;
  up?: {
    fill?: string;
    stroke?: string;
  };
  down?: {
    fill?: string;
    stroke?: string;
  };
  widthRatio?: number;
  wickStrokeWidth?: number;
  bodyStrokeWidth?: number;
  animation?: boolean | SeriesAnimationOptions;
}
```