#### Description:

This attribute controls the appearance of text strings and numerical labels drawn by the astGrid and (for the Plot class) astText functions, by determining if any escape sequences contained within the strings should be used to control the appearance of the text, or should be printed literally. Note, the Plot3D class only interprets escape sequences within the astGrid function.

If the Escape value of a Plot is one (the default), then any escape sequences in text strings produce the effects described below when printed. Otherwise, they are printed literally.

See also the astEscapes function.

Type:

  Integer (boolean).

#### Applicability

##### Plot

All Plots have this attribute.

#### Escape Sequences

Escape sequences are introduced into the text string by a percent `"` %`"` character. Any unrecognised, illegal or incomplete escape sequences are printed literally. The following escape sequences are currently recognised (`"` ...`"` represents a string of one or more decimal digits):

%% - Print a literal `"` %`"` character.

%`^`...+ - Draw subsequent characters as super-scripts. The digits `"` ...`"` give the distance from the base-line of `"` normal`"` text to the base-line of the super-script text, scaled so that a value of `"` 100`"` corresponds to the height of `"` normal`"` text. %`^`+ - Draw subsequent characters with the normal base-line.

%v...+ - Draw subsequent characters as sub-scripts. The digits `"` ...`"` give the distance from the base-line of `"` normal`"` text to the base-line of the sub-script text, scaled so that a value of `"` 100`"` corresponds to the height of `"` normal`"` text.

%v+ - Draw subsequent characters with the normal base-line (equivalent to %`^`+).

% >...+ - Leave a gap before drawing subsequent characters. The digits `"` ...`"` give the size of the gap, scaled so that a value of `"` 100`"` corresponds to the height of `"` normal`"` text.

% <...+ - Move backwards before drawing subsequent characters. The digits `"` ...`"` give the size of the movement, scaled so that a value of `"` 100`"` corresponds to the height of `"` normal`"` text.

%s...+ - Change the Size attribute for subsequent characters. The digits `"` ...`"` give the new Size as a fraction of the `"` normal`"` Size, scaled so that a value of `"` 100`"` corresponds to 1.0;

%s+ - Reset the Size attribute to its `"` normal`"` value.

%w...+ - Change the Width attribute for subsequent characters. The digits `"` ...`"` give the new width as a fraction of the `"` normal`"` Width, scaled so that a value of `"` 100`"` corresponds to 1.0;

%w+ - Reset the Size attribute to its `"` normal`"` value.

%f...+ - Change the Font attribute for subsequent characters. The digits `"` ...`"` give the new Font value.

%f+ - Reset the Font attribute to its `"` normal`"` value.

%c...+ - Change the Colour attribute for subsequent characters. The digits `"` ...`"` give the new Colour value.

%c+ - Reset the Colour attribute to its `"` normal`"` value.

%t...+ - Change the Style attribute for subsequent characters. The digits `"` ...`"` give the new Style value.

%t+ - Reset the Style attribute to its `"` normal`"` value.

%h+ - Remember the current horizontal position (see `"` %g+`"` )

%g+ - Go to the horizontal position of the previous `"` %h+`"` (if any).

%- - Push the current graphics attribute values onto the top of the stack (see `"` %+`"` ).

%+ - Pop attributes values of the top the stack (see `"` %-`"` ). If the stack is empty, `"` normal`"` attribute values are restored.

Copyright (C) 2021 East Asian Observatory