diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json index 8bbffd8..9d8430c 100644 --- a/dev/.documenter-siteinfo.json +++ b/dev/.documenter-siteinfo.json @@ -1 +1 @@ -{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2025-01-08T19:37:11","documenter_version":"1.8.0"}} \ No newline at end of file +{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2025-01-09T16:09:33","documenter_version":"1.8.0"}} \ No newline at end of file diff --git a/dev/api/index.html b/dev/api/index.html index 5a00681..438ab61 100644 --- a/dev/api/index.html +++ b/dev/api/index.html @@ -25,33 +25,33 @@ "BNBUSDT", Hour(4); indicators = [BB{Float64}(), StochRSI{Float64}()], visuals = [nothing, nothing] # To use defaults, pass in `nothing`. - )source
TechnicalIndicatorCharts.abbrev — Method
abbrev(p::Period)

Return an abbreviated string representation of the given period.

Example

abbrev(Hour(4)) # "4h"
-abbrev(Day(1))  # "1d"
source
TechnicalIndicatorCharts.extract_value — Method
extract_value(value) -> Vector{Any}
-

Extract values out of an indicators value struct. This is only intended to be used for indicators that emit multiple values per tick.

source
TechnicalIndicatorCharts.indicator_fields — Method

Return a tuple of symbol names to be used for the output of ind.

source
TechnicalIndicatorCharts.indicator_fields_values — Method
indicator_fields_values(
+       )
source
TechnicalIndicatorCharts.abbrev — Method
abbrev(p::Period)

Return an abbreviated string representation of the given period.

Example

abbrev(Hour(4)) # "4h"
+abbrev(Day(1))  # "1d"
source
TechnicalIndicatorCharts.extract_value — Method
extract_value(value) -> Vector{Any}
+

Extract values out of an indicators value struct. This is only intended to be used for indicators that emit multiple values per tick.

source
TechnicalIndicatorCharts.indicator_fields — Method

Return a tuple of symbol names to be used for the output of ind.

source
TechnicalIndicatorCharts.indicator_fields_values — Method
indicator_fields_values(
     ind::OnlineTechnicalIndicators.TechnicalIndicatorMultiOutput
 ) -> Any
-

Extract values from an indicator instance.

source
TechnicalIndicatorCharts.ismultiinput — Method

This is a wrapper around OnlineTechnicalIndicators.ismultiinput that takes any instance of a TechnicalIndicator and digs out its unparametrized type before running the original ismultiinput method.

source
TechnicalIndicatorCharts.ismultioutput — Method

This is a wrapper around OnlineTechnicalIndicators.ismultioutput that takes any instance of a TechnicalIndicator and digs out its unparametrized type before running the original ismultioutput method.

