Visualisation

tradeexecutor.state.visualisation.Visualisation class.

class Visualisation

Bases: object

This object is returned from the strategy execution cycle. It allows you to plot values, add debug messages, etc. It is not used in any trading, but can help and visualize trade backtesting and execution.

__init__(messages=<factory>, plots=<factory>)

Parameters

• messages (Dict[int, List[str]]) –

• plots (Dict[str, Plot]) –

Return type

None

Methods

__init__([messages, plots])
add_message(timestamp, content)	Write a debug message.
from_dict(kvs, *[, infer_missing])
from_json(s, *[, parse_float, parse_int, ...])
plot_indicator(timestamp, name, kind, value)	Add a value to the output data and diagram.
schema(*[, infer_missing, only, exclude, ...])
to_dict([encode_json])
to_json(*[, skipkeys, ensure_ascii, ...])

Attributes

messages	Messages for each strategy cycle.
plots

messages: Dict[int, List[str]]

Messages for each strategy cycle.

TODO: Because we cannot use datetime.datetime directly as a key in JSON, we use UNIX timestamp here to keep our state easily serialisable.

add_message(timestamp, content)

Write a debug message.

• Each message is associated to a different timepoint.

Parameters

• timestamp (datetime) – The current strategy cycle timestamp

• content (str) – The contents of the message

plot_indicator(timestamp, name, kind, value, colour=None)

Add a value to the output data and diagram.

Plots are stored by their name.

Parameters

• timestamp (Union[datetime, Timestamp]) – The current strategy cycle timestamp

• name (str) – The plot label

• kind (PlotKind) – The plot typre

• value (float) – Current value e.g. price as USD

• colour (Optional[str]) – Optional colour

__init__(messages=<factory>, plots=<factory>)

Parameters

• messages (Dict[int, List[str]]) –

• plots (Dict[str, Plot]) –

Return type

None