ScottPlot
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
ScottPlot.Plottables.Rectangle Class Reference
Inheritance diagram for ScottPlot.Plottables.Rectangle:
ScottPlot.IPlottable ScottPlot.IHasLine ScottPlot.IHasFill ScottPlot.IHasLegendText

Public Member Functions

AxisLimits GetAxisLimits ()
 Return the 2D area (in coordinate space) occupied by the data contained in this plottable.
 
virtual void Render (RenderPack rp)
 Draw the data from this plottable into the data area defined in the Axes. By default the surface is already clipped to the data area, but this can be cleared inside the plottable.
 

Properties

bool IsVisible = true [get, set]
 Toggles whether this plottable is shown and contributes to the automatic axis limit detection. The calling method will check this variable (it does not need to be checked inside the Render method).
 
IAxes Axes = new Axes() [get, set]
 This object performs coordinate/pixel translation at render time based on the latest data area. It stores the axes to use for this plottable and also the data area (in pixels) updated just before each render. If this object is null it will be constructed using the default X and Y axes at render time.
 
IEnumerable< LegendItemLegendItems [get]
 Items which will appear in the legend.
 
LineStyle LineStyle = new() { Width = 1 } [get, set]
 
float LineWidth [get, set]
 
LinePattern LinePattern [get, set]
 
Color LineColor [get, set]
 
FillStyle FillStyle = new() [get, set]
 
Color FillColor [get, set]
 
Color FillHatchColor [get, set]
 
IHatchFillHatch [get, set]
 
string Label [get, set]
 
string LegendText = string.Empty [get, set]
 If populated, this text appears in the legend.
 
double X1 [get, set]
 
double X2 [get, set]
 
double Y1 [get, set]
 
double Y2 [get, set]
 
CoordinateRect CoordinateRect [get, set]
 
- Properties inherited from ScottPlot.IPlottable
- Properties inherited from ScottPlot.IHasLine
- Properties inherited from ScottPlot.IHasFill
- Properties inherited from ScottPlot.IHasLegendText

Member Function Documentation

◆ GetAxisLimits()

AxisLimits ScottPlot.Plottables.Rectangle.GetAxisLimits ( )

Return the 2D area (in coordinate space) occupied by the data contained in this plottable.

Implements ScottPlot.IPlottable.

◆ Render()

virtual void ScottPlot.Plottables.Rectangle.Render ( RenderPack  rp)
inlinevirtual

Draw the data from this plottable into the data area defined in the Axes. By default the surface is already clipped to the data area, but this can be cleared inside the plottable.

Implements ScottPlot.IPlottable.

Property Documentation

◆ Axes

IAxes ScottPlot.Plottables.Rectangle.Axes = new Axes()
getset

This object performs coordinate/pixel translation at render time based on the latest data area. It stores the axes to use for this plottable and also the data area (in pixels) updated just before each render. If this object is null it will be constructed using the default X and Y axes at render time.

Implements ScottPlot.IPlottable.

◆ CoordinateRect

CoordinateRect ScottPlot.Plottables.Rectangle.CoordinateRect
getset

◆ FillColor

Color ScottPlot.Plottables.Rectangle.FillColor
getset

Implements ScottPlot.IHasFill.

◆ FillHatch

IHatch? ScottPlot.Plottables.Rectangle.FillHatch
getset

Implements ScottPlot.IHasFill.

◆ FillHatchColor

Color ScottPlot.Plottables.Rectangle.FillHatchColor
getset

Implements ScottPlot.IHasFill.

◆ FillStyle

FillStyle ScottPlot.Plottables.Rectangle.FillStyle = new()
getset

Implements ScottPlot.IHasFill.

◆ IsVisible

bool ScottPlot.Plottables.Rectangle.IsVisible = true
getset

Toggles whether this plottable is shown and contributes to the automatic axis limit detection. The calling method will check this variable (it does not need to be checked inside the Render method).

Implements ScottPlot.IPlottable.

◆ Label

string ScottPlot.Plottables.Rectangle.Label
getset

◆ LegendItems

IEnumerable<LegendItem> ScottPlot.Plottables.Rectangle.LegendItems
get

Items which will appear in the legend.

Implements ScottPlot.IPlottable.

◆ LegendText

string ScottPlot.Plottables.Rectangle.LegendText = string.Empty
getset

If populated, this text appears in the legend.

Implements ScottPlot.IHasLegendText.

◆ LineColor

Color ScottPlot.Plottables.Rectangle.LineColor
getset

Implements ScottPlot.IHasLine.

◆ LinePattern

LinePattern ScottPlot.Plottables.Rectangle.LinePattern
getset

Implements ScottPlot.IHasLine.

◆ LineStyle

LineStyle ScottPlot.Plottables.Rectangle.LineStyle = new() { Width = 1 }
getset

Implements ScottPlot.IHasLine.

◆ LineWidth

float ScottPlot.Plottables.Rectangle.LineWidth
getset

Implements ScottPlot.IHasLine.

◆ X1

double ScottPlot.Plottables.Rectangle.X1
getset

◆ X2

double ScottPlot.Plottables.Rectangle.X2
getset

◆ Y1

double ScottPlot.Plottables.Rectangle.Y1
getset

◆ Y2

double ScottPlot.Plottables.Rectangle.Y2
getset

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