source
TechnicalIndicatorCharts.make_panel — Method
make_panel(
+

Extract values from an indicator instance.

source
TechnicalIndicatorCharts.ismultiinput — Method

This is a wrapper around OnlineTechnicalIndicators.ismultiinput that takes any instance of a TechnicalIndicator and digs out its unparametrized type before running the original ismultiinput method.

source
TechnicalIndicatorCharts.ismultioutput — Method

This is a wrapper around OnlineTechnicalIndicators.ismultioutput that takes any instance of a TechnicalIndicator and digs out its unparametrized type before running the original ismultioutput method.

source
TechnicalIndicatorCharts.make_panel — Method
make_panel(
     plots::AbstractVector
 ) -> LightweightCharts.LWCPanel
-

Wrap a Vector of LWCCharts in a panel.

source
TechnicalIndicatorCharts.make_panel — Method
make_panel(
+

Wrap a Vector of LWCCharts in a panel.

source
TechnicalIndicatorCharts.make_panel — Method
make_panel(
     chart::LightweightCharts.LWCChart
 ) -> LightweightCharts.LWCPanel
-

Wrap a single LWCChart in a panel.

source
TechnicalIndicatorCharts.merge_candle! — Method
merge_candle!(
+

Wrap a single LWCChart in a panel.

source
TechnicalIndicatorCharts.merge_candle! — Method
merge_candle!(
     last_candle::Union{Missing, Candle},
     c::Union{Candle, DataFrames.DataFrameRow}
 ) -> Candle
-

If last candle is not provided, construct a new candle with the given OHLCV data. If last candle is provided, mutate last_candle such that it's HLCV are updated. When tw candles are passed in, it's assumed they have the same timestamp.

source
TechnicalIndicatorCharts.push_new_candle! — Method
push_new_candle!(
+

If last candle is not provided, construct a new candle with the given OHLCV data. If last candle is provided, mutate last_candle such that it's HLCV are updated. When tw candles are passed in, it's assumed they have the same timestamp.

source
TechnicalIndicatorCharts.push_new_candle! — Method
push_new_candle!(
     chart::Chart,
     c::Candle
 ) -> DataFrames.DataFrame
-

This is meant to be called on timeframe boundaries to onto the chart's dataframe. It also does indicator calculation at this time.

source
TechnicalIndicatorCharts.update! — Method
update!(chart::Chart, c::Candle) -> Union{Nothing, Candle}
-

Update a chart with a candle. When a candle is completed, return it. Otherwise, return nothing on update.

source
TechnicalIndicatorCharts.update_last_candle! — Method
update_last_candle!(chart::Chart, c::Candle) -> Float64
-

This updates the HLCV values of the last row of the chart's DataFrame when we're not at a chart.tf boundary.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

This is meant to be called on timeframe boundaries to onto the chart's dataframe. It also does indicator calculation at this time.

source
TechnicalIndicatorCharts.update! — Method
update!(chart::Chart, c::Candle) -> Union{Nothing, Candle}
+

Update a chart with a candle. When a candle is completed, return it. Otherwise, return nothing on update.

source
TechnicalIndicatorCharts.update_last_candle! — Method
update_last_candle!(chart::Chart, c::Candle) -> Float64
+

This updates the HLCV values of the last row of the chart's DataFrame when we're not at a chart.tf boundary.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     unimplemented,
     opts,
     df::DataFrames.DataFrame
 ) -> LightweightCharts.LWCChart
-

This is a visualize method that's a catch-all for indicators that haven't had a visualize method made for them yet. For now, it returns missing.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

This is a visualize method that's a catch-all for indicators that haven't had a visualize method made for them yet. For now, it returns missing.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     chart::Chart;
     min_height,
     mode,
@@ -59,83 +59,83 @@
     down_color,
     copyright
 ) -> LightweightCharts.LWCLayout
-

Return an LWCLayout that visualizes all the components in chart appropriately.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

Return an LWCLayout that visualizes all the components in chart appropriately.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     df::DataFrames.DataFrame,
     opts
 ) -> LightweightCharts.LWCChart
-

Visualize a DataFrame using lwc_candlestick.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

Visualize a DataFrame using lwc_candlestick.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     alma::OnlineTechnicalIndicators.ALMA,
     opts::Union{Nothing, AbstractDict},
     df::DataFrames.DataFrame
 ) -> LightweightCharts.LWCChart
-

Visualize ALMA using 1 lwc_line.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

Visualize ALMA using 1 lwc_line.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     atr::OnlineTechnicalIndicators.ATR,
     opts::Union{Nothing, AbstractDict},
     df::DataFrames.DataFrame
 ) -> LightweightCharts.LWCChart
-

Visualize ATR using 1 lwc_line.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

Visualize ATR using 1 lwc_line.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     bb::OnlineTechnicalIndicators.BB,
     opts::Union{Nothing, AbstractDict},
     df::DataFrames.DataFrame
 ) -> Vector{LightweightCharts.LWCChart}
-

Visualize Bollinger Bands using 3 lwc_lines.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

Visualize Bollinger Bands using 3 lwc_lines.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     dema::OnlineTechnicalIndicators.DEMA,
     opts::Union{Nothing, AbstractDict},
     df::DataFrames.DataFrame
 ) -> LightweightCharts.LWCChart
-

Visualize DEMA using 1 lwc_line.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

Visualize DEMA using 1 lwc_line.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     ema::OnlineTechnicalIndicators.EMA,
     opts::Union{Nothing, AbstractDict},
     df::DataFrames.DataFrame
 ) -> LightweightCharts.LWCChart
-

Visualize EMA using 1 lwc_line.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

Visualize EMA using 1 lwc_line.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     hma::OnlineTechnicalIndicators.HMA,
     opts::Union{Nothing, AbstractDict},
     df::DataFrames.DataFrame
 ) -> LightweightCharts.LWCChart
-

Visualize HMA using 1 lwc_line.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

Visualize HMA using 1 lwc_line.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     keltnerchannels::OnlineTechnicalIndicators.KeltnerChannels,
     opts::Union{Nothing, AbstractDict},
     df::DataFrames.DataFrame
 ) -> Vector{LightweightCharts.LWCChart}
-

Visualize Keltner Channels (KC) using 3 lwc_lines.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

Visualize Keltner Channels (KC) using 3 lwc_lines.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     mcginleydynamic::OnlineTechnicalIndicators.McGinleyDynamic,
     opts::Union{Nothing, AbstractDict},
     df::DataFrames.DataFrame
 ) -> LightweightCharts.LWCChart
-

Visualize McGinleyDynamic using 1 lwc_line.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

