`massdash.plotting`.PlotConfig

class massdash.plotting.PlotConfig

Bases: object

A class representing the configuration for a plot.

include_ms1

A flag indicating whether to include MS1 data.

Type:: bool

include_ms2

A flag indicating whether to include MS2 data.

Type:: bool

num_plot_columns

The number of columns to be displayed in the plot.

Type:: int

hide_legends

A flag indicating whether to hide the legends in the plot.

Type:: bool

title

The title of the plot.

Type:: str

subtitle

The subtitle of the plot.

Type:: str

x_axis_label

The label for the x-axis.

Type:: str

y_axis_label

The label for the y-axis.

Type:: str

smoothing_dict

A dictionary containing the parameters for smoothing the data. e.g. {‘type’: ‘sgolay’, ‘sgolay_polynomial_order’: 3, ‘sgolay_frame_length’: 11} e.g. {‘type’: ‘none’}

Type:: dict

x_range

The range of values to be displayed on the x-axis.

Type:: tuple

y_range

The range of values to be displayed on the y-axis.

Type:: tuple

scale_intensity

A flag indicating whether to scale the intensity of the data.

Type:: bool

aggregate_mslevels

A flag indicating whether to aggregate the data within an MS level.

Type:: bool

type_of_heatmap

The type of heatmap to be displayed. (Only used for InteractiveTwoDimensionalPlotter)

Type:: str

type_of_3d_plot

The type of 3D plot to be displayed. (Only used for InteractiveThreeDimensionalPlotter)

Type:: str

type_of_comparison

The type of comparison to be displayed. (Only used for InteractivePlotter)

Type:: str

context

The context in which the plot is being displayed. valid: “streamlit”, “jupyter”

Type:: str

normalization_dict

A dictionary containing the parameters for normalizing the data (2D heatmap only)

Type:: dict

update(config_dict)

Update the configuration attributes using a dictionary.

Parameters:: config_dict (dict) – A dictionary containing configuration values.