Defines a legend object. More...

Inheritance diagram for fplot_core::legend:

Public Member Functions
procedure, public	get_draw_inside_axes leg_get_inside
	Gets a value determining if the legend should be drawn inside the axes border (true), or outside the axes border (false).

procedure, public	set_draw_inside_axes leg_set_inside
	Sets a value determining if the legend should be drawn inside the axes border (true), or outside the axes border (false).

procedure, public	get_draw_border leg_get_box
	Gets a value determining if the legend should have a border.

procedure, public	set_draw_border leg_set_box
	Sets a value determining if the legend should have a border.

procedure, public	get_horizontal_position leg_get_horz_pos
	Gets the horizontal position of the legend.

procedure, public	set_horizontal_position leg_set_horz_pos
	Sets the horizontal position of the legend.

procedure, public	get_vertical_position leg_get_vert_pos
	Gets the vertical position of the legend.

procedure, public	set_vertical_position leg_set_vert_pos
	Gets the vertical position of the legend.

procedure, public	get_is_visible leg_get_visible
	Gets a value determining if the legend is visible.

procedure, public	set_is_visible leg_set_visible
	Sets a value determining if the legend is visible.

procedure, public	get_command_string leg_get_command_txt
	Gets the command string defining the legend properties.

procedure, public	get_layout leg_get_layout
	Gets the layout of the legend.

procedure, public	set_layout leg_set_layout
	Sets the layout of the legend.

procedure, public	get_is_opaque leg_get_opaque
	Gets a value determining if the legend is to be opaque.

procedure, public	set_is_opaque leg_set_opaque
	Sets a value determining if the legend is to be opaque.

Public Attributes
logical	m_box = .true.
	Draw a box around the legend.

character(len=20)	m_horzposition = LEGEND_RIGHT
	Defines the horizontal position.

character(len=20)	m_vertposition = LEGEND_TOP
	Defines the vertical position.

logical	m_show = .false.
	Determines if the legend is visible.

character(len=20)	m_layout = LEGEND_ARRANGE_VERTICALLY
	Determines the legend layout.

logical	m_opaque = .true.
	Opaque background?

Private Attributes
logical	m_inside = .true.
	Legend on inside or outside of axes.

Detailed Description

Defines a legend object.

Definition at line 2115 of file fplot_core.f90.

Member Function/Subroutine Documentation

◆ get_command_string()

procedure, public fplot_core::legend::get_command_string

virtual

Gets the command string defining the legend properties.

Syntax: character(len = :) function, allocatable get_command_string(class(legend) this)

Parameters

[in] this The legend object.

Returns: The GNUPLOT command string.

Implements fplot_core::plot_object.

Definition at line 2249 of file fplot_core.f90.

◆ get_draw_border()

procedure, public fplot_core::legend::get_draw_border

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

Syntax: pure logical function get_draw_border(class(legend) this)

Parameters

[in] this The legend object.

Returns: The logical value.

Definition at line 2163 of file fplot_core.f90.

◆ get_draw_inside_axes()

procedure, public fplot_core::legend::get_draw_inside_axes

Gets a value determining if the legend should be drawn inside the axes border (true), or outside the axes border (false).

Syntax: pure logical function get_draw_inside_axes(class(legend) this)

Parameters

[in] this The legend object.

Returns: The logical value.

Definition at line 2142 of file fplot_core.f90.

◆ get_horizontal_position()

procedure, public fplot_core::legend::get_horizontal_position

Gets the horizontal position of the legend.

Syntax: character(len = :) function, allocatable get_horizontal_position(class(legend) this)

Parameters

[in] this The legend object.

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

Definition at line 2184 of file fplot_core.f90.

◆ get_is_opaque()

procedure, public fplot_core::legend::get_is_opaque

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

Syntax: logical pure function get_is_opaque(class(legend) this)

Parameters

[in] this The legend object.

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

Definition at line 2281 of file fplot_core.f90.

◆ get_is_visible()

procedure, public fplot_core::legend::get_is_visible

Gets a value determining if the legend is visible.

Syntax: pure logical function get_is_visible(class(legend) this)

Parameters

[in] this The legend object.

Returns: The logical value.

Definition at line 2229 of file fplot_core.f90.

◆ get_layout()

procedure, public fplot_core::legend::get_layout

Gets the layout of the legend.

Syntax: character(len = :) pure function get_layout(class(legend) this)

Parameters

[in] this The legend object.

Returns: The layout type, either LEGEND_ARRANGE_VERTICALLY or LEGEND_ARRANGE_HORIZONTALLY.

Definition at line 2260 of file fplot_core.f90.

