OEPeptideDisplayOptions

class OEPeptideDisplayOptions

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

See also

Code Example

Constructors

OEPeptideDisplayOptions() -> OEPeptideDisplayOptions

Default constructor.

../../_images/OEPeptideDisplayOptions_Default.svg

Peptide depiction with default options

OEPeptideDisplayOptions(style: int) -> OEPeptideDisplayOptions
OEPeptideDisplayOptions(arg2: OEPeptideDisplayOptions) -> OEPeptideDisplayOptions

Copy constructor.

GetAminoAcidScale

GetAminoAcidScale() -> float

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

GetInteractive

GetInteractive() -> bool

Returns whether the generated svg image will be interactive.

GetLabelStyle

GetLabelStyle() -> int

Warning

This is a deprecated API.

SetAminoAcidScale

SetAminoAcidScale(scale: float) -> None

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:

opts = oegrapheme.OEPeptideDisplayOptions()
opts.SetInteractive(True)
opts.SetAminoAcidScale(0.75)

../../_images/OEPeptideDisplayOptions_SetAminoAcidScale.svg

Note

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

SetInteractive

SetInteractive(interactive: bool) -> None

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:

opts = oegrapheme.OEPeptideDisplayOptions()
opts.SetInteractive(True)

../../_images/OEPeptideDisplayOptions_SetInteractive.svg

Note

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

SetLabelStyle

SetLabelStyle(style: int) -> None

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