Chemical Data Processing Library C++ API - Version 1.1.1
Variables
CDPL::Vis::ControlParameter Namespace Reference

Provides keys for built-in control-parameters. More...

Variables

CDPL_VIS_API const Base::LookupKey VIEWPORT
 Specifies a rectangular viewport area which constrains the location and size of 2D depictions. More...
 
CDPL_VIS_API const Base::LookupKey SIZE_ADJUSTMENT
 Specifies how to adjust the size of a 2D depiction relative to the available viewport area. More...
 
CDPL_VIS_API const Base::LookupKey ALIGNMENT
 Specifies the alignment of a 2D depiction within the viewport area. More...
 
CDPL_VIS_API const Base::LookupKey BACKGROUND_COLOR
 Specifies the color with which the drawing area is erased before rendering any graphical primitives. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_ARROW_STYLE
 Specifies the style of reaction arrows. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_ARROW_COLOR
 Specifies the color of reaction arrows. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_ARROW_LENGTH
 Specifies the length of reaction arrows. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_ARROW_HEAD_LENGTH
 Specifies the head length of reaction arrows. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_ARROW_HEAD_WIDTH
 Specifies the head width of reaction arrows. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_ARROW_SHAFT_WIDTH
 Specifies the shaft width of reaction arrows. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_ARROW_LINE_WIDTH
 Specifies the width of reaction arrow outlines. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_COMPONENT_LAYOUT
 Specifies the layout style of reaction products and reactants. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_COMPONENT_LAYOUT_DIRECTION
 Specifies the layout direction of reaction products and reactants. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_COMPONENT_MARGIN
 Specifies the amount of free space that is added horizontally and vertically to the bounds of a reaction component. More...
 
CDPL_VIS_API const Base::LookupKey SHOW_REACTION_REACTANTS
 Specifies whether or not to show the reactants of a reaction. More...
 
CDPL_VIS_API const Base::LookupKey SHOW_REACTION_AGENTS
 Specifies whether or not to show the agents of a reaction. More...
 
CDPL_VIS_API const Base::LookupKey SHOW_REACTION_PRODUCTS
 Specifies whether or not to show the products of a reaction. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_AGENT_ALIGNMENT
 Specifies the vertical alignment of reaction agents relative to the reaction arrow. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_AGENT_LAYOUT
 Specifies the reaction agent layout style. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_AGENT_LAYOUT_DIRECTION
 Specifies the reaction agent layout direction. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_PLUS_SIGN_COLOR
 Specifies the color of reaction component '+' signs. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_PLUS_SIGN_SIZE
 Specifies the size of reaction component '+' signs. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_PLUS_SIGN_LINE_WIDTH
 Specifies the line width of reaction component '+' signs. More...
 
CDPL_VIS_API const Base::LookupKey SHOW_REACTION_PLUS_SIGNS
 Specifies whether or not to draw '+' signs between the components of a reaction. More...
 
CDPL_VIS_API const Base::LookupKey ATOM_COLOR
 Specifies the color of atom labels. More...
 
CDPL_VIS_API const Base::LookupKey ATOM_COLOR_TABLE
 Specifies a lookup table for the atom type dependent coloring of atom labels. More...
 
CDPL_VIS_API const Base::LookupKey USE_CALCULATED_ATOM_COORDINATES
 Specifies whether or not to use calculated atom coordinates for the visualization of chemical structures. More...
 
CDPL_VIS_API const Base::LookupKey ATOM_LABEL_FONT
 Specifies the font for atom element and query match expression labels. More...
 
CDPL_VIS_API const Base::LookupKey ATOM_LABEL_SIZE
 Specifies the size of atom element and query match expression labels. More...
 
CDPL_VIS_API const Base::LookupKey SECONDARY_ATOM_LABEL_FONT
 Specifies the font for text labels that show the value of various atomic properties. More...
 
CDPL_VIS_API const Base::LookupKey SECONDARY_ATOM_LABEL_SIZE
 Specifies the size of text labels that show the value of various atomic properties. More...
 
CDPL_VIS_API const Base::LookupKey ATOM_CONFIGURATION_LABEL_FONT
 Specifies the font used for atom configuration descriptor text labels. More...
 
CDPL_VIS_API const Base::LookupKey ATOM_CONFIGURATION_LABEL_SIZE
 Specifies the size of atom configuration descriptor text labels. More...
 
CDPL_VIS_API const Base::LookupKey ATOM_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 SHOW_EXPLICIT_HYDROGENS
 Specifies whether or not to show explicit hydrogen atoms. More...
 
CDPL_VIS_API const Base::LookupKey SHOW_CARBONS
 Specifies whether or not to show the element label of carbon atoms. More...
 
CDPL_VIS_API const Base::LookupKey SHOW_CHARGES
 Specifies whether or not to show the formal charge of atoms. More...
 
CDPL_VIS_API const Base::LookupKey SHOW_ISOTOPES
 Specifies whether or not to show the isotopic mass of atoms. More...
 
CDPL_VIS_API const Base::LookupKey SHOW_HYDROGEN_COUNTS
 Specifies whether or not to show the implicit hydrogen count of connected atoms. More...
 
CDPL_VIS_API const Base::LookupKey SHOW_NON_CARBON_HYDROGEN_COUNTS
 Specifies whether or not to show the implicit hydrogen count of connected non-carbon atoms. More...
 
CDPL_VIS_API const Base::LookupKey SHOW_ATOM_QUERY_INFOS
 Specifies whether or not to show query atom match expressions. More...
 
CDPL_VIS_API const Base::LookupKey SHOW_ATOM_REACTION_INFOS
 Specifies whether or not to show reaction atom-atom mapping numbers. More...
 
CDPL_VIS_API const Base::LookupKey SHOW_RADICAL_ELECTRONS
 Specifies whether or not to draw radical electron dots. More...
 
CDPL_VIS_API const Base::LookupKey SHOW_ATOM_CONFIGURATION_LABELS
 Specifies whether or not to show atom configuration descriptor labels. More...
 
CDPL_VIS_API const Base::LookupKey BOND_LENGTH
 Specifies the desired average bond length for the visualization of chemical structures. More...
 
CDPL_VIS_API const Base::LookupKey BOND_COLOR
 Specifies the color of bonds. More...
 
CDPL_VIS_API const Base::LookupKey BOND_LINE_WIDTH
 Specifies the width of bond lines. More...
 
CDPL_VIS_API const Base::LookupKey BOND_LINE_SPACING
 Specifies the distance between the lines of double and triple bonds. More...
 
CDPL_VIS_API const Base::LookupKey STEREO_BOND_WEDGE_WIDTH
 Specifies the width of wedge-shaped stereo bonds. More...
 
CDPL_VIS_API const Base::LookupKey STEREO_BOND_HASH_SPACING
 Specifies the distance between the hashes of down stereo bonds. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_CENTER_LINE_LENGTH
 Specifies the length of the lines in reaction center marks. More...
 
CDPL_VIS_API const Base::LookupKey REACTION_CENTER_LINE_SPACING
 Specifies the distance between the lines in reaction center marks. More...
 
CDPL_VIS_API const Base::LookupKey DOUBLE_BOND_TRIM_LENGTH
 Specifies the amount by which the non-central lines of asymmetric double bonds have to be trimmed at each line end. More...
 
CDPL_VIS_API const Base::LookupKey TRIPLE_BOND_TRIM_LENGTH
 Specifies the amount by which the non-central lines of triple bonds have to be trimmed at each line end. More...
 
CDPL_VIS_API const Base::LookupKey BOND_LABEL_FONT
 Specifies the font for bond labels. More...
 
CDPL_VIS_API const Base::LookupKey BOND_LABEL_SIZE
 Specifies the size of bond labels. More...
 
CDPL_VIS_API const Base::LookupKey BOND_CONFIGURATION_LABEL_FONT
 Specifies the font used for bond configuration descriptor text labels. More...
 
CDPL_VIS_API const Base::LookupKey BOND_CONFIGURATION_LABEL_SIZE
 Specifies the size of bond configuration descriptor text labels. More...
 
CDPL_VIS_API const Base::LookupKey BOND_LABEL_MARGIN
 Specifies the margin of free space around bond labels. More...
 
CDPL_VIS_API const Base::LookupKey SHOW_BOND_REACTION_INFOS
 Specifies whether or not to draw reaction center marks. More...
 
CDPL_VIS_API const Base::LookupKey SHOW_BOND_QUERY_INFOS
 Specifies whether or not to show query bond match expressions. More...
 
CDPL_VIS_API const Base::LookupKey SHOW_STEREO_BONDS
 Specifies whether or not to draw stereo bonds. More...
 
CDPL_VIS_API const Base::LookupKey SHOW_BOND_CONFIGURATION_LABELS
 Specifies whether or not to show bond configuration descriptor labels. More...
 

Detailed Description

Provides keys for built-in control-parameters.

Variable Documentation

◆ VIEWPORT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::VIEWPORT
extern

Specifies a rectangular viewport area which constrains the location and size of 2D depictions.

The way the size and location of a graphical object is adjusted has to be specified separately by the control-parameters Vis::ControlParameter::SIZE_ADJUSTMENT and Vis::ControlParameter::ALIGNMENT. If VIEWPORT is left unspecified, the default setting Vis::ControlParameterDefault::VIEWPORT will be used.

Value Type: Vis::Rectangle2D

◆ SIZE_ADJUSTMENT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SIZE_ADJUSTMENT
extern

Specifies how to adjust the size of a 2D depiction relative to the available viewport area.

Supported adjustment policies are defined in namespace Vis::SizeAdjustment. If SIZE_ADJUSTMENT is left unspecified, the default size adjustment setting Vis::ControlParameterDefault::SIZE_ADJUSTMENT will be used.

Value Type: unsigned int

Note
The control-parameter setting only takes effect if a valid viewport area has been specified by the parameter Vis::ControlParameter::VIEWPORT.

◆ ALIGNMENT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::ALIGNMENT
extern

Specifies the alignment of a 2D depiction within the viewport area.

The alignment is specified by a combination of the flags defined in namespace Vis::Alignment. If ALIGNMENT is left unspecified, the default alignment setting Vis::ControlParameterDefault::ALIGNMENT will be used.

Value Type: unsigned int

Note
The control-parameter setting only takes effect if a valid viewport area has been specified by the parameter Vis::ControlParameter::VIEWPORT.

◆ BACKGROUND_COLOR

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::BACKGROUND_COLOR
extern

Specifies the color with which the drawing area is erased before rendering any graphical primitives.

The area which gets ereased is either the viewport area specified by Vis::ControlParameter::VIEWPORT, or if Vis::ControlParameter::VIEWPORT is not defined, the total bounds of the graphical objects to render. If the control-parameter is left unspecified or Vis::Color::TRANSPARENT, the drawing area won't be erased.

Value Type: Vis::Color

◆ REACTION_ARROW_STYLE

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_ARROW_STYLE
extern

Specifies the style of reaction arrows.

Supported styles are defined as constants in namespace Vis::ArrowStyle. If REACTION_ARROW_STYLE is left unspecified and the property Vis::ReactionProperty::ARROW_STYLE is not set, the default arrow style Vis::ControlParameterDefault::REACTION_ARROW_STYLE will be used.

Value Type: unsigned int

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::ARROW_STYLE.

◆ REACTION_ARROW_COLOR

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_ARROW_COLOR
extern

Specifies the color of reaction arrows.

If the control-parameter is left unspecified and the property Vis::ReactionProperty::ARROW_COLOR is not set, the default setting Vis::ControlParameterDefault::REACTION_ARROW_COLOR will be used.

Value Type: Vis::Color

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::ARROW_COLOR.

◆ REACTION_ARROW_LENGTH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_ARROW_LENGTH
extern

Specifies the length of reaction arrows.

Specifying the length as beeing relative has the effect, that the given length is interpreted as a minimum length for an arrow which is as long as the width of the overall area covered by the drawn reaction agents (if any). The output- and input-scaling settings are ignored and have no effect. If the control-parameter is left unspecified and the property Vis::ReactionProperty::ARROW_LENGTH is not set, the default setting Vis::ControlParameterDefault::REACTION_ARROW_LENGTH will be used.

Value Type: Vis::SizeSpecification

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::ARROW_LENGTH.

◆ REACTION_ARROW_HEAD_LENGTH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_ARROW_HEAD_LENGTH
extern

Specifies the head length of reaction arrows.

The specified head length can be absolute or relative to the overall arrow length defined by Vis::ControlParameter::REACTION_ARROW_LENGTH or Vis::ReactionProperty::ARROW_LENGTH. The output- and input-scaling settings are ignored and have no effect. If the control-parameter is left unspecified and the property Vis::ReactionProperty::ARROW_HEAD_LENGTH is not set, the default setting Vis::ControlParameterDefault::REACTION_ARROW_HEAD_LENGTH will be used.

Value Type: Vis::SizeSpecification

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::ARROW_HEAD_LENGTH.

◆ REACTION_ARROW_HEAD_WIDTH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_ARROW_HEAD_WIDTH
extern

Specifies the head width of reaction arrows.

The specified width can be absolute or relative to the overall arrow length defined by Vis::ControlParameter::REACTION_ARROW_LENGTH or Vis::ReactionProperty::ARROW_LENGTH. The output- and input-scaling settings are ignored and have no effect. If the control-parameter is left unspecified and the property Vis::ReactionProperty::ARROW_HEAD_WIDTH is not set, the default setting Vis::ControlParameterDefault::REACTION_ARROW_HEAD_WIDTH will be used.

Value Type: Vis::SizeSpecification

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::ARROW_HEAD_WIDTH.

◆ REACTION_ARROW_SHAFT_WIDTH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_ARROW_SHAFT_WIDTH
extern

Specifies the shaft width of reaction arrows.

The specified width can be absolute or relative to the overall arrow length defined by Vis::ControlParameter::REACTION_ARROW_LENGTH or Vis::ReactionProperty::ARROW_LENGTH. The output- and input-scaling settings are ignored and have no effect. If the control-parameter is left unspecified and the property Vis::ReactionProperty::ARROW_SHAFT_WIDTH is not set, the default setting Vis::ControlParameterDefault::REACTION_ARROW_SHAFT_WIDTH will be used.

Value Type: Vis::SizeSpecification

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::ARROW_SHAFT_WIDTH.

◆ REACTION_ARROW_LINE_WIDTH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_ARROW_LINE_WIDTH
extern

Specifies the width of reaction arrow outlines.

The specified width can be absolute or relative to the overall arrow length defined by Vis::ControlParameter::REACTION_ARROW_LENGTH or Vis::ReactionProperty::ARROW_LENGTH. The output- and input-scaling settings are ignored and have no effect. If the control-parameter is left unspecified and the property Vis::ReactionProperty::ARROW_LINE_WIDTH is not set, the default setting Vis::ControlParameterDefault::REACTION_ARROW_HEAD_LENGTH will be used.

Value Type: Vis::SizeSpecification

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::ARROW_LINE_WIDTH.

◆ REACTION_COMPONENT_LAYOUT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_COMPONENT_LAYOUT
extern

Specifies the layout style of reaction products and reactants.

Supported layout styles are defined in namespace Vis::LayoutStyle. If REACTION_COMPONENT_LAYOUT is left unspecified and the property Vis::ReactionProperty::COMPONENT_LAYOUT is not set, the default layout setting Vis::ControlParameterDefault::REACTION_COMPONENT_LAYOUT will be used.

Value Type: unsigned int

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::COMPONENT_LAYOUT.

◆ REACTION_COMPONENT_LAYOUT_DIRECTION

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_COMPONENT_LAYOUT_DIRECTION
extern

Specifies the layout direction of reaction products and reactants.

Supported layout directions are defined in namespace Vis::LayoutDirection. If REACTION_COMPONENT_LAYOUT_DIRECTION is left unspecified and the property Vis::ReactionProperty::COMPONENT_LAYOUT_DIRECTION is not set, the default layout direction Vis::ControlParameterDefault::REACTION_COMPONENT_LAYOUT_DIRECTION will be used.

Value Type: unsigned int

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::COMPONENT_LAYOUT_DIRECTION.

◆ REACTION_COMPONENT_MARGIN

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_COMPONENT_MARGIN
extern

Specifies the amount of free space that is added horizontally and vertically to the bounds of a reaction component.

The margin width has to be specified as an absolute value. The output- and input-scaling settings are ignored and have no effect. If the control-parameter is left unspecified and the property Vis::ReactionProperty::COMPONENT_MARGIN is not set, the default setting Vis::ControlParameterDefault::REACTION_COMPONENT_MARGIN will be used.

Value Type: Vis::SizeSpecification

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::COMPONENT_MARGIN.

◆ SHOW_REACTION_REACTANTS

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_REACTION_REACTANTS
extern

Specifies whether or not to show the reactants of a reaction.

If the control-parameter is left unspecified and the property Vis::ReactionProperty::SHOW_REACTANTS is not set, the default setting Vis::ControlParameterDefault::SHOW_REACTION_REACTANTS will be used.

Value Type: bool

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::SHOW_REACTANTS.

◆ SHOW_REACTION_AGENTS

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_REACTION_AGENTS
extern

Specifies whether or not to show the agents of a reaction.

If the control-parameter is left unspecified and the property Vis::ReactionProperty::SHOW_AGENTS is not set, the default setting Vis::ControlParameterDefault::SHOW_REACTION_AGENTS will be used.

Value Type: bool

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::SHOW_AGENTS.

◆ SHOW_REACTION_PRODUCTS

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_REACTION_PRODUCTS
extern

Specifies whether or not to show the products of a reaction.

If the control-parameter is left unspecified and the property Vis::ReactionProperty::SHOW_PRODUCTS is not set, the default setting Vis::ControlParameterDefault::SHOW_REACTION_PRODUCTS will be used.

Value Type: bool

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::SHOW_PRODUCTS.

◆ REACTION_AGENT_ALIGNMENT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_AGENT_ALIGNMENT
extern

Specifies the vertical alignment of reaction agents relative to the reaction arrow.

Supported vertical alignment styles are defined in namespace Vis::Alignment. If REACTION_AGENT_ALIGNMENT is left unspecified and the property Vis::ReactionProperty::AGENT_ALIGNMENT is not set, the default alignment setting Vis::ControlParameterDefault::REACTION_AGENT_ALIGNMENT will be used.

Value Type: unsigned int

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::AGENT_ALIGNMENT.

◆ REACTION_AGENT_LAYOUT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_AGENT_LAYOUT
extern

Specifies the reaction agent layout style.

Supported layout styles are defined in namespace Vis::LayoutStyle. If REACTION_AGENT_LAYOUT is left unspecified and the property Vis::ReactionProperty::AGENT_LAYOUT is not set, the default layout Vis::ControlParameterDefault::REACTION_AGENT_LAYOUT will be used.

Value Type: unsigned int

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::AGENT_LAYOUT.

◆ REACTION_AGENT_LAYOUT_DIRECTION

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_AGENT_LAYOUT_DIRECTION
extern

Specifies the reaction agent layout direction.

Supported layout directions are defined in namespace Vis::LayoutDirection. If REACTION_AGENT_LAYOUT_DIRECTION is left unspecified and the property Vis::ReactionProperty::AGENT_LAYOUT_DIRECTION is not set, the default layout direction Vis::ControlParameterDefault::REACTION_AGENT_LAYOUT_DIRECTION will be used.

Value Type: unsigned int

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::AGENT_LAYOUT_DIRECTION.

◆ REACTION_PLUS_SIGN_COLOR

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_PLUS_SIGN_COLOR
extern

Specifies the color of reaction component '+' signs.

If the control-parameter is left unspecified and the property Vis::ReactionProperty::PLUS_SIGN_COLOR is not set, the default setting Vis::ControlParameterDefault::REACTION_PLUS_SIGN_COLOR will be used.

Value Type: Vis::Color

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::PLUS_SIGN_COLOR.

◆ REACTION_PLUS_SIGN_SIZE

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_PLUS_SIGN_SIZE
extern

Specifies the size of reaction component '+' signs.

The size has to be specified as an absolute value. The output- and input-scaling settings are ignored and have no effect. If the control-parameter is left unspecified and the property Vis::ReactionProperty::PLUS_SIGN_SIZE is not set, the default setting Vis::ControlParameterDefault::REACTION_PLUS_SIGN_SIZE will be used.

Value Type: Vis::SizeSpecification

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::PLUS_SIGN_SIZE.

◆ REACTION_PLUS_SIGN_LINE_WIDTH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_PLUS_SIGN_LINE_WIDTH
extern

Specifies the line width of reaction component '+' signs.

The size has to be specified as an absolute value. The output- and input-scaling settings are ignored and have no effect. If the control-parameter is left unspecified and the property Vis::ReactionProperty::PLUS_SIGN_LINE_WIDTH is not set, the default setting Vis::ControlParameterDefault::REACTION_PLUS_SIGN_LINE_WIDTH will be used.

Value Type: Vis::SizeSpecification

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::PLUS_SIGN_LINE_WIDTH.

◆ SHOW_REACTION_PLUS_SIGNS

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_REACTION_PLUS_SIGNS
extern

Specifies whether or not to draw '+' signs between the components of a reaction.

If the control-parameter is left unspecified and the property Vis::ReactionProperty::SHOW_PLUS_SIGNS is not set, the default setting Vis::ControlParameterDefault::SHOW_REACTION_PLUS_SIGNS will be used.

Value Type: bool

Note
The setting is overridden by the Chem::Reaction property Vis::ReactionProperty::SHOW_PLUS_SIGNS.

◆ ATOM_COLOR

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::ATOM_COLOR
extern

Specifies the color of atom labels.

If ATOM_COLOR is left unspecified and the properties Vis::MolecularGraphProperty::ATOM_COLOR and Vis::AtomProperty::COLOR are not set, the default color setting Vis::ControlParameterDefault::ATOM_COLOR will be used. If an atom color table has been specified by Vis::ControlParameter::ATOM_COLOR_TABLE or Vis::MolecularGraphProperty::ATOM_COLOR_TABLE and the property Vis::AtomProperty::COLOR is not set, the color provided by ATOM_COLOR or Vis::MolecularGraphProperty::ATOM_COLOR will be used as a fallback for missing color table entries.

Value Type: Vis::Color

Note
The control-parameter setting is ignored if a color has been specified by Vis::MolecularGraphProperty::ATOM_COLOR or Vis::AtomProperty::COLOR.

◆ ATOM_COLOR_TABLE

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::ATOM_COLOR_TABLE
extern

Specifies a lookup table for the atom type dependent coloring of atom labels.

If the color for a particular atom type is missing, the color specified by Vis::ControlParameter::ATOM_COLOR or Vis::MolecularGraphProperty::ATOM_COLOR will be used.

Value Type: Vis::ColorTable::SharedPointer

Note
The color table will only be considered if the property Vis::AtomProperty::COLOR has not been set for the atom to visualize. A color table specified by Vis::MolecularGraphProperty::ATOM_COLOR_TABLE takes precedence over the table specified by ATOM_COLOR_TABLE.

◆ USE_CALCULATED_ATOM_COORDINATES

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::USE_CALCULATED_ATOM_COORDINATES
extern

Specifies whether or not to use calculated atom coordinates for the visualization of chemical structures.

