mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 13:01:38 +00:00
4ad995fdd0
* add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato <zmcdonato@gmail.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
87 lines
2.2 KiB
Markdown
Vendored
87 lines
2.2 KiB
Markdown
Vendored
---
|
|
title: plot
|
|
description: Learn how to harness the power of OpenBB's financial forecasting functions
|
|
such as the plot and plot_chart to visualize data. These Python functions extract
|
|
dataframes and accept options for export format and external plot axes.
|
|
keywords:
|
|
- plot data visualization
|
|
- OpenBB finance
|
|
- forecast
|
|
- dataframe
|
|
- export format
|
|
- docusaurus tabs
|
|
- optional axes
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="forecast.plot - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Plot data from a dataset
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_view.py#L74)]
|
|
|
|
```python
|
|
openbb.forecast.plot(data: pd.DataFrame, columns: List[str], export: str = "", external_axes: Optional[List[axes]] = None)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| data | pd.DataFrame | The dataframe to plot | None | False |
|
|
| columns | List[str] | The columns to show | None | False |
|
|
| export | str | Format to export image | | True |
|
|
| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Plot data from a dataset
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_view.py#L74)]
|
|
|
|
```python
|
|
openbb.forecast.plot_chart(data: pd.DataFrame, columns: List[str], export: str = "", external_axes: Optional[List[axes]] = None)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| data | pd.DataFrame | The dataframe to plot | None | False |
|
|
| columns | List[str] | The columns to show | None | False |
|
|
| export | str | Format to export image | | True |
|
|
| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|