ScottPlot.Panels.TitlePanel Class Reference

Inheritance diagram for ScottPlot.Panels.TitlePanel:

Public Member Functions
	TitlePanel ()
PixelRect	GetPanelRect (PixelRect dataRect, float size, float offset)
	Return the rectangle for this panel.
float	Measure ()
	Return the size (in pixels) of the panel in the dimension perpendicular to the edge it lays on.
void	Render (RenderPack rp, float size, float offset)
	Draw this panel on a canvas.

Public Attributes
float	VerticalPadding = 10
	Extra space to add above the title text so the title does not touch the edge of the image.

Properties
bool	IsVisible = true [get, set]
	If false, the panel will not be displayed or report any size.
Edge	Edge [get]
	Indicates which edge of the data rectangle this panel lays on.
bool	ShowDebugInformation = false [get, set]
	Enable this to display extra information on the axis to facilitate development.
float	MinimumSize = 0 [get, set]
	Disallow the panel to be smaller than this.
float	MaximumSize = float.MaxValue [get, set]
	Disallow the panel to be larger than this.
bool	FullFigureCenter = false [get, set]
	Enable this to center the panel using the full width of the figure rather than centering it over the width of the data area.
LabelStyle	Label [get]
Properties inherited from ScottPlot.IPanel

Constructor & Destructor Documentation

TitlePanel()

ScottPlot.Panels.TitlePanel.TitlePanel ( )

inline

Member Function Documentation

GetPanelRect()

PixelRect ScottPlot.Panels.TitlePanel.GetPanelRect ( PixelRect  dataRect, float  size, float  offset  )

inline

Return the rectangle for this panel.

Implements ScottPlot.IPanel.

Measure()

float ScottPlot.Panels.TitlePanel.Measure ( )

inline

Return the size (in pixels) of the panel in the dimension perpendicular to the edge it lays on.

Returns

Implements ScottPlot.IPanel.

Render()

void ScottPlot.Panels.TitlePanel.Render ( RenderPack  rp, float  size, float  offset  )

inline

Draw this panel on a canvas.

Parameters

surface	contains the canvas to draw on
dataRect	dimensions of the data area (pixel units)
size	size of this panel (pixel units)
offset	distance from the edge of this panel to the edge of the data area

Implements ScottPlot.IPanel.

Member Data Documentation

VerticalPadding

float ScottPlot.Panels.TitlePanel.VerticalPadding = 10

Extra space to add above the title text so the title does not touch the edge of the image.

Property Documentation

Edge

Edge ScottPlot.Panels.TitlePanel.Edge

get

Indicates which edge of the data rectangle this panel lays on.

Implements ScottPlot.IPanel.

FullFigureCenter

bool ScottPlot.Panels.TitlePanel.FullFigureCenter = false

getset

Enable this to center the panel using the full width of the figure rather than centering it over the width of the data area.

IsVisible

bool ScottPlot.Panels.TitlePanel.IsVisible = true

getset

If false, the panel will not be displayed or report any size.

Implements ScottPlot.IPanel.

Label

LabelStyle ScottPlot.Panels.TitlePanel.Label

get

Initial value:

= new()
    {
        Text = string.Empty,
        FontSize = 16,
        Bold = true,
        Alignment = Alignment.LowerCenter,
    }

MaximumSize

float ScottPlot.Panels.TitlePanel.MaximumSize = float.MaxValue

getset

Disallow the panel to be larger than this.

Implements ScottPlot.IPanel.

MinimumSize

float ScottPlot.Panels.TitlePanel.MinimumSize = 0

getset

Disallow the panel to be smaller than this.

Implements ScottPlot.IPanel.

ShowDebugInformation

bool ScottPlot.Panels.TitlePanel.ShowDebugInformation = false

getset

Enable this to display extra information on the axis to facilitate development.

Implements ScottPlot.IPanel.

---

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

• ScottPlot/src/ScottPlot5/ScottPlot5/Panels/TitlePanel.cs