colormap Derived Type

type, public, extends(plot_object) :: colormap

A colormap object for a surface plot.


Type-Bound Procedures

procedure, public :: get_axes_origin => cm_get_axes_origin

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

    Gets the relative x-y coordinates of the axes origin.

    Arguments

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

    The colormap object.

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

    The [x, y] coordinates, each in [0.0, 1.0].

procedure, public :: get_axes_size => cm_get_axes_size

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

    Gets the relative width and height of the axes.

    Arguments

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

    The colormap object.

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

    The [width, height], each in [0.0, 1.0].

procedure(cm_get_string_result), public, deferred :: get_color_string

  • function cm_get_string_result(this) result(x) Prototype

    Retrieves a string result from a colormap object.

    Arguments

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

    The colormap object.

    Return Value character(len=:), allocatable

    The string.

procedure, public :: get_colorbar_length => cm_get_colorbar_length

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

    Gets the relative length of the colorbar.

    Arguments

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

    The colormap object.

    Return Value real(kind=real32)

    The length in [0.0, 1.0]; 0 uses GNUPLOT's default.

procedure, public :: get_colorbar_thickness => cm_get_colorbar_thickness

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

    Gets the relative thickness of the colorbar.

    Arguments

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

    The colormap object.

    Return Value real(kind=real32)

    The thickness in [0.0, 1.0]; 0 uses GNUPLOT's default.

procedure, public :: get_command_string => cm_get_cmd

  • private function cm_get_cmd(this) result(x)

    Gets the GNUPLOT command string to represent this colormap object.

    Arguments

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

    The colormap object.

    Return Value character(len=:), allocatable

    The command string.

procedure, public :: get_draw_border => cm_get_draw_border

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

    Gets a logical value determining if the border should be drawn.

    Arguments

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

    The colormap object.

    Return Value logical

    Returns true if the border should be drawn; else, false.

procedure, public :: get_horizontal => cm_get_horizontal

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

    Gets a logical value determining if the colormap should be drawn horizontally and below the plot.

    Arguments

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

    The colormap object.

    Return Value logical

    Returns true if the colormap should be drawn horizontally; else, false.

procedure, public :: get_label => cm_get_label

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

    Gets the label to associate with the colorbar.

    Arguments

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

    The colormap object.

    Return Value character(len=:), allocatable

    The label.

procedure, public :: get_show_tics => cm_get_show_tics

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

    Gets a logical value determining if the tic marks should be drawn.

    Arguments

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

    The colormap object.

    Return Value logical

    Returns true if the tic marks should be drawn; else, false.

procedure, public :: set_axes_origin => cm_set_axes_origin

  • private subroutine cm_set_axes_origin(this, x)

    Sets the axes origin coordinates, each clamped to [0.0, 1.0].

    Arguments

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

    The colormap object.
    real(kind=real32), intent(in), dimension(2) :: x

    The requested [x, y] coordinates.

procedure, public :: set_axes_size => cm_set_axes_size

  • private subroutine cm_set_axes_size(this, x)

    Sets the axes width and height, each clamped to [0.0, 1.0].

    Arguments

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

    The colormap object.
    real(kind=real32), intent(in), dimension(2) :: x

    The requested [width, height].

procedure, public :: set_colorbar_length => cm_set_colorbar_length

  • private subroutine cm_set_colorbar_length(this, x)

    Sets the relative colorbar length, clamped to [0.0, 1.0].

    Arguments

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

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

    The requested length; 0 uses GNUPLOT's default.

procedure, public :: set_colorbar_thickness => cm_set_colorbar_thickness

  • private subroutine cm_set_colorbar_thickness(this, x)

    Sets the relative colorbar thickness, clamped to [0.0, 1.0].

    Arguments

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

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

    The requested thickness; 0 uses GNUPLOT's default.

procedure, public :: set_draw_border => cm_set_draw_border

  • private subroutine cm_set_draw_border(this, x)

    Sets a logical value determining if the border should be drawn.

    Arguments

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

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

    Set to true if the border should be drawn; else, false.

procedure, public :: set_horizontal => cm_set_horizontal

  • private subroutine cm_set_horizontal(this, x)

    Sets a logical value determining if the colormap should be drawn horizontally and below the plot.

    Arguments

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

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

    Set to true if the colormap should be drawn horizontally; else, false.

procedure, public :: set_label => cm_set_label

  • private subroutine cm_set_label(this, x)

    Sets the label to associate with the colorbar.

    Arguments

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

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

    The label.

procedure, public :: set_show_tics => cm_set_show_tics

  • private subroutine cm_set_show_tics(this, x)

    Sets a logical value determining if the tic marks should be drawn.

    Arguments

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

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

    Set to true if the tic marks should be drawn; else, false.