poILegend GetCategoryList

Gets the contributing category label list for Category Legend plots.

Syntax

legend_handle GetCategoryList

Application

HyperView Tcl Query

Description

This command retrieves the contributing category label list for Category Legend plots (like a Max/Min/Extreme layer plot, or an Envelope Subcase/Simulation plot). This label list will assist in identifying the contributing categories, if the legend displays the category groups.

Example

To get the contributing category label list:

hwi OpenStack
hwi GetSessionHandle session_handle
session_handle GetProjectHandle project_handle
project_handle GetPageHandle page_handle [project_handle GetActivePage]
page_handle GetWindowHandle window_handle [page_handle GetActiveWindow]
window_handle GetClientHandle client_handle
client_handle GetModelHandle model_handle [client_handle GetActiveModel]
model_handle GetResultCtrlHandle result_handle
result_handle GetContourCtrlHandle contour_handle
contour_handle GetLegendHandle legend_handle

# Gets the contributing category layer list
set layer_list [legend_handle GetCategoryLayerList]
hwi CloseStack

Error

Returns an error if the legend handle is invalid and if the legend is of a numeric type.