pltIBuildPlotsCtrl SetLegend

Sets whether the legend is on.

Syntax

pltIBuildPlotsCtrl_handle SetLegendlegend_on

Application

HyperWorks Tcl Modify

Description

This command sets whether the legend is on or off (visible or invisible).
Note: The command GeneratePlot must be called to draw the plot with these changes.

Inputs

legend_on
true
If you want the legend to be on (visible).
false
If you want the legend to be off (invisible).

Example

hwi GetSessionHandle sess;
sess GetClientManagerHandle mgr plot;
mgr GetBuildPlotsCtrlHandle build;
build SetLegend false;
build GeneratePlot;

Errors

Success (0) or an error message is returned.

Keywords

HyperWorks

Tcl

Build Plots

Legend

Modify