If the control-parameter is set to false and assigned 2D atom coordinates are available, then the assigned coordinates will be used. If the parameter is true or no assigned 2D-coordinates are available, the atom coordinates will be calculated. If the control-parameter is left unspecified, the default setting Vis::ControlParameterDefault::USE_CALCULATED_ATOM_COORDINATES will be used.

Value Type: bool

◆ ATOM_LABEL_FONT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::ATOM_LABEL_FONT
extern

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

If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::ATOM_LABEL_FONT and Vis::AtomProperty::LABEL_FONT are not set, the default font Vis::ControlParameterDefault::ATOM_LABEL_FONT will be used.

Value Type: Vis::Font

Note
The control-parameter setting is ignored if a font has been specified by Vis::MolecularGraphProperty::ATOM_LABEL_FONT or Vis::AtomProperty::LABEL_FONT.

◆ ATOM_LABEL_SIZE

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::ATOM_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 will grow/shrink with the size of the chemical structure during viewport size adjustment. If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::ATOM_LABEL_SIZE and Vis::AtomProperty::LABEL_SIZE are not set, the default setting Vis::ControlParameterDefault::ATOM_LABEL_SIZE will be used.

Value Type: Vis::SizeSpecification

Note
The control-parameter setting is ignored if a size has been specified by Vis::MolecularGraphProperty::ATOM_LABEL_SIZE or Vis::AtomProperty::LABEL_SIZE.

◆ SECONDARY_ATOM_LABEL_FONT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SECONDARY_ATOM_LABEL_FONT
extern

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

If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::SECONDARY_ATOM_LABEL_FONT and Vis::AtomProperty::SECONDARY_LABEL_FONT are not set, the default setting Vis::ControlParameterDefault::SECONDARY_ATOM_LABEL_FONT will be used.

Value Type: Vis::Font

Note
The control-parameter setting is ignored if a font has been specified by Vis::MolecularGraphProperty::SECONDARY_ATOM_LABEL_FONT or Vis::AtomProperty::SECONDARY_LABEL_FONT.

◆ SECONDARY_ATOM_LABEL_SIZE

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SECONDARY_ATOM_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::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. If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::SECONDARY_ATOM_LABEL_SIZE and Vis::AtomProperty::SECONDARY_LABEL_SIZE are not set, the default setting Vis::ControlParameterDefault::SECONDARY_ATOM_LABEL_SIZE will be used.

Value Type: Vis::SizeSpecification

Note
The control-parameter setting is ignored if a size has been specified by Vis::MolecularGraphProperty::SECONDARY_ATOM_LABEL_SIZE or Vis::AtomProperty::SECONDARY_LABEL_SIZE.

◆ ATOM_CONFIGURATION_LABEL_FONT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::ATOM_CONFIGURATION_LABEL_FONT
extern

Specifies the font used for atom configuration descriptor text labels.

If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::ATOM_CONFIGURATION_LABEL_FONT and Vis::AtomProperty::CONFIGURATION_LABEL_FONT are not set, the default setting Vis::ControlParameterDefault::ATOM_CONFIGURATION_LABEL_FONT will be used.

Value Type: Vis::Font

Note
The control-parameter setting is ignored if a font has been specified by Vis::MolecularGraphProperty::ATOM_CONFIGURATION_LABEL_FONT or Vis::AtomProperty::CONFIGURATION_LABEL_FONT.
Since
1.1

◆ ATOM_CONFIGURATION_LABEL_SIZE

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::ATOM_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. If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::ATOM_CONFIGURATION_LABEL_SIZE and Vis::AtomProperty::CONFIGURATION_LABEL_SIZE are not set, the default setting Vis::ControlParameterDefault::ATOM_CONFIGURATION_LABEL_SIZE will be used.

Value Type: Vis::SizeSpecification

Note
The control-parameter setting is ignored if a size has been specified by Vis::MolecularGraphProperty::ATOM_CONFIGURATION_LABEL_SIZE or Vis::AtomProperty::ATOM_CONFIGURATION_LABEL_SIZE.
Since
1.1

◆ ATOM_LABEL_MARGIN

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::ATOM_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::ControlParameter::ATOM_LABEL_SIZE, Vis::MolecularGraphProperty::ATOM_LABEL_SIZE or Vis::AtomProperty::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. If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::ATOM_LABEL_MARGIN and Vis::AtomProperty::LABEL_MARGIN are not set, the default setting Vis::ControlParameterDefault::ATOM_LABEL_MARGIN will be used.

Value Type: Vis::SizeSpecification

Note
The control-parameter setting is ignored if a margin has been specified by Vis::MolecularGraphProperty::ATOM_LABEL_MARGIN or Vis::AtomProperty::LABEL_MARGIN.

◆ RADICAL_ELECTRON_DOT_SIZE

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::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::ControlParameter::ATOM_LABEL_SIZE, Vis::MolecularGraphProperty::ATOM_LABEL_SIZE or Vis::AtomProperty::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. If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::RADICAL_ELECTRON_DOT_SIZE and Vis::AtomProperty::RADICAL_ELECTRON_DOT_SIZE are not set, the default setting Vis::ControlParameterDefault::RADICAL_ELECTRON_DOT_SIZE will be used.

Value Type: Vis::SizeSpecification

Note
The control-parameter setting is ignored if a dot size has been specified by Vis::MolecularGraphProperty::RADICAL_ELECTRON_DOT_SIZE or Vis::AtomProperty::RADICAL_ELECTRON_DOT_SIZE.

◆ SHOW_EXPLICIT_HYDROGENS

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_EXPLICIT_HYDROGENS
extern

Specifies whether or not to show explicit hydrogen atoms.

If the control-parameter is left unspecified, the default setting Vis::ControlParameterDefault::SHOW_EXPLICIT_HYDROGENS will be used.

Value Type: bool

Note
This setting has only an effect for standard explicit hydrogen atoms which are bound to at least one heavy atom. Explicit hydrogens whose formal charge (Vis::ControlParameter::SHOW_CHARGES), isotopic mass (see Vis::ControlParameter::SHOW_ISOTOPES), query expression label (see Vis::ControlParameter::SHOW_ATOM_QUERY_INFOS), atom-atom mapping number (see Vis::ControlParameter::SHOW_ATOM_REACTION_INFOS) or radical electron cloud (see Vis::ControlParameter::SHOW_RADICAL_ELECTRONS) is visible, are always drawn.

