poIFLDCtrl GetCategoryLabel

Gets the label of a particular band of the FLD zone category legend.

Syntax

poIFLDCtrl GetCategoryLabelband_idx

Application

HyperView Tcl Query

Description

This command retrieves the label of a particular band of the FLD zone category legend.

Inputs

band_idx: The index of the FLD legend band (valid values are 0,1,2,3,4,5).

Example

To get the label of the 3rd band of FLD zone legend:

Note: The example below assumes that an FLD is currently plotted in a HyperView session.

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 GetFLDCtrlHandle fld_ctrl

set lab [fld_ctrl GetCategoryLabel 2]

hwi CloseStack

Errors

Returns an empty string if there is an error.