Note: IPOLYLINE creates an annotation object with an identifier of LINE. This identifier must be used when manipulating the object with routines like ISETPROPERTY.

Examples

See the example for ITEXT.

Syntax

IPOLYLINE, Points [, ARROW_SIZE=Value] [, ARROW_STYLE=Value] [, /DATA | , /DEVICE | , /NORMAL] [, IDENTIFIER=Variable] [, PROPERTY=Value] [, TOOL=iToolID] [, TARGET_IDENTIFIER=iToolID] [, /VISUALIZATION]

Arguments

Points

The vertices of the polyline. Points is either a vector of two-element vectors [[x1, y1], [x2, y2] ...], a 2-D array of points, or a 3-D array of points. Unless a 3-D array is specified, a 2-D polyline is created. Locations are specified in normalized coordinates unless the DATA or DEVICE keyword is set.

Keywords

Any property of a polyline annotation can be set using this routine. To set the value of a property, specify the property name as a keyword set equal to the appropriate property value. See ISETPROPERTY for details.

ARROW_SIZE

Set this keyword to the size (in normalized units) of the displayed arrowhead(s). This keyword has no effect if ARROW_STYLE is not set.

ARROW_STYLE

Set this keyword to the style of arrow used to decorate the line.

DATA

Set this keyword if the input arguments are specified in data coordinates.

DEVICE

Set this keyword if the input arguments are specified in device coordinates (pixels).

IDENTIFIER

Set this keyword to a named variable that will contain the full identifier of the newly-created object.

NORMAL

Set this keyword if the input arguments are specified in normalized [0, 1] coordinates (the default).

TARGET_IDENTIFIER

Set this keyword to the iTools identifier of an object that is contained in the data space into which the polyline object should be placed. If a value is not supplied, the first data space in the current view is used.

TOOL

Set this keyword to the iTools identifier of the iTool in which TARGET_IDENTIFIER is found. If a value is not supplied, the current iTool is used.

VISUALIZATION

Set this keyword to add the object to the data space. The default behavior is to add the object to the annotation layer.

Version History

7.1

Introduced

See Also

IPOLYGON, ICONVERTCOORD, IELLIPSE, ITEXT