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

These are the methods and attributes for the plot axes.

See Tutorial::Plots for more information.

Methods

bottom_edge_type   bottom_edge_visible   left_edge_type   left_edge_visible   right_edge_type   right_edge_visible   show_axis   show_bottom_edge   show_edge   show_left_edge   show_right_edge   show_top_edge   show_xaxis   show_yaxis   top_edge_type   top_edge_visible   xaxis_digits_max   xaxis_line_width   xaxis_loc   xaxis_locations_for_major_ticks   xaxis_locations_for_minor_ticks   xaxis_log_values   xaxis_major_tick_length   xaxis_major_tick_width   xaxis_min_between_major_ticks   xaxis_minor_tick_length   xaxis_minor_tick_width   xaxis_number_of_minor_intervals   xaxis_numeric_label_alignment   xaxis_numeric_label_angle   xaxis_numeric_label_decimal_digits   xaxis_numeric_label_frequency   xaxis_numeric_label_justification   xaxis_numeric_label_phase   xaxis_numeric_label_scale   xaxis_numeric_label_shift   xaxis_numeric_label_tex   xaxis_reversed   xaxis_stroke_color   xaxis_tick_interval   xaxis_tick_labels   xaxis_ticks_inside   xaxis_ticks_outside   xaxis_type   xaxis_use_fixed_pt   xaxis_visible   yaxis_digits_max   yaxis_line_width   yaxis_loc   yaxis_locations_for_major_ticks   yaxis_locations_for_minor_ticks   yaxis_log_values   yaxis_major_tick_length   yaxis_major_tick_width   yaxis_min_between_major_ticks   yaxis_minor_tick_length   yaxis_minor_tick_width   yaxis_number_of_minor_intervals   yaxis_numeric_label_alignment   yaxis_numeric_label_angle   yaxis_numeric_label_decimal_digits   yaxis_numeric_label_frequency   yaxis_numeric_label_justification   yaxis_numeric_label_phase   yaxis_numeric_label_scale   yaxis_numeric_label_shift   yaxis_numeric_label_tex   yaxis_reversed   yaxis_stroke_color   yaxis_tick_interval   yaxis_tick_labels   yaxis_ticks_inside   yaxis_ticks_outside   yaxis_type   yaxis_use_fixed_pt   yaxis_visible  

Public Instance methods

Determines the axis type to use when showing the bottom edge of a plot. Valid types are the following predefined constants: AXIS_HIDDEN, AXIS_LINE_ONLY, AXIS_WITH_MAJOR_TICKS_ONLY, AXIS_WITH_TICKS_ONLY, AXIS_WITH_MAJOR_TICKS_AND_NUMERIC_LABELS, and AXIS_WITH_TICKS_AND_NUMERIC_LABELS.

If true, then it is okay for tioga to show the bottom edge of a plot. If false, then calls on show_bottom_edge 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 showing the x axis on the bottom; it only applies to calls on show_bottom_edge.

Determines the axis type to use when showing the left edge of a plot. Valid types are the following predefined constants: AXIS_HIDDEN, AXIS_LINE_ONLY, AXIS_WITH_MAJOR_TICKS_ONLY, AXIS_WITH_TICKS_ONLY, AXIS_WITH_MAJOR_TICKS_AND_NUMERIC_LABELS, and AXIS_WITH_TICKS_AND_NUMERIC_LABELS.

If true, then it is okay for tioga to show the left edge of a plot. If false, then calls on show_left_edge 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 showing the y axis on the left; it only applies to calls on show_left_edge.

Determines the axis type to use when showing the right edge of a plot. Valid types are the following predefined constants: AXIS_HIDDEN, AXIS_LINE_ONLY, AXIS_WITH_MAJOR_TICKS_ONLY, AXIS_WITH_TICKS_ONLY, AXIS_WITH_MAJOR_TICKS_AND_NUMERIC_LABELS, and AXIS_WITH_TICKS_AND_NUMERIC_LABELS.

