mirror of
https://github.com/freqtrade/freqtrade.git
synced 2026-02-26 06:11:45 +00:00
Deployed e55a196 to develop in en with MkDocs 1.6.1 and mike 2.1.3
This commit is contained in:
File diff suppressed because one or more lines are too long
@@ -999,6 +999,39 @@
|
||||
<nav class="md-nav" aria-label="Plot annotations callback">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#annotation-types" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Annotation types
|
||||
</span>
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="Annotation types">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#area" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Area
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#line" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Line
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#plot-annotations-example" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -2536,6 +2569,39 @@
|
||||
<nav class="md-nav" aria-label="Plot annotations callback">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#annotation-types" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Annotation types
|
||||
</span>
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="Annotation types">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#area" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Area
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#line" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
Line
|
||||
</span>
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#plot-annotations-example" class="md-nav__link">
|
||||
<span class="md-ellipsis">
|
||||
@@ -3714,8 +3780,10 @@ Please keep in mind that this is considered advanced usage, and should be used w
|
||||
<p>The plot annotations callback is called whenever freqUI requests data to display a chart.
|
||||
This callback has no meaning in the trade cycle context and is only used for charting purposes.</p>
|
||||
<p>The strategy can then return a list of <code>AnnotationType</code> objects to be displayed on the chart.
|
||||
Depending on the content returned - the chart can display horizontal areas, vertical areas, or boxes.</p>
|
||||
<p>The full object looks like this:</p>
|
||||
Depending on the content returned - the chart can display horizontal areas, vertical areas, boxes or lines.</p>
|
||||
<h3 id="annotation-types">Annotation types<a class="headerlink" href="#annotation-types" title="Permanent link">¶</a></h3>
|
||||
<p>Currently two types of annotations are supported, <code>area</code> and <code>line</code>.</p>
|
||||
<h4 id="area">Area<a class="headerlink" href="#area" title="Permanent link">¶</a></h4>
|
||||
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"area"</span><span class="p">,</span><span class="w"> </span><span class="c1">// Type of the annotation, currently only "area" is supported</span>
|
||||
<span class="w"> </span><span class="nt">"start"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-01-01 15:00:00"</span><span class="p">,</span><span class="w"> </span><span class="c1">// Start date of the area</span>
|
||||
@@ -3725,6 +3793,21 @@ Depending on the content returned - the chart can display horizontal areas, vert
|
||||
<span class="w"> </span><span class="nt">"color"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"z_level"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w"> </span><span class="c1">// z-level, higher values are drawn on top of lower values. Positions relative to the Chart elements need to be set in freqUI.</span>
|
||||
<span class="w"> </span><span class="nt">"label"</span><span class="p">:</span><span class="w"> </span><span class="s2">"some label"</span>
|
||||
<span class="p">}</span>
|
||||
</code></pre></div>
|
||||
<h4 id="line">Line<a class="headerlink" href="#line" title="Permanent link">¶</a></h4>
|
||||
<div class="highlight"><pre><span></span><code><span class="p">{</span>
|
||||
<span class="w"> </span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"line"</span><span class="p">,</span><span class="w"> </span><span class="c1">// Type of the annotation, currently only "line" is supported</span>
|
||||
<span class="w"> </span><span class="nt">"start"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-01-01 15:00:00"</span><span class="p">,</span><span class="w"> </span><span class="c1">// Start date of the line</span>
|
||||
<span class="w"> </span><span class="nt">"end"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2024-01-01 16:00:00"</span><span class="p">,</span><span class="w"> </span><span class="c1">// End date of the line</span>
|
||||
<span class="w"> </span><span class="nt">"y_start"</span><span class="p">:</span><span class="w"> </span><span class="mf">94000.2</span><span class="p">,</span><span class="w"> </span><span class="c1">// Price / y axis value</span>
|
||||
<span class="w"> </span><span class="nt">"y_end"</span><span class="p">:</span><span class="w"> </span><span class="mi">98000</span><span class="p">,</span><span class="w"> </span><span class="c1">// Price / y axis value</span>
|
||||
<span class="w"> </span><span class="nt">"color"</span><span class="p">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"z_level"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w"> </span><span class="c1">// z-level, higher values are drawn on top of lower values. Positions relative to the Chart elements need to be set in freqUI.</span>
|
||||
<span class="w"> </span><span class="nt">"label"</span><span class="p">:</span><span class="w"> </span><span class="s2">"some label"</span><span class="p">,</span>
|
||||
<span class="w"> </span><span class="nt">"width"</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span><span class="w"> </span><span class="c1">// Optional, line width in pixels. Defaults to 1</span>
|
||||
<span class="w"> </span><span class="nt">"line_style"</span><span class="p">:</span><span class="w"> </span><span class="s2">"dashed"</span><span class="p">,</span><span class="w"> </span><span class="c1">// Optional, can be "solid", "dashed" or "dotted". Defaults to "solid"</span>
|
||||
|
||||
<span class="p">}</span>
|
||||
</code></pre></div>
|
||||
<p>The below example will mark the chart with areas for the hours 8 and 15, with a grey color, highlighting the market open and close hours.
|
||||
@@ -3787,7 +3870,7 @@ Use the annotation feature with care.</p>
|
||||
<span class="k">while</span> <span class="n">start_dt</span> <span class="o"><</span> <span class="n">end_date</span><span class="p">:</span>
|
||||
<span class="n">start_dt</span> <span class="o">+=</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">hours</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
|
||||
<span class="k">if</span> <span class="p">(</span><span class="n">start_dt</span><span class="o">.</span><span class="n">hour</span> <span class="o">%</span> <span class="mi">4</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
|
||||
<span class="n">mark_areas</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
|
||||
<span class="n">annotations</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
|
||||
<span class="p">{</span>
|
||||
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"area"</span><span class="p">,</span>
|
||||
<span class="s2">"label"</span><span class="p">:</span> <span class="s2">"4h"</span><span class="p">,</span>
|
||||
@@ -3798,7 +3881,7 @@ Use the annotation feature with care.</p>
|
||||
<span class="p">)</span>
|
||||
<span class="k">elif</span> <span class="p">(</span><span class="n">start_dt</span><span class="o">.</span><span class="n">hour</span> <span class="o">%</span> <span class="mi">2</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
|
||||
<span class="n">price</span> <span class="o">=</span> <span class="n">dataframe</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="n">dataframe</span><span class="p">[</span><span class="s2">"date"</span><span class="p">]</span> <span class="o">==</span> <span class="n">start_dt</span><span class="p">,</span> <span class="p">[</span><span class="s2">"close"</span><span class="p">]]</span><span class="o">.</span><span class="n">mean</span><span class="p">()</span>
|
||||
<span class="n">mark_areas</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
|
||||
<span class="n">annotations</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
|
||||
<span class="p">{</span>
|
||||
<span class="s2">"type"</span><span class="p">:</span> <span class="s2">"area"</span><span class="p">,</span>
|
||||
<span class="s2">"label"</span><span class="p">:</span> <span class="s2">"2h"</span><span class="p">,</span>
|
||||
|
||||
Reference in New Issue
Block a user