ScottPlot
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Properties | List of all members
ScottPlot.Blazor.BlazorPlotBase Class Referenceabstract
Inheritance diagram for ScottPlot.Blazor.BlazorPlotBase:
ComponentBase ScottPlot.IPlotControl

Public Member Functions

 BlazorPlotBase ()
 
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.
 
void Reset ()
 Disposes the current Plot and creates a new one for the control.
 
void Reset (Plot plot)
 Loads the given Plot into the control.
 
virtual void Refresh ()
 Render the plot and update the image.
 
void ShowContextMenu (Pixel position)
 Launch the default pop-up menu (typically in response to a right-click) at the given position in the control.
 
void OnPointerMoved (PointerEventArgs e)
 
void OnPointerPressed (PointerEventArgs e)
 
void OnPointerReleased (PointerEventArgs e)
 
void OnPointerWheelChanged (WheelEventArgs e)
 
void OnKeyDown (KeyboardEventArgs e)
 
void OnKeyUp (KeyboardEventArgs e)
 

Public Attributes

EventHandler< Pixel >? MouseMoved
 
EventHandler<(Pixel, ScottPlot.Interactivity.MouseButton)>? MouseButtonPressed
 
EventHandler<(Pixel, ScottPlot.Interactivity.MouseButton)>? MouseButtonReleased
 
EventHandler<(Pixel, double)>? MouseWheelChanged
 
EventHandler< ScottPlot.Interactivity.Key >? KeyPressed
 
EventHandler< ScottPlot.Interactivity.Key >? KeyReleased
 

Properties

string Style = string.Empty [get, set]
 
bool EnableRenderLoop = false [get, set]
 
Plot Plot [get]
 The primary Plot displayed by this interactive control.
 
IMultiplot Multiplot [get, set]
 The multiplot managed by this interactive control.
 
IPlotMenuMenu [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.
 
GRContext? GRContext [get]
 Context for hardware-accelerated graphics (or null if not available)
 
float DisplayScale [get, set]
 The value of the present display scaling. Mouse positions are multiplied by this value for pixel/coordinate conversions.
 
- Properties inherited from ScottPlot.IPlotControl

Constructor & Destructor Documentation

◆ BlazorPlotBase()

ScottPlot.Blazor.BlazorPlotBase.BlazorPlotBase ( )
inline

Member Function Documentation

◆ DetectDisplayScale()

float ScottPlot.Blazor.BlazorPlotBase.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.

◆ OnKeyDown()

void ScottPlot.Blazor.BlazorPlotBase.OnKeyDown ( KeyboardEventArgs  e)
inline

◆ OnKeyUp()

void ScottPlot.Blazor.BlazorPlotBase.OnKeyUp ( KeyboardEventArgs  e)
inline

◆ OnPointerMoved()

void ScottPlot.Blazor.BlazorPlotBase.OnPointerMoved ( PointerEventArgs  e)
inline

◆ OnPointerPressed()

void ScottPlot.Blazor.BlazorPlotBase.OnPointerPressed ( PointerEventArgs  e)
inline

◆ OnPointerReleased()

void ScottPlot.Blazor.BlazorPlotBase.OnPointerReleased ( PointerEventArgs  e)
inline

◆ OnPointerWheelChanged()

void ScottPlot.Blazor.BlazorPlotBase.OnPointerWheelChanged ( WheelEventArgs  e)
inline

◆ Refresh()

virtual void ScottPlot.Blazor.BlazorPlotBase.Refresh ( )
inlinevirtual

Render the plot and update the image.

Implements ScottPlot.IPlotControl.

◆ Reset() [1/2]

void ScottPlot.Blazor.BlazorPlotBase.Reset ( )

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

Implements ScottPlot.IPlotControl.

◆ Reset() [2/2]

void ScottPlot.Blazor.BlazorPlotBase.Reset ( Plot  plot)
inline

Loads the given Plot into the control.

Implements ScottPlot.IPlotControl.

◆ ShowContextMenu()

void ScottPlot.Blazor.BlazorPlotBase.ShowContextMenu ( Pixel  position)

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

Implements ScottPlot.IPlotControl.

Member Data Documentation

◆ KeyPressed

EventHandler<ScottPlot.Interactivity.Key>? ScottPlot.Blazor.BlazorPlotBase.KeyPressed

◆ KeyReleased

EventHandler<ScottPlot.Interactivity.Key>? ScottPlot.Blazor.BlazorPlotBase.KeyReleased

◆ MouseButtonPressed

EventHandler<(Pixel, ScottPlot.Interactivity.MouseButton)>? ScottPlot.Blazor.BlazorPlotBase.MouseButtonPressed

◆ MouseButtonReleased

EventHandler<(Pixel, ScottPlot.Interactivity.MouseButton)>? ScottPlot.Blazor.BlazorPlotBase.MouseButtonReleased

◆ MouseMoved

EventHandler<Pixel>? ScottPlot.Blazor.BlazorPlotBase.MouseMoved

◆ MouseWheelChanged

EventHandler<(Pixel, double)>? ScottPlot.Blazor.BlazorPlotBase.MouseWheelChanged

Property Documentation

◆ DisplayScale

float ScottPlot.Blazor.BlazorPlotBase.DisplayScale
getset

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

Implements ScottPlot.IPlotControl.

◆ EnableRenderLoop

bool ScottPlot.Blazor.BlazorPlotBase.EnableRenderLoop = false
getset

◆ GRContext

GRContext? ScottPlot.Blazor.BlazorPlotBase.GRContext
get

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

Implements ScottPlot.IPlotControl.

◆ Menu

IPlotMenu? ScottPlot.Blazor.BlazorPlotBase.Menu
getset

Platform-specific logic for managing the context menu.

Implements ScottPlot.IPlotControl.

◆ Multiplot

IMultiplot ScottPlot.Blazor.BlazorPlotBase.Multiplot
getset

The multiplot managed by this interactive control.

Implements ScottPlot.IPlotControl.

◆ Plot

Plot ScottPlot.Blazor.BlazorPlotBase.Plot
get

The primary Plot displayed by this interactive control.

Implements ScottPlot.IPlotControl.

◆ Style

string ScottPlot.Blazor.BlazorPlotBase.Style = string.Empty
getset

◆ UserInputProcessor

Interactivity.UserInputProcessor ScottPlot.Blazor.BlazorPlotBase.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: