Struct RenderDetails

Namespace

ScottPlot

Assembly

ScottPlot.dll

Details about a completed render

public readonly struct RenderDetails

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Extension Methods

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

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

Constructors

RenderDetails(RenderPack, (string, TimeSpan)[], RenderDetails)

public RenderDetails(RenderPack rp, (string, TimeSpan)[] actionTimes, RenderDetails lastRender)

Parameters

rp RenderPack

actionTimes (string, TimeSpan)[]

lastRender RenderDetails

Fields

AxisLimits

Axis limits of the primary axes for this render

public readonly AxisLimits AxisLimits

Field Value

AxisLimits

AxisLimitsByAxis

Axis limits for every axis

public readonly Dictionary<IAxis, CoordinateRange> AxisLimitsByAxis

Field Value

Dictionary<IAxis, CoordinateRange>

Count

The number of total renders including this one

public readonly int Count

Field Value

int

DataRect

Size of the data area of the plot in pixel units

public readonly PixelRect DataRect

Field Value

PixelRect

Elapsed

Total time required to render this image

public readonly TimeSpan Elapsed

Field Value

TimeSpan

FigureRect

Size of the plot image in pixel units

public readonly PixelRect FigureRect

Field Value

PixelRect

Layout

Arrangement of all panels

public readonly Layout Layout

Field Value

Layout

Padding

Distance between the data area and the edge of the figure

public readonly PixelPadding Padding

Field Value

PixelPadding

PreviousAxisLimits

Axis limits of the primary axes for the previous render

public readonly AxisLimits PreviousAxisLimits

Field Value

AxisLimits

PreviousAxisLimitsByAxis

Axis limits of all axes from the previous render

public readonly Dictionary<IAxis, CoordinateRange> PreviousAxisLimitsByAxis

Field Value

Dictionary<IAxis, CoordinateRange>

TimedActions

Each step of the render and how long it took to execute

public readonly (string, TimeSpan)[] TimedActions

Field Value

(string, TimeSpan)[]

Timestamp

Time the render was completed

public readonly DateTime Timestamp

Field Value

DateTime

Properties

AxisLimitsChanged

Indicates whether the axis view (coordinate units) of this render differs from the previous

public bool AxisLimitsChanged { get; }

Property Value

bool

PxPerUnitX

public double PxPerUnitX { get; }

Property Value

double

PxPerUnitY

public double PxPerUnitY { get; }

Property Value

double

SizeChanged

Indicates whether the size (pixels) of this render differs from the previous

public bool SizeChanged { get; }

Property Value

bool

UnitsPerPxX

public double UnitsPerPxX { get; }

Property Value

double

UnitsPerPxY

public double UnitsPerPxY { get; }

Property Value

double

Methods

TryGetPixelPerUnitX(IXAxis?, out double)

Search the AxisLimitsByAxis for the specified axis and calculate the pixels per unit

public bool TryGetPixelPerUnitX(IXAxis? axis, out double value)

Parameters

axis IXAxis

the X-Axis to search for

value double

the pxPerUnitX

Returns

bool

true if the axis was in the collection and a result was calculated. Otherwise false
When false, the value will be set to PxPerUnitX

TryGetPixelPerUnitY(IYAxis?, out double)

Search the AxisLimitsByAxis for the specified axis and calculate the pixels per unit

public bool TryGetPixelPerUnitY(IYAxis? axis, out double value)

Parameters

axis IYAxis

the Y-Axis to search for

value double

the pxPerUnitX

Returns

bool

true if the axis was in the collection and a result was calculated. Otherwise false
When false, the value will be set to PxPerUnitY

TryGetUnitPerPixelX(IXAxis?, out double)

Search the AxisLimitsByAxis for the specified axis and calculate the pixels per unit

public bool TryGetUnitPerPixelX(IXAxis? axis, out double value)

Parameters

axis IXAxis

the X-Axis to search for

value double

the pxPerUnitX

Returns

bool

true if the axis was in the collection and a result was calculated. Otherwise false
When false, the value will be set to PxPerUnitX

TryGetUnitPerPixelY(IYAxis?, out double)

Search the AxisLimitsByAxis for the specified axis and calculate the pixels per unit

public bool TryGetUnitPerPixelY(IYAxis? axis, out double value)

Parameters

axis IYAxis

the Y-Axis to search for

value double

the pxPerUnitX

Returns

bool

true if the axis was in the collection and a result was calculated. Otherwise false
When false, the value will be set to PxPerUnitY