OEPeptideDisplayOptions

class OEPeptideDisplayOptions

This class represents the OEPeptideDisplayOptions class that encapsulates properties that determine how a peptide is depicted.

See also

Constructors

OEPeptideDisplayOptions(unsigned int style=OEPeptideLabelStyle::Default)

Default constructor.

Peptide depiction with default options

OEPeptideDisplayOptions(const OEPeptideDisplayOptions &rhs)

Copy constructor.

operator=

OEPeptideDisplayOptions &operator=(const OEPeptideDisplayOptions &rhs)

Assignment operator.

GetAminoAcidScale

double GetAminoAcidScale() const

Returns the scaling factor of amino-acid components in interactive mode.

GetInteractive

bool GetInteractive() const

Returns whether the generated svg image will be interactive.

GetLabelStyle

unsigned int GetLabelStyle() const

Returns the style that controls the label of the amino acid circles are displayed. The return value is taken from the OEPeptideLabelStyle namespace.

SetAminoAcidScale

void SetAminoAcidScale(double scale)

Sets the scaling factor of amino-acid components in interactive mode.

scale
This value has to be in a range of [0.25, 0.75]. The default value is 0.50.

Note

This option has to be used along with the OEPeptideDisplayOptions::SetInteractive method

Example:

OEPeptideDisplayOptions opts;
opts.SetInteractive(true);
opts.SetAminoAcidScale(0.75);

Note

This functionality is only available for .svg image format. In other image formats it has no effect.

SetInteractive

void SetInteractive(bool interactive)

Sets whether the generated svg image will be interactive. In interactive mode the amino acid components of the compact peptide representation are depicted on mouse over.

Example:

OEPeptideDisplayOptions opts;
opts.SetInteractive(true);

Note

This functionality is only available for .svg image format. In other image formats it has no effect.

SetLabelStyle

void SetLabelStyle(unsigned int style)

Sets the style that controls how labels inside the the amino acid circles are displayed.

style
This value has to be from the OEPeptideLabelStyle namespace.

Example:

OEPeptideDisplayOptions opts;
opts.SetLabelStyle(OEPeptideLabelStyle::SingleLetter);

Peptide depiction with single letter style

See also