plotcontrols

Unless otherwise specified, data names are accessible in level 3 only.

activesuppressed
Returns non-zero if the entity is set inactive, 0 otherwise.
Type: integer
applied
The flag to display applied forces.
Type: Boolean
arrowlength
The plot arrow length. Default is 75 (%).
Type: double
attributesmax
The number of attributes owned by this entity.
Type: unsigned integer
averaging
The averaging mode.
Type: string
categoryforce
The flag to show/hide FBD plot force options to show/hide arrows.
Type: Boolean
categorymoment
The flag to show/hide FBD plot moment options to show/hide arrows.
Type: Boolean
categoryoptions
The flag to show/hide FBD plot options.
Type: Boolean
categorysectiontype
The flag to show/hide section type plot options.
Type: Boolean
categorysystemtype
The flag to show/hide system type plot options.
Type: Boolean
color
The 1-64 color of the entity.
Type: integer
color_rgb
The RGB color of the entity.
Type: string
complexfilter
The complex filter mode.
real
imaginary
magnitude
phase
mag*cos(wt+phase)
mag*cos(wt-phase)
Type: string
config
The configuration of the entity.
2 - contour
3 - vector
4 - tensor
5 - deformed
6 - marker
7 - fbd
Type: unsigned integer
contour_enable_iso
The flag to enable the iso plot.
Type: Boolean
contour_label
The flag to enable contour labels to show min/max locations.
Type: Boolean
corner
The flag to request corner data.
Type: Boolean
custom_legend
The flag enabling custom legend for the plotcontrol entity (default 0).
Type: Boolean
datacomponent
The datacomponent corresponding to the datatype specified.
Type: string
datatype
The result datatype which is used for plotting.
Type: string
decimallimit
The decimal limit (default 2).
Type: integer
definedentity
True if the entity is defined, false otherwise.
Type: Boolean
deformed_scaling_mode
The deformation plot scaling mode. Valid value is “Scale Factor”.
Type: string
deformed_scaling_type
The deformation plot scaling type. Valid value is “Uniform”.
Type: string
deformed_scale_uniform
The deformation plot uniform scale factor.
Type: double
deformed_undef_display_mode
The undeformed shape display mode.
None
Wireframe
Edges
Component color
Type: string
fbdids
The IDs of the freebodysection entities.
Type: entity array
forcedisplay
The force display options.
1 - Components (default)
2 - Resultant Plane on Direction-1
3 - Resultant Plane on Direction-2
4 - Resultant Plane on Direction-3
Type: integer
forcenormal
The flag to display normal force.
Type: Boolean
forcetangent
The flag to display tangent force.
Type: Boolean
forcex
The flag to display Fx force.
Type: Boolean
forcexyz
The flag to display Fxyz force.
Type: Boolean
forcey
The flag to display Fy force.
Type: Boolean
forcez
The flag to display Fz force.
Type: Boolean
id
The ID of the entity.
Type: unsigned integer
ids
The entity IDs (nodes, elements, components) which are used for result plotting.
Type: entity
include
The ID of the include file the entity is organized in.
Type: entity
includeid
The ID of the include file the entity is organized in.
Type: unsigned integer
internal
The flag to display grid point data internal forces.
Default active when sectiontype=1 and sectiondatatype=3
Type: Boolean
internalid
The ID of the entity.
Type: unsigned integer
internalname
The internal name of the entity.
Type: string
layer
The layer corresponding to the datatype specified.
Type: string
legend
The ID of the legend entity assigned to the plotcontrol entity.
Type: entity
legend_visibility
Controls the visibility of the associated legend (default true).
Type: Boolean
marker_displayColor
The marker plot entity color. Valid values are 1-64.
Type: integer
moduleid
The module ID of the entity.
Type: integer
momentdisplay
The moment display options.
1 - Components (default)
2 - Resultant Plane on Direction-1
3 - Resultant Plane on Direction-2
4 - Resultant Plane on Direction-3
Type: integer
momentnormal
The flag to display normal moment.
Type: Boolean
momenttangent
The flag to display tangent moment.
Type: Boolean
momentx
The flag to display Mx moment.
Type: Boolean
momentxyz
The flag to display Mxyz moment.
Type: Boolean
momenty
The flag to display My moment.
Type: Boolean
mpc
The flag to display MPC forces.
Type: Boolean
name
The name of the entity.
Type: string
numeric_format
The format of the marker values.
0 – Fixed
1 – Scientific (default)
Type: unsigned integer
numeric_precision
The precision of the marker values. Valid values are 0-12 (default 2).
Type: unsigned integer
omega_t
The phase value.
Type: double
outputsuppressed
Returns non-zero if the entity is set "do not export", 0 otherwise.
Type: integer
poolid
The pool number of the entity.
Type: integer
plot
The plot state indicating whether it is plotted or not.
Type: Boolean
poolname
The pool name of the entity.
Type: string
resolved
The system in which the result values are transformed to.
Type: string
resolveintype
The system in which to resolve the data.
1 - Free Body System (default)
2 - Global System
3 - User System
Type: integer
scale
1 - Constant arrow length (default)
2 - By Magnitude arrow length
Type: integer
sectiondatatype
The force/moment data type option when sectiontype=1.
1 - Resultant
2 - Free Body (default)
3 - Grid Point
Type: integer
sectiontype
1 - Force/Moment (Default)
2 - Translation/Rotation
Type: integer
show_entityid
The flag to enable the display of entity ID in marker text.
Type: Boolean
show_value_multiline
The flag to enable the display of the marker text in multiline. If false, the marker text will be displayed as a single line of text.
Type: Boolean
showvalues
The flag to show the plot values (default true).
Type: Boolean
solver_id
The solver ID of the entity.
Type: integer
solverkeyword
The name of the solver keyword.
Type: string
solvername
The solver name of the entity for entities enabled for name pool, otherwise the internal name of the entity.
Type: string
spc
The flag to display applied SPC forces.
Type: Boolean
Style
1 - 3D arrow (Default)
2 - 2D arrow
Type: integer
system
The system ID which the result values are transformed to.
Type: entity
systemids
The ID for the system when resolveintype=3.
Type: entity
tensor_data_components
Represents the combination of the active data components (XX, YY, ZZ, XY, YZ, ZX).
Type: string
Default: XY
tensor_format
The tensor plotting format. Valid value is Component.
Type: string
tensor_scale
The tensor arrow size scaling factor.
Type: double
tensor_show_normal_prefix
The flag to show the tensor normal value’s prefix.
Type: Boolean
tensor_show_normal_values
The flag to show the tensor normal values.
Type: Boolean
tensor_show_shear_prefix
The flag to show the tensor shear value’s prefix.
Type: Boolean
tensor_show_shear_values
The flag to show the tensor shear values.
Type: Boolean
tensor_size_scaling_mode
The tensor size scaling mode.
Normalize
By Magnitude
Type: string
tolerance
The tolerance to limit the values (default 0.0001).
Type: double
txy
The flag to display tensor XY component.
Type: Boolean
tyz
The flag to display tensor YZ component.
Type: Boolean
tzx
The flag to display tensor ZX component.
Type: Boolean
value_format
The numeric format for vector or tensor values.
Fixed
Scientific
Type: string
value_precision

