poILegend GetMaximumLevelForCategory

Gets the maximum number of levels allowed in the Category Legend for a Max/Min/Extreme layer contour.

Syntax

legend_handle GetMaximumLevelForCategory

Application

HyperView Tcl Query

Description

This command retrieves the maximum number of levels allowed in the Category Legend for a Max/Min/Extreme layer contour. By default, the maximum level is set to 12.

Inputs

Example

To get the maximum number of levels 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

# Gets the max no of levels allowed for category legend
set max_level [legend_handle GetMaximumLevelForCategory]
hwi CloseStack

Errors

Returns -1 if the legend handle is invalid.