tsa.dashboard.update_figure

DashboardAPI.update_figure(figure)

Create or update a figure configuration.

The figure is validated before being persisted: first by a structural check via validate_for_render, then for non-balance variants by rendering them through the plotter to catch deeper problems (missing series, bad parameters, …). A FigureError is raised on any validation failure.

tsa.dashboard.update_figure(
    Figure(
        name='french_prices',
        variant='timeseries',
        traces=[Trace(name='power.fr', style=Style(color='blue'))],
        layout=FigureLayout(title='French prices'),
    )
)

Parameters:

figure (Figure)

Return type:

None