IDLgrSymbol::Init

IDLgrSymbol::Init

Syntax | Return Value | Arguments | Keywords | Version History

The IDLgrSymbol::Init function method initializes the plot symbol.

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('IDLgrSymbol' [, Data] [, PROPERTY=value])

Result = Obj->[IDLgrSymbol::]Init([Data] [, PROPERTY=value]) (Only in a subclass' Init method.)

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

Data

Either an integer value from the list shown below, or an object reference to either an IDLgrModel object or atomic graphic object.

Use one of the following scalar-represented internal default symbols:

0 = No symbol

1 = Plus sign, `+' (default)

2 = Asterisk

3 = Period (Dot)

4 = Diamond

5 = Triangle

6 = Square

7 = X

8 = "Greater-than" Arrow Head (>)

9 = "Less-than" Arrow Head (<)

If an instance of the IDLgrModel object class or an atomic graphic object is used, the object tree is used as the symbol. For best results, the object should fill the domain from -1 to +1 in all dimensions. The pre-defined symbols listed above are all defined in the domain -1 to +1.

Keywords

Any property listed under IDLgrSymbol 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

Introduced: 5.0

Data argument added: 5.6