colormap Derived Type

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

A colormap object for a surface plot.


Contents

Type-Bound Procedures


Type-Bound Procedures

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_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_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.