API

Note: This section provides a comprehensive overview of all methods and classes available in PyOpenMS-Viz. This content is generated automatically using Sphinx autosummary and autodoc based on the Python documentation.

Configuration Classes

BaseConfig
LegendConfig	Configuration for the legend in a plot.
BasePlotConfig	Base configuration for a plot.
LineConfig	Configuration for a line plot.
VLineConfig	Configuration for a vertical or horizontal line plot.
ScatterConfig	Configuration for a scatter plot.
ChromatogramConfig	Configuration for a chromatogram plot.
MobilogramConfig	Configuration for a mobilogram plot.
SpectrumConfig	Configuration for a spectrum plot.
PeakMapConfig	Configuration for a peak map plot.

Core

Base

These are base abstract classes that are inherited by other classes.

BasePlot	This class shows functions which must be implemented by all backends
BaseMSPlot	Abstract class for complex plots, such as chromatograms and mobilograms which are made up of simple plots such as ScatterPlots, VLines and LinePlots.

Simple Plots

These are simple plots that inherit from the BasePlot class.

LinePlot
VLinePlot
ScatterPlot

Mass Spectrometry Plots

These are mass spectrometry plots that inherit from the BaseMSPlot class.

ChromatogramPlot
MobilogramPlot
SpectrumPlot
PeakMapPlot

Extension: BOKEH

Base

BOKEHPlot	Base class for assembling a Bokeh plot
BOKEH_MSPlot

Simple Plots

These are simple plots that inherit from the BasePlot class.

BOKEHLinePlot	Class for assembling a collection of Bokeh line plots
BOKEHVLinePlot	Class for assembling a series of vertical line plots in Bokeh
BOKEHScatterPlot	Class for assembling a Bokeh scatter plot

Mass Spectrometry Plots

These are mass spectrometry plots that inherit from the BaseMSPlot class.

BOKEHChromatogramPlot	Class for assembling a Bokeh extracted ion chromatogram plot
BOKEHMobilogramPlot	Class for assembling a Bokeh mobilogram plot
BOKEHSpectrumPlot	Class for assembling a Bokeh spectrum plot
BOKEHPeakMapPlot	Class for assembling a Bokeh feature heatmap plot

Extension: PLOTLY

Base

PLOTLYPlot	Base class for assembling a Ploty plot
PLOTLY_MSPlot

Simple Plots

These are simple plots that inherit from the BasePlot class.

PLOTLYLinePlot	Class for assembling a set of line plots in plotly
PLOTLYVLinePlot
PLOTLYScatterPlot

Mass Spectrometry Plots

These are mass spectrometry plots that inherit from the BaseMSPlot class.

PLOTLYChromatogramPlot
PLOTLYMobilogramPlot
PLOTLYSpectrumPlot
PLOTLYPeakMapPlot

Extension: MATPLOTLIB

Base

MATPLOTLIBPlot	Base class for assembling a Matplotlib plot.
MATPLOTLIB_MSPlot

Simple Plots

These are simple plots that inherit from the BasePlot class.

MATPLOTLIBLinePlot	Class for assembling a matplotlib line plot
MATPLOTLIBVLinePlot	Class for assembling a matplotlib vertical line plot
MATPLOTLIBScatterPlot	Class for assembling a matplotlib scatter plot

Mass Spectrometry Plots

These are mass spectrometry plots that inherit from the BaseMSPlot class.

MATPLOTLIBChromatogramPlot	Class for assembling a matplotlib extracted ion chromatogram plot
MATPLOTLIBMobilogramPlot	Class for assembling a matplotlib mobilogram plot
MATPLOTLIBSpectrumPlot	Class for assembling a matplotlib spectrum plot
MATPLOTLIBPeakMapPlot	Class for assembling a matplotlib feature heatmap plot