jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-01 06:51:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
948d2ef29900c48ec26616eb48ba952aaaadd883
OpenBB/website/content/terminal/reference/forex/candle.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* 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>
2023-10-30 21:01:29 +00:00

1.7 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
candle This documentation is for the 'candle' function used to show loaded fx data. It provides usage details, parameters explanations and choices, including plotly, sort, reverse, raw, trendlines, moving averages, and more, along with a graphical presentation.
candle function
loaded fx data
interactive plotly chart
sort data
reverse flag
raw data
trendlines
moving average
log scale
fx data visualization

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

Show candle for loaded fx data

Usage

candle [-p] [--sort {adjclose,open,close,high,low,volume,logret}] [-r] [--raw] [-t] [--ma MOV_AVG] [--log]

Parameters

Name Description Default Optional Choices
plotly Flag to show interactive plotly chart True True None
sort Choose a column to sort by. Only works when raw data is displayed. True adjclose, open, close, high, low, volume, logret
reverse Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. False True None
raw Shows raw data instead of chart. False True None
trendlines Flag to add high and low trends to candle False True None
mov_avg Add moving average in number of days to plot and separate by a comma. Value for ma (moving average) keyword needs to be greater than 1. None True None
logy Plot with y axis on log scale False True None

candle