ActiveField - QuickField API help

QuickField Student Edition free download Contacts

Objects

Properties

Methods

XYPlotWindow Object

Properties

Methods

Summary

The window where an xy-plot of field quantities along the contour is displayed.

Details

XYPlotWindow object represents an xy-plot view.

The XYPlotWindow object is derived from the general Window object and inherits all of its methods and properties. All the XYPlotWindow objects are members of the Windows collection that is accessible by the Windows property of the Result object.

To get the XYPlotWindow you need first define a contour in one of the FieldWidow's associated with the Result. When the contour is built, you create the xy-plot using GetXYPlot method of Result. If the XYPlotWindow for the contour is already opened GetXYPlot method returns the existing XYPlotWindow.

There is a special object PlotPicture containing all the settings affected to the picture presented in the XYPlotWindow. To change some setting you get a PlotPicture associated with the XYPlotWindow, modify its properties and put it back to the XYPlotWindow.

In addition to generic Window features the XYPlotWindow object offers the following methods and properties:

Zoom method	Allows you to magnify and diminish the plot picture. The two parameters as Point gives the left-upper and right-bottom corners of the rectangle you want to be magnified to the whole window. If only one input point is given, it becomes in the center of the window and the picture is magnifies about twice. If no one input parameter is given, the picture is set to see the whole xy-plot.
PlotSettings property (read and write)	Returns and sets the PlotPicture object that contains all the picture settings.
Contour property (read only)	Returns the Contour object used for drawing a xy-plot.
Parent property (read only)	Returns the FieldWindow owns the Contour.
WindowType property (read only)	Returns the type of this window as QfWindowType. The XYPlotWindow has a qfXYPlotWindow type.
GetLegendPicture method	Puts a picture of the legend window into the Windows clipboard.
LegendVisible property (read and write)	Gets and sets the visibility status of the legend window as Boolean.

The following example creates an XYPlotWindow, adjusts the X-axis range and the displays the modulus, normal and tangential components of the heat flux density:

Dim plot As QuickField.XYPlotWindow
Set plot = res.GetXYPlot(cont)
Dim parms As QuickField.PlotPicture
Set parms = plot.PlotSettings
With parms
    .RangeX(qfMin) = 6
    .RangeX(qfMax) = 12
    .Group = qfGrad
    .curve(qfGrad) = True
    .curve(qfGradN) = True
    .curve(qfGradT) = True
End With
plot.PlotSettings = parms