DADiSP Worksheet Functions > A - E > ARROWCUR

 

ARROWCUR

Purpose:

Invokes a freehand arrow drawing cursor in a Window.

Syntax:

ARROWCUR(

color, style, target, match, focus, width, stem, base, head, x, y)

(x1, y1, x2, y2) = ARROWCUR(

color, style, target, match, focus, width, stem, base, head, x, y)

color

-

Optional. An integer or macro color name (e.g. RED) specifying line color. Defaults to color of primary series.

style

-

Optional. An integer specifying line style:

1:

Solid (default)

2:

Dashed

3:

Dotted

target

-

Optional. An integer specifying the spatial relationship of the arrow to the Window:

0:

PAPER (default). The arrow is located on the "graph paper" in the Window; within the coordinate system of the data. The arrow scrolls with the series.

1:

GLASS. The arrow is located within the plotting area of Window. The arrow remains fixed in place when the series scrolls.

2:

GLASS_WMARGIN. The arrow is located within the area of the entire Window. The arrow remains fixed in place when the series scrolls.

3:

GLASS_WPMARGIN. The arrow is located within the vertical dimensions of a Window, and within the horizontal dimensions of the plotting area. The arrow remains fixed in place when the series scrolls.

4:

GLASS_WSMARGIN. The arrow is located anywhere within the entire Worksheet area.

match

-

Optional. An integer that sets the line color to match the color of the selected overplot. Defaults to 1 (primary series). –1 implies use color parameter.

focus

-

Optional. An integer specifying 1-based focus offset for PAPER annotations.

width

-

Optional. An integer specifying the arrow line width in pixels. Defaults to 1.

stem

-

Optional. An integer specifying the length of the arrowhead stem in pixels. Defaults to 1.

base

-

Optional. An integer specifying the width of the arrowhead base in pixels. Defaults to 1.

head

-

Optional. An integer specifying the location of the arrowhead:

0:

Last point. The arrowhead is located at the ending coordinates (default).

1:

First point. The arrowhead is located at the starting coordinates.

2:

Both ends. Arrowheads are located at the start and end coordinates.

x, y

-

Optional. Real values specifying the starting coordinates.

Returns:

(x1, y1, x2, y2) = ARRROWCUR( ) returns the start and end coordinates of the resulting arrow line.

Example:

1..100;

arrowcur(-1, 3, 0, 2);

 

brings up a dotted crosshair cursor with the color of the second series (i.e. the first overplot).

Example:

1..100;

arrowcur(lred, 1, 0, 30.0, 40.0);

 

brings up a solid red crosshair cursor with the first anchor point at 30.0, 40.0.

Remarks:

ARROWCUR brings up a crosshair cursor in the middle of the Window unless a starting x and y location are specified.

 

To move the cursor use the mouse, the arrow keys, or use the CTRL arrow key combinations for higher speed. Pressing the mouse button, ".", or [Enter] will anchor the first line segment. After moving to a new spot, pressing [Enter] or clicking the mouse button again will draw the arrow line from the anchor to the current position.

See Also:

ARROWDRAW

LINEANN

LINECOPY

LINECUR

LINEDEL

LINEDRAW

LINEMOVE