Chemical Data Processing Library Python API - Version 1.1.1
Static Public Attributes | List of all members
CDPL.Vis.ReactionProperty Class Reference

Provides keys for built-in Chem.Reaction properties. More...

+ Inheritance diagram for CDPL.Vis.ReactionProperty:

Static Public Attributes

 AGENT_ALIGNMENT = CDPL.Base.LookupKey('AGENT_ALIGNMENT')
 Specifies the vertical alignment of the reaction agents relative to the reaction arrow. More...
 
 AGENT_LAYOUT = CDPL.Base.LookupKey('AGENT_LAYOUT')
 Specifies the style of the reaction agent layout. More...
 
 AGENT_LAYOUT_DIRECTION = CDPL.Base.LookupKey('AGENT_LAYOUT_DIRECTION')
 Specifies the direction of the reaction agent layout. More...
 
 ARROW_COLOR = CDPL.Base.LookupKey('ARROW_COLOR')
 Specifies the color of the reaction arrow. More...
 
 ARROW_HEAD_LENGTH = CDPL.Base.LookupKey('ARROW_HEAD_LENGTH')
 Specifies the head length of the reaction arrow. More...
 
 ARROW_HEAD_WIDTH = CDPL.Base.LookupKey('ARROW_HEAD_WIDTH')
 Specifies the head width of the reaction arrow. More...
 
 ARROW_LENGTH = CDPL.Base.LookupKey('ARROW_LENGTH')
 Specifies the length of the reaction arrow. More...
 
 ARROW_LINE_WIDTH = CDPL.Base.LookupKey('ARROW_LINE_WIDTH')
 Specifies the line width of the reaction arrow outline. More...
 
 ARROW_SHAFT_WIDTH = CDPL.Base.LookupKey('ARROW_SHAFT_WIDTH')
 Specifies the shaft width of the reaction arrow. More...
 
 ARROW_STYLE = CDPL.Base.LookupKey('ARROW_STYLE')
 Specifies the style of the reaction arrow. More...
 
 COMPONENT_LAYOUT = CDPL.Base.LookupKey('COMPONENT_LAYOUT')
 Specifies the style of the reaction product and reactant layout. More...
 
 COMPONENT_LAYOUT_DIRECTION = CDPL.Base.LookupKey('COMPONENT_LAYOUT_DIRECTION')
 Specifies the direction of the reaction product and reactant layout. More...
 
 COMPONENT_MARGIN = CDPL.Base.LookupKey('COMPONENT_MARGIN')
 Specifies the amount of free space that is added horizontally and vertically to the bounds of a reaction component. More...
 
 SHOW_REACTANTS = CDPL.Base.LookupKey('SHOW_REACTANTS')
 Specifies whether or not to show the reactants of the reaction. More...
 
 SHOW_AGENTS = CDPL.Base.LookupKey('SHOW_AGENTS')
 Specifies whether or not to show the agents of the reaction. More...
 
 SHOW_PRODUCTS = CDPL.Base.LookupKey('SHOW_PRODUCTS')
 Specifies whether or not to show the products of the reaction. More...
 
 PLUS_SIGN_COLOR = CDPL.Base.LookupKey('PLUS_SIGN_COLOR')
 Specifies the color of the '+' signs between the components of the reaction. More...
 
 PLUS_SIGN_LINE_WIDTH = CDPL.Base.LookupKey('PLUS_SIGN_LINE_WIDTH')
 Specifies the line width of the '+' signs between the components of the reaction. More...
 
 PLUS_SIGN_SIZE = CDPL.Base.LookupKey('PLUS_SIGN_SIZE')
 Specifies the size of the '+' signs between the components of the reaction. More...
 
 SHOW_PLUS_SIGNS = CDPL.Base.LookupKey('SHOW_PLUS_SIGNS')
 Specifies whether or not to draw '+' signs between the components of the reaction. More...
 

Detailed Description

Provides keys for built-in Chem.Reaction properties.

Member Data Documentation

◆ AGENT_ALIGNMENT

CDPL.Vis.ReactionProperty.AGENT_ALIGNMENT = CDPL.Base.LookupKey('AGENT_ALIGNMENT')
static

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

