C# Class NPlot.Windows.PlotSurface2D

Inheritance: System.Windows.Forms.Control, IPlotSurface2D

Afficher le fichier Open project: GridProtectionAlliance/openHistorian Class Usage Examples

Private Properties

Свойство	Type	Description
DrawHorizontalSelection	void
InitializeComponent	void
NPlot_PrintPage	void
drawDesignMode	void

Méthodes publiques

Méthode	Description
Add ( IDrawable p ) : void	Adds a drawable object to the plot surface. If the object is an IPlot, the PlotSurface2D axes will also be updated.
Add ( IDrawable p, int zOrder ) : void	Adds a drawable object to the plot surface. If the object is an IPlot, the PlotSurface2D axes will also be updated.
AddAxesConstraint ( AxesConstraint c ) : void	Add an axis constraint to the plot surface. Axis constraints can specify relative world-pixel scalings, absolute axis positions etc.
AddInteraction ( Interactions i ) : void	Adds and interaction to the plotsurface that adds functionality that responds to a set of mouse / keyboard events.
CacheAxes ( ) : void	Remembers the current axes - useful in interactions.
Clear ( ) : void	Clears the plot and resets to default values.
CopyToClipboard ( ) : void	Coppies the chart currently shown in the control to the clipboard as an image.
DoMouseDown ( MouseEventArgs e ) : void	All functionality of the OnMouseDown function is contained here. This allows use of the all encompasing PlotSurface.
DoMouseLeave ( EventArgs e, Control ctr ) : void
DoMouseMove ( MouseEventArgs e, Control ctr ) : void	All functionality of the OnMouseMove function is contained here. This allows use of the all encompasing PlotSurface.
DoMouseUp ( MouseEventArgs e, Control ctr ) : void	All functionality of the OnMouseUp function is contained here. This allows use of the all encompasing PlotSurface.
DoMouseWheel ( MouseEventArgs e ) : void	All functionality of the OnMouseWheel function is containd here. This allows use of the all encompasing PlotSurface.
DoPaint ( PaintEventArgs pe, int width, int height ) : void	All functionality of the OnPaint method is provided by this function. This allows use of the all encompasing PlotSurface.
Draw ( Graphics g, Rectangle bounds ) : void	Draws the plot surface on the supplied graphics surface [not the control surface].
OriginalDimensions ( ) : void	sets axes to be those saved in the cache.
PlotSurface2D ( ) : System	Default constructor.
Print ( bool preview ) : void	Print the chart as currently shown by the control
Refresh ( ) : void
Remove ( IDrawable p, bool updateAxes ) : void	Remove a drawable object from the plot surface.
RemoveInteraction ( Interactions i ) : void	Remove a previously added interaction

Méthodes protégées

Méthode	Description
Dispose ( bool disposing ) : void	Clean up any resources being used.
OnInteractionOccured ( object sender ) : void	Default function called when plotsurface modifying interaction occured. Override this, or add method to InteractionOccured event.
OnKeyDown ( KeyEventArgs e ) : void	the key down callback
OnKeyUp ( KeyEventArgs e ) : void	The key up callback.
OnMouseDown ( MouseEventArgs e ) : void	Mouse down event handler.
OnMouseLeave ( EventArgs e ) : void	MouseLeave event handler. It has to invalidate the control to get rid of any remnant of vertical and horizontal guides.
OnMouseMove ( MouseEventArgs e ) : void	MouseMove event handler.
OnMouseUp ( MouseEventArgs e ) : void	mouse up event handler.
OnMouseWheel ( MouseEventArgs e ) : void	Mouse Wheel event handler.
OnPaint ( PaintEventArgs pe ) : void	the paint event callback.
OnPreRefresh ( object sender ) : void	Default function called just before a refresh happens.

Private Methods

Méthode	Description
DrawHorizontalSelection ( Point start, Point end, UserControl ctr ) : void
InitializeComponent ( ) : void	Required method for Designer support - do not modify the contents of this method with the code editor. Modified! :-)
NPlot_PrintPage ( object sender, System.Drawing.Printing.PrintPageEventArgs ev ) : void
drawDesignMode ( Graphics g, Rectangle bounds ) : void	Draw a lightweight representation of us for design mode.

Method Details

Add() public méthode

Adds a drawable object to the plot surface. If the object is an IPlot, the PlotSurface2D axes will also be updated.

public Add ( IDrawable p ) : void
p	IDrawable	The IDrawable object to add to the plot surface.
Résultat	void

Add() public méthode

Adds a drawable object to the plot surface. If the object is an IPlot, the PlotSurface2D axes will also be updated.

public Add ( IDrawable p, int zOrder ) : void
p	IDrawable	The IDrawable object to add to the plot surface.
zOrder	int	The z-ordering when drawing (objects with lower numbers are drawn first)
Résultat	void

AddAxesConstraint() public méthode

Add an axis constraint to the plot surface. Axis constraints can specify relative world-pixel scalings, absolute axis positions etc.

public AddAxesConstraint ( AxesConstraint c ) : void
c	NPlot.AxesConstraint	The axis constraint to add.
Résultat	void

AddInteraction() public méthode

Adds and interaction to the plotsurface that adds functionality that responds to a set of mouse / keyboard events.

public AddInteraction ( Interactions i ) : void
i	Interactions	the interaction to add.
Résultat	void

CacheAxes() public méthode

Remembers the current axes - useful in interactions.

