ScottPlot.Plottables.ContourLines Class Reference

Inheritance diagram for ScottPlot.Plottables.ContourLines:

Public Member Functions
AxisLimits	GetAxisLimits ()
	Return the 2D area (in coordinate space) occupied by the data contained in this plottable.
void	Update (IEnumerable< Coordinates3d > coordinates)
	Update contour lines from arbitrarily placed data points.
void	Update (Coordinates3d[,] coordinateGrid)
	Update contour lines from a rectangular grid of coordinates.
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.

Public Attributes
int	ContourLineCount = 10
	If defined, contour lines will be drawn at this height and ContourLineCount will be ignored.
double?[]	ContourLineLevels = null
	If defined, contour lines will be drawn at this height and ContourLineCount will be ignored.

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< LegendItem >	LegendItems [get]
	Items which will appear in the legend.
List< ContourLine >	Lines = [] [get]
LineStyle	LineStyle = new() { Width = 1, Color = Colors.Black } [get, set]
LabelStyle	LabelStyle = new() [get, set]
float	LineWidth [get, set]
LinePattern	LinePattern [get, set]
Color	LineColor [get, set]
IColormap?	Colormap = null [get, set]
double	MinZ [get]
double	MaxZ [get]
Properties inherited from ScottPlot.IPlottable
Properties inherited from ScottPlot.IHasLine

Member Function Documentation

GetAxisLimits()

AxisLimits ScottPlot.Plottables.ContourLines.GetAxisLimits

(

)

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

Implements ScottPlot.IPlottable.

Render()

virtual void ScottPlot.Plottables.ContourLines.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.

Update() [1/2]

void ScottPlot.Plottables.ContourLines.Update ( Coordinates3d  coordinateGrid[,] )

inline

Update contour lines from a rectangular grid of coordinates.

Update() [2/2]

void ScottPlot.Plottables.ContourLines.Update ( IEnumerable< Coordinates3d >  coordinates )

inline

Update contour lines from arbitrarily placed data points.

Member Data Documentation

ContourLineCount

int ScottPlot.Plottables.ContourLines.ContourLineCount = 10

If defined, contour lines will be drawn at this height and ContourLineCount will be ignored.

ContourLineLevels

double? [] ScottPlot.Plottables.ContourLines.ContourLineLevels = null

If defined, contour lines will be drawn at this height and ContourLineCount will be ignored.

Property Documentation

Axes

IAxes ScottPlot.Plottables.ContourLines.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.

Colormap

IColormap? ScottPlot.Plottables.ContourLines.Colormap = null

getset

IsVisible

bool ScottPlot.Plottables.ContourLines.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.

LabelStyle

LabelStyle ScottPlot.Plottables.ContourLines.LabelStyle = new()

getset

LegendItems

IEnumerable<LegendItem> ScottPlot.Plottables.ContourLines.LegendItems

get

Items which will appear in the legend.

Implements ScottPlot.IPlottable.

LineColor

Color ScottPlot.Plottables.ContourLines.LineColor

getset

Implements ScottPlot.IHasLine.

LinePattern

LinePattern ScottPlot.Plottables.ContourLines.LinePattern

getset

Implements ScottPlot.IHasLine.

Lines

List<ContourLine> ScottPlot.Plottables.ContourLines.Lines = []

get

LineStyle

LineStyle ScottPlot.Plottables.ContourLines.LineStyle = new() { Width = 1, Color = Colors.Black }

getset

Implements ScottPlot.IHasLine.

LineWidth

float ScottPlot.Plottables.ContourLines.LineWidth

getset

Implements ScottPlot.IHasLine.

MaxZ

double ScottPlot.Plottables.ContourLines.MaxZ

get

MinZ

double ScottPlot.Plottables.ContourLines.MinZ

get

---

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

• ScottPlot/src/ScottPlot5/ScottPlot5/Plottables/ContourLines.cs