jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-29 13:32:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
9a9cc14ec145f4133e69a389f8a032e35fee2ea3
OpenBB/website/versioned_docs/version-v3/sdk/reference/qa/line.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470) 
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

1.4 KiB
Vendored
Raw Blame History

title, description
title description
line OpenBB SDK Function

line

Display line plot of data

Source Code: [link]

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

from openbb_terminal.sdk import openbb
df = openbb.stocks.load("AAPL")
openbb.qa.line(data=df["Adj Close"])