pltIDatum SetComplexAxis

Sets the associated complex area for the datum line.

Syntax

pltIDatum SetComplexAxis complex_component

Application

HyperWorks Tcl Modify

Description

The SetComplexAxis command assigns a datum line to an area of the complex plot. Horizontal datum lines can exist in only one complex axis while vertical datum lines can be drawn in both complex areas.

In previous releases, the command SetAssociatedAxis was used to perform this action to assign the datum line to the “top” or “bottom” areas. This was incorrect because the top area can be any of phase, magnitude, real, or imaginary. Also, SetAssociatedAxis applies to multiple parallel axis and not complex components.

Inputs

complex_component
Phase, magnitude, real, or imaginary for horizontal and vertical datum lines.
"both” for vertical datum lines which displays the line in both complex areas.

Example

The following example generates a curve in the magnitude portion of the complex plot running from the lower left corner to the upper right corner of the plot grid:
hwi GetSessionHandle session
session GetProjectHandle proj
proj GetPageHandle page 1
page GetWindowHandle win 1
win GetClientHandle plot
plot SetChartType complex
plot GetHorizontalDatumHandle datum [plot AddHorizontalDatum]
datum SetComplexAxis "magnitude"
datum SetValue x
plot Draw

Errors

Returns success or an error code.

Keywords

complex plot

complex datum

associated axis