OEPeptideDisplayOptions

class OEPeptideDisplayOptions

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

See also

OEDrawPeptide function

Code Example

Depict Peptide OpenEye Python Cookbook recipe

Constructors

OEPeptideDisplayOptions()

Default constructor.

../../_images/OEPeptideDisplayOptions_Default.svg — **Peptide depiction with default options**

OEPeptideDisplayOptions(const OEPeptideDisplayOptions& rhs)

Copy constructor.

GetAminoAcidScale

double GetAminoAcidScale() const

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

See also

OEPeptideDisplayOptions.SetAminoAcidScale method

GetInteractive

bool GetInteractive() const

Returns whether the generated svg image will be interactive.

See also

OEPeptideDisplayOptions.SetInteractive method

GetLabelStyle

unsigned int GetLabelStyle() const

Warning

This is a deprecated API.

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 = new OEPeptideDisplayOptions();
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 = new OEPeptideDisplayOptions();
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)

Warning

This is a deprecated API.

style: This value has to be from the OEPeptideLabelStyle namespace.

Example:

../../_images/OEPeptideDisplayOptions_SetLabelStyle.svg — **Peptide depiction with single letter style**

See also

OEPeptideLabelStyle namespace