legends

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

absorbplotid
Absorb the database legend entity to current graphics legend.
Type: unsigned integer
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
color
The 1-64 color of the entity.
Type: integer
color_rgb
The RGB color of the entity.
Type: string
color_scheme
The color scheme of the legend.
0 - Rainbow
1 - Divergent (default)
2 - User Defined
Type: unsigned integer
colorlevels
The colors associated with legend.
Type: color array
config
The configuration of the entity.
2 - Contour
3 - Vector
4 - Tensor
Type: unsigned integer
custom_position
The custom position of the legend.
Type: triple double
definedentity
True if the entity is defined, false otherwise.
Type: Boolean
displays
The beyond threshold of the legend.
0 - Off (default)
1 - Transparent
2 - Feature Lines
Type: unsigned integer
drag
The flag representing if graphics legend is getting dragged for position change.
Type: Boolean
id
The ID of the entity.
Type: unsigned integer
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
legend_level_labels
The labels associated with a category legend.
Type: string array
legend_level_values
The values associated with a numeric legend.
Type: double array
legend_levels
The number of levels of the legend. Ranges from 2 to 32 (default 7).
Type: unsigned integer array
legend_max_level_values
The values used in custom contour category legend “Label Range – Max” column. Valid for hm_getvalue query only.
Type: double array
legend_min_level_values
The values which in custom contour category legend “Label Range – Min” column. Valid for hm_getvalue query only.
Type: double array
legend_type
The type of legend.
0 – Numeric (default)
1 – Category
Type: unsigned integer
moduleid
The module ID of the entity.
Type: integer
name
The name of the entity.
Type: string
numeric_format
The format of the legend values.
0 – Auto
1 – Fixed
2 – Scientific (default)
Type: unsigned integer
numeric_precision
The precision of the legend values. Ranges from 0 to 15 (default 2).
Type: unsigned integer
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
poolname
The pool name of the entity.
Type: string
position
The position of the legend.
0 – Top Right (default)
1 – Top Center
2 – Top Left
3 – Mid Right
4 – Mid Center
5 – Mid Left
6 – Bottom Right
7 – Bottom Center
8 – Bottom Left
9 – User Defined
Type: unsigned integer
range
The range definition of the legend values.
0 – Automatic (default)
1 – User defined
Type: unsigned integer
realize
The flag to realize current graphics legend to database legend entity (default 0).
Type: Boolean
reset
The flag to perform reset operation on the legend entity.
Type: Boolean
reversed
The flag to reverse the color order of the legend (default 0).
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

Version History

2022.1

2023 - Added new data names legend_max_level_values and legend_min_level_values.