Processing math: 100%

AST_FORMAT

Format a coordinate value for a Frame axis

Description:

This function returns a character string containing the formatted (character) version of a coordinate value for a Frame axis. The formatting applied is determined by the Frame s attributes and, in particular, by any Format attribute string that has been set for the axis. A suitable default format (based on the Digits attribute value) will be applied if necessary.

Invocation

RESULT = AST_FORMAT( THIS, AXIS, VALUE, STATUS )

Arguments

THIS = INTEGER (given)
Pointer to the Frame.
AXIS = INTEGER (Given)
The number of the Frame axis for which formatting is to be performed (axis numbering starts at 1 for the first axis).
VALUE = DOUBLE PRECISION (Given)
The coordinate value to be formatted.
STATUS = INTEGER (Given and Returned)
The global status.

Returned Value

AST_FORMAT = CHARACTER ( AST__SZCHR )
The formatted value.

Notes: