::hwp::GetPlotLegend

Gets a legend handle of a plot client.

Syntax

::hwp::GetPlotLegend

Application

HyperWorks Tcl Query

Description

This procedure implements minus options.

This procedure returns a legend handle of HyperGraph.

If no page ID is requested, then it operates on the current/active page.

If no window ID is given, then it returns a legend handle of the active window.

Mandatory Arguments

None.

Optional Arguments

-clientHandle "plot client handle"
The handle (object reference to a plot client).
-page "pageID"
The page ID of the requested page.
-window "windowID"
The window ID of the requested window.

Returns

Returns a legend handle of a plot client.

Example

set legendHandle [::hwp::GetPlotLegend -page 3 -window 2]