◆ get_vertical_position()

procedure, public fplot_core::legend::get_vertical_position

Gets the vertical position of the legend.

Syntax: character(len = :) function, allocatable get_vertical_position(class(legend) this)

Parameters

[in] this The legend object.

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

Definition at line 2207 of file fplot_core.f90.

◆ set_draw_border()

procedure, public fplot_core::legend::set_draw_border

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

Syntax: subroutine set_draw_border(class(legend) this, logical x)

Parameters

[in,out]	this	The legend object.
[in]	x	The logical value.

Definition at line 2173 of file fplot_core.f90.

◆ set_draw_inside_axes()

procedure, public fplot_core::legend::set_draw_inside_axes

Sets a value determining if the legend should be drawn inside the axes border (true), or outside the axes border (false).

Syntax: subroutine set_draw_inside_axes(class(legend) this, logical x)

Parameters

[in,out]	this	The legend object.
[in]	x	The logical value.

Definition at line 2153 of file fplot_core.f90.

◆ set_horizontal_position()

procedure, public fplot_core::legend::set_horizontal_position

Sets the horizontal position of the legend.

Syntax: subroutine set_horizontal_position(class(legend) this, character(len = *) x)

Parameters

[in,out]	this	The legend object.
	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.

Definition at line 2196 of file fplot_core.f90.

◆ set_is_opaque()

procedure, public fplot_core::legend::set_is_opaque

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

Syntax: subroutine set_is_opaque(class(legend) this)

Parameters

[in,out]	this	The legend object.
[in]	x	True if the legend is to be opaque; else, false.

Definition at line 2291 of file fplot_core.f90.

◆ set_is_visible()

procedure, public fplot_core::legend::set_is_visible

Sets a value determining if the legend is visible.

Syntax: subroutine set_is_visible(class(legend) this, logical x)

Parameters

[in,out]	this	The legend object.
[in]	x	The logical value.

Definition at line 2239 of file fplot_core.f90.

◆ set_layout()

procedure, public fplot_core::legend::set_layout

Sets the layout of the legend.

Syntax: subroutine set_layout(class(legend) this, character(len = *) x)

Parameters

[in,out]	this	The legend object.
[in]	x	The layout type, either LEGEND_ARRANGE_VERTICALLY or LEGEND_ARRANGE_HORIZONTALLY.

Definition at line 2271 of file fplot_core.f90.

◆ set_vertical_position()

procedure, public fplot_core::legend::set_vertical_position

Gets the vertical position of the legend.

Syntax: subroutine set_vertical_position(class(legend) this, character(len = *) x)

Parameters

[in,out]	this	The legend object.
	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.

Definition at line 2219 of file fplot_core.f90.

Member Data Documentation

◆ m_box

logical fplot_core::legend::m_box = .true.

Draw a box around the legend.

Definition at line 2120 of file fplot_core.f90.

◆ m_horzposition

character(len = 20) fplot_core::legend::m_horzposition = LEGEND_RIGHT

Defines the horizontal position.

Definition at line 2122 of file fplot_core.f90.

◆ m_inside

logical fplot_core::legend::m_inside = .true.

private

Legend on inside or outside of axes.

Definition at line 2118 of file fplot_core.f90.

◆ m_layout

character(len = 20) fplot_core::legend::m_layout = LEGEND_ARRANGE_VERTICALLY

Determines the legend layout.

Definition at line 2128 of file fplot_core.f90.

◆ m_opaque

logical fplot_core::legend::m_opaque = .true.

Opaque background?

Definition at line 2130 of file fplot_core.f90.

◆ m_show

logical fplot_core::legend::m_show = .false.

Determines if the legend is visible.

Definition at line 2126 of file fplot_core.f90.

◆ m_vertposition

character(len = 20) fplot_core::legend::m_vertposition = LEGEND_TOP

Defines the vertical position.

Definition at line 2124 of file fplot_core.f90.

The documentation for this type was generated from the following file:

D:/Code/fplot-1/src/fplot_core.f90

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ get_command_string()

◆ get_draw_border()

◆ get_draw_inside_axes()

◆ get_horizontal_position()

◆ get_is_opaque()

◆ get_is_visible()

◆ get_layout()

◆ get_vertical_position()

◆ set_draw_border()

◆ set_draw_inside_axes()

◆ set_horizontal_position()

◆ set_is_opaque()

◆ set_is_visible()

◆ set_layout()

◆ set_vertical_position()

Member Data Documentation

◆ m_box

◆ m_horzposition

◆ m_inside

◆ m_layout

◆ m_opaque

◆ m_show

◆ m_vertposition