poIFLDCtrl SetCategoryLabel

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

Syntax

poIFLDCtrl SetCategoryLabel band_idx label

Application

HyperView Tcl Modify

Description

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

Inputs

band_idx: The index of the color band (valid values are 0,1,2,3,4,5).
label: The label for the particular band.

Example

To set the 3rd band of the FLD zone legend to "My Custom Label":

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

fld_ctrl SetCategoryLabel 2 “My Custom Label”

fld_ctrl SetEnableState true
client_handle Draw
hwi CloseStack

Error

Returns a non-zero value if there is an error.