Class HittablePlottableDecorator

Namespace

ScottPlot.Plottables

Assembly

ScottPlot.dll

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

public class HittablePlottableDecorator : IPlottable, IDisposable

Inheritance

object

HittablePlottableDecorator

Implements

IPlottable

IDisposable

Derived

DraggablePlottableDecorator

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

DataSourceUtilities.BinarySearch<T, TList>(TList, int, int, T, IComparer<T>?)

DataSourceUtilities.GetClosestIndex<TValue, TList>(TList, TValue, IndexRange, IComparer<TValue>?)

Constructors

HittablePlottableDecorator(IPlottable)

public HittablePlottableDecorator(IPlottable plottable)

Parameters

plottable IPlottable

Properties

Axes

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.

public IAxes Axes { get; set; }

Property Value

IAxes

IsVisible

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).

public bool IsVisible { get; set; }

Property Value

bool

LegendItems

Items which will appear in the legend

public IEnumerable<LegendItem> LegendItems { get; }

Property Value

IEnumerable<LegendItem>

Source

public IPlottable Source { get; }

Property Value

IPlottable

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

GetAxisLimits()

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

public AxisLimits GetAxisLimits()

Returns

AxisLimits

IsHit(Pixel, float)

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

public bool IsHit(Pixel pixel, float radius)

Parameters

pixel Pixel

radius float

Returns

bool

Render(RenderPack)

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 virtual void Render(RenderPack rp)

Parameters

rp RenderPack