C# Class NPlot.Windows.PlotSurface2D

Inheritance: System.Windows.Forms.Control, IPlotSurface2D

Mostrar archivo Open project: GridProtectionAlliance/openHistorian Class Usage Examples

Private Properties

Property	Type	Description
DrawHorizontalSelection	void
InitializeComponent	void
NPlot_PrintPage	void
drawDesignMode	void

Public Methods

Method	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

Protected Methods

Method	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

Method	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 method

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.
return	void

Add() public method

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)
return	void

AddAxesConstraint() public method

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.
return	void

AddInteraction() public method

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.
return	void

CacheAxes() public method

Remembers the current axes - useful in interactions.

public CacheAxes ( ) : void
return	void

Clear() public method

Clears the plot and resets to default values.

public Clear ( ) : void
return	void

CopyToClipboard() public method

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

public CopyToClipboard ( ) : void
return	void

Dispose() protected method

Clean up any resources being used.

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

DoMouseDown() public method

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.
return	void

DoMouseLeave() public method

public DoMouseLeave ( EventArgs e, Control ctr ) : void
e	System.EventArgs
ctr	System.Windows.Forms.Control
return	void

DoMouseMove() public method

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.
return	void

DoMouseUp() public method

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.
return	void

DoMouseWheel() public method

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.
return	void

DoPaint() public method

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
return	void

Draw() public method

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.
return	void

OnInteractionOccured() protected method

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

protected OnInteractionOccured ( object sender ) : void
sender	object
return	void

OnKeyDown() protected method

the key down callback

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

OnKeyUp() protected method

The key up callback.

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

OnMouseDown() protected method

Mouse down event handler.

protected OnMouseDown ( MouseEventArgs e ) : void
e	MouseEventArgs	the event args.
return	void

OnMouseLeave() protected method

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.
return	void

OnMouseMove() protected method

MouseMove event handler.

protected OnMouseMove ( MouseEventArgs e ) : void
e	MouseEventArgs	The event arguments.
return	void

OnMouseUp() protected method

mouse up event handler.

protected OnMouseUp ( MouseEventArgs e ) : void
e	MouseEventArgs	The event arguments.
return	void

OnMouseWheel() protected method

Mouse Wheel event handler.

protected OnMouseWheel ( MouseEventArgs e ) : void
e	MouseEventArgs	the event args
return	void

OnPaint() protected method

the paint event callback.

protected OnPaint ( PaintEventArgs pe ) : void
pe	PaintEventArgs	the PaintEventArgs
return	void

OnPreRefresh() protected method

Default function called just before a refresh happens.

protected OnPreRefresh ( object sender ) : void
sender	object
return	void

OriginalDimensions() public method

sets axes to be those saved in the cache.

public OriginalDimensions ( ) : void
return	void

PlotSurface2D() public method

Default constructor.

public PlotSurface2D ( ) : System
return	System

Print() public method

Print the chart as currently shown by the control

public Print ( bool preview ) : void
preview	bool	If true, show print preview window.
return	void

Refresh() public method

public Refresh ( ) : void
return	void

Remove() public method

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.
return	void

RemoveInteraction() public method

Remove a previously added interaction

public RemoveInteraction ( Interactions i ) : void
i	Interactions	interaction to remove
return	void