◆ SHOW_CARBONS

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_CARBONS
extern

Specifies whether or not to show the element label of carbon atoms.

If the control-parameter is left unspecified, the default setting Vis::ControlParameterDefault::SHOW_CARBONS will be used.

Value Type: bool

Note
The control-parameter setting has only an effect for normal carbon atoms with bonds to other visible atoms. Element labels of isolated carbons and carbons with a visible formal charge (Vis::ControlParameter::SHOW_CHARGES), isotopic mass (see Vis::ControlParameter::SHOW_ISOTOPES), query expression label (see Vis::ControlParameter::SHOW_ATOM_QUERY_INFOS), atom-atom mapping number (see Vis::ControlParameter::SHOW_ATOM_REACTION_INFOS) or with visible radical electron dots (see Vis::ControlParameter::SHOW_RADICAL_ELECTRONS) are always shown.

◆ SHOW_CHARGES

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_CHARGES
extern

Specifies whether or not to show the formal charge of atoms.

If the control-parameter is left unspecified, the default setting Vis::ControlParameterDefault::SHOW_CHARGES will be used.

Value Type: bool

Note
The control-parameter setting has only an effect for atoms with a non-zero formal charge. A formal charge of zero is never shown.

◆ SHOW_ISOTOPES

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_ISOTOPES
extern

Specifies whether or not to show the isotopic mass of atoms.

If the control-parameter is left unspecified, the default setting Vis::ControlParameterDefault::SHOW_ISOTOPES will be used.

Value Type: bool

Note
The control-parameter setting has only an effect for atoms with a non-zero isotopic mass. An istopic mass of zero is never shown.

◆ SHOW_HYDROGEN_COUNTS

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_HYDROGEN_COUNTS
extern

Specifies whether or not to show the implicit hydrogen count of connected atoms.

If the control-parameter is left unspecified, the default setting Vis::ControlParameterDefault::SHOW_HYDROGEN_COUNTS will be used.

Value Type: bool

Note
The control-parameter setting has no effect for isolated atoms (i.e. that have no bonds to other visible atoms). The hydrogen count of unbound atoms is always shown.

◆ SHOW_NON_CARBON_HYDROGEN_COUNTS

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_NON_CARBON_HYDROGEN_COUNTS
extern

Specifies whether or not to show the implicit hydrogen count of connected non-carbon atoms.

If the control-parameter is left unspecified, the default setting Vis::ControlParameterDefault::SHOW_NON_CARBON_HYDROGEN_COUNTS will be used.

Value Type: bool

Note
The control-parameter setting has no effect if Vis::ControlParameter::SHOW_HYDROGEN_COUNTS is set to true or if an atom has no bonds to other visible atoms.

◆ SHOW_ATOM_QUERY_INFOS

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_ATOM_QUERY_INFOS
extern

Specifies whether or not to show query atom match expressions.

If the control-parameter is left unspecified, the default setting Vis::ControlParameterDefault::SHOW_ATOM_QUERY_INFOS will be used.

Value Type: bool

◆ SHOW_ATOM_REACTION_INFOS

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_ATOM_REACTION_INFOS
extern

Specifies whether or not to show reaction atom-atom mapping numbers.

If the control-parameter is left unspecified, the default setting Vis::ControlParameterDefault::SHOW_ATOM_REACTION_INFOS will be used.

Value Type: bool

◆ SHOW_RADICAL_ELECTRONS

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_RADICAL_ELECTRONS
extern

Specifies whether or not to draw radical electron dots.

If the control-parameter is left unspecified, the default setting Vis::ControlParameterDefault::SHOW_RADICAL_ELECTRONS will be used.

Value Type: bool

◆ SHOW_ATOM_CONFIGURATION_LABELS

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_ATOM_CONFIGURATION_LABELS
extern

Specifies whether or not to show atom configuration descriptor labels.

If the control-parameter is left unspecified, the default setting Vis::ControlParameterDefault::SHOW_ATOM_CONFIGURATION_LABELS will be used.

Value Type: bool

Since
1.1

◆ BOND_LENGTH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::BOND_LENGTH
extern

Specifies the desired average bond length for the visualization of chemical structures.

The bond length has to be specified as an absolute value. The input- and output-scaling settings are ignored and have no effect. If the specified bond length is smaller or equal zero, then the structure is not resized and the original 2D atom coordinates are used. Otherwise the atom coordinates are scaled to obtain the specified average bond length. If the control-parameter is left unspecified, the default setting Vis::ControlParameterDefault::BOND_LENGTH will be used.

Value Type: Vis::SizeSpecification

◆ BOND_COLOR

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::BOND_COLOR
extern

Specifies the color of bonds.

If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::BOND_COLOR and Vis::BondProperty::COLOR are not set, the default setting Vis::ControlParameterDefault::BOND_COLOR will be used.

Value Type: Vis::Color

Note
The control-parameter setting is ignored if a font has been specified by Vis::MolecularGraphProperty::BOND_COLOR or Vis::BondProperty::COLOR.

◆ BOND_LINE_WIDTH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::BOND_LINE_WIDTH
extern

Specifies the width of bond lines.

The width can either be specified as an absolute value or as a scaling factor for the bond length. If input-scaling is enabled, the line width will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the line width grows/shrinks with the size of the chemical structure during viewport size adjustment. If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::BOND_LINE_WIDTH and Vis::BondProperty::LINE_WIDTH are not set, the default setting Vis::ControlParameterDefault::BOND_LINE_WIDTH will be used.

Value Type: Vis::SizeSpecification

Note
The control-parameter setting is ignored if a line width has been specified by Vis::MolecularGraphProperty::BOND_LINE_WIDTH or Vis::BondProperty::LINE_WIDTH.

