ScottPlot.WPF.WpfPlotBase Class Reference

Inheritance diagram for ScottPlot.WPF.WpfPlotBase:

Public Member Functions
void	Refresh ()
	Render the plot and update the image.
	WpfPlotBase ()
void	Reset ()
	Disposes the current Plot and creates a new one for the control.
void	Reset (Plot newPlot)
	Loads the given Plot into the control.
void	ShowContextMenu (Pixel position)
	Launch the default pop-up menu (typically in response to a right-click) at the given position in the control.
float	DetectDisplayScale ()
	Determine the DPI scaling ratio of the present display. A value of 1.0 means no scaling, and 1.5 means 150% scaling. This operation may be costly so do not call it frequently.
Pixel	GetPlotPixelPosition (MouseEventArgs e)
	Returns the position of the mouse pointer relative to Plot drawing surface.
Pixel	GetCurrentPlotPixelPosition ()
	Returns the current position of the mouse pointer relative to Plot drawing surface.

Protected Member Functions
override void	OnKeyDown (KeyEventArgs e)
override void	OnKeyUp (KeyEventArgs e)

Properties
GRContext	GRContext [get]
	Context for hardware-accelerated graphics (or null if not available)
Plot	Plot [get, set]
	The primary Plot displayed by this interactive control.
IMultiplot	Multiplot [get, set]
	The multiplot managed by this interactive control.
float	DisplayScale [get, set]
	The value of the present display scaling. Mouse positions are multiplied by this value for pixel/coordinate conversions.
IPlotMenu?	Menu [get, set]
	Platform-specific logic for managing the context menu.
Interactivity.UserInputProcessor	UserInputProcessor [get]
	This object takes in UI events and contains logic for how to respond to them. This is a newer alternative to the older Interaction system.
FrameworkElement	PlotFrameworkElement [get]
Properties inherited from ScottPlot.IPlotControl

Constructor & Destructor Documentation

WpfPlotBase()

ScottPlot.WPF.WpfPlotBase.WpfPlotBase ( )

inline

Member Function Documentation

DetectDisplayScale()

float ScottPlot.WPF.WpfPlotBase.DetectDisplayScale ( )

inline

Determine the DPI scaling ratio of the present display. A value of 1.0 means no scaling, and 1.5 means 150% scaling. This operation may be costly so do not call it frequently.

Implements ScottPlot.IPlotControl.

GetCurrentPlotPixelPosition()

Pixel ScottPlot.WPF.WpfPlotBase.GetCurrentPlotPixelPosition ( )

inline

Returns the current position of the mouse pointer relative to Plot drawing surface.

Returns

The x and y coordinates in pixel of the mouse pointer position relative to Plot. The point (0,0) is the upper-left corner of the plot.

GetPlotPixelPosition()

Pixel ScottPlot.WPF.WpfPlotBase.GetPlotPixelPosition ( MouseEventArgs  e )

inline

Returns the position of the mouse pointer relative to Plot drawing surface.

Parameters

e	Provides data for mouse related routed events

Returns

The x and y coordinates in pixel of the mouse pointer position relative to Plot. The point (0,0) is the upper-left corner of the plot.

OnKeyDown()

override void ScottPlot.WPF.WpfPlotBase.OnKeyDown ( KeyEventArgs  e )

inlineprotected

OnKeyUp()

override void ScottPlot.WPF.WpfPlotBase.OnKeyUp ( KeyEventArgs  e )

inlineprotected

Refresh()

void ScottPlot.WPF.WpfPlotBase.Refresh ( )

abstract

Render the plot and update the image.

Implements ScottPlot.IPlotControl.

Reset() [1/2]

void ScottPlot.WPF.WpfPlotBase.Reset ( )

inline

Disposes the current Plot and creates a new one for the control.

Implements ScottPlot.IPlotControl.

Reset() [2/2]

void ScottPlot.WPF.WpfPlotBase.Reset ( Plot  plot )

inline

Loads the given Plot into the control.

Implements ScottPlot.IPlotControl.

ShowContextMenu()

void ScottPlot.WPF.WpfPlotBase.ShowContextMenu ( Pixel  position )

inline

Launch the default pop-up menu (typically in response to a right-click) at the given position in the control.

Implements ScottPlot.IPlotControl.

Property Documentation

DisplayScale

float ScottPlot.WPF.WpfPlotBase.DisplayScale

getset

The value of the present display scaling. Mouse positions are multiplied by this value for pixel/coordinate conversions.

Implements ScottPlot.IPlotControl.

GRContext

GRContext ScottPlot.WPF.WpfPlotBase.GRContext

getabstract

Context for hardware-accelerated graphics (or null if not available)

Implements ScottPlot.IPlotControl.

Menu

IPlotMenu? ScottPlot.WPF.WpfPlotBase.Menu

getset

Platform-specific logic for managing the context menu.

Implements ScottPlot.IPlotControl.

Multiplot

IMultiplot ScottPlot.WPF.WpfPlotBase.Multiplot

getset

The multiplot managed by this interactive control.

Implements ScottPlot.IPlotControl.

Plot

Plot ScottPlot.WPF.WpfPlotBase.Plot

getset

The primary Plot displayed by this interactive control.

Implements ScottPlot.IPlotControl.

PlotFrameworkElement

FrameworkElement ScottPlot.WPF.WpfPlotBase.PlotFrameworkElement

getabstractprotected

UserInputProcessor

Interactivity.UserInputProcessor ScottPlot.WPF.WpfPlotBase.UserInputProcessor

get

This object takes in UI events and contains logic for how to respond to them. This is a newer alternative to the older Interaction system.

Implements ScottPlot.IPlotControl.

---

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

• ScottPlot/src/ScottPlot5/ScottPlot5 Controls/ScottPlot.WPF/WpfPlotBase.cs