Supported vertical alignment styles are defined in namespace Vis.Alignment. The specified alignment takes precedence over the alignment specified by the parameter Vis.ControlParameter.REACTION_AGENT_ALIGNMENT.

Value Type: unsigned int

◆ AGENT_LAYOUT

CDPL.Vis.ReactionProperty.AGENT_LAYOUT = CDPL.Base.LookupKey('AGENT_LAYOUT')
static

Specifies the style of the reaction agent layout.

Supported layout styles are defined in namespace Vis.LayoutStyle. The specified layout style takes precedence over the layout specified by the parameter Vis.ControlParameter.REACTION_AGENT_LAYOUT.

Value Type: unsigned int

◆ AGENT_LAYOUT_DIRECTION

CDPL.Vis.ReactionProperty.AGENT_LAYOUT_DIRECTION = CDPL.Base.LookupKey('AGENT_LAYOUT_DIRECTION')
static

Specifies the direction of the reaction agent layout.

Supported layout directions are defined in namespace Vis.LayoutDirection. The specified layout direction takes precedence over the direction specified by the parameter Vis.ControlParameter.REACTION_AGENT_LAYOUT_DIRECTION.

Value Type: unsigned int

◆ ARROW_COLOR

CDPL.Vis.ReactionProperty.ARROW_COLOR = CDPL.Base.LookupKey('ARROW_COLOR')
static

Specifies the color of the reaction arrow.

The specified color takes precedence over the color specified by the parameter Vis.ControlParameter.REACTION_ARROW_COLOR.

Value Type: Vis.Color

◆ ARROW_HEAD_LENGTH

CDPL.Vis.ReactionProperty.ARROW_HEAD_LENGTH = CDPL.Base.LookupKey('ARROW_HEAD_LENGTH')
static

Specifies the head length of the reaction arrow.

The value of the specified 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. The specified length takes precedence over the length specified by the parameter Vis.ControlParameter.REACTION_ARROW_HEAD_LENGTH.

Value Type: Vis.SizeSpecification

◆ ARROW_HEAD_WIDTH

CDPL.Vis.ReactionProperty.ARROW_HEAD_WIDTH = CDPL.Base.LookupKey('ARROW_HEAD_WIDTH')
static

Specifies the head width of the reaction arrow.

The value of 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. The specified width takes precedence over the width specified by the parameter Vis.ControlParameter.REACTION_ARROW_HEAD_WIDTH.

Value Type: Vis.SizeSpecification

◆ ARROW_LENGTH

CDPL.Vis.ReactionProperty.ARROW_LENGTH = CDPL.Base.LookupKey('ARROW_LENGTH')
static

Specifies the length of the reaction arrow.

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. The specified length takes precedence over the length specified by the parameter Vis.ControlParameter.REACTION_ARROW_LENGTH.

Value Type: Vis.SizeSpecification

◆ ARROW_LINE_WIDTH

CDPL.Vis.ReactionProperty.ARROW_LINE_WIDTH = CDPL.Base.LookupKey('ARROW_LINE_WIDTH')
static

Specifies the line width of the reaction arrow outline.

The value of 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. The specified width takes precedence over the width specified by the parameter Vis.ControlParameter.REACTION_ARROW_LINE_WIDTH.

Value Type: Vis.SizeSpecification

◆ ARROW_SHAFT_WIDTH

CDPL.Vis.ReactionProperty.ARROW_SHAFT_WIDTH = CDPL.Base.LookupKey('ARROW_SHAFT_WIDTH')
static

Specifies the shaft width of the reaction arrow.

The value of 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. The specified width takes precedence over the width specified by the parameter Vis.ControlParameter.REACTION_ARROW_SHAFT_WIDTH.

Value Type: Vis.SizeSpecification

◆ ARROW_STYLE

CDPL.Vis.ReactionProperty.ARROW_STYLE = CDPL.Base.LookupKey('ARROW_STYLE')
static

Specifies the style of the reaction arrow.

Supported styles are defined as constants in namespace Vis.ArrowStyle. The arrow style specified by this property takes precedence over the style specified by the parameter Vis.ControlParameter.REACTION_ARROW_STYLE.

Value Type: unsigned int

◆ COMPONENT_LAYOUT

