Class InteractiveLineSegment

Namespace

ScottPlot.Plottables.Interactive

Assembly

ScottPlot.dll

A straight line between two points

public class InteractiveLineSegment : IPlottable, IHasInteractiveHandles

Inheritance

object

InteractiveLineSegment

Implements

IPlottable

IHasInteractiveHandles

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

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

Color

public Color Color { set; }

Property Value

Color

Cursor

public Cursor Cursor { get; set; }

Property Value

Cursor

EndMarkerStyle

public MarkerStyle EndMarkerStyle { get; }

Property Value

MarkerStyle

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>

Line

public CoordinateLine Line { get; set; }

Property Value

CoordinateLine

LineStyle

public LineStyle LineStyle { get; }

Property Value

LineStyle

StartMarkerStyle

public MarkerStyle StartMarkerStyle { get; }

Property Value

MarkerStyle

Methods

GetAxisLimits()

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

public AxisLimits GetAxisLimits()

Returns

AxisLimits

GetHandle(CoordinateRect)

Return the interactive handle inside the rectangle

public InteractiveHandle? GetHandle(CoordinateRect rect)

Parameters

rect CoordinateRect

Returns

InteractiveHandle

MoveHandle(InteractiveHandle, Coordinates)

Called when the given handle has been moved (typically the result of a click-drag)

public virtual void MoveHandle(InteractiveHandle handle, Coordinates point)

Parameters

handle InteractiveHandle

point Coordinates

PressHandle(InteractiveHandle)

Called when the given handle has been pressed (typically the start of a drag)

public virtual void PressHandle(InteractiveHandle handle)

Parameters

handle InteractiveHandle

ReleaseHandle(InteractiveHandle)

Called when the given handle has been released (typically the end of a drag)

public virtual void ReleaseHandle(InteractiveHandle handle)

Parameters

handle InteractiveHandle

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