Chemical Data Processing Library C++ API - Version 1.2.0
Variables
CDPL::Vis::AtomProperty Namespace Reference

Provides keys for built-in Chem::Atom properties. More...

Variables

CDPL_VIS_API const Base::LookupKey COLOR
 Specifies the color of text labels. More...
 
CDPL_VIS_API const Base::LookupKey LABEL_FONT
 Specifies the font for atom element and query match expression labels. More...
 
CDPL_VIS_API const Base::LookupKey LABEL_SIZE
 Specifies the size of atom element and query match expression labels. More...
 
CDPL_VIS_API const Base::LookupKey SECONDARY_LABEL_FONT
 Specifies the font for text labels that show the value of various atomic properties. More...
 
CDPL_VIS_API const Base::LookupKey SECONDARY_LABEL_SIZE
 Specifies the size of text labels that show the value of various atomic properties. More...
 
CDPL_VIS_API const Base::LookupKey LABEL_MARGIN
 Specifies the margin of free space around atom labels. More...
 
CDPL_VIS_API const Base::LookupKey RADICAL_ELECTRON_DOT_SIZE
 Specifies the size of radical electron dots. More...
 
CDPL_VIS_API const Base::LookupKey CONFIGURATION_LABEL_FONT
 Specifies the font used for atom configuration descriptor text labels. More...
 
CDPL_VIS_API const Base::LookupKey CONFIGURATION_LABEL_SIZE
 Specifies the size of atom configuration descriptor text labels. More...
 
CDPL_VIS_API const Base::LookupKey CONFIGURATION_LABEL_COLOR
 Specifies the color used for atom configuration descriptor text labels. More...
 
CDPL_VIS_API const Base::LookupKey CUSTOM_LABEL_FONT
 Specifies the font used for custom text labels. More...
 
CDPL_VIS_API const Base::LookupKey CUSTOM_LABEL_SIZE
 Specifies the size of custom text labels. More...
 
CDPL_VIS_API const Base::LookupKey CUSTOM_LABEL_COLOR
 Specifies the color used for custom text labels. More...
 
CDPL_VIS_API const Base::LookupKey CUSTOM_LABEL
 Specifies the custom label text. Value Type: std::string. More...
 
CDPL_VIS_API const Base::LookupKey HIGHLIGHTED_FLAG
 Specifies whether or not the atom is highlighted. Value Type: bool. More...
 
CDPL_VIS_API const Base::LookupKey HIGHLIGHT_AREA_BRUSH
 Specifies the brush to use for filling atom highlighting areas. Value Type: Vis::Brush. More...
 
CDPL_VIS_API const Base::LookupKey HIGHLIGHT_AREA_OUTLINE_PEN
 Specifies the pen to use for drawing atom highlighting area outlines. Value Type: Vis::Pen. More...
 

Detailed Description

Provides keys for built-in Chem::Atom properties.

Variable Documentation

◆ COLOR

CDPL_VIS_API const Base::LookupKey CDPL::Vis::AtomProperty::COLOR
extern

Specifies the color of text labels.

The color specified by this property takes precedence over the colors specified by Vis::ControlParameter::ATOM_COLOR and Vis::MolecularGraphProperty::ATOM_COLOR. Furthermore, color tables specified by Vis::ControlParameter::ATOM_COLOR_TABLE or Vis::MolecularGraphProperty::ATOM_COLOR_TABLE will not be considered if this property is set.

Value Type: Vis::Color

◆ LABEL_FONT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::AtomProperty::LABEL_FONT
extern

Specifies the font for atom element and query match expression labels.

The font specified by this property takes precedence over the fonts specified by Vis::ControlParameter::ATOM_LABEL_FONT and Vis::MolecularGraphProperty::ATOM_LABEL_FONT.

Value Type: Vis::Font

◆ LABEL_SIZE

CDPL_VIS_API const Base::LookupKey CDPL::Vis::AtomProperty::LABEL_SIZE
extern

Specifies the size of atom element and query match expression labels.

