plot_axis Derived Type

type, public, abstract, extends(plot_object) :: plot_axis

Defines a plot axis object.


Contents

Type-Bound Procedures


Type-Bound Procedures

procedure, public :: get_autoscale => pa_get_autoscale

  • private pure function pa_get_autoscale(this) result(x)

    Gets a value determining if the axis should be automatically scaled to fit the data.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value logical

    Returns true if the axis should be automatically scaled; else, false.

procedure, public :: get_command_string => pa_get_cmd_string

  • private function pa_get_cmd_string(this) result(txt)

    Returns the appropriate GNUPLOT command string to define the plot_axis properties.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value character(len=:), allocatable

    The GNUPLOT command string.

procedure(pa_get_string_result), public, deferred :: get_id_string

  • function pa_get_string_result(this) result(x) Prototype

    Retrieves a string from a plot_axis.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value character(len=:), allocatable

    The string.

procedure, public :: get_is_log_scaled => pa_get_log_scale

  • private pure function pa_get_log_scale(this) result(x)

    Gets a logical value defining if the axis should be log scaled.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value logical

    Returns true if log scaling is applied to the axis; else, false.

procedure, public :: get_limits => pa_get_axis_limits

  • private pure function pa_get_axis_limits(this) result(x)

    Gets the axis display limits, assuming autoscaling is not active for this axis.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value real(kind=real64), dimension(2)

    A two-element array containing the limits as follows: [lower, upper].

procedure, public :: get_offset_tics => pa_get_offset_tics

  • private pure function pa_get_offset_tics(this) result(x)

    Gets a value determining if the tics should be offset.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value logical

    Returns true to offset the tics; else, set to false.

procedure, public :: get_show_tic_labels => pa_get_show_tic_labels

  • private pure function pa_get_show_tic_labels(this) result(x)

    Gets a value determining if tic labels should be shown.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value logical

    Returns true to show tic labels; else, set to false.

procedure, public :: get_tic_label_alignment => pa_get_tic_label_alignment

  • private pure function pa_get_tic_label_alignment(this) result(x)

    Gets the tic label alignment.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value character(len=:), allocatable

    The tic label alignment. The tic label alignment must be one of the following:

    • GNUPLOT_HORIZONTAL_ALIGN_LEFT

    • GNUPLOT_HORIZONTAL_ALIGN_CENTER

    • GNUPLOT_HORIZONTAL_ALIGN_RIGHT

procedure, public :: get_tic_label_angle => pa_get_tic_label_angle

  • private pure function pa_get_tic_label_angle(this) result(x)

    Gets the tic label angle, in degrees.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value real(kind=real32)

    The tic label angle, in degrees.

procedure, public :: get_tic_label_format => pa_get_tic_label_fmt

  • private pure function pa_get_tic_label_fmt(this) result(rst)

    Gets the tic label format. The format string can be any format string accepted by the C command 'printf.'

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value character(len=:), allocatable

    The tic label format string.

procedure, public :: get_tic_label_rotation_origin => pa_get_tic_rotation_origin

  • private pure function pa_get_tic_rotation_origin(this) result(x)

    Gets the tic label rotation origin.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value character(len=:), allocatable

    The tic label rotation origin. The tic label rotation origin must be one of the following:

    • GNUPLOT_ROTATION_ORIGIN_RIGHT

    • GNUPLOT_ROTATION_ORIGIN_LEFT

    • GNUPLOT_ROTATION_ORIGIN_CENTER

procedure, public :: get_tic_label_x_offset => pa_get_tic_x_offset

  • private pure function pa_get_tic_x_offset(this) result(x)

    Gets the tic label x-offset, in characters.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value integer(kind=int32)

    The tic label x-offset, in characters.

procedure, public :: get_tic_label_y_offset => pa_get_tic_y_offset

  • private pure function pa_get_tic_y_offset(this) result(x)

    Gets the tic label y-offset, in characters.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value integer(kind=int32)

    The tic label y-offset, in characters.