The numeric precision for vector or tensor values. Valid values are integers in the range of 0 to 12.

Type: unsigned integer
vector_data_components
Represents the combination of the active data components (X, Y, Z, Resultant).
Type: string
vector_scale
The vector size scaling factor.
Type: double
vector_size_scaling_mode
The vector arrow size scaling.
Uniform
By Magnitude
Type: string
vector_show_prefix
The flag to show vector value’s prefix.
Type: Boolean
vector_show_values
The flag to show vector values.
Type: Boolean
vres
The flag to display vector plot resultant.
Type: Boolean
vx
The flag to display vector plot x component.
Type: Boolean
vy
The flag to display vector plot y component.
Type: Boolean
vz
The flag to display vector plot z component.
Type: Boolean

Version History

2021.2

2022.1 - Added new data names custom_legend and legend. Removed data names tensor_color_by_mode and vector_color_by_mode.

2022.3 - Added new config value 6 and new data names marker_displayColor, numeric_format, numeric_precision show_entityid, and show_value_multiline.

2023 - Added new config value 7 and new data names applied, arrowlength, categoryforce, categorymoment, categoryoptions, categorysectiontype, categorysystemtype, decimallimit, fbdids, forcedisplay, forcenormal, forcetangent, forcex, forcexyz, forcey, forcez, internal, legend_visibility, momentdisplay, momentnormal, momenttangent, momentx, momentxyz, momenty, mpc, resolveintype, scale, sectiondatatype, sectiontype, showvalues, spc, Style, and systemids, tensor_data_components and vector_data_components.