Annotations Property Reference

Annotation Names and Abbreviations

2D Image 2DI
3D Image 3DI
Background BG
Center of Loads CoL
Derived Data Annotation DDA
Iteration I
Logo L
Maximum Max
Minimum Min
Plot Image PI
Point Probe PP
Report Rp
Scene S
Scene Grid SG
Scene Image SI
Simple Text STx
Solution Time STi
Time-Step TS

Properties Lookup

The following table shows which properties are used by which annotation. Use the abbreviations given above.

2DI 3DI BG CoL DDA   I    L  Max Min  PI   PP  Rp  S  SG  SI  STx STi TS
Background
When activated, displays the text with a colored background box.
Background Color
The color of the background text box (visible when the Background checkbox is activated), which can be selected from a drop-down list. The property customizer executes the define color action. See Defining Colors.
Color
The color of the text, which can be selected from a drop-down list. The property customizer executes the define color action. See Defining Colors.
Date
When activated, includes the date and time (timestamp) of the last save in the scene or plot information.
Default Height
The default character height as a fraction of the visualization display height, where 1.0 equals the full height.
Default Position
The default position of the text in the visualization display based on the coordinate system specified in the Coordinate System property.
Default Scaling
When activated, scales the elements of a plot image (such as font and line thickness) based on the overall size of the plot image annotation as it appears in the scene or plot.
Default Solution Time Format
Defines the numeric formatting of the solution time value, using either a text entry or a dialog. For details, see Controlling Format of Text and Numbers.
Default Width
The default width of the annotation as a fraction of the visualization display width, where 1.0 equals the full width.
Default Width Stretch Factor
The default amount by which the annotation is stretched in the horizontal direction.
Derived Data
The derived data object, which is selected from a drop-down list.
Font
The font and style of the text. These settings can be entered directly, or you can click the property customizer to activate a dialog. To change the point size, use the Default Height property.
Grid Color
The color of the grid, which can be selected from a drop-down list. The property customizer executes the define color action. See Defining Colors.
Line Thickness
Controls the grid line width in pixels.
Number Format
Defines the numeric formatting of the value associated with the report, using either a text entry or a dialog. For details, see Controlling Format of Text and Numbers.
Opacity
Adjusts the transparency of the annotation. The settings range from 0.0 (completely invisible) to 1.0 (completely opaque). This option allows you to use the annotation as an overlay.
Path
The relative path to the imported graphic. The formats that can be imported are PNG, JPEG, TIFF, PNM, and BMP.
Plot
Selects a plot from a drop-down list of the existing plots in the simulation.
Precision
Controls the grid coordinate precision. The default value is 3; this will display three digits after the decimal place.
Product Name
When activated, includes the name of the program in the scene or plot information.
Product Version
When activated, includes the version of the program in the scene or plot information.
Report
The name of the associated report (read-only).
Representation
Selects a representation. Additional selections would appear as representations are added to the simulation.
Save to Simulation
When activated, retains imported images in the simulation file.
Scene
Selects a scene from a drop-down list of the existing scenes in the simulation.
Shadow
When activated, displays the text with a shadow effect.
Show Part Name
When activated, shows the part name next to the point probe.
Show per-part
When activated, shows the locations of the minimum or maximum values on a per-part basis.
Simulation
When activated, includes the simulation title in the scene or plot information.
Spacing Mode
Selects the method for setting the grid spacing.
Solution Time
When activated, reports the solution time in the annotation. This is useful for unsteady simulations.
Tags
Selects a tag from a drop-down list of the existing tags in the simulation.
Text
The text of the annotation. The property customizer opens a dialog with a larger space for more text. If you enter the function name of any report prepended by ‘$’, Simcenter STAR-CCM+ will replace this by the numerical value provided by the report. For example, $InletPressureReport will return the numerical value given by the report Inlet Pressure.
For report annotations, displays the title and value of the associated report (read-only).
For solution state annotations, displays one of the following values (read-only):
  • number of iterations
  • number of time-steps
  • elapsed physical time
  • current completed time-step
For derived data annotations, displays the following (read-only):
  • For time histories, the text displays the name of the derived data object, the display time, and the name of the field function that is recorded in the history.
  • For spectra, the text displays the name of the derived data object and object properties and their values, indicating how the data was processed.
Text Color
The color of the text, which can be selected from a drop-down list. The property customizer executes the define color action. See Defining Colors.
Time Step
When activated, reports the time-step in the annotation. This is useful for unsteady simulations.
Units
Selects the type of units to use.
User
When activated, includes the Simcenter STAR-CCM+ user name in the scene or plot information.

Annotation Pop-Up Menu

This pop-up menu becomes available if you right-click an annotation in the scene or plot display or in the object tree.

Remove Removes the annotation from the active scene or plot.