next up previous 264
Next: LabelAt(axis) - Where to place numerical labels for a Plot
Up: AST Attribute Descriptions
Previous: LTOffset - The offset from UTC to Local Time, in hours


Label(axis) - Axis label

Description:
This attribute specifies a label to be attached to each axis of a Frame when it is represented (e.g.) in graphical output.

If a Label value has not been set for a Frame axis, then a suitable default is supplied.

Type:
String.
Class Applicability:
Frame
The default supplied by the Frame class is the string "Axis $<$n$>$", where $<$n$>$ is 1, 2, etc. for each successive axis.
SkyFrame
The SkyFrame class re-defines the default Label value (e.g. to "Right ascension" or "Galactic latitude") as appropriate for the particular celestial coordinate system being represented.
TimeFrame
The TimeFrame class re-defines the default Label value as appropriate for the particular time system being represented.
FrameSet
The Label attribute of a FrameSet axis is the same as that of its current Frame (as specified by the Current attribute).
Notes:
  • Axis labels are intended purely for interpretation by human readers and not by software.

  • When specifying this attribute by name, it should be subscripted with the number of the Frame axis to which it applies.


next up previous 264
Next: LabelAt(axis) - Where to place numerical labels for a Plot
Up: AST Attribute Descriptions
Previous: LTOffset - The offset from UTC to Local Time, in hours

AST A Library for Handling World Coordinate Systems in Astronomy
Starlink User Note 210
R.F. Warren-Smith & D.S. Berry
24th May 2011
E-mail:ussc@star.rl.ac.uk

Copyright (C) 2009 Science \& Technology Facilities Council