ScottPlot.AxisPanels.AxisBase Class Reference

Inheritance diagram for ScottPlot.AxisPanels.AxisBase:

Public Member Functions
override string	ToString ()
void	Color (Color color)
	Apply a single color to all axis components: label, tick labels, tick marks, and frame.
void	SetTicks (double[] xs, string[] labels)
	Replace the TickGenerator with a NumericManual pre-loaded with the given ticks.

Static Public Member Functions
static void	DrawFrame (RenderPack rp, PixelRect panelRect, Edge edge, LineStyle lineStyle)
	Draw a line along the edge of an axis on the side of the data area.
static void	DrawTicks (RenderPack rp, LabelStyle label, PixelRect panelRect, IEnumerable< Tick > ticks, IAxis axis, TickMarkStyle majorStyle, TickMarkStyle minorStyle)

Properties
bool	IsVisible = true [get, set]
Edge	Edge [get]
virtual CoordinateRangeMutable	Range = CoordinateRangeMutable.NotSet [get]
float	MinimumSize = 0 [get, set]
float	MaximumSize = float.MaxValue [get, set]
float	SizeWhenNoData = 15 [get, set]
PixelPadding	EmptyLabelPadding = new(10, 5) [get, set]
PixelPadding	PaddingBetweenTickAndAxisLabels = new(5, 3) [get, set]
PixelPadding	PaddingOutsideAxisLabels = new(2, 2) [get, set]
bool	ClipLabel = false [get, set]
	Controls whether labels should be clipped to the boundaries of the data area.
double	Min [get, set]
double	Max [get, set]
virtual ITickGenerator	TickGenerator = null! [get, set]
LabelStyle	Label [get]
override LabelStyle	LabelStyle [get, set]
bool	ShowDebugInformation = false [get, set]
LineStyle	FrameLineStyle [get]
TickMarkStyle	MajorTickStyle [get, set]
TickMarkStyle	MinorTickStyle [get, set]
LabelStyle	TickLabelStyle [get, set]
Properties inherited from ScottPlot.LabelStyleProperties
LabelStyle	LabelStyle [get, set]
float	LabelOffsetX [get, set]
float	LabelOffsetY [get, set]
float	LabelRotation [get, set]
float	LabelPadding [set]
PixelPadding	LabelPixelPadding [get, set]
PixelRect	LabelLastRenderPixelRect [get]
string	LabelText [get, set]
Alignment	LabelAlignment [get, set]
string	LabelFontName [get, set]
float	LabelFontSize [get, set]
float?	LabelLineSpacing [get, set]
bool	LabelItalic [get, set]
bool	LabelBold [get, set]
Color	LabelFontColor [get, set]
Color	LabelBackgroundColor [get, set]
float	LabelBorderRadius [get, set]
float	LabelBorderRadiusX [get, set]
float	LabelBorderRadiusY [get, set]
float	LabelBorderWidth [get, set]
Color	LabelBorderColor [get, set]
Color	LabelShadowColor [get, set]
PixelOffset	LabelShadowOffset [get, set]
Properties inherited from ScottPlot.IHasLabel

Member Function Documentation

Color()

void ScottPlot.AxisPanels.AxisBase.Color ( Color  color )

inline

Apply a single color to all axis components: label, tick labels, tick marks, and frame.

DrawFrame()

static void ScottPlot.AxisPanels.AxisBase.DrawFrame ( RenderPack  rp, PixelRect  panelRect, Edge  edge, LineStyle  lineStyle  )

inlinestatic

Draw a line along the edge of an axis on the side of the data area.

DrawTicks()

static void ScottPlot.AxisPanels.AxisBase.DrawTicks ( RenderPack  rp, LabelStyle  label, PixelRect  panelRect, IEnumerable< Tick >  ticks, IAxis  axis, TickMarkStyle  majorStyle, TickMarkStyle  minorStyle  )

inlinestatic

SetTicks()

void ScottPlot.AxisPanels.AxisBase.SetTicks ( double[]  xs, string[]  labels  )

inline

Replace the TickGenerator with a NumericManual pre-loaded with the given ticks.

ToString()

override string ScottPlot.AxisPanels.AxisBase.ToString ( )

inline

Property Documentation

ClipLabel

bool ScottPlot.AxisPanels.AxisBase.ClipLabel = false

getset

Controls whether labels should be clipped to the boundaries of the data area.

Edge

Edge ScottPlot.AxisPanels.AxisBase.Edge

getabstract

EmptyLabelPadding

PixelPadding ScottPlot.AxisPanels.AxisBase.EmptyLabelPadding = new(10, 5)

getset

FrameLineStyle

LineStyle ScottPlot.AxisPanels.AxisBase.FrameLineStyle

get

Initial value:

= new()
    {
        Width = 1,
        Color = Colors.Black,
        AntiAlias = false,
    }

IsVisible

bool ScottPlot.AxisPanels.AxisBase.IsVisible = true

getset

Label

LabelStyle ScottPlot.AxisPanels.AxisBase.Label

get

LabelStyle

override LabelStyle ScottPlot.AxisPanels.AxisBase.LabelStyle

getset

Initial value:

= new()
    {
        Text = string.Empty,
        FontSize = 16,
        Bold = true,
        Rotation = -90,
    }

Implements ScottPlot.IHasLabel.

MajorTickStyle

TickMarkStyle ScottPlot.AxisPanels.AxisBase.MajorTickStyle

getset

Initial value:

= new()
    {
        Length = 4,
        Width = 1,
        Color = Colors.Black,
        AntiAlias = false,
    }

Max

double ScottPlot.AxisPanels.AxisBase.Max

getset

MaximumSize

float ScottPlot.AxisPanels.AxisBase.MaximumSize = float.MaxValue

getset

Min

double ScottPlot.AxisPanels.AxisBase.Min

getset

MinimumSize

float ScottPlot.AxisPanels.AxisBase.MinimumSize = 0

getset

MinorTickStyle

TickMarkStyle ScottPlot.AxisPanels.AxisBase.MinorTickStyle

getset

Initial value:

= new()
    {
        Length = 2,
        Width = 1,
        Color = Colors.Black,
        AntiAlias = false,
    }

PaddingBetweenTickAndAxisLabels

PixelPadding ScottPlot.AxisPanels.AxisBase.PaddingBetweenTickAndAxisLabels = new(5, 3)

getset

PaddingOutsideAxisLabels

PixelPadding ScottPlot.AxisPanels.AxisBase.PaddingOutsideAxisLabels = new(2, 2)

getset

Range

virtual CoordinateRangeMutable ScottPlot.AxisPanels.AxisBase.Range = CoordinateRangeMutable.NotSet

get

ShowDebugInformation

bool ScottPlot.AxisPanels.AxisBase.ShowDebugInformation = false

getset

SizeWhenNoData

float ScottPlot.AxisPanels.AxisBase.SizeWhenNoData = 15

getset

TickGenerator

virtual ITickGenerator ScottPlot.AxisPanels.AxisBase.TickGenerator = null!

getset

TickLabelStyle

LabelStyle ScottPlot.AxisPanels.AxisBase.TickLabelStyle

getset

Initial value:

= new()
    {
        Alignment = Alignment.MiddleCenter
    }

---

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

• ScottPlot/src/ScottPlot5/ScottPlot5/AxisPanels/AxisBase.cs