poILegend SetShowCategoryID

Sets the state of the Show Category ID option for the Category Legend.

Syntax

legend_handle SetShowCategoryID state

Application

HyperView Tcl Modify

Description

This command sets the state of the Show Category ID option for the Category Legend.

Inputs

state
Boolean value to set the Show Category ID option to true or false.
  • If the state is to set to true, the Category ID will be shown in the Category Legend.
  • If the state is set to false, the Category labels will be shown in the Category Legend.

Example

To set the state of the Show Category ID option for the Category Legend:
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

# Sets the state of the Show category ID to true
legend_handle SetShowCategoryID true
hwi CloseStack

Errors

Returns an error if the Legend is not valid.