◆ BOND_LINE_SPACING

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::BOND_LINE_SPACING
extern

Specifies the distance between the lines of double and triple bonds.

The distance can either be specified as an absolute value or as a scaling factor for the bond length. If input-scaling is enabled, the line distance will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the distance grows/shrinks with the size of the chemical structure during viewport size adjustment. If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::BOND_LINE_SPACING and Vis::BondProperty::LINE_SPACING are not set, the default setting Vis::ControlParameterDefault::BOND_LINE_SPACING will be used.

Value Type: Vis::SizeSpecification

Note
The control-parameter setting is ignored if a line spacing has been specified by Vis::MolecularGraphProperty::BOND_LINE_SAPCING or Vis::BondProperty::LINE_SPACING.

◆ STEREO_BOND_WEDGE_WIDTH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::STEREO_BOND_WEDGE_WIDTH
extern

Specifies the width of wedge-shaped stereo bonds.

The width can either be specified as an absolute value or as a scaling factor for the bond length. If input-scaling is enabled, the wedge width will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the wedge width grows/shrinks with the size of the chemical structure during viewport size adjustment. If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::STEREO_BOND_WEDGE_WIDTH and Vis::BondProperty::STEREO_BOND_WEDGE_WIDTH are not set, the default setting Vis::ControlParameterDefault::STEREO_BOND_WEDGE_WIDTH will be used.

Value Type: Vis::SizeSpecification

Note
The control-parameter setting is ignored if a wedge width has been specified by Vis::MolecularGraphProperty::STEREO_BOND_WEDGE_WIDTH or Vis::BondProperty::STEREO_BOND_WEDGE_WIDTH.

◆ STEREO_BOND_HASH_SPACING

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::STEREO_BOND_HASH_SPACING
extern

Specifies the distance between the hashes of down stereo bonds.

The distance can either be specified as an absolute value or as a scaling factor for the bond length. If input-scaling is enabled, the hash distance will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the hash distance grows/shrinks with the size of the chemical structure during viewport size adjustment. If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::STEREO_BOND_HASH_SPACING and Vis::BondProperty::STEREO_BOND_HASH_SPACING are not set, the default setting Vis::ControlParameterDefault::STEREO_BOND_HASH_DISTANCE will be used.

Value Type: Vis::SizeSpecification

Note
The control-parameter setting is ignored if a hash spacing has been specified by Vis::MolecularGraphProperty::STEREO_BOND_HASH_SPACING or Vis::BondProperty::STEREO_BOND_HASH_SPACING.

◆ REACTION_CENTER_LINE_LENGTH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_CENTER_LINE_LENGTH
extern

Specifies the length of the lines in reaction center marks.

The length can either be specified as an absolute value or as a scaling factor for the bond length. If input-scaling is enabled, the line length will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the length grows/shrinks with the size of the chemical structure during viewport size adjustment. If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::REACTION_CENTER_LINE_LENGTH and Vis::BondProperty::REACTION_CENTER_LINE_LENGTH are not set, the default setting Vis::ControlParameterDefault::REACTION_CENTER_LINE_LENGTH will be used.

Value Type: Vis::SizeSpecification

Note
The control-parameter setting is ignored if a line length has been specified by Vis::MolecularGraphProperty::REACTION_CENTER_LINE_LENGTH or Vis::BondProperty::REACTION_CENTER_LINE_LENGTH.
See also
Vis::ControlParameter::SHOW_BOND_REACTION_INFOS

◆ REACTION_CENTER_LINE_SPACING

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::REACTION_CENTER_LINE_SPACING
extern

Specifies the distance between the lines in reaction center marks.

The distance can either be specified as an absolute value or as a scaling factor for the bond length. If input-scaling is enabled, the line distance will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the distance grows/shrinks with the size of the chemical structure during viewport size adjustment. If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::REACTION_CENTER_LINE_SPACING and Vis::BondProperty::REACTION_CENTER_LINE_SPACING are not set, the default setting Vis::ControlParameterDefault::REACTION_CENTER_LINE_SPACING will be used.

Value Type: Vis::SizeSpecification

Note
The control-parameter setting is ignored if a line length has been specified by Vis::MolecularGraphProperty::REACTION_CENTER_LINE_SPACING or Vis::BondProperty::REACTION_CENTER_LINE_SPACING.
See also
Vis::ControlParameter::SHOW_BOND_REACTION_INFOS

◆ DOUBLE_BOND_TRIM_LENGTH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::DOUBLE_BOND_TRIM_LENGTH
extern

Specifies the amount by which the non-central lines of asymmetric double bonds have to be trimmed at each line end.

The trim length can either be specified as an absolute value or as a scaling factor for the bond length. If input-scaling is enabled, the trim length will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the length grows/shrinks with the size of the chemical structure during viewport size adjustment. If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::DOUBLE_BOND_TRIM_LENGTH and Vis::BondProperty::DOUBLE_BOND_TRIM_LENGTH are not set, the default setting Vis::ControlParameterDefault::DOUBLE_BOND_TRIM_LENGTH will be used.

Value Type: Vis::SizeSpecification

Note
The control-parameter setting is ignored if a trim length has been specified by Vis::MolecularGraphProperty::DOUBLE_BOND_TRIM_LENGTH or Vis::BondProperty::DOUBLE_BOND_TRIM_LENGTH.
See also
Vis::ControlParameter::SHOW_BOND_REACTION_INFOS

◆ TRIPLE_BOND_TRIM_LENGTH

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::TRIPLE_BOND_TRIM_LENGTH
extern

Specifies the amount by which the non-central lines of triple bonds have to be trimmed at each line end.

The trim length can either be specified as an absolute value or as a scaling factor for the bond length. If input-scaling is enabled, the trim length will follow the size change of the chemical structure during bond length normalization. If output-scaling is enabled, the length grows/shrinks with the size of the chemical structure during viewport size adjustment. If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::TRIPLE_BOND_TRIM_LENGTH and Vis::BondProperty::TRIPLE_BOND_TRIM_LENGTH are not set, the default setting Vis::ControlParameterDefault::TRIPLE_BOND_TRIM_LENGTH will be used.

