LegendSpecs Class Reference

The class used to specify options for legend. More...

#include <LegendSpecs.hpp>

Inheritance diagram for LegendSpecs:

Collaboration diagram for LegendSpecs:

Public Member Functions
	LegendSpecs ()
	Construct a default LegendSpecs instance.
auto	opaque () -> LegendSpecs &
	Set the background of the legend box to be opaque.
auto	transparent () -> LegendSpecs &
	Set the background of the legend box to be transparent.
auto	atLeft () -> LegendSpecs &
	Place the legend on the inside of the plot at its left side.
auto	atRight () -> LegendSpecs &
	Place the legend on the inside of the plot at its right side.
auto	atCenter () -> LegendSpecs &
	Place the legend on the inside of the plot at its center.
auto	atTop () -> LegendSpecs &
	Place the legend on the inside of the plot at its top side.
auto	atTopLeft () -> LegendSpecs &
	Place the legend on the inside of the plot at its top-left corner.
auto	atTopRight () -> LegendSpecs &
	Place the legend on the inside of the plot at its top-right corner.
auto	atBottom () -> LegendSpecs &
	Place the legend on the inside of the plot at its bottom side.
auto	atBottomLeft () -> LegendSpecs &
	Place the legend on the inside of the plot at its bottom-left corner.
auto	atBottomRight () -> LegendSpecs &
	Place the legend on the inside of the plot at its bottom-right corner.
auto	atOutsideLeft () -> LegendSpecs &
	Place the legend on the outside of the plot at its left side.
auto	atOutsideLeftTop () -> LegendSpecs &
	Place the legend on the outside of the plot at its left-top corner.
auto	atOutsideLeftBottom () -> LegendSpecs &
	Place the legend on the outside of the plot at its left-bottom corner.
auto	atOutsideRight () -> LegendSpecs &
	Place the legend on the outside of the plot at its right side.
auto	atOutsideRightTop () -> LegendSpecs &
	Place the legend on the outside of the plot at its right-top corner.
auto	atOutsideRightBottom () -> LegendSpecs &
	Place the legend on the outside of the plot at its right-bottom corner.
auto	atOutsideBottom () -> LegendSpecs &
	Place the legend on the outside of the plot at its bottom side.
auto	atOutsideBottomLeft () -> LegendSpecs &
	Place the legend on the outside of the plot at its bottom-left corner.
auto	atOutsideBottomRight () -> LegendSpecs &
	Place the legend on the outside of the plot at its bottom-right corner.
auto	atOutsideTop () -> LegendSpecs &
	Place the legend on the outside of the plot at its top side.
auto	atOutsideTopLeft () -> LegendSpecs &
	Place the legend on the outside of the plot at its top-left corner.
auto	atOutsideTopRight () -> LegendSpecs &
	Place the legend on the outside of the plot at its top-right corner.
auto	titleLeft () -> LegendSpecs &
	Place the legend title on the left.
auto	titleCenter () -> LegendSpecs &
	Place the legend title on the center.
auto	titleRight () -> LegendSpecs &
	Place the legend title on the right.
auto	displayVertical () -> LegendSpecs &
	Set the legend entries to be displayed along the vertical (in columns).
auto	displayVerticalMaxRows (int value) -> LegendSpecs &
	Set the number of rows that trigger a new column to be created in the legend (when using vertical display).
auto	displayHorizontal () -> LegendSpecs &
	Set the legend entries to be displayed along the horizontal (in rows).
auto	displayHorizontalMaxCols (int value) -> LegendSpecs &
	Set the number of columns that trigger a new row to be created in the legend (when using horizontal display).
auto	displayLabelsBeforeSymbols () -> LegendSpecs &
	Set the labels in the legend entries to appear before their corresponding symbols (on the left).
auto	displayLabelsAfterSymbols () -> LegendSpecs &
	Set the labels in the legend entries to appear after their corresponding symbols (on the right).
auto	displayJustifyLeft () -> LegendSpecs &
	Set the legend labels to be left justified.
auto	displayJustifyRight () -> LegendSpecs &
	Set the legend labels to be right justified.
auto	displayStartFromFirst () -> LegendSpecs &
	Set the legend entries to be displayed in the order from first to last.
auto	displayStartFromLast () -> LegendSpecs &
	Set the legend entries to be displayed in the order from last to first.
auto	displaySpacing (int value) -> LegendSpecs &
	Set the spacing between the titles in the legend.
auto	displayExpandWidthBy (int value) -> LegendSpecs &
	Set the width increment/decrement of the legend frame to either enlarge or reduce its width.
auto	displayExpandHeightBy (int value) -> LegendSpecs &
	Set the height increment/decrement of the legend frame to either enlarge or reduce its height.
