OEHighlightMonomerDisplayOptions

Attention

This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

class OEHighlightMonomerDisplayOptions : public OEDepict::OE2DMolDisplayOptions

The OEHighlightMonomerDisplayOptions class is used to customize molecule depiction when using OEHighlightMonomers function.

../../_images/HighlightMonomers.svg

Example of using OEHighlightMonomers function

The following methods are publicly inherited from OE2DMolDisplayOptions:

operator=

GetHydrogenStyle

SetBondLineAtomLabelGapScale

GetAromaticStyle

GetMargin

SetBondLineGapScale

GetAtomColor

GetScale

SetBondPropLabelFont

GetAtomColorStyle

GetSuperAtomLabelFont

SetBondPropLabelFontScale

GetAtomLabelFont

GetSuperAtomStyle

SetBondPropertyFunctor

GetAtomLabelFontScale

GetTitleFont

SetBondStereoStyle

GetAtomPropLabelFont

GetTitleFontScale

SetBondWidthScaling

GetAtomPropLabelFontScale

GetTitleHeight

SetDefaultBondPen

GetAtomPropertyFunctor

GetTitleLocation

SetDimensions

GetAtomStereoStyle

GetWidth

SetHeight

GetBackgroundColor

SetAromaticStyle

SetHydrogenStyle

GetBondColorStyle

SetAtomColor

SetMargin

GetBondLineAtomLabelGapScale

SetAtomColorStyle

SetMargins

GetBondLineGapScale

SetAtomLabelFont

SetScale

GetBondPropLabelFont

SetAtomLabelFontScale

SetSuperAtomLabelFont

GetBondPropLabelFontScale

SetAtomPropLabelFont

SetSuperAtomStyle

GetBondPropertyFunctor

SetAtomPropLabelFontScale

SetTitleFont

GetBondStereoStyle

SetAtomPropertyFunctor

SetTitleFontScale

GetBondWidthScaling

SetAtomStereoStyle

SetTitleHeight

GetDefaultBondPen

SetBackgroundColor

SetTitleLocation

GetHeight

SetBondColorStyle

SetWidth

Constructors

OEHighlightMonomerDisplayOptions() -> OEHighlightMonomerDisplayOptions

Default constructor.

OEHighlightMonomerDisplayOptions(width: float, height: float,
                                 scale: float) -> OEHighlightMonomerDisplayOptions

Constructor that sets the image dimensions and scale.

OEHighlightMonomerDisplayOptions(rhs: OEHighlightMonomerDisplayOptions) -> OEHighlightMonomerDisplayOptions

Copy constructor.

GetMonomerHighlightColorFunctor

GetMonomerHighlightColorFunctor() -> OEMonomerColorBase

Returns the functor that is used to determine the color used to highlight the monomers. By default, the OEMonomerColorDefault functor is used.

GetMonomerLabelColorFunctor

GetMonomerLabelColorFunctor() -> OEMonomerColorBase

Returns the functor that is used to determine the color of the font use to draw the monomer code.

By default, the OEMonomerColorMonochrome functor is used to set all monomer code fonts to black.

SetMonomerHighlightColorFunctor

SetMonomerHighlightColorFunctor(func: OEMonomerColorBase) -> None

Sets the functor that is used to determine the color used to highlight the monomers.

SetMonomerLabelColorFunctor

SetMonomerLabelColorFunctor(func: OEMonomerColorBase) -> None

Sets the functor that is used to determine the color of the font used to draw the monomer code.

GetHighlightUnspecifiedStereo

GetHighlightUnspecifiedStereo() -> bool

Returns whether monomers with unspecified stereo are highlighted.

SetHighlightUnspecifiedStereo

SetHighlightUnspecifiedStereo(highlight: bool) -> None

Sets whether monomers with unspecified stereo are highlighted.