ScottPlot.IPanel Interface Reference

A panel is a rectangular region outside the data area of a plot. Example panels include axes, colorbars, and titles. More...

Inheritance diagram for ScottPlot.IPanel:

Public Member Functions
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.
PixelRect	GetPanelRect (PixelRect dataRect, float size, float offset)
	Return the rectangle for this panel.

Properties
bool	IsVisible [get, set]
	If false, the panel will not be displayed or report any size.
float	MinimumSize [get, set]
	Disallow the panel to be smaller than this.
float	MaximumSize [get, set]
	Disallow the panel to be larger than this.
Edge	Edge [get]
	Indicates which edge of the data rectangle this panel lays on.
bool	ShowDebugInformation [get, set]
	Enable this to display extra information on the axis to facilitate development.

Detailed Description

A panel is a rectangular region outside the data area of a plot. Example panels include axes, colorbars, and titles.

Member Function Documentation

GetPanelRect()

PixelRect ScottPlot.IPanel.GetPanelRect	(	PixelRect	dataRect,
		float	size,
		float	offset
	)

Return the rectangle for this panel.

Implemented in ScottPlot.AxisPanels.XAxisBase, ScottPlot.AxisPanels.YAxisBase, ScottPlot.Panels.PanelBase, and ScottPlot.Panels.TitlePanel.

Measure()

float ScottPlot.IPanel.Measure

(

)

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

Returns

Implemented in ScottPlot.AxisPanels.Experimental.LeftAxisWithSubtitle, ScottPlot.AxisPanels.XAxisBase, ScottPlot.AxisPanels.YAxisBase, ScottPlot.Panels.PanelBase, and ScottPlot.Panels.TitlePanel.

Render()

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

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

Implemented in ScottPlot.AxisPanels.Experimental.LeftAxisWithSubtitle, ScottPlot.AxisPanels.XAxisBase, ScottPlot.AxisPanels.YAxisBase, ScottPlot.Panels.PanelBase, and ScottPlot.Panels.TitlePanel.

Property Documentation

Edge

Edge ScottPlot.IPanel.Edge

get

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

Implemented in ScottPlot.AxisPanels.BottomAxis, ScottPlot.AxisPanels.DateTimeXAxis, ScottPlot.AxisPanels.Experimental.LeftAxisWithSubtitle, ScottPlot.AxisPanels.LeftAxis, ScottPlot.AxisPanels.MirroredXAxis, ScottPlot.AxisPanels.MirroredYAxis, ScottPlot.AxisPanels.RightAxis, ScottPlot.AxisPanels.TopAxis, ScottPlot.Panels.PanelBase, and ScottPlot.Panels.TitlePanel.

IsVisible

bool ScottPlot.IPanel.IsVisible

getset

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

Implemented in ScottPlot.Panels.PanelBase, and ScottPlot.Panels.TitlePanel.

MaximumSize

float ScottPlot.IPanel.MaximumSize

getset

Disallow the panel to be larger than this.

Implemented in ScottPlot.Panels.PanelBase, and ScottPlot.Panels.TitlePanel.

MinimumSize

float ScottPlot.IPanel.MinimumSize

getset

Disallow the panel to be smaller than this.

Implemented in ScottPlot.Panels.PanelBase, and ScottPlot.Panels.TitlePanel.

ShowDebugInformation

bool ScottPlot.IPanel.ShowDebugInformation

getset

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

Implemented in ScottPlot.Panels.PanelBase, and ScottPlot.Panels.TitlePanel.

---

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

• ScottPlot/src/ScottPlot5/ScottPlot5/Interfaces/IPanel.cs