legends
Unless otherwise specified, data names are accessible in level 3 only.
- absorbplotid
- Absorb the database legend entity to current graphics legend.
- activesuppressed
- Returns non-zero if the entity is set inactive, 0 otherwise.
- attributesmax
- The number of attributes owned by this entity.
- color
- The 1-64 color of the entity.
- color_rgb
- The RGB color of the entity.
- color_scheme
- The color scheme of the legend.
- colorlevels
- The colors associated with legend.
- config
- The configuration of the entity.
- custom_position
- The custom position of the legend.
- definedentity
- True if the entity is defined, false otherwise.
- displays
- The beyond threshold of the legend.
- drag
- The flag representing if graphics legend is getting dragged for position change.
- id
- The ID of the entity.
- include
- The ID of the include file the entity is organized in.
- includeid
- The ID of the include file the entity is organized in.
- internalid
- The ID of the entity.
- internalname
- The internal name of the entity.
- legend_level_labels
- The labels associated with a category legend.
- legend_level_values
- The values associated with a numeric legend.
- legend_levels
- The number of levels of the legend. Ranges from 2 to 32 (default 7).
- legend_max_level_values
- The values used in custom contour category legend “Label Range – Max” column. Valid for hm_getvalue query only.
- legend_min_level_values
- The values which in custom contour category legend “Label Range – Min” column. Valid for hm_getvalue query only.
- legend_type
- The type of legend.
- moduleid
- The module ID of the entity.
- name
- The name of the entity.
- numeric_format
- The format of the legend values.
- numeric_precision
- The precision of the legend values. Ranges from 0 to 15 (default 2).
- outputsuppressed
- Returns non-zero if the entity is set "do not export", 0 otherwise.
- poolid
- The pool number of the entity.
- poolname
- The pool name of the entity.
- position
- The position of the legend.
- range
- The range definition of the legend values.
- realize
- The flag to realize current graphics legend to database legend entity (default 0).
- reset
- The flag to perform reset operation on the legend entity.
- reversed
- The flag to reverse the color order of the legend (default 0).
- solver_id
- The solver ID of the entity.
- solverkeyword
- The name of the solver keyword.
- solvername
- The solver name of the entity for entities enabled for name pool, otherwise the internal name of the entity.
Version History
2022.1
2023 - Added new data names legend_max_level_values and legend_min_level_values.