ChromatogramConfig

class pyopenms_viz._config.ChromatogramConfig(*, 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 = 'Chromatogram', xlabel: str = 'Retention Time', ylabel: str = 'Intensity', 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, line_width: float = 1, line_type: str = 'solid', annotation_data: ~pandas.core.frame.DataFrame | None = None, annotation_colormap: str = 'Dark2', annotation_line_width: float = 3, annotation_line_type: str = 'solid', annotation_legend_config: ~typing.Dict | ~pyopenms_viz._config.LegendConfig = <factory>)

Bases: LineConfig

Configuration for a chromatogram plot.

annotation_data

Data for annotations. Default is None.

Type:

pd.DataFrame | None

annotation_colormap

Colormap for annotations. Default is “Dark2”.

Type:

str

annotation_line_width

Width of the annotation lines. Default is 3.

Type:

float

annotation_line_type

Type of the annotation lines (e.g., “solid”, “dashed”). Default is “solid”.

Type:

str

annotation_legend_config

Configuration for the annotation legend. Default is a LegendConfig instance with title “Features”.

Type:

Dict | LegendConfig

xlabel

Label for the X-axis. Default is “Retention Time”.

Type:

str

ylabel

Label for the Y-axis. Default is “Intensity”.

Type:

str

title

Title of the plot. Default is “Chromatogram”.

Type:

str

__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 = 'Chromatogram', xlabel: str = 'Retention Time', ylabel: str = 'Intensity', 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, line_width: float = 1, line_type: str = 'solid', annotation_data: ~pandas.core.frame.DataFrame | None = None, annotation_colormap: str = 'Dark2', annotation_line_width: float = 3, annotation_line_type: str = 'solid', annotation_legend_config: ~typing.Dict | ~pyopenms_viz._config.LegendConfig = <factory>) → None

__repr__()

Return repr(self).