OpenMS
Plot2DGoToDialog Class Reference

GoTo dialog used to zoom to a m/z and retention time range or to a feature. More...

#include <OpenMS/VISUAL/DIALOGS/Plot2DGoToDialog.h>

Inheritance diagram for Plot2DGoToDialog:
[legend]
Collaboration diagram for Plot2DGoToDialog:
[legend]

Public Types

using AreaXYType = PlotCanvas::AreaXYType
 

Public Member Functions

 Plot2DGoToDialog (QWidget *parent, std::string_view x_name, std::string_view y_name)
 
 ~Plot2DGoToDialog () override
 Destructor. More...
 
bool showRange () const
 Returns if a feature UID was set an a feature should be displayed (false), otherwise, show a range (true) More...
 
bool checked ()
 
Methods for ranges
void setRange (const AreaXYType &range)
 Sets the data range to display initially. More...
 
void setMinMaxOfRange (const AreaXYType &max_range)
 Sets the data range of the complete experiment for better navigation with the dialog. More...
 
AreaXYType getRange ()
 

Methods for feature numbers

Ui::Plot2DGoToDialogTemplate * ui_
 
String getFeatureNumber () const
 Returns the selected feature numbers. If a number is returned, the feature rather than the range should be displayed. More...
 
void enableFeatureNumber (bool)
 Disables the feature number field. More...
 

Detailed Description

GoTo dialog used to zoom to a m/z and retention time range or to a feature.

Member Typedef Documentation

◆ AreaXYType

Constructor & Destructor Documentation

◆ Plot2DGoToDialog()

Plot2DGoToDialog ( QWidget parent,
std::string_view  x_name,
std::string_view  y_name 
)

Constructor

Parameters
parentParent widget
x_nameName of the x_axis dimension
y_nameName of the y_axis dimension

◆ ~Plot2DGoToDialog()

~Plot2DGoToDialog ( )
override

Destructor.

Member Function Documentation

◆ checked()

bool checked ( )

◆ enableFeatureNumber()

void enableFeatureNumber ( bool  )

Disables the feature number field.

◆ getFeatureNumber()

String getFeatureNumber ( ) const

Returns the selected feature numbers. If a number is returned, the feature rather than the range should be displayed.

◆ getRange()

AreaXYType getRange ( )

Query the range set by the user. If any dimension is <1, it is extended to at least 1 to ensure proper displaying.

◆ setMinMaxOfRange()

void setMinMaxOfRange ( const AreaXYType max_range)

Sets the data range of the complete experiment for better navigation with the dialog.

◆ setRange()

void setRange ( const AreaXYType range)

Sets the data range to display initially.

◆ showRange()

bool showRange ( ) const

Returns if a feature UID was set an a feature should be displayed (false), otherwise, show a range (true)

Member Data Documentation

◆ ui_

Ui::Plot2DGoToDialogTemplate* ui_
private