Files
lightweight-charts-python/docs/source/reference/typing.md
louisnw b1f007f6d0 Enhancements:
- added the `align` parameter to all topbar widgets, allowing for individual widgets to be placed either on the left or right hand side of the topbar.
- Disabled QtChart’s context menu by default.

Bug Fixes:
- The `screenshot` method now works for subcharts.
- Tables will still render if a `NoneType` is passed to them as a value.
- Qt and Wx charts no longer throw an error when using the toolbox.
2023-09-14 10:51:10 +01:00

46 lines
934 B
Markdown

:orphan:
# `Typing`
These classes serve as placeholders for type requirements.
```{py:class} NUM(Literal[float, int])
```
```{py:class} FLOAT(Literal['left', 'right', 'top', 'bottom'])
```
```{py:class} TIME(Union[datetime, pd.Timestamp, str])
```
```{py:class} COLOR(str)
Throughout the library, colors should be given as either rgb (`rgb(100, 100, 100)`), rgba(`rgba(100, 100, 100, 0.7)`), hex(`#32a852`) or a html literal(`blue`, `red` etc).
```
```{py:class} LINE_STYLE(Literal['solid', 'dotted', 'dashed', 'large_dashed', 'sparse_dotted'])
```
```{py:class} MARKER_POSITION(Literal['above', 'below', 'inside'])
```
```{py:class} MARKER_SHAPE(Literal['arrow_up', 'arrow_down', 'circle', 'square'])
```
```{py:class} CROSSHAIR_MODE(Literal['normal', 'magnet'])
```
```{py:class} PRICE_SCALE_MODE(Literal['normal', 'logarithmic', 'percentage', 'index100'])
```
```{py:class} ALIGN(Literal['left', 'right'])
```