ScottPlot
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Properties | List of all members
ScottPlot.RenderDetails Struct Reference

Details about a completed render. More...

Public Member Functions

 readonly (string, TimeSpan)[] TimedActions
 Each step of the render and how long it took to execute.
 
 RenderDetails (RenderPack rp,(string, TimeSpan)[] actionTimes, RenderDetails lastRender)
 
bool TryGetPixelPerUnitX (IXAxis? axis, out double value)
 Search the AxisLimitsByAxis for the specified axis and calculate the pixels per unit.
 
bool TryGetPixelPerUnitY (IYAxis? axis, out double value)
 Search the AxisLimitsByAxis for the specified axis and calculate the pixels per unit.
 
bool TryGetUnitPerPixelX (IXAxis? axis, out double value)
 Search the AxisLimitsByAxis for the specified axis and calculate the pixels per unit.
 
bool TryGetUnitPerPixelY (IYAxis? axis, out double value)
 Search the AxisLimitsByAxis for the specified axis and calculate the pixels per unit.
 

Public Attributes

readonly PixelRect FigureRect
 Size of the plot image in pixel units.
 
readonly PixelRect DataRect
 Size of the data area of the plot in pixel units.
 
readonly PixelPadding Padding
 Distance between the data area and the edge of the figure.
 
readonly TimeSpan Elapsed
 Total time required to render this image.
 
readonly DateTime Timestamp
 Time the render was completed.
 
readonly AxisLimits AxisLimits
 Axis limits of the primary axes for this render.
 
readonly AxisLimits PreviousAxisLimits
 Axis limits of the primary axes for the previous render.
 
readonly Dictionary< IAxis, CoordinateRange > AxisLimitsByAxis
 Axis limits for every axis.
 
readonly Dictionary< IAxis, CoordinateRange > PreviousAxisLimitsByAxis
 Axis limits of all axes from the previous render.
 
readonly Layout Layout
 Arrangement of all panels.
 
readonly int Count
 The number of total renders including this one.
 

Properties

readonly bool AxisLimitsChanged [get]
 Indicates whether the axis view (coordinate units) of this render differs from the previous.
 
readonly bool SizeChanged [get]
 Indicates whether the size (pixels) of this render differs from the previous.
 
double PxPerUnitX [get]
 
double PxPerUnitY [get]
 
double UnitsPerPxX [get]
 
double UnitsPerPxY [get]
 

Detailed Description

Details about a completed render.

Constructor & Destructor Documentation

◆ RenderDetails()

ScottPlot.RenderDetails.RenderDetails ( RenderPack  rp,
(string, TimeSpan)[]  actionTimes,
RenderDetails  lastRender 
)
inline

Member Function Documentation

◆ readonly()

ScottPlot.RenderDetails.readonly ( string  ,
TimeSpan   
)

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

◆ TryGetPixelPerUnitX()

bool ScottPlot.RenderDetails.TryGetPixelPerUnitX ( IXAxis?  axis,
out double  value 
)
inline

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

Parameters
axisthe X-Axis to search for
valuethe pxPerUnitX
Returns
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()

bool ScottPlot.RenderDetails.TryGetPixelPerUnitY ( IYAxis?  axis,
out double  value 
)
inline

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

Parameters
axisthe Y-Axis to search for
valuethe pxPerUnitX
Returns
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()

bool ScottPlot.RenderDetails.TryGetUnitPerPixelX ( IXAxis?  axis,
out double  value 
)
inline

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

Parameters
axisthe X-Axis to search for
valuethe pxPerUnitX
Returns
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()

bool ScottPlot.RenderDetails.TryGetUnitPerPixelY ( IYAxis?  axis,
out double  value 
)
inline

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

Parameters
axisthe Y-Axis to search for
valuethe pxPerUnitX
Returns
true if the axis was in the collection and a result was calculated. Otherwise false
When false, the value will be set to PxPerUnitY

Member Data Documentation

◆ AxisLimits

readonly AxisLimits ScottPlot.RenderDetails.AxisLimits

Axis limits of the primary axes for this render.

◆ AxisLimitsByAxis

readonly Dictionary<IAxis, CoordinateRange> ScottPlot.RenderDetails.AxisLimitsByAxis

Axis limits for every axis.

◆ Count

readonly int ScottPlot.RenderDetails.Count

The number of total renders including this one.

◆ DataRect

readonly PixelRect ScottPlot.RenderDetails.DataRect

Size of the data area of the plot in pixel units.

◆ Elapsed

readonly TimeSpan ScottPlot.RenderDetails.Elapsed

Total time required to render this image.

◆ FigureRect

readonly PixelRect ScottPlot.RenderDetails.FigureRect

Size of the plot image in pixel units.

◆ Layout

readonly Layout ScottPlot.RenderDetails.Layout

Arrangement of all panels.

◆ Padding

readonly PixelPadding ScottPlot.RenderDetails.Padding

Distance between the data area and the edge of the figure.

◆ PreviousAxisLimits

readonly AxisLimits ScottPlot.RenderDetails.PreviousAxisLimits

Axis limits of the primary axes for the previous render.

◆ PreviousAxisLimitsByAxis

readonly Dictionary<IAxis, CoordinateRange> ScottPlot.RenderDetails.PreviousAxisLimitsByAxis

Axis limits of all axes from the previous render.

◆ Timestamp

readonly DateTime ScottPlot.RenderDetails.Timestamp

Time the render was completed.

Property Documentation

◆ AxisLimitsChanged

readonly bool ScottPlot.RenderDetails.AxisLimitsChanged
get

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

◆ PxPerUnitX

double ScottPlot.RenderDetails.PxPerUnitX
get

◆ PxPerUnitY

double ScottPlot.RenderDetails.PxPerUnitY
get

◆ SizeChanged

readonly bool ScottPlot.RenderDetails.SizeChanged
get

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

◆ UnitsPerPxX

double ScottPlot.RenderDetails.UnitsPerPxX
get

◆ UnitsPerPxY

double ScottPlot.RenderDetails.UnitsPerPxY
get
The documentation for this struct was generated from the following file:
Generated by doxygen 1.9.8