Skip to content

PlotsConfig


dataclass backtide.config.PlotsConfig

Configuration for plot appearance.

The plot parameters control the visual styling of all charts produced by backtide. Read more in the user guide.

Attributes

template : str, default="plotly"

Plotly template used for figure styling. Common choices are plotly, plotly_dark, plotly_white, ggplot2, seaborn. This parameter does not affect plots shown in the application.

palette : list[str]
Ordered list of RGB color strings used for data traces. Colors cycle when more traces than colors exist.

title_fontsize : int, default=22
Font size in pixels for plot titles.

label_fontsize : int, default=20
Font size in pixels for axis labels and legend entries.

tick_fontsize : int, default=14
Font size in pixels for axis tick labels.

line_width : float, default=2.0
Default line width in pixels for data traces. Reference/identity lines and band boundaries use half this value.

marker_size : float, default=8.0
Default marker size in pixels for scatter plots.


See Also

get_config

Get a copy of the current global configuration.

load_config

Load a backtide configuration from a file.

set_config

Set the global configuration.


Methods

to_dict Convert the configuration object to a dictionary.


method backtide.configto_dict()

Convert the configuration object to a dictionary.

Returns

dict

Self as dict.