Template spec

March 28, 2024 ยท View on GitHub

keymandatoryvalues
:idyesalgo name
:algoyesAlgo spec
:optionsyesAlgo options fields in the interactive ui
:chartyesChart spec
:tablenoTable spec
:metricsnoMetrics spec

Algo spec

keymandatoryvalues
:typeyes:time
:trailing-bar
:calendaryesvector with the market and timeframe:
markets [...]
timeframes: [....]
:assetyesdefault symbol name
:trailing-nyesdefault displayed bar amount on chart
:importyesdatafeed for missing bars
:feedyesdatafeed for existing bars
:algoyesalgo namespace incl. function
*nodefault custom option values passed to algo function

Algo options

Array of fields. One field has the following format:

keymandatoryvalues
:typeyes:select (Select Box)
:string (Input Field)
:bool (Checkbox)
:pathyesmatching keyword of Algo spec
:nameyesLabel of the option field
:specyes*array or function (which returns an array) for :select
not mandatory for :bool or :string

Chart spec

keymandatoryvalues
:vizyeschart renderer namespace
highchart ns: ta.viz.ds.highchart/highstock-render-spec
vega ns: ta.viz.ds.vega/vega-render-spec
:viz-optionsyesviz-options spec

:viz-options (highchart)

keymandatoryvalues
:chartyeschart container options: {:box :fl}

:fl = full (100%)
:sm = small
:md = medium
:lg = large
:chartsyesarray of indicator panes and main chart itself. Charts options

Table spec

keymandatoryvalues
:vizyestable renderer namespace
table ns: ta.viz.ds.rtable/rtable-render-spec
:viz-optionsyesviz-options spec

TODO: path, column, ....

Metrics spec

keymandatoryvalues
:vizyesmetrics renderer namespace
metrics ns: ta.viz.ds.metrics/metrics-render-spec
:viz-optionsyesviz-options spec