Visualize McGinleyDynamic using 1 lwc_line.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     obv::OnlineTechnicalIndicators.OBV,
     opts::Union{Nothing, AbstractDict},
     df::DataFrames.DataFrame
 ) -> LightweightCharts.LWCChart
-

Visualize On Balance Volume (OBV) using 1 lwc_line.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

Visualize On Balance Volume (OBV) using 1 lwc_line.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     rsi::OnlineTechnicalIndicators.RSI,
     opts::Union{Nothing, AbstractDict},
     df::DataFrames.DataFrame
 ) -> LightweightCharts.LWCChart
-

Visualize RSI using 1 lwc_line.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

Visualize RSI using 1 lwc_line.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     sma::OnlineTechnicalIndicators.SMA,
     opts::Union{Nothing, AbstractDict},
     df::DataFrames.DataFrame
 ) -> LightweightCharts.LWCChart
-

Return an lwc_line for visualizing an SMA indicator.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

Return an lwc_line for visualizing an SMA indicator.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     SMMA::OnlineTechnicalIndicators.SMMA,
     opts::Union{Nothing, AbstractDict},
     df::DataFrames.DataFrame
 ) -> LightweightCharts.LWCChart
-

Return an lwc_line for visualizing an SMMA indicator.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

Return an lwc_line for visualizing an SMMA indicator.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     srsi::OnlineTechnicalIndicators.StochRSI,
     opts::Union{Nothing, AbstractDict},
     df::DataFrames.DataFrame
 ) -> Vector{LightweightCharts.LWCChart}
-

Visualize StochRSI using 2 lwc_lines.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

Visualize StochRSI using 2 lwc_lines.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     tsi::OnlineTechnicalIndicators.TSI,
     opts::Union{Nothing, AbstractDict},
     df::DataFrames.DataFrame
 ) -> LightweightCharts.LWCChart
-

Visualize True Strength Index (TSI) using 1 lwc_line. Note that on TradingView, TSI includes a second signal line that is not included here.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
+

Visualize True Strength Index (TSI) using 1 lwc_line. Note that on TradingView, TSI includes a second signal line that is not included here.

source
TechnicalIndicatorCharts.visualize — Method
visualize(
     wma::OnlineTechnicalIndicators.WMA,
     opts::Union{Nothing, AbstractDict},
     df::DataFrames.DataFrame
 ) -> LightweightCharts.LWCChart
-

Visualize WMA using 1 lwc_line.

source
+

Visualize WMA using 1 lwc_line.

source diff --git a/dev/index.html b/dev/index.html index b9e3587..381b376 100644 --- a/dev/index.html +++ b/dev/index.html @@ -70,4 +70,4 @@ update!(golden_cross_chart, c) end -lwc_save("golden_cross_example.html", visualize(golden_cross_chart));
Tip

Notebooks

If you were in a Pluto.jl or Jupyter notebook, use visualize to make the chart renderable.

visualize(golden_cross_chart)
+lwc_save("golden_cross_example.html", visualize(golden_cross_chart));
Tip

Notebooks

If you were in a Pluto.jl or Jupyter notebook, use visualize to make the chart renderable.

visualize(golden_cross_chart)
diff --git a/dev/indicators/index.html b/dev/indicators/index.html index 3d90be7..9549364 100644 --- a/dev/indicators/index.html +++ b/dev/indicators/index.html @@ -20,4 +20,4 @@ [df[!, name][start:end]...]; kwargs... ) -end

If you need to return more than one line, return them in a vector. A good example of this is BB.jl which returns 3 lwc_lines.

You're also not limited to lwc_line. You can use any visualization function supported by LightweightCharts.jl.

Examples

All indicator visualizations fall into one of these four categories.

Denominated in PriceNot Denominated in Price
Single Visual ElementEMA, HMA, SMARSI
Multiple Visual ElementsBBStochRSI

When implementing a new visualization, feel free to look at the source for these and use them as a starting point for your own work.

Finally

Thanks

Thanks to all future indicator visualization authors.

+end

If you need to return more than one line, return them in a vector. A good example of this is BB.jl which returns 3 lwc_lines.

You're also not limited to lwc_line. You can use any visualization function supported by LightweightCharts.jl.

Examples

All indicator visualizations fall into one of these four categories.

Denominated in PriceNot Denominated in Price
Single Visual ElementEMA, HMA, SMARSI
Multiple Visual ElementsBBStochRSI

When implementing a new visualization, feel free to look at the source for these and use them as a starting point for your own work.

Finally

Thanks

Thanks to all future indicator visualization authors.

diff --git a/dev/objects.inv b/dev/objects.inv index c032149..704162f 100644 Binary files a/dev/objects.inv and b/dev/objects.inv differ