poILegend GetMaxByModel

Gets the legend maximum for a given model ID.

Syntax

legend_handle GetMaxByModelmodelID formatted

Application

HyperView Tcl Query

Description

This command retrieves the maximum legend value for a given model ID.

Inputs

modelID
The model ID for which the legend maximum value is required.
formatted
The formatted output required or not. The default value is true.

Example

To get the legend maximum value for a model:
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
set maxValue [legend_handle GetMaxByModel 1]
hwi CloseStack

Errors

Returns a float value.