Class: ProbeLabel

A class of labels that allows you to probe a value at a specific location.

Implemented types

Properties

Name Description
AssociatedObject Gets the associated object.
Color Gets or sets the label's color.
DeformedPosition Gets the post-solution position of the probe, based on Scoping. If AssociatedObject is not evaluated, this property returns None. If AssociatedObject is evaluated but does not have deformation data, this property returns Position.
Note Gets or sets the note on the label. The note refers to user-provided text, which is separate from the program-provided information (such as mesh entity IDs and result values). Multi-line notes are supported through the newline character '\n'. If the note consists of more than 10 lines then only the first 10 will be rendered and "..." will be appended to the 10th line. Setting this to None is treated the same way as setting it to an empty string.
Position Gets the pre-solution position of the probe, based on Scoping.
Scoping Gets or sets the scoping of the label.
ShellSide Gets or sets the side of the shell the probe is attached to. Default is Top. An exception is thrown if the label shell side is not Top or Bottom. An exception is thrown if the label does not exist or it failed to get or set the shell side.
Value Gets the last evaluated value from AssociatedObject at Scoping. If AssociatedObject is not evaluated or has no value at Scoping, this property returns None.