.ds f. AtXYPlot.man
.\"  $Header: /afs/athena.mit.edu/astaff/project/atdev/spec/man/RCS/AtXYPlot.man,v 3.2 91/01/17 15:37:44 crcraig Exp Locker: crcraig $
.\"  Copyright (C) 1990 by the Massachusetts Institute of Technology
.\"
.TH AtXYPlot 3X
.SH NAME
.B AtXYPlot -- the x-y plot widget class
.SH SYNOPSIS
.B #include <At/XYPlot.h>

.SH DESCRIPTION

The AtXYPlot widget class displays x-y data in an AtPlotter widget.
Data is supplied in two arrays of doubles, one for x data and one for
y data.  Data points can optionally be marked with several different
types of markers and/or connected.  Both horizontal and vertical
impulses can be drawn to the points with a user-defined interval.  The
AXYPlot widget has the ability to incrementally update itself (i.e.
dynamically changing data will cause only the changing XYPlot to be
redrawn) if its AtPlotterWidget parent's XtNautoScale resource is
False.

.SH CLASSES
The class pointer is atXYPlotWidgetClass, and the class name is
AtXYPlot.

.SH RESOURCES
The AtXYPlot widget inherits all the resources of the Object and AtPlot
widget classes.  In addition, it has the following new resources:

