WindowOverlayLinesOptions Object

The WindowOverlayLinesOptions object allows the user to configure a set of lines as a Lines shape in a WindowOverlay object. This object is not creatable in script, but is always created as a child object of the WindowOverlayShape object, as seen below:

Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.

Available In Editions:

Timing Precision Mode

Name	Description	Attributes
Colors	Array of colors of the lines.	Type: Array Access: Read/Write
Count	The number of lines drawn.	Type: Variable Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
DisplayName	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ElementType	The type of line elements to be drawn. Lines are defined by 2 points, LineStrip is a connected strip of lines where shared interior points need not be defined twice (N+1 defined vertices yields N lines), and LineLoop is similar to LineStrip but combines the last point with the first point (N defined vertices yields N lines).	Type: Variable Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
Positions	An nx2 matrix determining the positions of line end points relative to the Shape.ReferencePoint. Which end points need be defined is set by the ElementType property. The units of the Positions matrix is defined by the PositionUnits property.	Type: Matrix Access: Read/Write
PositionsUnits	Determines if the Positions matrix is in units of relative window size or in units of pixels.	Type: Variable Access: Read/Write
Widths	Array of widths of the lines.	Type: Array Access: Read/Write

Name	Description
ClearSavedStates	Clears previous saved states for this object.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.

WindowOverlayLinesOptions Object

Description

Available In Editions:

Timing Precision Mode