If true, then it is okay for tioga to show the right edge of a plot. If false, then calls on show_right_edge 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 showing the y axis on the right; it only applies to calls on show_right_edge.

Show one of the plot axes. If loc is LEFT, RIGHT, or AT_X_ORIGIN, and yaxis_visible is true, then the axis is shown using the current y axis settings. If loc is TOP, BOTTOM, or AT_Y_ORIGIN, and xaxis_visible is true, then the axis is shown using the current x axis settings.

If the flag bottom_edge_visible is true and the xaxis_loc is not BOTTOM, then shows the bottom edge of the frame. Otherwise, simply returns.

Show one of the plot edges. The loc argument must be one of LEFT, RIGHT, TOP, or BOTTOM. Left and right edges are shown using the current y axis settings. Top and bottom edges are shown using the x axis settings. If the corresponding edge_visible attribute has been set false, this command simply returns without doing anything.

If the flag left_edge_visible is true and the yaxis_loc is not LEFT, then shows the left edge of the frame. Otherwise, simply returns.

If the flag right_edge_visible is true and the yaxis_loc is not RIGHT, then shows the right edge of the frame. Otherwise, simply returns.

If the flag top_edge_visible is true and the xaxis_loc is not TOP, then shows the top edge of the frame. Otherwise, simply returns.

If the flag xaxis_visible is currently true, then this routine shows the x axis at the location specified by xaxis_loc. If the flag is false, it simply returns.

If the flag yaxis_visible is currently true, then this routine shows the y axis at the location specified by yaxis_loc. If the flag is false, it simply returns.

Determines the axis type to use when showing the top edge of a plot. Valid types are the following predefined constants: AXIS_HIDDEN, AXIS_LINE_ONLY, AXIS_WITH_MAJOR_TICKS_ONLY, AXIS_WITH_TICKS_ONLY, AXIS_WITH_MAJOR_TICKS_AND_NUMERIC_LABELS, and AXIS_WITH_TICKS_AND_NUMERIC_LABELS.

If true, then it is okay for tioga to show the top edge of a plot. If false, then calls on show_top_edge 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 showing the x axis on the top; it only applies to calls on show_top_edge.

If non-zero (and xaxis_use_fixed_pt is not true), then x axis numeric labels will be switched to exponential format if they require more than this number of digits. If yaxis_digits_max is set to zero, then a system-choosen default value is used instead. See also xaxis_use_fixed_pt.

Value for the line_width attribute when painting the x axis line.

Determines the location of the x axis. Valid locations are given as the following predefined constants: BOTTOM, TOP, and AT_Y_ORIGIN.

If nil, then tioga will pick locations for major ticks on the x axis. Otherwise, this should be Dvector of locations in x figure coordinates in strictly increasing order.

If nil, then tioga will pick locations for minor ticks on the x axis. Otherwise, this should be Dvector of locations in x figure coordinates in strictly increasing order.

If true, then locations along the x axis are to be treated as log values (base 10). This changes both the default placing of tick marks and the appearance of numeric labels.

Length of major ticks on the x axis measured in units of the default text height.

Value for the line_width attribute when painting the x axis major tick marks.

When tioga picks the interval between major tick marks on the x axis, it will ensure that the interval is at least this large. Note that this distance is given in units of the default text height rather than in x coordinates.

Length of minor ticks on the x axis measured in units of the default text height.

Value for the line_width attribute when painting the x axis minor tick marks.

Determines the number of minor intervals making up the distance between major ticks marks on the x axis. If this is set to 0, then tioga will pick the number.

The alignment setting for numeric labels on the x axis. See also tex_xaxis_numeric_label.

Numeric labels on the x axis are rotated by this angle from vertical. See also tex_xaxis_numeric_label.

If non-negative, then use this number of digits after the decimal when creating numeric labels for the x axis. See also tex_xaxis_numeric_label.

