> ## 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
export const Anchor = ({id}) => {
return ;
};
export const Field = ({id, name, type, required, defaultVal, children}) => {
return
{id &&
}
{name}
{type}
{required &&
required
}
{defaultVal &&
default:
{defaultVal}
}
{children}
;
};
Package for plotting series-like data.
***
## Decorators
### `@background()`
*decorator*
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.
Human readable title which is visible in the indicator's Settings panel.
Color of the plot.
Color of the outline.
Style of the outline. It is represented as enum value of type `line_style`.
Width of the outline.
```py Example theme={null}
@plot.background()
def Main(self):
return plot.Background(color=color.YELLOW)
```
See also: [`Background`](/indie/Library-reference/package-indie-plot#class_Background)
***
### `@bar_color()`
*decorator*
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.
Human readable title which is visible in the indicator's Settings panel.
Color of the plot.
Determines the ways to display plot data.
```py Example theme={null}
@plot.bar_color()
def Main(self):
return plot.BarColor(color=color.YELLOW)
```
See also: [`BarColor`](/indie/Library-reference/package-indie-plot#class_BarColor)
***
### `@columns()`
*decorator*
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.
A unique identifier of plot, reserved for internal use.
Human readable title which is visible in the indicator's Settings panel.
Color of the plot.
Base level from which to start plot.
Relative width.
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]
```
See also: [`Columns`](/indie/Library-reference/package-indie-plot#class_Columns)
***
### `@fill()`
*decorator*
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.
Identifier of the first plot to which the fill is applied.
Identifier of the second plot to which the fill is applied.
A unique identifier of plot, reserved for internal use.
Human readable title which is visible in the indicator's Settings panel.
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()
```
See also: [`Fill`](/indie/Library-reference/package-indie-plot#class_Fill)
***
### `@histogram()`
*decorator*
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.
A unique identifier of plot, reserved for internal use.
Human readable title which is visible in the indicator's Settings panel.
Color of the plot.
Width of the line.
Base level from which to start plot.
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]
```
See also: [`Histogram`](/indie/Library-reference/package-indie-plot#class_Histogram)
***
### `@line()`
*decorator*
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.
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.
Human readable title which is visible in the indicator's Settings panel.
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)*.
Style of the line. It is represented as enum value of type `line_style`.
Width of the line.
Whether the plot should be continuous when the indicator has `NaN` values.
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]
```
See also: [`Line`](/indie/Library-reference/package-indie-plot#class_Line)
***
### `@marker()`
*decorator*
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.
Human readable title which is visible in the indicator's Settings panel.
Color of the plot.
Default value for the text label of markers.
Determines how the plot data is rendered. It is represented as enum value of type `marker_style`.
Determines how the data and text are rendered.
Size of markers.
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]
```
See also: [`Marker`](/indie/Library-reference/package-indie-plot#class_Marker)
***
### `@steps()`
*decorator*
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.
A unique identifier of plot, reserved for internal use.
Human readable title which is visible in the indicator's Settings panel.
Color of the plot.
Width of the line.
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]
```
See also: [`Steps`](/indie/Library-reference/package-indie-plot#class_Steps)
***
## Types
### `Background`
*type*
Class which objects represent an element of background plot.
Color of the plot element.
Whether to draw left outline.
Whether to draw right outline.
Offset of the plot element.
Class constructor (initializer for the data type).
Color of the plot element.
Whether to draw an outline on the left.
Whether to draw an outline on the right.
Offset of the plot element.
See also: [`@background()`](/indie/Library-reference/package-indie-plot#decor_background)
***
### `BackgroundDisplayOptions`
*type*
Class with options that control how to display plot data on a chart.
Class constructor (initializer for the data type).
Whether or not to draw (by default) the plot on the pane.
***
### `BarColor`
*type*
Class which objects represent an element of bar color plot.
Color of the plot element.
Offset of the plot element.
Class constructor (initializer for the data type).
Color of the plot element.
Offset of the plot element.
See also: [`@bar_color()`](/indie/Library-reference/package-indie-plot#decor_bar_color)
***
### `BarColorDisplayOptions`
*type*
Class with options that control how to display plot data on a chart.
Class constructor (initializer for the data type).
Whether or not to draw (by default) the plot on the pane.
***
### `Columns`
*type*
Class which objects represent an element of columns plot.
Value of the plot element.
Color of the plot element.
Offset of the plot element.
Class constructor (initializer for the data type).
Value of the plot element.
Color of the plot element.
Offset of the plot element.
See also: [`@columns()`](/indie/Library-reference/package-indie-plot#decor_columns)
***
### `ColumnsDisplayOptions`
*type*
Class with options that control how to display plot data on a chart.
Class constructor (initializer for the data type).
Whether or not to draw (by default) the plot on the pane.
Whether or not to show the value of the plot in the status line.
Whether or not to show the value label of the plot on the price axis.
***
### `Fill`
*type*
Class which objects represent an element of fill plot.
Color of the plot element.
Offset of the plot element.
Class constructor (initializer for the data type).
Color of the plot element.
Offset of the plot element.
See also: [`@fill()`](/indie/Library-reference/package-indie-plot#decor_fill)
***
### `FillDisplayOptions`
*type*
Class with options that control how to display plot data on a chart.
Class constructor (initializer for the data type).
Whether or not to draw (by default) the plot on the pane.
***
### `Histogram`
*type*
Class which objects represent an element of histogram plot.
Value of the plot element.
Color of the plot element.
Offset of the plot element.
Class constructor (initializer for the data type).
Value of the plot element.
Color of the plot element.
Offset of the plot element.
See also: [`@histogram()`](/indie/Library-reference/package-indie-plot#decor_histogram)
***
### `HistogramDisplayOptions`
*type*
Class with options that control how to display plot data on a chart.
Class constructor (initializer for the data type).
Whether or not to draw (by default) the plot on the pane.
Whether or not to show the value of the plot in the status line.
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.
Value of the plot element.
Color of the plot element.
Offset of the plot element.
Class constructor (initializer for the data type).
Value of the plot element.
Color of the plot element.
Offset of the plot element.
See also: [`@line()`](/indie/Library-reference/package-indie-plot#decor_line)
***
### `LineDisplayOptions`
*type*
Class with options that control how to display plot data on a chart.
Class constructor (initializer for the data type).
Whether or not to draw (by default) the plot on the pane.
Whether or not to show the value of the plot in the status line.
Whether or not to show the value label of the plot on the price axis.
***
### `Marker`
*type*
Class which objects represent an element of marker plot.
Value of the plot element.
Color of the plot element.
Marker text.
Offset of the plot element.
Class constructor (initializer for the data type).
Value of the plot element.
Color of the plot element.
Marker text.
Offset of the plot element.
See also: [`@marker()`](/indie/Library-reference/package-indie-plot#decor_marker)
***
### `MarkerDisplayOptions`
*type*
Class with options that control how to display plot data on a chart.
Class constructor (initializer for the data type).
Whether or not to draw (by default) the plot on the pane.
Whether or not to show the value of the plot in the status line.
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.
Value of the plot element.
Color of the plot element.
Offset of the plot element.
Class constructor (initializer for the data type).
Value of the plot element.
Color of the plot element.
Offset of the plot element.
See also: [`@steps()`](/indie/Library-reference/package-indie-plot#decor_steps)
***
### `StepsDisplayOptions`
*type*
Class with options that control how to display plot data on a chart.
Class constructor (initializer for the data type).
Whether or not to draw (by default) the plot on the pane.
Whether or not to show the value of the plot in the status line.
Whether or not to show the value label of the plot on the price axis.
***
## Enums
### `marker_position`
*enum*
Enum-like class with constants of marker positions.
Built-in marker position constant that determines how the marker is rendered.
Built-in marker position constant that determines how the marker is rendered.
Built-in marker position constant that determines how the marker is rendered.
Built-in marker position constant that determines how the marker is rendered.
Built-in marker position constant that determines how the marker is rendered.
***
### `marker_style`
*enum*
Enum-like class with constants of marker styles.
Built-in marker style constant that determines how the marker is rendered.
Built-in marker style constant that determines how the marker is rendered.
Built-in marker style constant that determines how the marker is rendered.
Built-in marker style constant that determines how the marker is rendered.
***