class Tioga::Titles_and_Labels
These are the methods and attributes for doing plot titles and axis labels.
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.
# File lib/Tioga/Titles_and_Labels.rb, line 32 def do_box_labels(title, xlabel, ylabel) end
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.).
# File lib/Tioga/Titles_and_Labels.rb, line 13 def show_title(text = nil) end
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.).
# File lib/Tioga/Titles_and_Labels.rb, line 20 def show_xlabel(text = nil) end
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.).
# File lib/Tioga/Titles_and_Labels.rb, line 27 def show_ylabel(text = nil) end
The text to be used for the title, or nil
indicating no title.
# File lib/Tioga/Titles_and_Labels.rb, line 283 def title end
Defines the alignment for the title (default is ALIGNED_AT_BASELINE
).
# File lib/Tioga/Titles_and_Labels.rb, line 136 def title_alignment end
The angle of the baseline for the title with respect to the side of the frame (default is 0).
# File lib/Tioga/Titles_and_Labels.rb, line 208 def title_angle end
If not nil
, then is used to add a TeX “textcolor” specification to the title text.
# File lib/Tioga/Titles_and_Labels.rb, line 184 def title_color end
Defines the justification for the title (default is CENTERED
).
# File lib/Tioga/Titles_and_Labels.rb, line 160 def title_justification end
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
.
# File lib/Tioga/Titles_and_Labels.rb, line 257 def title_position end
Defines the text size scale for the title (default is 1.1).
# File lib/Tioga/Titles_and_Labels.rb, line 112 def title_scale end
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).
# File lib/Tioga/Titles_and_Labels.rb, line 86 def title_shift end
The side of the frame for the title (default is TOP
).
# File lib/Tioga/Titles_and_Labels.rb, line 232 def title_side end
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.
# File lib/Tioga/Titles_and_Labels.rb, line 47 def title_visible end
The text to be used for the x axis label, or nil
indicating no label.
# File lib/Tioga/Titles_and_Labels.rb, line 291 def xlabel end
Defines the alignment for the x label (default is ALIGNED_AT_BASELINE
).
# File lib/Tioga/Titles_and_Labels.rb, line 144 def xlabel_alignment end
The angle of the baseline for the x label with respect to the side of the frame (default is 0).
# File lib/Tioga/Titles_and_Labels.rb, line 216 def xlabel_angle end
If not nil
, then is used to add a TeX “textcolor” specification to the x label text.
# File lib/Tioga/Titles_and_Labels.rb, line 192 def xlabel_color end
Defines the justification for the x label (default is CENTERED
).
# File lib/Tioga/Titles_and_Labels.rb, line 168 def xlabel_justification end
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
.
# File lib/Tioga/Titles_and_Labels.rb, line 266 def xlabel_position end
Defines the text size scale for the x label (default is 1.0).
# File lib/Tioga/Titles_and_Labels.rb, line 120 def xlabel_scale end
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).
# File lib/Tioga/Titles_and_Labels.rb, line 95 def xlabel_shift end
The side of the frame for the x label (default is BOTTOM
).
# File lib/Tioga/Titles_and_Labels.rb, line 240 def xlabel_side end
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.
# File lib/Tioga/Titles_and_Labels.rb, line 62 def xlabel_visible end
The text to be used for the y axis label, or nil
indicating no label.
# File lib/Tioga/Titles_and_Labels.rb, line 299 def ylabel end
Defines the alignment for the y label (default is ALIGNED_AT_BASELINE
).
# File lib/Tioga/Titles_and_Labels.rb, line 152 def ylabel_alignment end
The angle of the baseline for the y label with respect to the side of the frame (default is 0).
# File lib/Tioga/Titles_and_Labels.rb, line 224 def ylabel_angle end
If not nil
, then is used to add a TeX “textcolor” specification to the y label text.
# File lib/Tioga/Titles_and_Labels.rb, line 200 def ylabel_color end
Defines the justification for the y label (default is CENTERED
).
# File lib/Tioga/Titles_and_Labels.rb, line 176 def ylabel_justification end
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
.
# File lib/Tioga/Titles_and_Labels.rb, line 275 def ylabel_position end
Defines the text size scale for the y label (default is 1.0).
# File lib/Tioga/Titles_and_Labels.rb, line 128 def ylabel_scale end
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).
# File lib/Tioga/Titles_and_Labels.rb, line 104 def ylabel_shift end
The side of the frame for the y label (default is LEFT
).
# File lib/Tioga/Titles_and_Labels.rb, line 248 def ylabel_side end
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.
# File lib/Tioga/Titles_and_Labels.rb, line 77 def ylabel_visible end