The frequency setting for numeric labels on the x axis. Major ticks are numbered from 0 at the small x end of the axis. Tick number k gets a label only if mod(i+j,k)==0 where j=xaxis_numeric_label_phase and k=xaxis_numeric_label_frequency. The default for xaxis_numeric_label_frequency is 1 so that every major tick gets a label. See also xaxis_numeric_label_phase.

The justification setting for numeric labels on the x axis. See also tex_xaxis_numeric_label.

The phase setting for numeric labels on the x axis. The default phase is 0. See xaxis_numeric_label_frequency for details.

Scaling factor relative to default_text_scale for the numeric labels on the x axis in plots. See also tex_xaxis_numeric_label.

Distance to shift the reference point for showing numeric labels on the x axis measured in character heights with positive directed out away from the plot for x axis on top or bottom, or toward positive y values for x axis at y origin. See also tex_xaxis_numeric_label.

The string for a numeric label is put in this TeX command string to be formatted. For example, `$1$’ will give the numbers in math mode, while `$\mathsf{1}$’ will show the label using the math sans-serif font.

Flag is true if the bounds_left is not the bounds_xmin.

Value for the stroke_color attribute when painting the x axis.

If 0, then tioga will pick the interval between major tick marks on the x axis. Otherwise, this will be used as the interval in x coordinates for the spacing between major ticks.

If nil, then tioga will create numeric labels for the major ticks on the x axis. Otherwise, you must also specify xaxis_locations_for_major_ticks, and xaxis_tick_labels must be an equal length array of strings giving the corresponding labels.

See also yaxis_tick_labels.

If true, then ticks will be added along the x axis inside the plot frame. If false, then no ticks will appear inside the frame along the x axis.

If true, then ticks will be added along the x axis outside the plot frame. If false, then no ticks will appear outside the frame along the x axis.

Determines the axis type to use when showing the x axis of a plot. Valid types are the following predefined constants: AXIS_HIDDEN, AXIS_LINE_ONLY, AXIS_WITH_MAJOR_TICKS_ONLY, AXIS_WITH_TICKS_ONLY, AXIS_WITH_MAJOR_TICKS_AND_NUMERIC_LABELS, and AXIS_WITH_TICKS_AND_NUMERIC_LABELS.

If this flag is true, then numeric labels for the x axis will always use fixed point notation rather than exponential. If false, then the value of xaxis_digits_max will be used to decide between fixed point or exponential notation. See also xaxis_digits_max.

If true, then it is okay for tioga to show the x axis of a plot. If false, then calls on show_axis for the x axis 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 showing the top or bottom edges; it only applies to calls on show_axis.

If non-zero (and yaxis_use_fixed_pt is not true), then y axis numeric labels will be switched to exponential format if they require more than this number of digits. If yaxis_digits_max is set to zero, then a system-choosen default value is used instead. See also yaxis_use_fixed_pt.

Value for the line_width attribute when painting the y axis line.

Determines the location of the y axis. Valid locations are given as the following predefined constants: LEFT, RIGHT, and AT_X_ORIGIN.

If nil, then tioga will pick locations for major ticks on the y axis. Otherwise, this should be Dvector of locations in y figure coordinates in strictly increasing order.

See also yaxis_tick_labels.

If nil, then tioga will pick locations for minor ticks on the y axis. Otherwise, this should be Dvector of locations in x figure coordinates in strictly increasing order.

If true, then locations along the y axis are to be treated as log values (base 10). This changes both the default placing of tick marks and the appearance of numeric labels.

Length of major ticks on the y axis measured in units of the default text height.

Value for the line_width attribute when painting the y axis major tick marks.

When tioga picks the interval between major tick marks on the y axis, it will ensure that the interval is at least this large. Note that this distance is given in units of the default text height rather than in y coordinates.

Length of minor ticks on the y axis measured in units of the default text height.

Value for the line_width attribute when painting the y axis minor tick marks.

Determines the number of minor intervals making up the distance between major ticks marks on the y axis. If this is set to 0, then tioga will pick the number.

The alignment setting for numeric labels on the y axis. See also tex_yaxis_numeric_label.

