WindowOverlayShape Object

The WindowOverlayShape object is an element in an array of shapes accessed via the WindowOverlay Shapes array property. Each WindowOverlayShape can be used to add an ellipse, image, rectangle, text box, or groups of lines, points, and triangles to its parent WindowOverlay. This object is not creatable in script, but an Array of WindowOverlayShape objects is always created as a child object of the WindowOverlay 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
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
EllipseOptions	Options for the 'Ellipse' shape type	Type: WindowOverlayEllipseOptions Access: Read-Only
ImageOptions	Options for the 'Image' shape type	Type: WindowOverlayImageOptions Access: Read-Only
LinesOptions	Options for the 'Line' shape type	Type: WindowOverlayLinesOptions Access: Read-Only
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String 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
Opacity	Global opacity modifier for each Shape object. Opacities defined at lower levels such as RectangleOptions.FillOpacity are combined multiplicatively with this opacity modifier. Exception: Text Backdrops are not affected by this property.	Type: Variable Access: Read/Write
PointsOptions	Options for the 'Point' shape type	Type: WindowOverlayPointsOptions Access: Read-Only
RectangleOptions	Options for the 'Rectangle' shape type	Type: WindowOverlayRectangleOptions Access: Read-Only
ReferencePoint	Determines which point on the shape lines up with the shape position. 0,0 is the upper-left and 1,1 is the lower-right.	Type: Array Access: Read/Write
TextOptions	Options for the 'Text' shape type	Type: WindowOverlayTextOptions Access: Read-Only
TrianglesOptions	Options for the 'Triangle' shape type	Type: WindowOverlayTrianglesOptions Access: Read-Only
Type	The type of shape to draw.	Type: String Access: Read/Write
Visible	Determines whether the shape is visible.	Type: Variable Access: Read/Write

Name	Description
BringForward	Brings the shape up one level in the rendering order.
BringToFront	Brings the shape to the front of the rendering order.
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.
ResetOrigin	Resets the origin to the default location: the top left corner of the ViewWindow.
ResetPosition	Resets the position to the origin.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.
SendBackwards	Moves the shape one level back in the rendering order
SendToBack	Moves the shape to the back of the rendering order.
SetOrigin	Sets the origin to which this shape's position is referenced with respect to the viewable ViewWindow area.
SetPosition	Sets the position of the shape with respect to the origin with the specified units.
SetSize	Sets the size of the shape in the specified units. Default is reset by changing the Shape Type; default for Text is (0,0,0), default for other shapes is (0,1,1).

WindowOverlayShape Object

Description

Available In Editions:

Timing Precision Mode