BasePlotConfig

class pyopenms_viz._config.BasePlotConfig(*, kind: ~typing.Literal['line', 'vline', 'scatter', 'chromatogram', 'mobilogram', 'spectrum', 'peakmap', 'complex'] | None = None, x: str | None = None, y: str | None = None, z: str | None = None, by: str | None = None, canvas: ~typing.Any = None, height: int = 500, width: int = 500, grid: bool = True, toolbar_location: str = 'above', title: str = '', xlabel: str = '', ylabel: str = '', zlabel: str = '', title_font_size: int = 18, xaxis_label_font_size: int = 16, yaxis_label_font_size: int = 16, zaxis_label_font_size: int = 16, xaxis_labelpad: int = 16, yaxis_labelpad: int = 16, zaxis_labelpad: int = 9, xaxis_tick_font_size: int = 14, yaxis_tick_font_size: int = 14, zaxis_tick_font_size: int = 14, y_axis_location: ~typing.Literal['left', 'right'] = 'left', x_axis_location: ~typing.Literal['above', 'below'] = 'below', annotation_font_size: int = 12, color: str | ~typing.Iterator[str] = <factory>, plot_3d: bool = False, min_border: int = 0, show_plot: bool = True, relative_intensity: bool = False, aggregate_duplicates: bool = False, legend_config: ~pyopenms_viz._config.LegendConfig | dict = <factory>, opacity: float = 1.0)

Bases: BaseConfig

Base configuration for a plot.

kind

Type of plot. Default is None.

Type:

Literal[“line”, “vline”, “scatter”, “chromatogram”, “mobilogram”, “spectrum”, “peakmap”, “complex”] | None

x

X-axis data. Default is None.

Type:

str | None

y

Y-axis data. Default is None.

Type:

str | None

z

Z-axis data. Default is None.

Type:

str | None

by

Grouping variable. Default is None.

Type:

str | None

canvas

Canvas for the plot. Default is None. For Bokeh, this is a bokeh.plotting.Figure object. For Matplotlib, this is a Axes object, and for Plotly, this is a plotly.graph_objects.Figure object.

Type:

Any

height

Height of the plot. Default is 500.

Type:

int

width

Width of the plot. Default is 500.

Type:

int

grid

Whether to show grid. Default is True.

Type:

bool

toolbar_location

Location of the toolbar. Default is “above”.

Type:

str

title

Title of the plot. Default is an empty string.

Type:

str

xlabel

Label for the X-axis. Default is an empty string.

Type:

str

ylabel

Label for the Y-axis. Default is an empty string.

Type:

str

zlabel

Label for the Z-axis. Default is an empty string.

Type:

str

x_axis_location

Location of the X-axis. Default is “below”.

Type:

str

y_axis_location

Location of the Y-axis. Default is “left”.

Type:

str

title_font_size

Font size of the title. Default is 18.

Type:

int

xaxis_label_font_size

Font size of the X-axis label. Default is 16.

Type:

int

yaxis_label_font_size

Font size of the Y-axis label. Default is 16.

Type:

int

zaxis_label_font_size

Font size of the Z-axis label. Default is 16.

Type:

int

xaxis_labelpad

Padding for the X-axis label. Default is 16.

Type:

int

yaxis_labelpad

Padding for the Y-axis label. Default is 16.

Type:

int

zaxis_labelpad

Padding for the Z-axis label. Default is 9.

Type:

int

default_legend_factory()

Returns a default LegendConfig instance with the title “Trace”.

__eq__(other)

Return self==value.

__hash__ = None

__init__(*, kind: ~typing.Literal['line', 'vline', 'scatter', 'chromatogram', 'mobilogram', 'spectrum', 'peakmap', 'complex'] | None = None, x: str | None = None, y: str | None = None, z: str | None = None, by: str | None = None, canvas: ~typing.Any = None, height: int = 500, width: int = 500, grid: bool = True, toolbar_location: str = 'above', title: str = '', xlabel: str = '', ylabel: str = '', zlabel: str = '', title_font_size: int = 18, xaxis_label_font_size: int = 16, yaxis_label_font_size: int = 16, zaxis_label_font_size: int = 16, xaxis_labelpad: int = 16, yaxis_labelpad: int = 16, zaxis_labelpad: int = 9, xaxis_tick_font_size: int = 14, yaxis_tick_font_size: int = 14, zaxis_tick_font_size: int = 14, y_axis_location: ~typing.Literal['left', 'right'] = 'left', x_axis_location: ~typing.Literal['above', 'below'] = 'below', annotation_font_size: int = 12, color: str | ~typing.Iterator[str] = <factory>, plot_3d: bool = False, min_border: int = 0, show_plot: bool = True, relative_intensity: bool = False, aggregate_duplicates: bool = False, legend_config: ~pyopenms_viz._config.LegendConfig | dict = <factory>, opacity: float = 1.0) → None

__repr__()

Return repr(self).