procedure, public :: get_title => pa_get_title

  • private function pa_get_title(this) result(txt)

    Gets the axis title.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value character(len=:), allocatable

    The title.

procedure, public :: get_title_x_offset => pa_get_title_x_offset

  • private pure function pa_get_title_x_offset(this) result(x)

    Gets the axis title x-offset, in characters.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value integer(kind=int32)

    The axis title x-offset, in characters.

procedure, public :: get_title_y_offset => pa_get_title_y_offset

  • private pure function pa_get_title_y_offset(this) result(x)

    Gets the axis title y-offset, in characters.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value integer(kind=int32)

    The axis title y-offset, in characters.

procedure, public :: get_use_default_tic_label_format => pa_get_use_dft_tic_lbl_fmt

  • private pure function pa_get_use_dft_tic_lbl_fmt(this) result(rst)

    Gets a value determining if the default tic label format will be used.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value logical

    Returns true if the default tic label format will be used; else, false.

procedure, public :: get_zero_axis => pa_get_zero_axis

  • private pure function pa_get_zero_axis(this) result(x)

    Gets a value determining if the axis should be drawn through zero of opposing axes.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value logical

    Returns true to draw as a zero axis; else, set to false.

procedure, public :: get_zero_axis_line_width => pa_get_zero_axis_width

  • private pure function pa_get_zero_axis_width(this) result(x)

    Gets the width of the line used to represent the zero axis line, if active.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value real(kind=real32)

    The width of the line, in pixels.

procedure, public :: is_title_defined => pa_has_title

  • private pure function pa_has_title(this) result(x)

    Gets a value determining if a title has been defined for this axis.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(in) :: this

    The plot_axis object.

    Return Value logical

    Returns true if a title has been defined; else, false.

procedure, public :: set_autoscale => pa_set_autoscale

  • private subroutine pa_set_autoscale(this, x)

    Sets a value determining if the axis should be automatically scaled to fit the data.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(inout) :: this

    The plot_axis object.
    logical, intent(in) :: x

    Set to true if the axis should be automatically scaled; else, set to false.

procedure, public :: set_is_log_scaled => pa_set_log_scale

  • private subroutine pa_set_log_scale(this, x)

    Sets a logical value defining if the axis should be log scaled.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(inout) :: this

    The plot_axis object.
    logical, intent(in) :: x

    Set to true if log scaling is applied to the axis; else, false.

procedure, public :: set_limits => pa_set_axis_limits

  • private subroutine pa_set_axis_limits(this, lower, upper)

    Gets the axis display limits, assuming autoscaling is not active for this axis.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(inout) :: this

    The plot_axis object.
    real(kind=real64), intent(in) :: lower

    The lower display limit.
    real(kind=real64), intent(in) :: upper

    The upper display limit.

procedure, public :: set_offset_tics => pa_set_offset_tics

  • private subroutine pa_set_offset_tics(this, x)

    Sets a value determining if the tics should be offset.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(inout) :: this

    The plot_axis object.
    logical, intent(in) :: x

    Set to true to offset the tics; else, set to false.

procedure, public :: set_show_tic_labels => pa_set_show_tic_labels

  • private subroutine pa_set_show_tic_labels(this, x)

    Sets a value determining if tic labels should be shown.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(inout) :: this

    The plot_axis object.
    logical, intent(in) :: x

    Set to true to show tic labels; else, set to false.

procedure, public :: set_tic_label_alignment => pa_set_tic_label_alignment

  • private subroutine pa_set_tic_label_alignment(this, x)

    Sets the tic label alignment.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(inout) :: this

    The plot_axis object.
    character(len=*), intent(in) :: x

    The tic label alignment. The tic label alignment must be one of the following:

    • GNUPLOT_HORIZONTAL_ALIGN_LEFT

    • GNUPLOT_HORIZONTAL_ALIGN_CENTER

    • GNUPLOT_HORIZONTAL_ALIGN_RIGHT

