plot_data_box_whisker Derived Type

type, public, extends(plot_data_colored) :: plot_data_box_whisker

A container for box-whisker plot data.


Contents

Type-Bound Procedures


Type-Bound Procedures

procedure, public :: define_data => pdbw_define_data_xstring

  • private subroutine pdbw_define_data_xstring(this, x, boxmin, boxmax, whiskermin, whiskermax, err)

    Defines the data set to plot.

    Arguments

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

    The plot_data_box_whisker object.
    type(string), intent(in), dimension(:) :: x

    The x-coordinate data.
    real(kind=real64), intent(in), dimension(size(x)) :: boxmin

    The minimum y-values for each box.
    real(kind=real64), intent(in), dimension(size(x)) :: boxmax

    The maximum y-values for each box.
    real(kind=real64), intent(in), dimension(size(x)) :: whiskermin

    The minimum y-values for each whisker.
    real(kind=real64), intent(in), dimension(size(x)) :: whiskermax

    The maximum y-values for each whisker.
    class(errors), intent(inout), optional, target :: err

    An error handling object.

procedure, public :: get_box_fill_opacity => pdbw_get_opacity

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

    Gets the opacity of the box fill color.

    Arguments

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

    The plot_data_box_whisker object.

    Return Value real(kind=real32)

    The opacity on a scale from 0 to 1.

procedure, public :: get_box_width => pdbw_get_box_width

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

    Gets the box width. By default the x-axis is incremented in units of 1; therefore, a box width of 1 will fully fill the space.

    Arguments

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

    The plot_data_box_whisker object.

    Return Value real(kind=real32)

    The box width.

procedure, public :: get_color_index => pdc_get_color_index

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

    Gets the color index.

    Arguments

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

    The plot_data_colored object.

    Return Value integer(kind=int32)

    The index value.

procedure, public :: get_command_string => pdbw_get_cmd

  • private function pdbw_get_cmd(this) result(rst)

    Gets the GNUPLOT command string for this object.

    Arguments

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

    The plot_data_box_whisker object.

    Return Value character(len=:), allocatable

    The command string.

procedure, public :: get_data_string => pdbw_get_data_cmd

  • private function pdbw_get_data_cmd(this) result(rst)

    Gets the GNUPLOT command string defining the data for this object.

    Arguments

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

    The plot_data_box_whisker object.

    Return Value character(len=:), allocatable

    The command string.

procedure, public :: get_draw_against_y2 => pdbw_get_use_y2

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

    Gets a value determining if the data is to be plotted against the secondary y axis.

    Arguments

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

    The plot_data_box_whisker object.

    Return Value logical

    Returns true if the data is to be plotted against the secondary y axis; else, false for the primary y axis.

procedure, public :: get_fill_boxes => pdbw_get_fill_boxes

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

    Gets a value determining if the boxes should be filled.

    Arguments

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

    The plot_data_box_whisker object.

    Return Value logical

    True if the boxes are to be filled; else, false.

procedure, public :: get_line_color => pdc_get_line_color

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

    Gets the object color.

    Arguments

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

    The plot_data_colored object.

    Return Value type(color)

    The color.

procedure, public :: get_line_width => pdbw_get_line_width

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

    Gets the width of the line, in pixels.

    Arguments

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

    The plot_data_box_whisker object.

    Return Value real(kind=real32)

    The line width.

procedure, public :: get_name => pd_get_name

  • private pure function pd_get_name(this) result(txt)

    Gets the name to associate with this data set.

    Arguments

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

    The plot_data object.

    Return Value character(len=:), allocatable

    The name.

procedure, public :: get_use_whiskerbars => pdbw_get_use_whiskerbars

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

    Gets a value determining if whiskerbars should be used.

    Arguments

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

    The plot_data_box_whisker object.

    Return Value logical

    True if whiskerbars should be used; else, false.

procedure, public :: get_whiskerbar_width => pdbw_get_whiskerbar_width

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

    Gets the width of whiskerbar.

    Arguments

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

    The plot_data_box_whisker object.

    Return Value real(kind=real32)

    The width of the whiskerbar on a scale of 0:1 with 1 being the full width.

procedure, public :: set_box_fill_opacity => pdbw_set_opacity

  • private subroutine pdbw_set_opacity(this, x)

    Sets the opacity of the box fill color.

    Arguments

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

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

    The opacity on a scale from 0 to 1.

procedure, public :: set_box_width => pdbw_set_box_width

  • private subroutine pdbw_set_box_width(this, x)

    Sets the box width. By default the x-axis is incremented in units of 1; therefore, a box width of 1 will fully fill the space.

    Arguments

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

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

    The box width.

procedure, public :: set_color_index => pdc_set_color_index

  • private subroutine pdc_set_color_index(this, x)

    Sets the color index.

    Arguments

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

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

    The index value.

procedure, public :: set_draw_against_y2 => pdbw_set_use_y2

  • private subroutine pdbw_set_use_y2(this, x)

    Sets a value determining if the data is to be plotted against the secondary y axis.

    Arguments

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

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

    Set to true if the data is to be plotted against the secondary y axis; else, false for the primary y axis.

procedure, public :: set_fill_boxes => pdbw_set_fill_boxes

  • private subroutine pdbw_set_fill_boxes(this, x)

    Sets a value determining if the boxes should be filled.

    Arguments

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

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

    Set to true if the boxes are to be filled; else, false.

procedure, public :: set_line_color => pdc_set_line_color

  • private subroutine pdc_set_line_color(this, x)

    Sets the object color.

    Arguments

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

    The plot_data_colored object.
    type(color), intent(in) :: x

    The color.

procedure, public :: set_line_width => pdbw_set_line_width

  • private subroutine pdbw_set_line_width(this, x)

    Sets the width of the line, in pixels.

    Arguments

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

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

    The line width.

procedure, public :: set_name => pd_set_name

  • private subroutine pd_set_name(this, txt)

    Sets the name to associate with this data set.

    Arguments

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

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

    The name.

procedure, public :: set_use_whiskerbars => pdbw_set_use_whiskerbars

  • private subroutine pdbw_set_use_whiskerbars(this, x)

    Sets a value determining if whiskerbars should be used.

    Arguments

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

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

    Set to true if whiskerbars should be used; else, false.

procedure, public :: set_whiskerbar_width => pdbw_set_whiskerbar_width

  • private subroutine pdbw_set_whiskerbar_width(this, x)

    Sets the width of the whiskerbar.

    Arguments

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

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

    The width of the whiskerbar. This value is clamped to [0, 1] with 1 representing full width.