The IDLgrPlot::Init function method initializes the plot object.

Note: Init methods are special lifecycle methods, and as such cannot be called outside the context of object creation. This means that in most cases, you cannot call the Init method directly. There is one exception to this rule: if you write your own subclass of this class, you can call the Init method from within the Init method of the subclass.

Syntax


Obj = OBJ_NEW('IDLgrPlot' [, [X,] Y] [, PROPERTY=value])

or

Result = Obj->[IDLgrPlot::]Init( [[X,] Y] [, PROPERTY=value])     (In a lifecycle method only.)

Return Value


When this method is called indirectly, as part of the call to the OBJ_NEW function, the return value is an object reference to the newly-created object.

When called directly within a subclass Init method, the return value is 1 if initialization was successful, or zero otherwise.

Arguments


Note: The values specified by the X and Y arguments are used to initialize the values of the DATAX and DATAY properties of the IDLgrPlot object.

X

A vector representing the abscissa values to be plotted. If X is provided, Y is plotted as a function of X. The value for this argument is double-precision floating-point if the DOUBLE keyword is set or the input value is of type DOUBLE. Otherwise it is converted to single-precision floating-point.

Y

The ordinate data to be plotted. The value for this argument is double-precision floating-point if the DOUBLE keyword is set or the input value is of type DOUBLE. Otherwise it is converted to single-precision floating-point.

Keywords


Any property listed under IDLgrPlot Properties that contains the word “Yes” in the “Init” column of the properties table can be initialized during object creation using this method. To initialize the value of a property, specify the property name as a keyword set equal to the appropriate property value.

All other keywords are passed to the superclass of this object.

Version History


5.0

Introduced