plt3DILegend GetMetaData

Gets a named meta-data value previously associated with the legend.

Syntax

plt3DILegend_handle GetMetaData

Application

HyperWorks Tcl Query

Description

Returns a string (the meta-data value). Metadata can be any string or string representation of a number.

Example

To set and get a meta-data value from a 3D legend:

hwi GetSessionHandle mySessionName
mySessionName GetProjectHandle myProjectName
myProjectName GetPageHandle myPageName 1
myPageName GetWindowHandle myWinName 1
myWinName GetClientHandle myClientName
myClientName GetLegendHandle myLegendName x
myLegendName SetMetaData species dog
myLegendName GetMetaData species

Errors

Returns an empty string if the value is not defined.