> For the complete documentation index, see [llms.txt](https://nocode-artisan.gitbook.io/plotly-charts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://nocode-artisan.gitbook.io/plotly-charts/additional-resources/elements-fields-reference/traces/business-and-financial-charts/candlestick.md).

# Candlestick & OHLC

### Basic Options

<details>

<summary>Name</summary>

**Type**: string

**Documentation**: Sets the trace name. The trace name appears as the legend item and on hover.

**Path**: data.index.name

</details>

<details>

<summary>Opacity</summary>

**Default Value**: 1

**Type**: number

**Min**: 0

**Max**: 1

**Documentation**: Sets the opacity of the trace.

**Path**: data.index.opacity

</details>

***

### Data Source

<details>

<summary>Close</summary>

**Type**: any

**Accept List**: true

**Documentation**: Sets the close values.

**Path**: data.index.close

</details>

<details>

<summary>High</summary>

**Type**: any

**Accept List**: true

**Documentation**: Sets the high values.

**Path**: data.index.high

</details>

<details>

<summary>Low</summary>

**Type**: any

**Accept List**: true

**Documentation**: Sets the low values.

**Path**: data.index.low

</details>

<details>

<summary>Open</summary>

**Type**: any

**Accept List**: true

**Documentation**: Sets the open values.

**Path**: data.index.open

</details>

<details>

<summary>Text</summary>

**Default Value**:

**Type**: string

**Accept List**: true

**Documentation**: Sets hover text elements associated with each sample point. If a single string, the same string appears over all the data points. If an array of string, the items are mapped in order to this trace's sample points.

**Path**: data.index.text

</details>

<details>

<summary>X</summary>

**Type**: any

**Accept List**: true

**Documentation**: Sets the x coordinates. If absent, linear coordinate will be generated.

**Path**: data.index.x

</details>

***

### Decreasing Items Styling

<details>

<summary>Line Color</summary>

**Default Value**: #FF4136

**Type**: color

**Documentation**: Sets the color of line bounding the box(es).

**Path**: data.index.decreasing.line.color

</details>

<details>

<summary>Line Width</summary>

**Default Value**: 2

**Type**: number

**Min**: 0

**Documentation**: Sets the width (in px) of line bounding the box(es).

**Path**: data.index.decreasing.line.width

</details>

***

### Increasing Items Styling

<details>

<summary>Line Color</summary>

**Default Value**: #3D9970

**Type**: color

**Documentation**: Sets the color of line bounding the box(es).

**Path**: data.index.increasing.line.color

</details>

<details>

<summary>Line Width</summary>

**Default Value**: 2

**Type**: number

**Min**: 0

**Documentation**: Sets the width (in px) of line bounding the box(es).

**Path**: data.index.increasing.line.width

</details>

***

### Lines Styling

<details>

<summary>Width</summary>

**Default Value**: 2

**Type**: number

**Min**: 0

**Documentation**: Sets the width (in px) of line bounding the box(es). Note that this style setting can also be set per direction via `increasing.line.width` and `decreasing.line.width`.

**Path**: data.index.line.width

</details>

***

### Exclusive Options

<details>

<summary>Whisker Width</summary>

**Default Value**: 0

**Type**: number

**Min**: 0

**Max**: 1

**Documentation**: Sets the width of the whiskers relative to the box' width. For example, with 1, the whiskers are as wide as the box(es).

**Path**: data.index.whiskerwidth

</details>

***

### Calendar Options

<details>

<summary>X Calendar</summary>

**Default Value**: gregorian

**Type**: enumerated

**Enum Options**: chinese,coptic,discworld,ethiopian,gregorian,hebrew,islamic,jalali,julian,mayan,nanakshahi,nepali,persian,taiwan,thai,ummalqura

**Documentation**: Sets the calendar system to use with `x` date data.

**Path**: data.index.xcalendar

</details>

<details>

<summary>X Period</summary>

**Default Value**: 0

**Type**: any

**Documentation**: Only relevant when the axis `type` is *date*. Sets the period positioning in milliseconds or *M* on the x axis. Special values in the form of *M* could be used to declare the number of months. In this case `n` must be a positive integer.

**Path**: data.index.xperiod

</details>

<details>

<summary>X Period Alignment</summary>

**Default Value**: middle

**Type**: enumerated

**Enum Options**: start,middle,end

**Documentation**: Only relevant when the axis `type` is *date*. Sets the alignment of data points on the x axis.

**Path**: data.index.xperiodalignment

</details>

***

### Hover Formatting

<details>

<summary>Hover Info</summary>

**Default Value**: all

**Type**: flaglist

**Accept List**: true

**Flag Options**: x,y,z,text,name

**Flag Single**: all,none,skip

**Documentation**: Determines which trace information appear on hover. If `none` or `skip` are set, no information is displayed upon hovering. But, if `none` is set, click and hover events are still fired.

**Path**: data.index.hoverinfo

</details>