legend Derived Type

type, public, extends(plot_object) :: legend

Defines a legend object.


Contents

Type-Bound Procedures


Type-Bound Procedures

procedure, public :: get_command_string => leg_get_command_txt

  • private function leg_get_command_txt(this) result(txt)

    Gets the command string defining the legend properties.

    Arguments

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

    The legend object.

    Return Value character(len=:), allocatable

    The GNUPLOT command string.

procedure, public :: get_draw_border => leg_get_box

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

    Gets a value determining if the legend should have a border.

    Arguments

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

    The legend object.

    Return Value logical

    True if the legend should have a border; else, false.

procedure, public :: get_draw_inside_axes => leg_get_inside

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

    Gets a value determining if the legend should be drawn inside or outside the axes border.

    Arguments

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

    The legend object.

    Return Value logical

    True to draw inside the axes border; else, false for outside.

procedure, public :: get_horizontal_position => leg_get_horz_pos

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

    Gets the horizontal position of the legend.

    Arguments

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

    The legend object.

    Return Value character(len=:), allocatable

    The horizontal position of the legend (LEGEND_LEFT, LEGEND_CENTER, or LEGEND_RIGHT).

procedure, public :: get_is_opaque => leg_get_opaque

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

    Gets a value determining if the legend is to be opaque.

    Arguments

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

    The legend object.

    Return Value logical

    True if the legend is to be opaque; else, false.

procedure, public :: get_is_visible => leg_get_visible

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

    Gets a value determining if the legend is visible.

    Arguments

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

    The legend object.

    Return Value logical

    True if the legend is visible; else, false.

procedure, public :: get_layout => leg_get_layout

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

    Gets the layout of the legend.

    Arguments

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

    The legend object.

    Return Value character(len=:), allocatable

    The layout type, either LEGEND_ARRANGE_VERTICALLY or LEGEND_ARRANGE_HORIZONTALLY.

procedure, public :: get_vertical_position => leg_get_vert_pos

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

    Gets the vertical position of the legend.

    Arguments

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

    The legend object.

    Return Value character(len=:), allocatable

    The vertical position of the legend (LEGEND_TOP, LEGEND_CENTER, or LEGEND_BOTTOM).

procedure, public :: set_draw_border => leg_set_box

  • private subroutine leg_set_box(this, x)

    Sets a value determining if the legend should have a border.

    Arguments

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

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

    True if the legend should have a border; else, false.

procedure, public :: set_draw_inside_axes => leg_set_inside

  • private subroutine leg_set_inside(this, x)

    Sets a value determining if the legend should be drawn inside or outside the axes border.

    Arguments

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

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

    True to draw inside the axes border; else, false for outside.

procedure, public :: set_horizontal_position => leg_set_horz_pos

  • private subroutine leg_set_horz_pos(this, x)

    Sets the horizontal position of the legend.

    Arguments

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

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

    The horizontal position of the legend. The parameter must be set to one of the following: LEGEND_LEFT, LEGEND_CENTER, or LEGEND_RIGHT. If not, the default LEGEND_RIGHT will be used.

procedure, public :: set_is_opaque => leg_set_opaque

  • private subroutine leg_set_opaque(this, x)

    Sets a value determining if the legend is to be opaque.

    Arguments

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

    The legend object.
    logical :: x

    True if the legend is to be opaque; else, false.

procedure, public :: set_is_visible => leg_set_visible

  • private subroutine leg_set_visible(this, x)

    Sets a value determining if the legend is visible.

    Arguments

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

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

    True if the legend is visible; else, false.

procedure, public :: set_layout => leg_set_layout

  • private subroutine leg_set_layout(this, x)

    Sets the layout of the legend.

    Arguments

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

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

    The layout type, either LEGEND_ARRANGE_VERTICALLY or LEGEND_ARRANGE_HORIZONTALLY.

procedure, public :: set_vertical_position => leg_set_vert_pos

  • private subroutine leg_set_vert_pos(this, x)

    Sets the vertical position of the legend.

    Arguments

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

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

    The vertical position of the legend. The parameter must be set to one of the following: LEGEND_TOP, LEGEND_CENTER, or LEGEND_BOTTOM. If not, the default LEGEND_TOP will be used.