pltIDatum GetComplexAxis

Sets the associated complex area for the datum line. Returns the complex component axis in which the datum line is located.

Syntax

pltIDatum_handle GetComplexAxis

Application

Tcl Query

Description

The GetComplexAxis command finds which complex area contains the datum line. 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 GetAssociatedAxis returned zero for the top axis area and one for the bottom axis area. This was incorrect because the top area can be any of phase, magnitude, real, or imaginary. Also, GetAssociatedAxis applies to multiple parallel axis and not complex components.

Example

Returns "magnitude" as the complex axis associated with the horizontal complex datum.

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"
puts [datum GetComplexAxis]

Errors

None.

Keywords

complex plot

complex datum

associated axis