ChartDecorator

class qf_lib.plotting.decorators.chart_decorator.ChartDecorator(key: str = None)

Bases: object

Abstract class for Chart decorators. Decorators are objects which add something to the chart (e.g. to Axes object) after the main chart has been plotted. To use a decorator you need to create it first and then add it to the chart using the Chart.add_decorator(ChartDecorator) method.

Parameters

key (str, optional) – Key is the identifier of the decorator. It must be unique to each decorator across the chart. If None is specified then the unique key is generated automatically.

Methods

decorate(chart)	Modifies the axes object taken from the chart (e.g.
decorate_html(chart, chart_id)	Constructs code to decorate an existing web chart.

decorate(chart: Chart) → None

Modifies the axes object taken from the chart (e.g. adds legend, draws cone, etc.).

decorate_html(chart: Chart, chart_id: str) → str

Constructs code to decorate an existing web chart.

Parameters

• chart (Chart) –

• chart_id (str) – A string identifying the specific chart. For the web, the <div> that represents this chart will typically use this as its id.

Returns

JavaScript code that is called before the underlying chart is initialised. The code can modify the pre-defined options variable.

Return type

str