plt3DISurface GetDisplayInLegend

Gets whether a surface is displayed in the legend.

Syntax

plt3DISurface_handle GetDisplayInLegend

Application

HyperWorks Tcl Query

Description

By default, all surfaces, curves, groups, charts, and waterfalls are displayed in the legend (except while contouring). Individual objects can be excluded from the list by setting this flag to false.

Returns true or false.

Example

To check whether a surface is listed in the legend:

hwi GetSessionHandle mySessionName
mySessionName GetProjectHandle myProjectName
myProjectName GetPageHandle myPageName 1
myPageName GetWindowHandle myWinName 1
myWinName GetClientHandle myClientName
myClientName GetSurfaceHandle mySurfaceName
mySurfaceName GetDisplayInLegend false
mySurfaceName GetDataSourceHandle dsW w

Errors

None.