next up previous 530
Next: LabelUp(axis) - Draw numerical axis labels upright?
Up: Descriptions of Plotting Attributes
Previous: LabelAt(axis) - Where to place numerical labels for a Plot


LabelUnits(axis) - Include unit descriptions in axis labels?

Description:
This attribute controls the appearance of annotated axes by determining whether the descriptive labels drawn for each axis should include a description of the units being used on the axis. It takes a separate value for each physical axis so that, for instance, the setting "LabelUnits(2)=1"  specifies that a unit description should be included in the label for the second axis.

If the LabelUnits value axis is non-zero, a unit description will be included in the descriptive label for that axis, otherwise it will be omitted. The default behaviour is to include a unit description unless the Frame  being annotated is a SkyFrame  (i.e. a celestial co-ordinate system), in which case it is omitted.


Type:
Integer (boolean).

Notes:
  • The text used for the unit description is obtained from Unit(axis)  attribute.

  • If no axis is specified, (e.g. LabelUnits instead of LabelUnits(2)), then both axes are affected.




next up previous 530
Next: LabelUp(axis) - Draw numerical axis labels upright?
Up: Descriptions of Plotting Attributes
Previous: LabelAt(axis) - Where to place numerical labels for a Plot

KAPPA --- Kernel Application Package
Starlink User Note 95
Malcolm J. Currie & David S. Berry
2013 February 14
E-mail:starlink@jiscmail.ac.uk

Copyright © 2013 Science and Technology Facilities Council