The font size has to be specified as an absolute value. If input-scaling is enabled, the font size will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the font size grows/shrinks with the size of the chemical structure during viewport size adjustment. The label size specified by this property takes precedence over the sizes specified by Vis::ControlParameter::ATOM_LABEL_SIZE and Vis::MolecularGraphProperty::ATOM_LABEL_SIZE.

Value Type: Vis::SizeSpecification

◆ SECONDARY_LABEL_FONT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::AtomProperty::SECONDARY_LABEL_FONT
extern

Specifies the font for text labels that show the value of various atomic properties.

The font specified by this property takes precedence over the fonts specified by Vis::ControlParameter::SECONDARY_ATOM_LABEL_FONT and Vis::MolecularGraphProperty::SECONDARY_ATOM_LABEL_FONT.

Value Type: Vis::Font

◆ SECONDARY_LABEL_SIZE

CDPL_VIS_API const Base::LookupKey CDPL::Vis::AtomProperty::SECONDARY_LABEL_SIZE
extern

Specifies the size of text labels that show the value of various atomic properties.

The size can either be specified as an absolute value or as a scaling factor for the primary label size given by Vis::AtomProperty::LABEL_SIZE, Vis::MolecularGraphProperty::ATOM_LABEL_SIZE or Vis::ControlParameter::ATOM_LABEL_SIZE. If input-scaling is enabled, the size of the font will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the font size will follow the size change of the chemical structure during viewport size adjustment. The label size specified by this property takes precedence over the sizes specified by Vis::ControlParameter::SECONDARY_ATOM_LABEL_SIZE and Vis::MolecularGraphProperty::SECONDARY_ATOM_LABEL_SIZE.

Value Type: Vis::SizeSpecification

◆ LABEL_MARGIN

CDPL_VIS_API const Base::LookupKey CDPL::Vis::AtomProperty::LABEL_MARGIN
extern

Specifies the margin of free space around atom labels.

The margin can either be specified as an absolute value or as a scaling factor for the primary label size given by Vis::AtomProperty::LABEL_SIZE, Vis::MolecularGraphProperty::ATOM_LABEL_SIZE or Vis::ControlParameter::ATOM_LABEL_SIZE. If input-scaling is enabled, the width of the margin will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the label margin will follow the size change of the chemical structure during viewport size adjustment. The margin specified by this property takes precedence over the margins specified by Vis::ControlParameter::ATOM_LABEL_MARGIN and Vis::MolecularGraphProperty::ATOM_LABEL_MARGIN.

Value Type: Vis::SizeSpecification

◆ RADICAL_ELECTRON_DOT_SIZE

CDPL_VIS_API const Base::LookupKey CDPL::Vis::AtomProperty::RADICAL_ELECTRON_DOT_SIZE
extern

Specifies the size of radical electron dots.

The dot size can either be specified as an absolute value or as a scaling factor for the primary label size given by Vis::AtomProperty::LABEL_SIZE, Vis::MolecularGraphProperty::ATOM_LABEL_SIZE or Vis::ControlParameter::ATOM_LABEL_SIZE. If input-scaling is enabled, the dot diameter will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the diameter will follow the size change of the chemical structure during viewport size adjustment. The dot diameter specified by this property takes precedence over the diameters specified by Vis::ControlParameter::ATOM_LABEL_MARGIN and Vis::MolecularGraphProperty::ATOM_LABEL_MARGIN.

Value Type: Vis::SizeSpecification

◆ CONFIGURATION_LABEL_FONT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::AtomProperty::CONFIGURATION_LABEL_FONT
extern

Specifies the font used for atom configuration descriptor text labels.

The font specified by this property takes precedence over the fonts specified by Vis::ControlParameter::ATOM_CONFIGURATION_LABEL_FONT and Vis::MolecularGraphProperty::ATOM_CONFIGURATION_LABEL_FONT.

Value Type: Vis::Font

Since
1.1

◆ CONFIGURATION_LABEL_SIZE

CDPL_VIS_API const Base::LookupKey CDPL::Vis::AtomProperty::CONFIGURATION_LABEL_SIZE
extern

Specifies the size of atom configuration descriptor text labels.

The size can either be specified as an absolute value or as a scaling factor for the primary label size given by Vis::ControlParameter::ATOM_LABEL_SIZE, Vis::MolecularGraphProperty::ATOM_LABEL_SIZE or Vis::AtomProperty::LABEL_SIZE. If input-scaling is enabled, the size of the font will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the font size will follow the size change of the chemical structure during viewport size adjustment. The specified size takes precedence over the size specified by the parameter Vis::ControlParameter::ATOM_CONFIGURATION_LABEL_SIZE and Vis::MolecularGraphProperty::ATOM_CONFIGURATION_LABEL_SIZE.

Value Type: Vis::SizeSpecification

Since
1.1

◆ CONFIGURATION_LABEL_COLOR

CDPL_VIS_API const Base::LookupKey CDPL::Vis::AtomProperty::CONFIGURATION_LABEL_COLOR
extern

Specifies the color used for atom configuration descriptor text labels.

The color specified by this property takes precedence over the colors specified by Vis::ControlParameter::ATOM_CONFIGURATION_LABEL_COLOR and Vis::MolecularGraphProperty::ATOM_CONFIGURATION_LABEL_COLOR.

Value Type: Vis::Color

Since
1.2

◆ CUSTOM_LABEL_FONT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::AtomProperty::CUSTOM_LABEL_FONT
extern

Specifies the font used for custom text labels.

The font specified by this property takes precedence over the fonts specified by Vis::ControlParameter::ATOM_CUSTOM_LABEL_FONT and Vis::MolecularGraphProperty::ATOM_CUSTOM_LABEL_FONT.

Value Type: Vis::Font

Since
1.2

◆ CUSTOM_LABEL_SIZE

CDPL_VIS_API const Base::LookupKey CDPL::Vis::AtomProperty::CUSTOM_LABEL_SIZE
extern

Specifies the size of custom text labels.

The size can either be specified as an absolute value or as a scaling factor for the primary label size given by Vis::ControlParameter::ATOM_LABEL_SIZE, Vis::MolecularGraphProperty::ATOM_LABEL_SIZE or Vis::AtomProperty::LABEL_SIZE. If input-scaling is enabled, the size of the font will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the font size will follow the size change of the chemical structure during viewport size adjustment. The specified size takes precedence over the size specified by the parameter Vis::ControlParameter::ATOM_CUSTOM_LABEL_SIZE and Vis::MolecularGraphProperty::ATOM_CUSTOM_LABEL_SIZE.

Value Type: Vis::SizeSpecification

Since
1.2

◆ CUSTOM_LABEL_COLOR

CDPL_VIS_API const Base::LookupKey CDPL::Vis::AtomProperty::CUSTOM_LABEL_COLOR
extern

Specifies the color used for custom text labels.

The color specified by this property takes precedence over the colors specified by Vis::ControlParameter::ATOM_CUSTOM_LABEL_COLOR and Vis::MolecularGraphProperty::ATOM_CUSTOM_LABEL_COLOR.

Value Type: Vis::Color

Since
1.2

◆ CUSTOM_LABEL

CDPL_VIS_API const Base::LookupKey CDPL::Vis::AtomProperty::CUSTOM_LABEL
extern

Specifies the custom label text. Value Type: std::string.

Since
1.2

◆ HIGHLIGHTED_FLAG

CDPL_VIS_API const Base::LookupKey CDPL::Vis::AtomProperty::HIGHLIGHTED_FLAG
extern

Specifies whether or not the atom is highlighted. Value Type: bool.

Since
1.2

◆ HIGHLIGHT_AREA_BRUSH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::AtomProperty::HIGHLIGHT_AREA_BRUSH
extern

Specifies the brush to use for filling atom highlighting areas. Value Type: Vis::Brush.

Since
1.2

◆ HIGHLIGHT_AREA_OUTLINE_PEN

CDPL_VIS_API const Base::LookupKey CDPL::Vis::AtomProperty::HIGHLIGHT_AREA_OUTLINE_PEN
extern

Specifies the pen to use for drawing atom highlighting area outlines. Value Type: Vis::Pen.

Since
1.2