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
attributesmax
The number of attributes owned by this entity.
Type: unsigned integer
averaging
The averaging mode.
Type: string
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
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
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
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
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
moduleid
The module ID of the entity.
Type: integer
name
The name of the entity.
Type: string
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
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
system
The system ID which the result values are transformed to.
Type: entity
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
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_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.