Skip to content

Commit

Permalink
Merge pull request #761 from nexusformat/760-plot-title
Browse files Browse the repository at this point in the history
document plot title and axis labels
  • Loading branch information
prjemian authored Mar 4, 2020
2 parents 3789b09 + dae9592 commit fbc8c0c
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion base_classes/NXdata.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,25 @@
* The oldest method uses the ``axis`` attribute on each
*dimension scale* to identify
with an integer the axis whose value is the number of the dimension.

.. index: !plot; axis label
plot, axis units
units
dimension scale

Each axis of the plot may be labeled with information from the
dimension scale for that axis. The optional ``@long_name`` attribute
is provided as the axis label default. If ``@long_name`` is not
defined, then use the name of the dimension scale. A ``@units`` attribute,
if available, may be added to the axis label for further description.
See the section :ref:`Design-Units` for more information.

.. index: !plot; axis title

The optional ``title`` field, if available, provides a suggested
title for the plot. If no ``title`` field is found in the :ref:`NXdata`
group, look for a ``title`` field in the parent :ref:`NXentry` group,
with a fallback to displaying the path to the :ref:`NXdata` group.
</doc>
<field name="VARIABLE" type="NX_NUMBER" nameType="any">
<doc>
Expand Down Expand Up @@ -365,6 +384,11 @@
An optional offset to apply to the values in data.
</doc>
</field>
<field name="title">
<doc>
Title for the plot.
</doc>
</field>
<field name="x" type="NX_FLOAT" units="NX_ANY">
<doc>
This is an array holding the values to use for the x-axis of
Expand Down Expand Up @@ -393,4 +417,3 @@
</dimensions>
</field>
</definition>

0 comments on commit fbc8c0c

Please sign in to comment.