LabelUnits(axis)LabelUnitsaxis - Use axis unit descriptions in a Plot?

Description:
This attribute controls the appearance of an annotated coordinate grid (drawn with the astGridastGrid function) by determining whether the descriptive labels drawn for each axis of a PlotPlot should include a description of the units being used on the axis. It takes a separate value for each physical axis of a Plot 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 of a Plot 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 current FrameFrame of the Plot is a SkyFrameSkyFrame representing equatorial, ecliptic, galactic or supergalactic coordinates, in which case it is omitted.

Type:
Integer (boolean).
Class Applicability:
Plot
All Plots have this attribute.
Notes:
  • The text used for the unit description is obtained from the Plot's Unit(axis)Unitaxis attribute.

  • If no axis is specified, (e.g. "LabelUnits" instead of "LabelUnits(2)"), then a "set" or "clear" operation will affect the attribute value of all the Plot axes, while a "get" or "test" operation will use just the LabelUnits(1) value.

  • If the current Frame of the Plot is not a SkyFrame, but includes axes which were extracted from a SkyFrame, then the default behaviour is to include a unit description only for those axes which were not extracted from a SkyFrame.