OEMonomerGraphDisplayOptions

Attention

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

class OEMonomerGraphDisplayOptions

The OEMonomerGraphDisplayOptions class is used to customize molecule depiction when using OEDrawMonomerGraph function.

hover cursor over graph

Example of using the OEDrawMonomerGraph function

Constructors

OEMonomerGraphDisplayOptions()

Default constructor.

OEMonomerGraphDisplayOptions(const OEMonomerGraphDisplayOptions& rhs)

Copy constructor.

operator=

OEMonomerGraphDisplayOptions &operator=(const OEMonomerGraphDisplayOptions &rhs)

Assignment operator.

GetInteractiveEffect

unsigned GetInteractiveEffect() const

Returns the interactive effect of the generated svg image.

GetMonomerColorFunctor

const OEMonomerColorBase& GetMonomerColorFunctor() const

Returns the functor that is used to determine the color used to draw the glyph representing the monomer. By default, the OEMonomerColorDefault functor is used.

GetMonomerScale

double GetMonomerScale() const

Returns the scaling factor of monomer components in interactive mode.

GetMonomerGlyphStyleFunctor

const OEMonomerGlyphStyleBase& GetMonomerGlyphStyleFunctor() const

Returns the functor that is used to determine the circle style used to draw the glyph representing the monomer. By default, the OEMonomerGlyphStyleDefault functor is used.

GetMonomerLabelColorFunctor

const OEMonomerColorBase& GetMonomerLabelColorFunctor() const

Returns the functor that is used to determine the color of the font used to depict the monomer code. By default, the OEMonomerColorMonochrome functor is used to set all monomer code fonts to black.

SetInteractiveEffect

void SetInteractiveEffect(const unsigned effect)

Sets the interactive effect of the generated svg image. In interactive mode, the structures of the monomers that make up the molecule are shown on mouse-over or mouse-click.

SetMonomerColorFunctor

void SetMonomerColorFunctor(const OEMonomerColorBase& func)

Sets the functor that is used to determine the color used to draw the glyph representing the monomer.

SetMonomerScale

void SetMonomerScale(const double scale)

Sets the scaling factor of monomer 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 OEMonomerGraphDisplayOptions::SetInteractiveEffect method

SetMonomerGlyphStyleFunctor

void SetMonomerGlyphStyleFunctor(const OEMonomerGlyphStyleBase& func)

Sets the functor that is used to determine the circle style used to draw the glyph representing the monomer.

SetMonomerLabelColorFunctor

void SetMonomerLabelColorFunctor(const OEMonomerColorBase& func)

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