> ## 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.drawings
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 drawing coordinate-based visual elements like labels, lines, and shapes.
***
## Types
### `AbsolutePosition`
*type*
Position defined in absolute chart coordinates (time and price values).
Time coordinate of the absolute position.
Price coordinate of the absolute position.
Offset adjustment for the absolute position.
Initializes an absolute position with time and price coordinates.
Time coordinate of the position on the chart.
Price coordinate of the position on the chart.
Optional offset adjustment for the position.
***
### `Channel`
*type*
Drawable price channel defined by two boundary line segments.
First anchor point of the channel.
Second anchor point of the channel.
Width of the channel (price units).
Visual style of the channel border line.
Width of the channel border line in pixels.
Color of the channel border line.
Fill/background color of the channel.
Visual style of the channel middle line.
Width of the channel middle line in pixels.
Color of the channel middle line.
Initializes a new channel defined by two points and a width with optional styling parameters.
First anchor point of the channel.
Second anchor point of the channel.
Width of the channel (price units).
Border line style.
Border line width in pixels.
Border line color.
Background/fill color.
Middle line style.
Middle line width in pixels.
Middle line color.
***
### `Chart`
*type*
Chart class for drawing and managing manual and coordinate-based visual elements on the chart.
Adds or updates a drawing element on the chart.
Drawing object to add or update on the chart.
Removes a drawing element from the chart.
Drawing object to remove from the chart.
***
### `Circle`
*type*
Drawable circle defined by center and edge points with customizable style.
Center point of the circle.
A point on the circle edge that defines the radius.
Visual style of the circle border line.
Width of the circle border line in pixels.
Color of the circle border line.
Fill/background color of the circle.
Initializes a new circle defined by center and edge points with optional styling parameters.
Center point of the circle.
A point on the circle edge that defines the radius.
Border line style.
Border line width in pixels.
Border line color.
Background/fill color.
***
### `Label[T]`
*type*
Base class for text labels that can be positioned on the chart.
```py theme={null}
LabelAbs = Label[AbsolutePosition]
```
```py theme={null}
LabelRel = Label[RelativePosition]
```
Text content displayed by the label.
Position of the label on the chart (absolute or relative).
Font size of the label text.
Color of the label text.
Background color of the label.
Position of the label relative to its specified coordinates.
Initializes a new label with text, position and optional styling parameters.
Text content to display in the label.
Position of the label on the chart (`AbsolutePosition` or `RelativePosition`).
Font size of the label text in pixels.
Color of the label text.
Background color of the label.
Position of the label relative to its specified coordinates.
***
### `LineSegment`
*type*
Drawable line segment between two points with customizable style and endpoints.
Starting point of the line segment.
Ending point of the line segment.
Color of the line segment.
Visual style of the line (solid, dashed, dotted).
Width of the line segment in pixels.
Initializes a new line segment between two points with optional styling parameters.
Starting point of the line segment.
Ending point of the line segment.
Color of the line segment.
Visual style of the line (solid, dashed, dotted).
Width of the line segment in pixels.
***
### `Rectangle`
*type*
Drawable rectangle defined by two corner points with customizable style.
First corner point of the rectangle.
Opposite corner point of the rectangle.
Visual style of the rectangle border line.
Width of the rectangle border line in pixels.
Color of the rectangle border line.
Fill/background color of the rectangle.
Visual style of the middle line.
Width of the middle line in pixels.
Color of the middle line.
Initializes a new rectangle defined by two corner points with optional styling parameters.
First corner point of the rectangle.
Opposite corner point of the rectangle.
Border line style.
Border line width in pixels.
Border line color.
Background/fill color.
Middle line style.
Middle line width in pixels.
Middle line color.
***
### `RelativePosition`
*type*
Position defined relative to chart boundaries using percentage ratios.
Vertical anchor point (top, middle, bottom) for the relative position.
Horizontal anchor point (left, center, right) for the relative position.
Vertical position ratio from 0.0 (top) to 1.0 (bottom) of the chart.
Horizontal position ratio from 0.0 (left) to 1.0 (right) of the chart.
Initializes a relative position with anchor points and ratio values.
Vertical anchor point (top, middle, bottom) for positioning.
Horizontal anchor point (left, center, right) for positioning.
Vertical position ratio from 0.0 (top) to 1.0 (bottom) of the chart.
Horizontal position ratio from 0.0 (left) to 1.0 (right) of the chart.
***
### `Triangle`
*type*
Drawable triangle defined by three corner points with customizable style.
First corner point of the triangle.
Second corner point of the triangle.
Third corner point of the triangle.
Visual style of the triangle border line.
Width of the triangle border line in pixels.
Color of the triangle border line.
Fill/background color of the triangle.
Initializes a new triangle defined by three corner points with optional styling parameters.
First corner point of the triangle.
Second corner point of the triangle.
Third corner point of the triangle.
Border line style.
Border line width in pixels.
Border line color.
Background/fill color.
***
## Enums
### `callout_position`
*enum*
Position of the label relative to its specified coordinates.
Position of the label relative to its specified coordinates.
Position of the label relative to its specified coordinates.
Position of the label relative to its specified coordinates.
Position of the label relative to its specified coordinates.
***
### `horizontal_anchor`
*enum*
Horizontal anchor point for relative positioning.
Horizontal anchor point for relative positioning.
Horizontal anchor point for relative positioning.
Horizontal anchor point for relative positioning.
***
### `relative_position`
*enum*
Predefined relative positions on the chart for placing elements.
Predefined relative positions on the chart for placing elements.
Predefined relative positions on the chart for placing elements.
Predefined relative positions on the chart for placing elements.
Predefined relative positions on the chart for placing elements.
Predefined relative positions on the chart for placing elements.
Predefined relative positions on the chart for placing elements.
Predefined relative positions on the chart for placing elements.
Predefined relative positions on the chart for placing elements.
Predefined relative positions on the chart for placing elements.
***
### `vertical_anchor`
*enum*
Vertical anchor point for relative positioning.
Vertical anchor point for relative positioning.
Vertical anchor point for relative positioning.
Vertical anchor point for relative positioning.
***