Skip to content

Commit 218a98a

Browse files
mention documentation is in the code examples.
1 parent e0eaa07 commit 218a98a

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

Diff for: markdown/animation.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
### Animation Support in mplfinance
22

3+
* **Real-time updates** to mplfinance plots are accomplished through the technique known as "**animation**"
34
* **`mplfinance`** animation requires the use of [**`mplfinance` External Axes Mode**](https://github.com/matplotlib/mplfinance/blob/master/markdown/subplots.md#external-axes-method)
45
* [**External Axes Mode**](https://github.com/matplotlib/mplfinance/blob/master/markdown/subplots.md#external-axes-method) allows mplfinance users to create and manage their own Figure and Axes (SubPlots), and pass Axes objects into mplfinance. _This also gives users access to matplotlib's animation features_.
56
* It can be tricky to display animations properly in jupyter notebooks,<br>&nbsp; therefore, to keep things simple, the mplfinance animation examples are scripts.
@@ -8,3 +9,4 @@
89
- [**`python mpf_animation_demo2.py`**](https://github.com/matplotlib/mplfinance/blob/master/examples/mpf_animation_demo2.py)
910
- [**`python mpf_animation_macd.py`**](https://github.com/matplotlib/mplfinance/blob/master/examples/mpf_animation_macd.py)
1011
- [**`python mpf_animation_growingcandle.py`**](https://github.com/matplotlib/mplfinance/blob/master/examples/mpf_animation_growingcandle.py)
12+
* **NOTE: There are comments,** in each of the above example files, that explain what's going on and how to use animation with mplfinance. You can view the code by clicking each of the above links.

0 commit comments

Comments
 (0)