ScottPlot.Plottables.HittablePlottableDecorator Class Reference

This class wraps an IPlottable to give it a pixel-based hit detection map that can be used for mouse interaction. More...

Inheritance diagram for ScottPlot.Plottables.HittablePlottableDecorator:

Public Member Functions
AxisLimits	GetAxisLimits ()
	Return the 2D area (in coordinate space) occupied by the data contained in this plottable.
	HittablePlottableDecorator (IPlottable plottable)
bool	IsHit (Pixel pixel, float radius)
	Returns true if the plottable is within radius pixels of the given pixel
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.
void	Dispose ()

Properties
IPlottable	Source [get]
bool	IsVisible [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 [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.
Properties inherited from ScottPlot.IPlottable

Detailed Description

This class wraps an IPlottable to give it a pixel-based hit detection map that can be used for mouse interaction.

Constructor & Destructor Documentation

HittablePlottableDecorator()

ScottPlot.Plottables.HittablePlottableDecorator.HittablePlottableDecorator ( IPlottable  plottable )

inline

Member Function Documentation

Dispose()

void ScottPlot.Plottables.HittablePlottableDecorator.Dispose ( )

inline

GetAxisLimits()

AxisLimits ScottPlot.Plottables.HittablePlottableDecorator.GetAxisLimits

(

)

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

Implements ScottPlot.IPlottable.

IsHit()

bool ScottPlot.Plottables.HittablePlottableDecorator.IsHit ( Pixel  pixel, float  radius  )

inline

Returns true if the plottable is within radius pixels of the given pixel

Render()

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

IsVisible

bool ScottPlot.Plottables.HittablePlottableDecorator.IsVisible

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.

LegendItems

IEnumerable<LegendItem> ScottPlot.Plottables.HittablePlottableDecorator.LegendItems

get

Items which will appear in the legend.

Implements ScottPlot.IPlottable.

Source

IPlottable ScottPlot.Plottables.HittablePlottableDecorator.Source

get

---

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

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