auto	displaySymbolLength (int value) -> LegendSpecs &
	Set the length of the samples used to generate the symbols in the legend entries.
auto	repr () const -> std::string
	Convert this LegendSpecs object into a gnuplot formatted string.
Public Member Functions inherited from TextSpecsOf< LegendSpecs >
	TextSpecsOf ()
	Construct a default TextSpecsOf instance.
auto	textColor (std::string color) -> LegendSpecs &
	Set the color of the text (e.g., "blue", "#404040")
auto	enhanced (bool value=true) -> LegendSpecs &
	Set the enhanced mode of the text. More...
auto	repr () const -> std::string
	Convert this TextSpecsOf object into a gnuplot formatted string.
Public Member Functions inherited from FontSpecsOf< LegendSpecs >
	FontSpecsOf ()
	Construct a default FontSpecsOf instance.
auto	fontName (std::string name) -> LegendSpecs &
	Set the name of the font (e.g., Helvetica, Georgia, Times).
auto	fontSize (std::size_t size) -> LegendSpecs &
	Set the point size of the font (e.g., 10, 12, 16).
Public Member Functions inherited from Specs< LegendSpecs >
virtual	~Specs ()=default
	Pure virtual destructor (this class is an abstract base class).
	operator std::string () const
	Return a string representation of this object of some class that derives from specs.
auto	derived () -> LegendSpecs &
	Return a reference to the specs object of class derived from this.
auto	derived () const -> const LegendSpecs &
	Return a const reference to the specs object of class derived from this.
Public Member Functions inherited from ShowSpecsOf< LegendSpecs >
	ShowSpecsOf ()
	Construct a default ShowSpecsOf instance.
auto	show (bool value=true) -> LegendSpecs &
	Set the visibility status of the plot element.
auto	hide () -> LegendSpecs &
	Set the visibility status of the plot element as hidden.
auto	isHidden () const -> bool
	Return true if the underlying plot element is hidden.
auto	repr () const -> std::string
	Convert this ShowSpecsOf object into a gnuplot formatted string.
Public Member Functions inherited from TitleSpecsOf< LegendSpecs >
	TitleSpecsOf ()
	Construct a default TitleSpecsOf instance.
auto	title (std::string title) -> LegendSpecs &
	Set the text of the title.
auto	titleShiftAlongX (double chars) -> LegendSpecs &
	Shift the title element along the x direction by given number of characters (can be fraction).
auto	titleShiftAlongY (double chars) -> LegendSpecs &
	Shift the title element along the y direction by given number of characters (can be fraction).
auto	titleShiftAlongGraphX (double val) -> LegendSpecs &
	Shift the title element along the x direction within the graph coordinate system.
auto	titleShiftAlongGraphY (double val) -> LegendSpecs &
	Shift the title element along the y direction within the graph coordinate system.
auto	titleShiftAlongScreenX (double val) -> LegendSpecs &
	Shift the title element along the x direction within the screen coordinate system.
auto	titleShiftAlongScreenY (double val) -> LegendSpecs &
	Shift the title element along the y direction within the screen coordinate system.
auto	titleTextColor (std::string color) -> LegendSpecs &
	Set the color of the title text (e.g., "blue", "#404040")
auto	titleFontName (std::string name) -> LegendSpecs &
	Set the font name of the title text (e.g., Helvetica, Georgia, Times).
auto	titleFontSize (int size) -> LegendSpecs &
	Set the font point size of the title text (e.g., 10, 12, 16).
auto	repr () const -> std::string
	Convert this TitleSpecsOf object into a gnuplot formatted string.
Public Member Functions inherited from FrameSpecsOf< LegendSpecs >
	FrameSpecsOf ()
	Construct a default FrameSpecsOf instance.
auto	frameShow (bool value=true) -> LegendSpecs &
	Set the visibility of the legend frame to a shown or hidden status.
auto	frameHide () -> LegendSpecs &
	Set the visibility of the legend frame to a hidden status.
auto	frameLineStyle (int value) -> LegendSpecs &
	Set the line style of the legend frame.
auto	frameLineType (int value) -> LegendSpecs &
	Set the line type of the legend frame.
auto	frameLineWidth (int value) -> LegendSpecs &
	Set the line width of the legend frame.
auto	frameLineColor (std::string value) -> LegendSpecs &
	Set the line color of the legend frame.
auto	frameDashType (int value) -> LegendSpecs &
	Set the dash type of the legend frame.
auto	repr () const -> std::string
	Convert this FrameSpecsOf object into a gnuplot formatted string.

Detailed Description

The class used to specify options for legend.

---

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

• sciplot/specs/LegendSpecs.hpp