CDPL.Vis.ReactionProperty.COMPONENT_LAYOUT = CDPL.Base.LookupKey('COMPONENT_LAYOUT')
static

Specifies the style of the reaction product and reactant layout.

Supported layout styles are defined in namespace Vis.LayoutStyle. The specified layout style takes precedence over the layout specified by the parameter Vis.ControlParameter.REACTION_COMPONENT_LAYOUT.

Value Type: unsigned int

◆ COMPONENT_LAYOUT_DIRECTION

CDPL.Vis.ReactionProperty.COMPONENT_LAYOUT_DIRECTION = CDPL.Base.LookupKey('COMPONENT_LAYOUT_DIRECTION')
static

Specifies the direction of the reaction product and reactant layout.

Supported layout directions are defined in namespace Vis.LayoutDirection. The specified layout direction takes precedence over the direction specified by the parameter Vis.ControlParameter.REACTION_COMPONENT_LAYOUT_DIRECTION.

Value Type: unsigned int

◆ COMPONENT_MARGIN

CDPL.Vis.ReactionProperty.COMPONENT_MARGIN = CDPL.Base.LookupKey('COMPONENT_MARGIN')
static

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. The specified margin takes precedence over the margin specified by the parameter Vis.ControlParameter.REACTION_COMPONENT_MARGIN.

Value Type: Vis.SizeSpecification

◆ SHOW_REACTANTS

CDPL.Vis.ReactionProperty.SHOW_REACTANTS = CDPL.Base.LookupKey('SHOW_REACTANTS')
static

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

The reactant visibility specified by this property overrides the setting of the control-parameter Vis.ControlParameter.SHOW_REACTION_REACTANTS.

Value Type: bool

◆ SHOW_AGENTS

CDPL.Vis.ReactionProperty.SHOW_AGENTS = CDPL.Base.LookupKey('SHOW_AGENTS')
static

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

The agent visibility specified by this property overrides the setting of the control-parameter Vis.ControlParameter.SHOW_REACTION_AGENTS.

Value Type: bool

◆ SHOW_PRODUCTS

CDPL.Vis.ReactionProperty.SHOW_PRODUCTS = CDPL.Base.LookupKey('SHOW_PRODUCTS')
static

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

The product visibility specified by this property overrides the setting of the control-parameter Vis.ControlParameter.SHOW_REACTION_PRODUCTS.

Value Type: bool

◆ PLUS_SIGN_COLOR

CDPL.Vis.ReactionProperty.PLUS_SIGN_COLOR = CDPL.Base.LookupKey('PLUS_SIGN_COLOR')
static

Specifies the color of the '+' signs between the components of the reaction.

The specified color takes precedence over the color specified by the parameter Vis.ControlParameter.REACTION_PLUS_SIGN_COLOR.

Value Type: Vis.Color

◆ PLUS_SIGN_LINE_WIDTH

CDPL.Vis.ReactionProperty.PLUS_SIGN_LINE_WIDTH = CDPL.Base.LookupKey('PLUS_SIGN_LINE_WIDTH')
static

Specifies the line width of the '+' signs between the components of the reaction.

The size has to be specified as an absolute value. The output- and input-scaling settings are ignored and have no effect. The specified line width takes precedence over the width specified by the parameter Vis.ControlParameter.REACTION_PLUS_SIGN_LINE_WIDTH.

Value Type: Vis.SizeSpecification

◆ PLUS_SIGN_SIZE

CDPL.Vis.ReactionProperty.PLUS_SIGN_SIZE = CDPL.Base.LookupKey('PLUS_SIGN_SIZE')
static

Specifies the size of the '+' signs between the components of the reaction.

The size has to be specified as an absolute value. The output- and input-scaling settings are ignored and have no effect. The specified size takes precedence over the size specified by the parameter Vis.ControlParameter.REACTION_PLUS_SIGN_SIZE.

Value Type: Vis.SizeSpecification

◆ SHOW_PLUS_SIGNS

CDPL.Vis.ReactionProperty.SHOW_PLUS_SIGNS = CDPL.Base.LookupKey('SHOW_PLUS_SIGNS')
static

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

The visibility specified by this property overrides the setting of the control-parameter Vis.ControlParameter.SHOW_REACTION_PLUS_SIGNS.

Value Type: bool