Numeric labels on the y axis are rotated by this angle from horizontal. See also tex_yaxis_numeric_label.

If non-negative, then use this number of digits after the decimal when creating numeric labels for the y axis. See also tex_yaxis_numeric_label.

The frequency setting for numeric labels on the y axis. Major ticks are numbered from 0 at the small y end of the axis. Tick number k gets a label only if mod(i+j,k)==0 where j=yaxis_numeric_label_phase and k=yaxis_numeric_label_frequency. The default for yaxis_numeric_label_frequency is 1 so that every major tick gets a label. See also yaxis_numeric_label_phase.

The justification setting for numeric labels on the y axis.

The phase setting for numeric labels on the y axis. The default phase is 0. See yaxis_numeric_label_frequency for details.

Scaling factor relative to default_text_scale for the numeric labels on the y axis in plots. See also tex_yaxis_numeric_label.

Distance to shift the reference point for showing numeric labels on the y axis measured in character heights with positive directed out away from the plot for y axis on left or right, or toward positive x values for y axis at x origin. See also tex_yaxis_numeric_label.

The string for a numeric label is put in this TeX command string to be formatted. For example, `$1$’ will give the numbers in math mode, while `$\mathsf{1}$’ will show the label using the math sans-serif font.

Flag is true if the bounds_bottom is not the bounds_ymin.

Value for the stroke_color attribute when painting the y axis.

If 0, then tioga will pick the interval between major tick marks on the y axis. Otherwise, this will be used as the interval in y coordinates for the spacing between major ticks.

If nil, then tioga will create numeric labels for the major ticks on the y axis. Otherwise, you must also specify yaxis_locations_for_major_ticks, and yaxis_tick_labels must be an equal length array of strings giving the corresponding labels.

See also xaxis_tick_labels.

Examples

    def special_y
        t.ylabel_shift += 2
        t.do_box_labels('Special Y Axis', 'Position', 'Y Values')
        t.yaxis_numeric_label_angle = -90
        t.yaxis_locations_for_major_ticks = [
            -10.0, -6.0, -PI, 0.0, PI, 6.0, 10.0 ]
        t.yaxis_tick_labels = [
            "-IX", "-VI", "$-\\pi$", "$\\mathcal{ZERO}$", "$\\pi$", "VI", "IX" ]
        t.yaxis_type = AXIS_WITH_MAJOR_TICKS_AND_NUMERIC_LABELS
        t.stroke_color = Blue
        t.yaxis_numeric_label_justification = RIGHT_JUSTIFIED
        t.right_edge_type = AXIS_WITH_MAJOR_TICKS_ONLY
        t.yaxis_numeric_label_shift = 0
        xs = @positions; ys = @big_blues
        t.show_plot('boundaries' => plot_boundaries(xs,ys,@margin,-11, 11)) do
            t.append_points_to_path(xs,ys)
            t.stroke
        end
    end

If true, then ticks will be added along the y axis inside the plot frame. If false, then no ticks will appear inside the frame along the y axis.

If true, then ticks will be added along the y axis outside the plot frame. If false, then no ticks will appear outside the frame along the y axis.

Determines the axis type to use when showing the y axis of a plot. Valid types are the following predefined constants: AXIS_HIDDEN, AXIS_LINE_ONLY, AXIS_WITH_MAJOR_TICKS_ONLY, AXIS_WITH_TICKS_ONLY, AXIS_WITH_MAJOR_TICKS_AND_NUMERIC_LABELS, and AXIS_WITH_TICKS_AND_NUMERIC_LABELS.

If this flag is true, then numeric labels for the y axis will always use fixed point notation rather than exponential. If false, then the value of yaxis_digits_max will be used to decide between fixed point or exponential notation. See also yaxis_digits_max.

If true, then it is okay for tioga to show the y axis of a plot. If false, then calls on show_axis for the y axis 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 showing the left or right edges; it only applies to calls on show_axis.

[Validate]