> ## Documentation Index
> Fetch the complete documentation index at: https://takeprofit.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Package indie.plot

> The indie.plot package: the decorators, types, and enums that control how plotted data appears on a chart.

Package for plotting series-like data.

***

## Decorators

### `@background()`

*decorator*

**1. Overloads**

@background

(title, color, outline\_color, outline\_style, outline\_width) -> None

Declares attributes of a background plot of an indicator. Can be applied only to the `Main` entry point of the indicator. When applied, it must match with the result of the `Main` indicator entry point.

**parameters info**

title

indie.Optional\[str]

default:
None

Human readable title which is visible in the indicator's Settings panel.

color

indie.Optional\[indie.Color]

default:
None

Color of the plot.

outline\_color

indie.Optional\[indie.Color]

default:
None

Color of the outline.

outline\_style

indie.Optional\[indie.line\_style]

default:
None

Style of the outline. It is represented as enum value of type `line_style`.

outline\_width

indie.Optional\[int]

default:
None

Width of the outline.

```py Example theme={null}
@plot.background()
def Main(self):
    return plot.Background(color=color.YELLOW)
```

> [!NOTE]
>
> See also: [`Background`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#class_Background)

***

### `@bar_color()`

*decorator*

**1. Overloads**

@bar\_color

(title, color, display\_options) -> None

Declares attributes of a bar color plot of an indicator. Can be applied only to the `Main` entry point of the indicator. When applied, it must match with the result of the `Main` indicator entry point.

**parameters info**

title

indie.Optional\[str]

default:
None

Human readable title which is visible in the indicator's Settings panel.

color

indie.Optional\[indie.Color]

default:
None

Color of the plot.

display\_options

indie.plot.BarColorDisplayOptions

default:
indie.plot.BarColorDisplayOptions(pane=True)

Determines the ways to display plot data.

```py Example theme={null}
@plot.bar_color()
def Main(self):
    return plot.BarColor(color=color.YELLOW)
```

> [!NOTE]
>
> See also: [`BarColor`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#class_BarColor)

***

### `@candles()`

*decorator*

**1. Overloads**

@candles

(id, title, up\_color, down\_color, wick\_visible, border\_visible, display\_options) -> None

Declares an independent candles plot of an indicator: every bar is drawn as a candle with a body between `open` and `close` and a thin wick between `low` and `high`. It does not replace the chart candles, and an indicator can declare multiple candles plots. Can be applied only to the `Main` entry point of the indicator. When applied, it must match with the result of the `Main` indicator entry point, which has to be a `plot.Candles` object.

**parameters info**

id

indie.Optional\[str]

default:
None

A unique identifier of plot, reserved for internal use.

title

indie.Optional\[str]

default:
None

Human readable title which is visible in the indicator's Settings panel.

up\_color

indie.Optional\[indie.Color]

default:
None

Default body color of a candle whose close is not below its open; the chart candle color when not set. The wick and border inherit the resolved body color unless their per-bar colors are set.

down\_color

indie.Optional\[indie.Color]

default:
None

Default body color of a candle whose close is below its open; the chart candle color when not set. The wick and border inherit the resolved body color unless their per-bar colors are set.

wick\_visible

bool

default:
True

Whether to draw the thin candle wick from low to high.

border\_visible

bool

default:
True

Whether to draw candle borders.

display\_options

indie.plot.CandlesDisplayOptions

default:
indie.plot.CandlesDisplayOptions(pane=True, status\_line=True, price\_label=True)

Determines the ways to display plot data.

```py Example theme={null}
@plot.candles(up_color=color.GREEN, down_color=color.RED)
def Main(self):
    return plot.Candles(self.open[0], self.high[0], self.low[0], self.close[0])
```

> [!NOTE]
>
> See also: [`Candles`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#class_Candles)

***

### `@columns()`

*decorator*

**1. Overloads**

@columns

(id, title, color, base\_value, rel\_width, display\_options) -> None

Declares attributes of a columns plot of an indicator. Can be applied only to the `Main` entry point of the indicator. When applied, it must match with the result of the `Main` indicator entry point.

**parameters info**

id

indie.Optional\[str]

default:
None

A unique identifier of plot, reserved for internal use.

title

indie.Optional\[str]

default:
None

Human readable title which is visible in the indicator's Settings panel.

color

indie.Optional\[indie.Color]

default:
None

Color of the plot.

base\_value

float

default:
0.0

Base level from which to start plot.

rel\_width

float

default:
0.8

Relative width.

display\_options

indie.plot.ColumnsDisplayOptions

default:
indie.plot.ColumnsDisplayOptions(pane=True, status\_line=True, price\_label=True)

Determines the ways to display plot data.

```py Example theme={null}
@plot.line()
@plot.columns(line_width=2)
@plot.columns(color=color.YELLOW)
# @plot.line() - for the fourth plot can be omitted
def Main(self):
    return self.open[0], self.high[0], self.low[0], self.close[0]
```

> [!NOTE]
>
> See also: [`Columns`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#class_Columns)

***

### `@data_grid()`

*decorator*

**1. Overloads**

@data\_grid

(id, \*, rows, title, cell\_style, cell\_coloring, show\_values, normalization, threshold, percentile) -> None

Displays indicator values in a table with one row per metric and one column per chart bar. Declare rows with plot.GridRow and return a plot.GridValue on every bar. Available only in a separate indicator pane; cannot be combined with other plots, levels or bands, or used in a strategy.

**parameters info**

id

str

required

Unique output ID; it cannot contain `$` or `.`.

rows

list\[indie.plot.GridRow]

required

From 1 to 30 rows, in display order.

title

indie.Optional\[str]

default:
None

Output title shown in chart settings; None uses the ID.

cell\_style

indie.plot.grid\_cell\_style

default:
indie.plot.grid\_cell\_style.FILL

Default style of the cells; a row can override it.

cell\_coloring

indie.plot.grid\_cell\_coloring

default:
indie.plot.grid\_cell\_coloring.STEPS

Default coloring of the cells; a row can override it.

show\_values

bool

default:
True

Whether values are written into `FILL` cells; `DOTS` and `COLUMNS` cells ignore it.

normalization

indie.plot.grid\_normalization

default:
indie.plot.grid\_normalization.ALL

Which bars are used to scale row colors.

threshold

float

default:
0.0

Hides weak values: a cell below this share of its row scale, in \[0, 1], gets no fill and no number.

percentile

float

default:
0.98

Percentile in \[0.5, 1] of absolute values that scales the colors of rows without a domain.

```py Example theme={null}
# indie:lang_version = 5
from indie import MainContext, color, indicator, plot


@indicator('Bar metrics')
@plot.data_grid('metrics', rows=[
    plot.GridRow('volume', 'Vol', 'Volume', colors=[color.BLUE],
                 format=plot.GridFormat(plot.grid_format.VOLUME)),
    plot.GridRow('range', 'Range', 'Price range', colors=[color.ORANGE],
                 format=plot.GridFormat(plot.grid_format.PRICE)),
])
class Main(MainContext):
    def calc(self):
        return plot.GridValue([self.volume[0], self.high[0] - self.low[0]])
```

> [!NOTE]
>
> See also: [`GridRow`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#class_GridRow)[`GridValue`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#class_GridValue)

***

### `@fill()`

*decorator*

**1. Overloads**

@fill

(id1, id2, id, title, color) -> None

Declares attributes of a fill plot of an indicator. Can be applied only to the `Main` entry point of the indicator. When applied, it must match with the result of the `Main` indicator entry point.

**parameters info**

id1

str

required

Identifier of the first plot to which the fill is applied.

id2

str

required

Identifier of the second plot to which the fill is applied.

id

indie.Optional\[str]

default:
None

A unique identifier of plot, reserved for internal use.

title

indie.Optional\[str]

default:
None

Human readable title which is visible in the indicator's Settings panel.

color

indie.Optional\[indie.Color]

default:
None

Color of the plot.

```py Example theme={null}
@plot.line('plot1')
@plot.line('plot2')
@plot.fill('plot1', 'plot2')
def Main(self):
    return self.open[0], self.high[0], plot.Fill()
```

> [!NOTE]
>
> See also: [`Fill`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#class_Fill)

***

### `@histogram()`

*decorator*

**1. Overloads**

@histogram

(id, title, color, line\_width, base\_value, display\_options) -> None

Declares attributes of a histogram plot of an indicator. Can be applied only to the `Main` entry point of the indicator. When applied, it must match with the result of the `Main` indicator entry point.

**parameters info**

id

indie.Optional\[str]

default:
None

A unique identifier of plot, reserved for internal use.

title

indie.Optional\[str]

default:
None

Human readable title which is visible in the indicator's Settings panel.

color

indie.Optional\[indie.Color]

default:
None

Color of the plot.

line\_width

int

default:
1

Width of the line.

base\_value

float

default:
0.0

Base level from which to start plot.

display\_options

indie.plot.HistogramDisplayOptions

default:
indie.plot.HistogramDisplayOptions(pane=True, status\_line=True, price\_label=True)

Determines the ways to display plot data.

```py Example theme={null}
@plot.line()
@plot.histogram(line_width=2)
@plot.histogram(color=color.YELLOW)
# @plot.line() - for the fourth plot can be omitted
def Main(self):
    return self.open[0], self.high[0], self.low[0], self.close[0]
```

> [!NOTE]
>
> See also: [`Histogram`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#class_Histogram)

***

### `@line()`

*decorator*

**1. Overloads**

@line

(id, title, color, line\_style, line\_width, continuous, display\_options) -> None

Declares attributes of a line plot of an indicator. Can be applied only to the `Main` entry point of the indicator. It is optional, so may be omitted in some simple use cases and plot will be rendered using defaults. When applied, it must match with the result of the `Main` indicator entry point.

**parameters info**

id

indie.Optional\[str]

default:
None

A unique identifier of plot which is used in cases when a `@plot.fill()` should be applied between some of the two plots of an indicator.

title

indie.Optional\[str]

default:
None

Human readable title which is visible in the indicator's Settings panel.

color

indie.Optional\[indie.Color]

default:
None

Color of the plot on a chart. This color can be overwritten if the plot is a multicolored one. Example of an indicator with a multicolored plot is *Awesome Oscillator (AO)*.

line\_style

indie.line\_style

default:
indie.line\_style.SOLID

Style of the line. It is represented as enum value of type `line_style`.

line\_width

int

default:
1

Width of the line.

continuous

bool

default:
False

Whether the plot should be continuous when the indicator has `NaN` values.

display\_options

indie.plot.LineDisplayOptions

default:
indie.plot.LineDisplayOptions(pane=True, status\_line=True, price\_label=True)

Determines the ways to display plot data.

```py Example theme={null}
@plot.line()
@plot.line(line_width=2)
@plot.line(color=color.YELLOW)
# @plot.line() - for the fourth plot can be omitted
def Main(self):
    return self.open[0], self.high[0], self.low[0], self.close[0]
```

> [!NOTE]
>
> See also: [`Line`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#class_Line)

***

### `@marker()`

*decorator*

**1. Overloads**

@marker

(title, color, text, style, position, size, display\_options) -> None

Declares attributes of a marker plot of an indicator. Can be applied only to the `Main` entry point of the indicator. When applied, it must match with the result of the `Main` indicator entry point.

**parameters info**

title

indie.Optional\[str]

default:
None

Human readable title which is visible in the indicator's Settings panel.

color

indie.Optional\[indie.Color]

default:
None

Color of the plot.

text

indie.Optional\[str]

default:
None

Default value for the text label of markers.

style

indie.plot.marker\_style

default:
indie.plot.marker\_style.CIRCLE

Determines how the plot data is rendered. It is represented as enum value of type `marker_style`.

position

indie.plot.marker\_position

default:
indie.plot.marker\_position.ABOVE

Determines how the data and text are rendered.

size

int

default:
4

Size of markers.

display\_options

indie.plot.MarkerDisplayOptions

default:
indie.plot.MarkerDisplayOptions(pane=True, status\_line=True, price\_label=True)

Determines the ways to display plot data.

```py Example theme={null}
@plot.line()
@plot.marker(line_width=2)
@plot.marker(color=color.YELLOW)
# @plot.line() - for the fourth plot can be omitted
def Main(self):
    return self.open[0], self.high[0], self.low[0], self.close[0]
```

> [!NOTE]
>
> See also: [`Marker`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#class_Marker)

***

### `@steps()`

*decorator*

**1. Overloads**

@steps

(id, title, color, line\_width, display\_options) -> None

Declares attributes of a steps plot of an indicator. Can be applied only to the `Main` entry point of the indicator. When applied, it must match with the result of the `Main` indicator entry point.

**parameters info**

id

indie.Optional\[str]

default:
None

A unique identifier of plot, reserved for internal use.

title

indie.Optional\[str]

default:
None

Human readable title which is visible in the indicator's Settings panel.

color

indie.Optional\[indie.Color]

default:
None

Color of the plot.

line\_width

int

default:
1

Width of the line.

display\_options

indie.plot.StepsDisplayOptions

default:
indie.plot.StepsDisplayOptions(pane=True, status\_line=True, price\_label=True)

Determines the ways to display plot data.

```py Example theme={null}
@plot.line()
@plot.steps(line_width=2)
@plot.steps(color=color.YELLOW)
# @plot.line() - for the fourth plot can be omitted
def Main(self):
    return self.open[0], self.high[0], self.low[0], self.close[0]
```

> [!NOTE]
>
> See also: [`Steps`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#class_Steps)

***

## Types

### `Background`

*type*

Class which objects represent an element of background plot.

**1. Fields**

[Navigate to field\_Background\_color](#field_Background_color)

color

indie.Optional\[indie.Color]

Color of the plot element.

[Navigate to field\_Background\_outline\_left](#field_Background_outline_left)

outline\_left

bool

Whether to draw left outline.

[Navigate to field\_Background\_outline\_right](#field_Background_outline_right)

outline\_right

bool

Whether to draw right outline.

[Navigate to field\_Background\_offset](#field_Background_offset)

offset

int

Offset of the plot element.

**2. Methods**

[Navigate to method\_Background\_init](#method_Background_init)

**init**

(color, outline\_left, outline\_right, offset) -> None

Class constructor (initializer for the data type).

**parameters info**

color

indie.Optional\[indie.Color]

default:
None

Color of the plot element.

outline\_left

bool

default:
False

Whether to draw an outline on the left.

outline\_right

bool

default:
False

Whether to draw an outline on the right.

offset

int

default:
0

Offset of the plot element.

> [!NOTE]
>
> See also: [`@background()`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#decor_background)

***

### `BackgroundDisplayOptions`

*type*

Class with options that control how to display plot data on a chart.

**1. Methods**

[Navigate to method\_BackgroundDisplayOptions\_init](#method_BackgroundDisplayOptions_init)

**init**

(\*, pane) -> None

Class constructor (initializer for the data type).

**parameters info**

pane

bool

default:
False

Whether or not to draw (by default) the plot on the pane.

***

### `BarColor`

*type*

Class which objects represent an element of bar color plot.

**1. Fields**

[Navigate to field\_BarColor\_color](#field_BarColor_color)

color

indie.Optional\[indie.Color]

Color of the plot element.

[Navigate to field\_BarColor\_offset](#field_BarColor_offset)

offset

int

Offset of the plot element.

**2. Methods**

[Navigate to method\_BarColor\_init](#method_BarColor_init)

**init**

(color, offset) -> None

Class constructor (initializer for the data type).

**parameters info**

color

indie.Optional\[indie.Color]

default:
None

Color of the plot element.

offset

int

default:
0

Offset of the plot element.

> [!NOTE]
>
> See also: [`@bar_color()`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#decor_bar_color)

***

### `BarColorDisplayOptions`

*type*

Class with options that control how to display plot data on a chart.

**1. Methods**

[Navigate to method\_BarColorDisplayOptions\_init](#method_BarColorDisplayOptions_init)

**init**

(\*, pane) -> None

Class constructor (initializer for the data type).

**parameters info**

pane

bool

default:
False

Whether or not to draw (by default) the plot on the pane.

***

### `Candles`

*type*

Class which objects represent an element of a candles plot: the body spans from open to close and the thin wick spans from low to high.

**1. Fields**

[Navigate to field\_Candles\_open](#field_Candles_open)

open

float

Open value of the candle, one end of its body.

[Navigate to field\_Candles\_high](#field_Candles_high)

high

float

High value of the candle, the top of its wick.

[Navigate to field\_Candles\_low](#field_Candles_low)

low

float

Low value of the candle, the bottom of its wick.

[Navigate to field\_Candles\_close](#field_Candles_close)

close

float

Close value of the candle, the other end of its body; the value of the plot.

[Navigate to field\_Candles\_color](#field_Candles_color)

color

indie.Optional\[indie.Color]

Body color of the candle, overrides the up and down colors of the plot.

[Navigate to field\_Candles\_wick\_color](#field_Candles_wick_color)

wick\_color

indie.Optional\[indie.Color]

Per-bar color of the thin wick from low to high. Uses the resolved body color when not set.

[Navigate to field\_Candles\_border\_color](#field_Candles_border_color)

border\_color

indie.Optional\[indie.Color]

Per-bar border color of the candle. Uses the resolved body color when not set.

[Navigate to field\_Candles\_offset](#field_Candles_offset)

offset

int

Offset of the plot element.

**2. Methods**

[Navigate to method\_Candles\_init](#method_Candles_init)

**init**

(open, high, low, close, color, wick\_color, border\_color, offset) -> None

Class constructor (initializer for the data type).

**parameters info**

open

float

required

Open value of the candle.

high

float

required

High value of the candle, the top of its wick.

low

float

required

Low value of the candle, the bottom of its wick.

close

float

required

Close value of the candle.

color

indie.Optional\[indie.Color]

default:
None

Color of the plot element.

wick\_color

indie.Optional\[indie.Color]

default:
None

Per-bar color of the thin wick from low to high. Uses the resolved body color when not set.

border\_color

indie.Optional\[indie.Color]

default:
None

Per-bar border color of the candle. Uses the resolved body color when not set.

offset

int

default:
0

Offset of the plot element.

> [!NOTE]
>
> See also: [`@candles()`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#decor_candles)

***

### `CandlesDisplayOptions`

*type*

Class with options that control how to display plot data on a chart.

**1. Methods**

[Navigate to method\_CandlesDisplayOptions\_init](#method_CandlesDisplayOptions_init)

**init**

(\*, pane, status\_line, price\_label) -> None

Class constructor (initializer for the data type).

**parameters info**

pane

bool

default:
False

Whether or not to draw (by default) the plot on the pane.

status\_line

bool

default:
False

Whether or not to show the value of the plot in the status line.

price\_label

bool

default:
False

Whether or not to show the value label of the plot on the price axis.

***

### `Columns`

*type*

Class which objects represent an element of columns plot.

**1. Fields**

[Navigate to field\_Columns\_value](#field_Columns_value)

value

float

Value of the plot element.

[Navigate to field\_Columns\_color](#field_Columns_color)

color

indie.Optional\[indie.Color]

Color of the plot element.

[Navigate to field\_Columns\_offset](#field_Columns_offset)

offset

int

Offset of the plot element.

**2. Methods**

[Navigate to method\_Columns\_init](#method_Columns_init)

**init**

(value, color, offset) -> None

Class constructor (initializer for the data type).

**parameters info**

value

float

required

Value of the plot element.

color

indie.Optional\[indie.Color]

default:
None

Color of the plot element.

offset

int

default:
0

Offset of the plot element.

> [!NOTE]
>
> See also: [`@columns()`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#decor_columns)

***

### `ColumnsDisplayOptions`

*type*

Class with options that control how to display plot data on a chart.

**1. Methods**

[Navigate to method\_ColumnsDisplayOptions\_init](#method_ColumnsDisplayOptions_init)

**init**

(\*, pane, status\_line, price\_label, price\_scale\_id) -> None

Class constructor (initializer for the data type).

**parameters info**

pane

bool

default:
False

Whether or not to draw (by default) the plot on the pane.

status\_line

bool

default:
False

Whether or not to show the value of the plot in the status line.

price\_label

bool

default:
False

Whether or not to show the value label of the plot on the price axis.

price\_scale\_id

str

default:
''

ID of the price scale used to draw the plot. Empty uses the legacy scale. `left` and `right` use the existing axes. Other IDs name a custom scale scoped to an indicator instance; `volume` places it in the lower strip of the main pane.

***

### `Fill`

*type*

Class which objects represent an element of fill plot.

**1. Fields**

[Navigate to field\_Fill\_color](#field_Fill_color)

color

indie.Optional\[indie.Color]

Color of the plot element.

[Navigate to field\_Fill\_offset](#field_Fill_offset)

offset

int

Offset of the plot element.

**2. Methods**

[Navigate to method\_Fill\_init](#method_Fill_init)

**init**

(color, offset) -> None

Class constructor (initializer for the data type).

**parameters info**

color

indie.Optional\[indie.Color]

default:
None

Color of the plot element.

offset

int

default:
0

Offset of the plot element.

> [!NOTE]
>
> See also: [`@fill()`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#decor_fill)

***

### `FillDisplayOptions`

*type*

Class with options that control how to display plot data on a chart.

**1. Methods**

[Navigate to method\_FillDisplayOptions\_init](#method_FillDisplayOptions_init)

**init**

(\*, pane) -> None

Class constructor (initializer for the data type).

**parameters info**

pane

bool

default:
False

Whether or not to draw (by default) the plot on the pane.

***

### `GridCell`

*type*

An optional detail value or explanation for a missing value in one grid cell. The row\_id identifies the declared row.

**1. Methods**

[Navigate to method\_GridCell\_init](#method_GridCell_init)

**init**

(row\_id, \*, detail, na\_reason) -> None

Class constructor (initializer for the data type).

**parameters info**

row\_id

str

required

ID of the row this cell belongs to.

detail

indie.Optional\[float]

default:
None

Detail value shown with the row detail format; None shows no detail.

na\_reason

str

default:
""

Why this cell has no value; ignored when the cell has a value.

***

### `GridDomain`

*type*

A fixed value range that maps row values to colors.

**1. Methods**

[Navigate to method\_GridDomain\_init](#method_GridDomain_init)

**init**

(min, max) -> None

Class constructor (initializer for the data type).

**parameters info**

min

float

required

Value that maps to no color; must be less than `max`.

max

float

required

Value that maps to the full color.

***

### `GridFormat`

*type*

How the values of a data grid row are formatted.

**1. Methods**

[Navigate to method\_GridFormat\_init](#method_GridFormat_init)

**init**

(type, \*, precision, suffix) -> None

Class constructor (initializer for the data type).

**parameters info**

type

indie.plot.grid\_format

required

Number format type.

precision

int

default:
2

Number of decimal places.

suffix

str

default:
""

Text appended to the value; allowed only with `grid_format.NUMBER`.

***

### `GridRow`

*type*

Declares one data grid row: its labels, colors, number format and optional detail format.

**1. Methods**

[Navigate to method\_GridRow\_init](#method_GridRow_init)

**init**

(id, short\_label, long\_label, \*, colors, signed, format, detail, domain, cell\_style, cell\_coloring, visible, description) -> None

Declares one row of a data grid.

**parameters info**

id

str

required

Row ID, unique in the grid: 1 to 32 letters, digits or underscores.

short\_label

str

required

Label shown next to the row.

long\_label

str

required

Label shown in tooltips and settings.

colors

list\[indie.Color]

required

One color, or two colors (positive, negative) for a signed row.

signed

bool

default:
False

Whether negative values get the second color.

format

indie.plot.GridFormat

default:
indie.plot.GridFormat(indie.plot.grid\_format.NUMBER)

Format of the row values.

detail

indie.Optional\[indie.plot.GridRowDetail]

default:
None

Format of the per-cell detail value; None shows no detail.

domain

indie.Optional\[indie.plot.GridDomain]

default:
None

Fixed value range for colors; None scales by the percentile of absolute values.

cell\_style

indie.Optional\[indie.plot.grid\_cell\_style]

default:
None

Cell style of this row; None uses the grid cell style.

cell\_coloring

indie.Optional\[indie.plot.grid\_cell\_coloring]

default:
None

Cell coloring of this row; None uses the grid cell coloring.

visible

bool

default:
True

Whether the row is visible by default.

description

str

default:
""

Row description shown in tooltips.

***

### `GridRowDetail`

*type*

A secondary value shown next to the cell value, set per cell with `plot.GridCell`.

**1. Methods**

[Navigate to method\_GridRowDetail\_init](#method_GridRowDetail_init)

**init**

(format, separator) -> None

Class constructor (initializer for the data type).

**parameters info**

format

indie.plot.GridFormat

required

Format of the detail value.

separator

str

default:
" @ "

Text between the value and its detail.

***

### `GridValue`

*type*

Values of the data grid for one bar, in the order of the declared rows. Return one value per row; use NaN for a missing value.

**1. Methods**

[Navigate to method\_GridValue\_init](#method_GridValue_init)

**init**

(values, \*, cells, marks, na\_reason) -> None

Class constructor (initializer for the data type).

**parameters info**

values

list\[float]

required

One value per row, in the declaration order; NaN marks a missing value.

cells

list\[indie.plot.GridCell]

default:
\[]

Per-cell extras for rows of this bar.

marks

list\[str]

default:
\[]

IDs of rows whose period starts at this bar.

na\_reason

str

default:
""

Why the whole bar has no values; empty when it has them.

> [!NOTE]
>
> See also: [`@data_grid()`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#decor_data_grid)

***

### `Histogram`

*type*

Class which objects represent an element of histogram plot.

**1. Fields**

[Navigate to field\_Histogram\_value](#field_Histogram_value)

value

float

Value of the plot element.

[Navigate to field\_Histogram\_color](#field_Histogram_color)

color

indie.Optional\[indie.Color]

Color of the plot element.

[Navigate to field\_Histogram\_offset](#field_Histogram_offset)

offset

int

Offset of the plot element.

**2. Methods**

[Navigate to method\_Histogram\_init](#method_Histogram_init)

**init**

(value, color, offset) -> None

Class constructor (initializer for the data type).

**parameters info**

value

float

required

Value of the plot element.

color

indie.Optional\[indie.Color]

default:
None

Color of the plot element.

offset

int

default:
0

Offset of the plot element.

> [!NOTE]
>
> See also: [`@histogram()`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#decor_histogram)

***

### `HistogramDisplayOptions`

*type*

Class with options that control how to display plot data on a chart.

**1. Methods**

[Navigate to method\_HistogramDisplayOptions\_init](#method_HistogramDisplayOptions_init)

**init**

(\*, pane, status\_line, price\_label) -> None

Class constructor (initializer for the data type).

**parameters info**

pane

bool

default:
False

Whether or not to draw (by default) the plot on the pane.

status\_line

bool

default:
False

Whether or not to show the value of the plot in the status line.

price\_label

bool

default:
False

Whether or not to show the value label of the plot on the price axis.

***

### `Line`

*type*

Class which objects represent an element of line plot.

**1. Fields**

[Navigate to field\_Line\_value](#field_Line_value)

value

float

Value of the plot element.

[Navigate to field\_Line\_color](#field_Line_color)

color

indie.Optional\[indie.Color]

Color of the plot element.

[Navigate to field\_Line\_offset](#field_Line_offset)

offset

int

Offset of the plot element.

**2. Methods**

[Navigate to method\_Line\_init](#method_Line_init)

**init**

(value, color, offset) -> None

Class constructor (initializer for the data type).

**parameters info**

value

float

required

Value of the plot element.

color

indie.Optional\[indie.Color]

default:
None

Color of the plot element.

offset

int

default:
0

Offset of the plot element.

> [!NOTE]
>
> See also: [`@line()`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#decor_line)

***

### `LineDisplayOptions`

*type*

Class with options that control how to display plot data on a chart.

**1. Methods**

[Navigate to method\_LineDisplayOptions\_init](#method_LineDisplayOptions_init)

**init**

(\*, pane, status\_line, price\_label, price\_scale\_id) -> None

Class constructor (initializer for the data type).

**parameters info**

pane

bool

default:
False

Whether or not to draw (by default) the plot on the pane.

status\_line

bool

default:
False

Whether or not to show the value of the plot in the status line.

price\_label

bool

default:
False

Whether or not to show the value label of the plot on the price axis.

price\_scale\_id

str

default:
''

ID of the price scale used to draw the plot. Empty uses the legacy scale. `left` and `right` use the existing axes. Other IDs name a custom scale scoped to an indicator instance; `volume` places it in the lower strip of the main pane.

***

### `Marker`

*type*

Class which objects represent an element of marker plot.

**1. Fields**

[Navigate to field\_Marker\_value](#field_Marker_value)

value

float

Value of the plot element.

[Navigate to field\_Marker\_color](#field_Marker_color)

color

indie.Optional\[indie.Color]

Color of the plot element.

[Navigate to field\_Marker\_text](#field_Marker_text)

text

indie.Optional\[str]

Marker text.

[Navigate to field\_Marker\_offset](#field_Marker_offset)

offset

int

Offset of the plot element.

**2. Methods**

[Navigate to method\_Marker\_init](#method_Marker_init)

**init**

(value, color, text, offset) -> None

Class constructor (initializer for the data type).

**parameters info**

value

float

required

Value of the plot element.

color

indie.Optional\[indie.Color]

default:
None

Color of the plot element.

text

indie.Optional\[str]

default:
None

Marker text.

offset

int

default:
0

Offset of the plot element.

> [!NOTE]
>
> See also: [`@marker()`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#decor_marker)

***

### `MarkerDisplayOptions`

*type*

Class with options that control how to display plot data on a chart.

**1. Methods**

[Navigate to method\_MarkerDisplayOptions\_init](#method_MarkerDisplayOptions_init)

**init**

(\*, pane, status\_line, price\_label) -> None

Class constructor (initializer for the data type).

**parameters info**

pane

bool

default:
False

Whether or not to draw (by default) the plot on the pane.

status\_line

bool

default:
False

Whether or not to show the value of the plot in the status line.

price\_label

bool

default:
False

Whether or not to show the value label of the plot on the price axis.

***

### `Steps`

*type*

Class which objects represent an element of steps plot.

**1. Fields**

[Navigate to field\_Steps\_value](#field_Steps_value)

value

float

Value of the plot element.

[Navigate to field\_Steps\_color](#field_Steps_color)

color

indie.Optional\[indie.Color]

Color of the plot element.

[Navigate to field\_Steps\_offset](#field_Steps_offset)

offset

int

Offset of the plot element.

**2. Methods**

[Navigate to method\_Steps\_init](#method_Steps_init)

**init**

(value, color, offset) -> None

Class constructor (initializer for the data type).

**parameters info**

value

float

required

Value of the plot element.

color

indie.Optional\[indie.Color]

default:
None

Color of the plot element.

offset

int

default:
0

Offset of the plot element.

> [!NOTE]
>
> See also: [`@steps()`](https://takeprofit.com/docs/indie/Library-reference/package-indie-plot#decor_steps)

***

### `StepsDisplayOptions`

*type*

Class with options that control how to display plot data on a chart.

**1. Methods**

[Navigate to method\_StepsDisplayOptions\_init](#method_StepsDisplayOptions_init)

**init**

(\*, pane, status\_line, price\_label) -> None

Class constructor (initializer for the data type).

**parameters info**

pane

bool

default:
False

Whether or not to draw (by default) the plot on the pane.

status\_line

bool

default:
False

Whether or not to show the value of the plot in the status line.

price\_label

bool

default:
False

Whether or not to show the value label of the plot on the price axis.

***

## Enums

### `grid_cell_coloring`

*enum*

How the cells of a data grid are colored.

**1. Static fields**

[Navigate to const\_grid\_cell\_coloring\_STEPS](#const_grid_cell_coloring_STEPS)

STEPS

indie.plot.grid\_cell\_coloring

Cells step from the neutral color to the row color by value strength.

[Navigate to const\_grid\_cell\_coloring\_SOLID](#const_grid_cell_coloring_SOLID)

SOLID

indie.plot.grid\_cell\_coloring

Cells use the row color whatever the value, the second color for negative values of a signed row.

***

### `grid_cell_style`

*enum*

How the cells of a data grid are drawn.

**1. Static fields**

[Navigate to const\_grid\_cell\_style\_FILL](#const_grid_cell_style_FILL)

FILL

indie.plot.grid\_cell\_style

Cells are filled with the row color.

[Navigate to const\_grid\_cell\_style\_DOTS](#const_grid_cell_style_DOTS)

DOTS

indie.plot.grid\_cell\_style

Cells are drawn as dots.

[Navigate to const\_grid\_cell\_style\_COLUMNS](#const_grid_cell_style_COLUMNS)

COLUMNS

indie.plot.grid\_cell\_style

Cells are drawn as columns.

***

### `grid_format`

*enum*

Number format of data grid values.

**1. Static fields**

[Navigate to const\_grid\_format\_VOLUME](#const_grid_format_VOLUME)

VOLUME

indie.plot.grid\_format

Volume format.

[Navigate to const\_grid\_format\_NUMBER](#const_grid_format_NUMBER)

NUMBER

indie.plot.grid\_format

Plain number format.

[Navigate to const\_grid\_format\_PERCENT](#const_grid_format_PERCENT)

PERCENT

indie.plot.grid\_format

Percent format.

[Navigate to const\_grid\_format\_PRICE](#const_grid_format_PRICE)

PRICE

indie.plot.grid\_format

Price format with the instrument price precision; `precision` is ignored.

***

### `grid_normalization`

*enum*

Which bars are used to scale row colors.

**1. Static fields**

[Navigate to const\_grid\_normalization\_ALL](#const_grid_normalization_ALL)

ALL

indie.plot.grid\_normalization

Scales by all loaded bars.

[Navigate to const\_grid\_normalization\_VISIBLE](#const_grid_normalization_VISIBLE)

VISIBLE

indie.plot.grid\_normalization

Scales by the visible bars.

***

### `marker_position`

*enum*

Enum-like class with constants of marker positions.

**1. Static fields**

[Navigate to const\_marker\_position\_ABOVE](#const_marker_position_ABOVE)

ABOVE

indie.plot.marker\_position

Built-in marker position constant that determines how the marker is rendered.

[Navigate to const\_marker\_position\_BELOW](#const_marker_position_BELOW)

BELOW

indie.plot.marker\_position

Built-in marker position constant that determines how the marker is rendered.

[Navigate to const\_marker\_position\_LEFT](#const_marker_position_LEFT)

LEFT

indie.plot.marker\_position

Built-in marker position constant that determines how the marker is rendered.

[Navigate to const\_marker\_position\_RIGHT](#const_marker_position_RIGHT)

RIGHT

indie.plot.marker\_position

Built-in marker position constant that determines how the marker is rendered.

[Navigate to const\_marker\_position\_CENTER](#const_marker_position_CENTER)

CENTER

indie.plot.marker\_position

Built-in marker position constant that determines how the marker is rendered.

***

### `marker_style`

*enum*

Enum-like class with constants of marker styles.

**1. Static fields**

[Navigate to const\_marker\_style\_NONE](#const_marker_style_NONE)

NONE

indie.plot.marker\_style

Built-in marker style constant that determines how the marker is rendered.

[Navigate to const\_marker\_style\_CIRCLE](#const_marker_style_CIRCLE)

CIRCLE

indie.plot.marker\_style

Built-in marker style constant that determines how the marker is rendered.

[Navigate to const\_marker\_style\_LABEL](#const_marker_style_LABEL)

LABEL

indie.plot.marker\_style

Built-in marker style constant that determines how the marker is rendered.

[Navigate to const\_marker\_style\_CROSS](#const_marker_style_CROSS)

CROSS

indie.plot.marker\_style

Built-in marker style constant that determines how the marker is rendered.

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.