.TS
.if \n+(b.=1 .nr d. \n(.c-\n(c.-1
.de 35
.ps \n(.s
.vs \n(.vu
.in \n(.iu
.if \n(.u .fi
.if \n(.j .ad
.if \n(.j=0 .na
..
.nf
.nr #~ 0
.if \n(.T .if n .nr #~ 0.6n
.ds #d .d
.if \(ts\n(.z\(ts\(ts .ds #d nl
.fc
.nr 33 \n(.s
.rm 48 49 50
.nr 48 0
.nr 38 \w\f2Name\fP
.if \n(48<\n(38 .nr 48 \n(38
.nr 38 \wXtNconnectPoints
.if \n(48<\n(38 .nr 48 \n(38
.nr 38 \wXtNmarkPoints
.if \n(48<\n(38 .nr 48 \n(38
.nr 38 \wXtNmarker
.if \n(48<\n(38 .nr 48 \n(38
.nr 38 \wXtNhorizontalImpulses
.if \n(48<\n(38 .nr 48 \n(38
.nr 38 \wXtNhorizontalImpulseInterval
.if \n(48<\n(38 .nr 48 \n(38
.nr 38 \wXtNverticalImpulses
.if \n(48<\n(38 .nr 48 \n(38
.nr 38 \wXtNverticalImpulseInterval
.if \n(48<\n(38 .nr 48 \n(38
.nr 38 \wXtNxPoints
.if \n(48<\n(38 .nr 48 \n(38
.nr 38 \wXtNyPoints
.if \n(48<\n(38 .nr 48 \n(38
.nr 38 \wXtNnumPoints
.if \n(48<\n(38 .nr 48 \n(38
.48
.rm 48
.nr 49 0
.nr 38 \w\f2Type\fP
.if \n(49<\n(38 .nr 49 \n(38
.nr 38 \wBoolean
.if \n(49<\n(38 .nr 49 \n(38
.nr 38 \wBoolean
.if \n(49<\n(38 .nr 49 \n(38
.nr 38 \wMarkerType
.if \n(49<\n(38 .nr 49 \n(38
.nr 38 \wBoolean
.if \n(49<\n(38 .nr 49 \n(38
.nr 38 \wint
.if \n(49<\n(38 .nr 49 \n(38
.nr 38 \wBoolean
.if \n(49<\n(38 .nr 49 \n(38
.nr 38 \wint
.if \n(49<\n(38 .nr 49 \n(38
.nr 38 \wdouble *
.if \n(49<\n(38 .nr 49 \n(38
.nr 38 \wdouble *
.if \n(49<\n(38 .nr 49 \n(38
.nr 38 \wint
.if \n(49<\n(38 .nr 49 \n(38
.49
.rm 49
.nr 50 0
.nr 38 \w\f2Default\fP
.if \n(50<\n(38 .nr 50 \n(38
.nr 38 \wFalse
.if \n(50<\n(38 .nr 50 \n(38
.nr 38 \wTrue
.if \n(50<\n(38 .nr 50 \n(38
.nr 38 \wAtMarkerCIRCLE
.if \n(50<\n(38 .nr 50 \n(38
.nr 38 \wFalse
.if \n(50<\n(38 .nr 50 \n(38
.nr 38 \w1
.if \n(50<\n(38 .nr 50 \n(38
.nr 38 \wFalse
.if \n(50<\n(38 .nr 50 \n(38
.nr 38 \w1
.if \n(50<\n(38 .nr 50 \n(38
.nr 38 \wNULL
.if \n(50<\n(38 .nr 50 \n(38
.nr 38 \wNULL
.if \n(50<\n(38 .nr 50 \n(38
.nr 38 \w0
.if \n(50<\n(38 .nr 50 \n(38
.50
.rm 50
.nr 38 \w\f3AtXYPlot Widget Resources\fP-\n(48-3n-\n(49-3n-\n(50
.if \n(38>0 .nr 38 \n(38/2
.if \n(38<0 .nr 38 0
.nr 49 +\n(38
.nr 50 +\n(38
.nr 38 1n
.nr 47 0
.nr 40 \n(47+((0*\n(38)/2)
.nr 48 +\n(40
.nr 41 \n(48+((6*\n(38)/2)
.nr 49 +\n(41
.nr 42 \n(49+((6*\n(38)/2)
.nr 50 +\n(42
.nr TW \n(50
.if t .if (\n(TW+\n(.o)>7.65i .tm Table at line 48 file AtXYPlot.man is too wide - \n(TW units
.nr #I \n(.i
.in +(\n(.lu-\n(TWu-\n(.iu)/2u
.fc  
.nr #T 0-1
.nr #a 0-1
.eo
.de T#
.nr 35 1m
.ds #d .d
.if \(ts\n(.z\(ts\(ts .ds #d nl
.mk ##
.nr ## -1v
.ls 1
.ls
..
.ec
.ta \n(50u 
.nr 35 1m
.nr 31 \n(.f
\&\h'|\n(40u'\f3AtXYPlot Widget Resources\f\n(31
.ta \n(48u \n(49u \n(50u 
.nr 35 1m
.nr 31 \n(.f
\&\h'|\n(40u'\f2Name\f\n(31\h'|\n(41u'\f2Type\f\n(31\h'|\n(42u'\f2Default\f\n(31
.sp
.ta \n(48u \n(49u \n(50u 
.nr 35 1m
.nr 31 \n(.f
\&\h'|\n(40u'XtNconnectPoints\h'|\n(41u'Boolean\h'|\n(42u'False
.ta \n(48u \n(49u \n(50u 
.nr 35 1m
.nr 31 \n(.f
\&\h'|\n(40u'XtNmarkPoints\h'|\n(41u'Boolean\h'|\n(42u'True
.ta \n(48u \n(49u \n(50u 
.nr 35 1m
.nr 31 \n(.f
\&\h'|\n(40u'XtNmarker\h'|\n(41u'MarkerType\h'|\n(42u'AtMarkerCIRCLE
.ta \n(48u \n(49u \n(50u 
.nr 35 1m
.nr 31 \n(.f
\&\h'|\n(40u'XtNhorizontalImpulses\h'|\n(41u'Boolean\h'|\n(42u'False
.ta \n(48u \n(49u \n(50u 
.nr 35 1m
.nr 31 \n(.f
\&\h'|\n(40u'XtNhorizontalImpulseInterval\h'|\n(41u'int\h'|\n(42u'1
.ta \n(48u \n(49u \n(50u 
.nr 35 1m
.nr 31 \n(.f
\&\h'|\n(40u'XtNverticalImpulses\h'|\n(41u'Boolean\h'|\n(42u'False
.ta \n(48u \n(49u \n(50u 
.nr 35 1m
.nr 31 \n(.f
\&\h'|\n(40u'XtNverticalImpulseInterval\h'|\n(41u'int\h'|\n(42u'1
.ta \n(48u \n(49u \n(50u 
.nr 35 1m
.nr 31 \n(.f
\&\h'|\n(40u'XtNxPoints\h'|\n(41u'double *\h'|\n(42u'NULL
.ta \n(48u \n(49u \n(50u 
.nr 35 1m
.nr 31 \n(.f
\&\h'|\n(40u'XtNyPoints\h'|\n(41u'double *\h'|\n(42u'NULL
.ta \n(48u \n(49u \n(50u 
.nr 35 1m
.nr 31 \n(.f
\&\h'|\n(40u'XtNnumPoints\h'|\n(41u'int\h'|\n(42u'0
.fc
.nr T. 1
.T# 1
.in \n(#Iu
.35
.TE
.if \n-(b.=0 .nr c. \n(.c-\n(d.-18

.IP XtNconnectPoints
Specifies whether the data points of the plot should be connected with
lines.  

.IP XtNmarkPoints
Specifies whether the data points of the plot should each be marked with
a small symbol (circle, square, plus-sign, etc.).  See XtNmarker for
marker types.

.IP XtNmarker
Specifies which symbol to use to mark the data point.  Possible values
are (omit the "AtMarker" prefix when specifying in a resource file)
AtMarkerCIRCLE, AtMarkerSQUARE, AtMarkerTRIANGLE, AtMarkerCROSS,
AtMarkerSTAR, AtMarkerDIAMOND, and AtMarkerPOINT.  If XtNmarkPoints is
False, this resource is ignored.

.IP XtNhorizontalImpulses
Specifies whether a line should be drawn from the y-axis horizontally to
each data point.

.IP XtNhorizontalImpulseInterval
Specifies the data point interval between horizontal impulses.  If
XtNhorizontalImpulses is False, this resource is ignored.

.IP XtNverticalImpulses
Specifies whether a line should be drawn from the x-axis vertically to
each data point.

.IP XtNverticalImpulseInterval
Specifies the data point interval between vertical impulses.  If
XtNverticalImpulses is False, this resource is ignored.

.IP XtNxPoints 
An array of doubles with XtNnumPoints elements specifiying the
x-coordinates of the data points.  If NULL, successive integers starting
at zero will be used.

.IP XtNyPoints
An array of doubles with XtNnumPoints elements specifying the
y-coordinates of the data points.

.IP XtNnumPoints
Specifies the number of points in the arrays.

.SH USAGE

.nf
xyplot = XtCreateWidget(\fIxyplot_name\fP, atXYPlotWidgetClass, \fIparent\fP,
                        \fIargs\fP, \fInum_args\fP)
	String \fIxyplot_name\fP;
	WidgetClass atXYPlotWidgetClass;
	Widget \fIparent\fP;
	ArgList \fIargs\fP;
	Cardinal \fInum_args\fP;
.fi

.SH "SEE ALSO"
AtPlot(3X), AtPlotter(3X), X(1)

.SH AUTHORS
David Flanagan (MIT Project Athena), Chris Craig (MIT Project Athena),
Kambiz Soroushian (MIT Project Athena)

.SH COPYRIGHT

Copyright (C) 1990 by the Massachusetts Institute of Technology

Export of this software from the United States of America is assumed
to require a specific license from the United States Government.
It is the responsibility of any person or organization contemplating
export to obtain such a license before exporting.

WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
distribute this software and its documentation for any purpose and
without fee is hereby granted, provided that the above copyright
notice appear in all copies and that both that copyright notice and
this permission notice appear in supporting documentation, and that
the name of M.I.T. not be used in advertising or publicity pertaining
to distribution of the software without specific, written prior
permission.  M.I.T. makes no representations about the suitability of
this software for any purpose.  It is provided "as is" without express
or implied warranty.