Class Tioga::Titles_and_Labels
In: lib/Tioga/Titles_and_Labels.rb
Parent: Doc< FigureMaker

These are the methods and attributes for doing plot titles and axis labels.

Methods

Public Instance methods

Each argument, if it is not nil, is shown (using show_title, show_xlabel, or show_ylabel) and it‘s "visible" flag is set false to stop any later attempts to "reshow" it.

If the text argument is nil, then the current title attribute is used instead. If the flag title_visible is true and the text is not nil, then calls show_text with the text and the attributes controlling the appearance of the title (title_scale, title_shift, etc.).

If the text argument is nil, then the current xlabel attribute is used instead. If the flag xlabel_visible is true and the text is not nil, then calls show_text with the text and the attributes controlling the appearance of the x label (xlabel_position, xlabel_scale, etc.).

If the text argument is nil, then the current ylabel attribute is used instead. If the flag ylabel_visible is true and the text is not nil, then calls show_text with the text and the attributes controlling the appearance of the y label (ylabel_position, ylabel_scale, etc.).

The text to be used for the title, or nil indicating no title.

Defines the alignment for the title (default is ALIGNED_AT_BASELINE).

The angle of the baseline for the title with respect to the side of the frame (default is 0).

If not nil, then is used to add a TeX "\textcolor" specification to the title text.

Defines the justification for the title (default is CENTERED).

The fractional position along the edge of the frame for the title reference point. The default title_position is 0.5 with title_justification == CENTERED.

Defines the text size scale for the title (default is 1.1).

Defines the shift distance away from the frame edge for the reference point of the title measured in units of text heights (default title_shift is 0.7).

The side of the frame for the title (default is TOP).

If true, then it is okay for tioga to show the title of a plot. If false, then calls on show_title return immediately. This attribute is "one-way-only" in that it starts true and can be set false, but cannot be reset to true except by restoring the graphics state in which is was still true. This is intended to help control the behavior of plots when embedded as subplots in a larger configuration. Note that this does not effect calls on show_text; it only applies to calls on show_title.

The text to be used for the x axis label, or nil indicating no label.

Defines the alignment for the x label (default is ALIGNED_AT_BASELINE).

The angle of the baseline for the x label with respect to the side of the frame (default is 0).

If not nil, then is used to add a TeX "\textcolor" specification to the x label text.

Defines the justification for the x label (default is CENTERED).

The fractional position along the edge of the frame for the x label reference point. The default xlabel_position is 0.5 with xlabel_justification == CENTERED.

Defines the text size scale for the x label (default is 1.0).

Defines the shift distance away from the frame edge for the reference point of the x label measured in units of text heights (default xlabel_shift is 1.0).

The side of the frame for the x label (default is BOTTOM).

If true, then it is okay for tioga to show the x label of a plot. If false, then calls on show_xlabel return immediately. This attribute is "one-way-only" in that it starts true and can be set false, but cannot be reset to true except by restoring the graphics state in which is was still true. This is intended to help control the behavior of plots when embedded as subplots in a larger configuration. Note that this does not effect calls on show_text; it only applies to calls on show_xlabel.

The text to be used for the y axis label, or nil indicating no label.

Defines the alignment for the y label (default is ALIGNED_AT_BASELINE).

The angle of the baseline for the y label with respect to the side of the frame (default is 0).

If not nil, then is used to add a TeX "\textcolor" specification to the y label text.

Defines the justification for the y label (default is CENTERED).

The fractional position along the edge of the frame for the y label reference point. The default ylabel_position is 0.5 with ylabel_justification == CENTERED.

Defines the text size scale for the y label (default is 1.0).

Defines the shift distance away from the frame edge for the reference point of the y label measured in units of text heights (default ylabel_shift is 1.8).

The side of the frame for the y label (default is LEFT).

If true, then it is okay for tioga to show the y label of a plot. If false, then calls on show_ylabel return immediately. This attribute is "one-way-only" in that it starts true and can be set false, but cannot be reset to true except by restoring the graphics state in which is was still true. This is intended to help control the behavior of plots when embedded as subplots in a larger configuration. Note that this does not effect calls on show_text; it only applies to calls on show_ylabel.

[Validate]