diff --git a/README.md b/README.md index 58c1e90..b1209c6 100644 --- a/README.md +++ b/README.md @@ -22,12 +22,12 @@ ___ ## Features 1. Streamlined for live data, with methods for updating directly from tick data. 2. Multi-pane charts using [Subcharts](https://lightweight-charts-python.readthedocs.io/en/latest/reference/abstract_chart.html#AbstractChart.create_subchart). -3. The [Toolbox](https://lightweight-charts-python.readthedocs.io/en/latest/reference/toolbox.html), allowing for trendlines, rays and horizontal lines to be drawn directly onto charts. +3. The [Toolbox](https://lightweight-charts-python.readthedocs.io/en/latest/reference/toolbox.html), allowing for trendlines, rectangles, rays and horizontal lines to be drawn directly onto charts. 4. [Events](https://lightweight-charts-python.readthedocs.io/en/latest/tutorials/events.html) allowing for timeframe selectors (1min, 5min, 30min etc.), searching, hotkeys, and more. 5. [Tables](https://lightweight-charts-python.readthedocs.io/en/latest/reference/tables.html) for watchlists, order entry, and trade management. 6. Direct integration of market data through [Polygon.io's](https://polygon.io/?utm_source=affiliate&utm_campaign=pythonlwcharts) market data API. -__Supports:__ Jupyter Notebooks, PyQt5, PySide6, wxPython, Streamlit, and asyncio. +__Supports:__ Jupyter Notebooks, PyQt6, PyQt5, PySide6, wxPython, Streamlit, and asyncio. PartTimeLarry: [Interactive Brokers API and TradingView Charts in Python](https://www.youtube.com/watch?v=TlhDI3PforA) ___ diff --git a/docs/source/examples/gui_examples.md b/docs/source/examples/gui_examples.md index 0678068..b5eaf7c 100644 --- a/docs/source/examples/gui_examples.md +++ b/docs/source/examples/gui_examples.md @@ -1,7 +1,7 @@ # Alternative GUI's -## PyQt5 / PySide6 +## PyQt6 / PyQt5 / PySide6 ```python import pandas as pd diff --git a/docs/source/examples/toolbox.md b/docs/source/examples/toolbox.md index 8c1a3e6..ae6c901 100644 --- a/docs/source/examples/toolbox.md +++ b/docs/source/examples/toolbox.md @@ -36,7 +36,7 @@ def on_timeframe_selection(chart): if new_data.empty: return # The symbol has not changed, so we want to re-render the drawings. - chart.set(new_data, render_drawings=True) + chart.set(new_data, keep_drawings=True) if __name__ == '__main__': diff --git a/docs/source/polygon.md b/docs/source/polygon.md index c82c9a1..949d080 100644 --- a/docs/source/polygon.md +++ b/docs/source/polygon.md @@ -22,7 +22,7 @@ The `websockets` library is required when using live data. ```{important} When using live data and the standard `show` method, the `block` parameter __must__ be set to `True` in order for the data to congregate on the chart (`chart.show(block=True)`). -If `show_async` is used with live data, `block` can be either value. +`show_async` can also be used with live data. ``` diff --git a/docs/source/reference/abstract_chart.md b/docs/source/reference/abstract_chart.md index fdc6c79..ceb5a67 100644 --- a/docs/source/reference/abstract_chart.md +++ b/docs/source/reference/abstract_chart.md @@ -8,7 +8,7 @@ ___ -```{py:method} set(data: pd.DataFrame, render_drawings: bool = False) +```{py:method} set(data: pd.DataFrame, keep_drawings: bool = False) Sets the initial data for the chart. @@ -17,7 +17,7 @@ Columns should be named: Time can be given in the index rather than a column, and volume can be omitted if volume is not used. Column names are not case sensitive. -If `render_drawings` is `True`, any drawings made using the `toolbox` will be redrawn with the new data. This is designed to be used when switching to a different timeframe of the same symbol. +If `keep_drawings` is `True`, any drawings made using the `toolbox` will be redrawn with the new data. This is designed to be used when switching to a different timeframe of the same symbol. `None` can also be given, which will erase all candle and volume data displayed on the chart. ``` @@ -27,7 +27,7 @@ ___ -```{py:method} update(series: pd.Series, render_drawings: bool = False) +```{py:method} update(series: pd.Series, keep_drawings: bool = False) Updates the chart data from a bar. Series labels should be akin to [`set`](#AbstractChart.set). diff --git a/docs/source/reference/charts.md b/docs/source/reference/charts.md index a0480c5..44ec256 100644 --- a/docs/source/reference/charts.md +++ b/docs/source/reference/charts.md @@ -45,7 +45,7 @@ ___ -```{py:method} show_async(block: bool) +```{py:method} show_async() :async: Show the chart asynchronously. @@ -85,7 +85,7 @@ ___ The `QtChart` object allows the use of charts within a `QMainWindow` object, and has similar functionality to the `Chart` object for manipulating data, configuring and styling. -Either the `PyQt5` or `PySide6` libraries will work with this chart. +Either the `PyQt5`, `PyQt6` or `PySide6` libraries will work with this chart. Callbacks can be received through the Qt event loop. ___ diff --git a/docs/source/tutorials/events.md b/docs/source/tutorials/events.md index ac91c20..0e4c527 100644 --- a/docs/source/tutorials/events.md +++ b/docs/source/tutorials/events.md @@ -101,7 +101,7 @@ async def update_clock(chart): async def main(): chart = Chart() chart.topbar.textbox('clock') - await asyncio.gather(chart.show_async(block=True), update_clock(chart)) + await asyncio.gather(chart.show_async(), update_clock(chart)) if __name__ == '__main__': @@ -130,7 +130,6 @@ async def data_loop(chart): return chart.update_from_tick(ticks.iloc[i]) await asyncio.sleep(0.03) - i += 1 def on_new_bar(chart): @@ -150,7 +149,7 @@ async def main(): df = pd.read_csv('ohlc.csv') chart.set(df) - await asyncio.gather(chart.show_async(block=True), data_loop(chart)) + await asyncio.gather(chart.show_async(), data_loop(chart)) if __name__ == '__main__':