Value Type: Vis::SizeSpecification

Note
The control-parameter setting is ignored if a trim length has been specified by Vis::MolecularGraphProperty::TRIPLE_BOND_TRIM_LENGTH or Vis::BondProperty::TRIPLE_BOND_TRIM_LENGTH.

◆ BOND_LABEL_FONT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::BOND_LABEL_FONT
extern

Specifies the font for bond labels.

If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::BOND_LABEL_FONT and Vis::BondProperty::LABEL_FONT are not set, the default setting Vis::ControlParameterDefault::BOND_LABEL_FONT will be used.

Value Type: Vis::Font

Note
The control-parameter setting is ignored if a font has been specified by Vis::MolecularGraphProperty::BOND_LABEL_FONT or Vis::BondProperty::LABEL_FONT.

◆ BOND_LABEL_SIZE

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::BOND_LABEL_SIZE
extern

Specifies the size of bond 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 will follow the size change of the chemical structure during viewport size adjustment. If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::BOND_LABEL_SIZE and Vis::BondProperty::LABEL_SIZE are not set, the default setting Vis::ControlParameterDefault::BOND_LABEL_SIZE will be used.

Value Type: Vis::SizeSpecification

Note
The control-parameter setting is ignored if a font has been specified by Vis::MolecularGraphProperty::BOND_LABEL_SIZE or Vis::BondProperty::LABEL_SIZE.

◆ BOND_CONFIGURATION_LABEL_FONT

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::BOND_CONFIGURATION_LABEL_FONT
extern

Specifies the font used for bond configuration descriptor text labels.

If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::BOND_CONFIGURATION_LABEL_FONT and Vis::BondProperty::CONFIGURATION_LABEL_FONT are not set, the default setting Vis::ControlParameterDefault::BOND_CONFIGURATION_LABEL_FONT will be used.

Value Type: Vis::Font

Note
The control-parameter setting is ignored if a font has been specified by Vis::MolecularGraphProperty::BOND_CONFIGURATION_LABEL_FONT or Vis::BondProperty::CONFIGURATION_LABEL_FONT.
Since
1.1

◆ BOND_CONFIGURATION_LABEL_SIZE

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::BOND_CONFIGURATION_LABEL_SIZE
extern

Specifies the size of bond 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::BOND_LABEL_SIZE, Vis::MolecularGraphProperty::BOND_LABEL_SIZE or Vis::BondProperty::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. If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::BOND_CONFIGURATION_LABEL_SIZE and Vis::BondProperty::CONFIGURATION_LABEL_SIZE are not set, the default setting Vis::ControlParameterDefault::BOND_CONFIGURATION_LABEL_SIZE will be used.

Value Type: Vis::SizeSpecification

Note
The control-parameter setting is ignored if a size has been specified by Vis::MolecularGraphProperty::BOND_CONFIGURATION_LABEL_SIZE or Vis::BondProperty::CONFIGURATION_LABEL_SIZE.
Since
1.1

◆ BOND_LABEL_MARGIN

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::BOND_LABEL_MARGIN
extern

Specifies the margin of free space around bond labels.

The margin can either be specified as an absolute value or as a scaling factor for the primary label size given by Vis::ControlParameter::BOND_LABEL_SIZE, Vis::MolecularGraphProperty::BOND_LABEL_SIZE or Vis::BondProperty::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. If the control-parameter is left unspecified and the properties Vis::MolecularGraphProperty::BOND_LABEL_MARGIN and Vis::BondProperty::LABEL_MARGIN are not set, the default setting Vis::ControlParameterDefault::BOND_LABEL_MARGIN will be used.

Value Type: Vis::SizeSpecification

Note
The control-parameter setting is ignored if a margin has been specified by Vis::MolecularGraphProperty::BOND_LABEL_MARGIN or Vis::BondProperty::LABEL_MARGIN.

◆ SHOW_BOND_REACTION_INFOS

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_BOND_REACTION_INFOS
extern

Specifies whether or not to draw reaction center marks.

If the control-parameter value is set to true and a bond is part of a reaction center, the bond will be decorated with reaction center marks. The look of reaction center marks is determined by the value of the Chem::Bond property Chem::BondProperty::REACTION_CENTER_STATUS:

If the control-parameter is left unspecified, the default setting Vis::ControlParameterDefault::SHOW_BOND_REACTION_INFOS will be used.

Value Type: bool

◆ SHOW_BOND_QUERY_INFOS

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_BOND_QUERY_INFOS
extern

Specifies whether or not to show query bond match expressions.

If the control-parameter is left unspecified, the default setting Vis::ControlParameterDefault::SHOW_BOND_QUERY_INFOS will be used.

Value Type: bool

◆ SHOW_STEREO_BONDS

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_STEREO_BONDS
extern

Specifies whether or not to draw stereo bonds.

If SHOW_STEREO_BONDS is set to true, the look of single and double bonds is determined by the value of the Chem::Bond property Chem::BondProperty::STEREO_FLAG.

Depending on the value of the stereo flag single bonds are drawn as follows:

Double bonds are drawn as crossed lines if the bond is flagged with Chem::BondStereoFlag::EITHER or Chem::BondStereoFlag::REVERSE_EITHER. All other flag values have no effect.

If the control-parameter is left unspecified, the default setting Vis::ControlParameterDefault::SHOW_STERO_BONDS will be used.

Value Type: bool

◆ SHOW_BOND_CONFIGURATION_LABELS

CDPL_VIS_API const Base::LookupKey CDPL::Vis::ControlParameter::SHOW_BOND_CONFIGURATION_LABELS
extern

Specifies whether or not to show bond configuration descriptor labels.

If the control-parameter is left unspecified, the default setting Vis::ControlParameterDefault::SHOW_BOND_CONFIGURATION_LABELS will be used.

Value Type: bool

Since
1.1