public CacheAxes ( ) : void
Résultat	void

Clear() public méthode

Clears the plot and resets to default values.

public Clear ( ) : void
Résultat	void

CopyToClipboard() public méthode

Coppies the chart currently shown in the control to the clipboard as an image.

public CopyToClipboard ( ) : void
Résultat	void

Dispose() protected méthode

Clean up any resources being used.

protected Dispose ( bool disposing ) : void
disposing	bool
Résultat	void

DoMouseDown() public méthode

All functionality of the OnMouseDown function is contained here. This allows use of the all encompasing PlotSurface.

public DoMouseDown ( MouseEventArgs e ) : void
e	MouseEventArgs	The mouse event args from the window we are drawing to.
Résultat	void

DoMouseLeave() public méthode

public DoMouseLeave ( EventArgs e, Control ctr ) : void
e	System.EventArgs
ctr	System.Windows.Forms.Control
Résultat	void

DoMouseMove() public méthode

All functionality of the OnMouseMove function is contained here. This allows use of the all encompasing PlotSurface.

public DoMouseMove ( MouseEventArgs e, Control ctr ) : void
e	MouseEventArgs	The mouse event args from the window we are drawing to.
ctr	System.Windows.Forms.Control	The control that the mouse event happened in.
Résultat	void

DoMouseUp() public méthode

All functionality of the OnMouseUp function is contained here. This allows use of the all encompasing PlotSurface.

public DoMouseUp ( MouseEventArgs e, Control ctr ) : void
e	MouseEventArgs	The mouse event args from the window we are drawing to.
ctr	System.Windows.Forms.Control	The control that the mouse event happened in.
Résultat	void

DoMouseWheel() public méthode

All functionality of the OnMouseWheel function is containd here. This allows use of the all encompasing PlotSurface.

public DoMouseWheel ( MouseEventArgs e ) : void
e	MouseEventArgs	the event args.
Résultat	void

DoPaint() public méthode

All functionality of the OnPaint method is provided by this function. This allows use of the all encompasing PlotSurface.

public DoPaint ( PaintEventArgs pe, int width, int height ) : void
pe	PaintEventArgs	the PaintEventArgs from paint event.
width	int	width of the control
height	int	height of the control
Résultat	void

Draw() public méthode

Draws the plot surface on the supplied graphics surface [not the control surface].

public Draw ( Graphics g, Rectangle bounds ) : void
g	System.Drawing.Graphics	The graphics surface on which to draw
bounds	System.Drawing.Rectangle	A bounding box on this surface that denotes the area on the /// surface to confine drawing to.
Résultat	void

OnInteractionOccured() protected méthode

Default function called when plotsurface modifying interaction occured. Override this, or add method to InteractionOccured event.

protected OnInteractionOccured ( object sender ) : void
sender	object
Résultat	void

OnKeyDown() protected méthode

the key down callback

protected OnKeyDown ( KeyEventArgs e ) : void
e	System.Windows.Forms.KeyEventArgs	information pertaining to the event
Résultat	void

OnKeyUp() protected méthode

The key up callback.

protected OnKeyUp ( KeyEventArgs e ) : void
e	System.Windows.Forms.KeyEventArgs	information pertaining to the event
Résultat	void

OnMouseDown() protected méthode

Mouse down event handler.

protected OnMouseDown ( MouseEventArgs e ) : void
e	MouseEventArgs	the event args.
Résultat	void

OnMouseLeave() protected méthode

MouseLeave event handler. It has to invalidate the control to get rid of any remnant of vertical and horizontal guides.

protected OnMouseLeave ( EventArgs e ) : void
e	System.EventArgs	The event arguments.
Résultat	void

OnMouseMove() protected méthode

MouseMove event handler.

protected OnMouseMove ( MouseEventArgs e ) : void
e	MouseEventArgs	The event arguments.
Résultat	void

OnMouseUp() protected méthode

mouse up event handler.

protected OnMouseUp ( MouseEventArgs e ) : void
e	MouseEventArgs	The event arguments.
Résultat	void

OnMouseWheel() protected méthode

Mouse Wheel event handler.

protected OnMouseWheel ( MouseEventArgs e ) : void
e	MouseEventArgs	the event args
Résultat	void

OnPaint() protected méthode

the paint event callback.

protected OnPaint ( PaintEventArgs pe ) : void
pe	PaintEventArgs	the PaintEventArgs
Résultat	void

OnPreRefresh() protected méthode

Default function called just before a refresh happens.

protected OnPreRefresh ( object sender ) : void
sender	object
Résultat	void

OriginalDimensions() public méthode

sets axes to be those saved in the cache.

public OriginalDimensions ( ) : void
Résultat	void

PlotSurface2D() public méthode

Default constructor.

public PlotSurface2D ( ) : System
Résultat	System

Print() public méthode

Print the chart as currently shown by the control

public Print ( bool preview ) : void
preview	bool	If true, show print preview window.
Résultat	void

Refresh() public méthode

public Refresh ( ) : void
Résultat	void

Remove() public méthode

Remove a drawable object from the plot surface.

public Remove ( IDrawable p, bool updateAxes ) : void
p	IDrawable	the drawable to remove
updateAxes	bool	whether or not to update the axes after removing the idrawable.
Résultat	void

RemoveInteraction() public méthode

Remove a previously added interaction

public RemoveInteraction ( Interactions i ) : void
i	Interactions	interaction to remove
Résultat	void