mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-02 23:41:27 +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>
60 lines
1.8 KiB
Markdown
Vendored
60 lines
1.8 KiB
Markdown
Vendored
---
|
|
title: line
|
|
description: The page describes the 'line' function of the OpenBB library, used for
|
|
displaying line plots of data. It provides the source code link and details the
|
|
parameters, usage, and examples of the function within the domain of quantitative
|
|
analysis and data visualization using Python.
|
|
keywords:
|
|
- line plot
|
|
- quantitative analysis
|
|
- data visualization
|
|
- pd.Series
|
|
- matplotlib
|
|
- datetime
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="qa.line - Reference | OpenBB SDK Docs" />
|
|
|
|
Display line plot of data
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L938)]
|
|
|
|
```python
|
|
openbb.qa.line(data: pd.Series, title: str = "", log_y: bool = True, markers_lines: Optional[List[datetime.datetime]] = None, markers_scatter: Optional[List[datetime.datetime]] = None, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| data | pd.Series | Data to plot | None | False |
|
|
| title | str | Title for plot | | True |
|
|
| log_y | bool | Flag for showing y on log scale | True | True |
|
|
| markers_lines | Optional[List[datetime]] | List of dates to highlight using vertical lines | None | True |
|
|
| markers_scatter | Optional[List[datetime]] | List of dates to highlight using scatter | None | True |
|
|
| export | str | Format to export data | | True |
|
|
| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
## Examples
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
df = openbb.stocks.load("AAPL")
|
|
openbb.qa.line(data=df["Adj Close"])
|
|
```
|
|
|
|
---
|