Package rdkit :: Package Chem :: Package Draw :: Module rdMolDraw2D :: Class MolDraw2D
[hide private]
[frames] | no frames]

Class MolDraw2D

 object --+    
          |    
??.instance --+
              |
             MolDraw2D
Known Subclasses:

Drawer abstract base class

Instance Methods [hide private]
 
DrawMolecule(...)
DrawMolecule( (MolDraw2D)self, (Mol)mol [, (AtomPairsParameters)highlightAtoms=None [, (AtomPairsParameters)highlightAtomColors=None [, (AtomPairsParameters)highlightAtomRadii=None [, (int)confId=-1 [, (str)legend='']]]]]) -> None : renders a molecule
 
DrawMolecules(...)
DrawMolecules( (MolDraw2D)self, (AtomPairsParameters)mols [, (AtomPairsParameters)highlightAtoms=None [, (AtomPairsParameters)highlightBonds=None [, (AtomPairsParameters)highlightAtomColors=None [, (AtomPairsParameters)highlightBondColors=None [, (AtomPairsParameters)highlightAtomRadii=None [, (AtomPairsParameters)confIds=None [, (AtomPairsParameters)legends=None]]]]]]]) -> None : renders multiple molecules
 
DrawString(...)
DrawString( (MolDraw2D)self, (str)string, (Point2D)pos) -> None : add text to the canvas
 
FontSize(...)
FontSize( (MolDraw2D)arg1) -> float : get the default font size
 
Height(...)
Height( (MolDraw2D)arg1) -> int : get the height of the drawing canvas
 
Offset(...)
Offset( (MolDraw2D)arg1) -> Point2D : returns the offset (in drawing coordinates) for the drawing
 
SetFontSize(...)
SetFontSize( (MolDraw2D)arg1, (float)arg2) -> None : change the default font size
 
SetOffset(...)
SetOffset( (MolDraw2D)arg1, (int)arg2, (int)arg3) -> None : set the offset (in drawing coordinates) for the drawing
 
SetScale(...)
SetScale( (MolDraw2D)arg1, (int)arg2, (int)arg3, (Point2D)arg4, (Point2D)arg5) -> None : uses the values provided to set the drawing scaling
 
Width(...)
Width( (MolDraw2D)arg1) -> int : get the width of the drawing canvas
 
__init__(...)
Raises an exception...
 
__reduce__(...)
helper for pickle
 
drawOptions(...)
drawOptions( (MolDraw2D)arg1) -> MolDrawOptions : Returns a modifiable version of the current drawing options

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

DrawMolecule(...)

 

DrawMolecule( (MolDraw2D)self, (Mol)mol [, (AtomPairsParameters)highlightAtoms=None [, (AtomPairsParameters)highlightAtomColors=None [, (AtomPairsParameters)highlightAtomRadii=None [, (int)confId=-1 [, (str)legend='']]]]]) -> None :
    renders a molecule
    

    C++ signature :
        void DrawMolecule(RDKit::MolDraw2D {lvalue},RDKit::ROMol [,boost::python::api::object=None [,boost::python::api::object=None [,boost::python::api::object=None [,int=-1 [,std::string='']]]]])

DrawMolecule( (MolDraw2D)self, (Mol)mol, (AtomPairsParameters)highlightAtoms, (AtomPairsParameters)highlightBonds [, (AtomPairsParameters)highlightAtomColors=None [, (AtomPairsParameters)highlightBondColors=None [, (AtomPairsParameters)highlightAtomRadii=None [, (int)confId=-1 [, (str)legend='']]]]]) -> None :
    renders a molecule
    

    C++ signature :
        void DrawMolecule(RDKit::MolDraw2D {lvalue},RDKit::ROMol,boost::python::api::object,boost::python::api::object [,boost::python::api::object=None [,boost::python::api::object=None [,boost::python::api::object=None [,int=-1 [,std::string='']]]]])

DrawMolecules(...)

 

DrawMolecules( (MolDraw2D)self, (AtomPairsParameters)mols [, (AtomPairsParameters)highlightAtoms=None [, (AtomPairsParameters)highlightBonds=None [, (AtomPairsParameters)highlightAtomColors=None [, (AtomPairsParameters)highlightBondColors=None [, (AtomPairsParameters)highlightAtomRadii=None [, (AtomPairsParameters)confIds=None [, (AtomPairsParameters)legends=None]]]]]]]) -> None :
    renders multiple molecules
    

    C++ signature :
        void DrawMolecules(RDKit::MolDraw2D {lvalue},boost::python::api::object [,boost::python::api::object=None [,boost::python::api::object=None [,boost::python::api::object=None [,boost::python::api::object=None [,boost::python::api::object=None [,boost::python::api::object=None [,boost::python::api::object=None]]]]]]])

DrawString(...)

 

DrawString( (MolDraw2D)self, (str)string, (Point2D)pos) -> None :
    add text to the canvas

    C++ signature :
        void DrawString(RDKit::MolDraw2D {lvalue},std::string,RDGeom::Point2D)

FontSize(...)

 

FontSize( (MolDraw2D)arg1) -> float :
    get the default font size

    C++ signature :
        double FontSize(RDKit::MolDraw2D {lvalue})

Height(...)

 

Height( (MolDraw2D)arg1) -> int :
    get the height of the drawing canvas

    C++ signature :
        int Height(RDKit::MolDraw2D {lvalue})

Offset(...)

 

Offset( (MolDraw2D)arg1) -> Point2D :
    returns the offset (in drawing coordinates) for the drawing

    C++ signature :
        RDGeom::Point2D Offset(RDKit::MolDraw2D {lvalue})

SetFontSize(...)

 

SetFontSize( (MolDraw2D)arg1, (float)arg2) -> None :
    change the default font size

    C++ signature :
        void SetFontSize(RDKit::MolDraw2D {lvalue},double)

SetOffset(...)

 

SetOffset( (MolDraw2D)arg1, (int)arg2, (int)arg3) -> None :
    set the offset (in drawing coordinates) for the drawing

    C++ signature :
        void SetOffset(RDKit::MolDraw2D {lvalue},int,int)

SetScale(...)

 

SetScale( (MolDraw2D)arg1, (int)arg2, (int)arg3, (Point2D)arg4, (Point2D)arg5) -> None :
    uses the values provided to set the drawing scaling

    C++ signature :
        void SetScale(RDKit::MolDraw2D {lvalue},int,int,RDGeom::Point2D,RDGeom::Point2D)

Width(...)

 

Width( (MolDraw2D)arg1) -> int :
    get the width of the drawing canvas

    C++ signature :
        int Width(RDKit::MolDraw2D {lvalue})

__init__(...)
(Constructor)

 
Raises an exception
This class cannot be instantiated from Python

Overrides: object.__init__

__reduce__(...)

 
helper for pickle

Overrides: object.__reduce__
(inherited documentation)

drawOptions(...)

 

drawOptions( (MolDraw2D)arg1) -> MolDrawOptions :
    Returns a modifiable version of the current drawing options

    C++ signature :
        RDKit::MolDrawOptions {lvalue} drawOptions(RDKit::MolDraw2D {lvalue})