procedure, public :: set_tic_label_angle => pa_set_tic_label_angle

  • private subroutine pa_set_tic_label_angle(this, x)

    Sets the tic label angle, in degrees.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(inout) :: this

    The plot_axis object.
    real(kind=real32), intent(in) :: x

    The tic label angle, in degrees.

procedure, public :: set_tic_label_format => pa_set_tic_label_fmt

  • private subroutine pa_set_tic_label_fmt(this, x)

    Sets the tic label format. The format string can be any format string accepted by the C command 'printf.'

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(inout) :: this

    The plot_axis object.
    character(len=*), intent(in) :: x

    The tic label format string.

procedure, public :: set_tic_label_rotation_origin => pa_set_tic_rotation_origin

  • private subroutine pa_set_tic_rotation_origin(this, x)

    Sets the tic label rotation origin.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(inout) :: this

    The plot_axis object.
    character(len=*), intent(in) :: x

    The tic label rotation origin. The tic label rotation origin must be one of the following:

    • GNUPLOT_ROTATION_ORIGIN_RIGHT

    • GNUPLOT_ROTATION_ORIGIN_LEFT

    • GNUPLOT_ROTATION_ORIGIN_CENTER

procedure, public :: set_tic_label_x_offset => pa_set_tic_x_offset

  • private subroutine pa_set_tic_x_offset(this, x)

    Sets the tic label x-offset, in characters.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(inout) :: this

    The plot_axis object.
    integer(kind=int32), intent(in) :: x

    The tic label x-offset, in characters.

procedure, public :: set_tic_label_y_offset => pa_set_tic_y_offset

  • private subroutine pa_set_tic_y_offset(this, x)

    Sets the tic label y-offset, in characters.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(inout) :: this

    The plot_axis object.
    integer(kind=int32), intent(in) :: x

    The tic label y-offset, in characters.

procedure, public :: set_title => pa_set_title

  • private subroutine pa_set_title(this, txt)

    Sets the axis title.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(inout) :: this

    The plot_axis object.
    character(len=*), intent(in) :: txt

    The title.

procedure, public :: set_title_x_offset => pa_set_title_x_offset

  • private subroutine pa_set_title_x_offset(this, x)

    Sets the axis title x-offset, in characters.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(inout) :: this

    The plot_axis object.
    integer(kind=int32), intent(in) :: x

    The axis title x-offset, in characters.

procedure, public :: set_title_y_offset => pa_set_title_y_offset

  • private subroutine pa_set_title_y_offset(this, x)

    Sets the axis title y-offset, in characters.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(inout) :: this

    The plot_axis object.
    integer(kind=int32), intent(in) :: x

    The axis title y-offset, in characters.

procedure, public :: set_use_default_tic_label_format => pa_set_use_dft_tic_lbl_fmt

  • private subroutine pa_set_use_dft_tic_lbl_fmt(this, x)

    Sets a value determining if the default tic label format will be used.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(inout) :: this

    The plot_axis object.
    logical, intent(in) :: x

    Set to true if the default tic label format will be used; else, false.

procedure, public :: set_zero_axis => pa_set_zero_axis

  • private subroutine pa_set_zero_axis(this, x)

    Sets a value determining if the axis should be drawn through zero of opposing axes.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(inout) :: this

    The plot_axis object.
    logical, intent(in) :: x

    Set to true to draw as a zero axis; else, set to false.

procedure, public :: set_zero_axis_line_width => pa_set_zero_axis_width

  • private subroutine pa_set_zero_axis_width(this, x)

    Sets the width of the line used to represent the zero axis line, if active.

    Arguments

    Type IntentOptional Attributes Name
    class(plot_axis), intent(inout) :: this

    The plot_axis object.
    real(kind=real32), intent(in) :: x

    The width of the line, in pixels.