com::mxgraph::mxICanvas2D Interface Reference

Defines the requirements for a canvas that paints the vertices and edges of a graph. More...

Inheritance diagram for com::mxgraph::mxICanvas2D:

List of all members.

Public Member Functions
void	Save ()
	Saves the current state of the canvas.
void	Restore ()
	Restores the previous state of the canvas.
void	Scale (double value)
	Uniformaly scales the canvas by the given amount.
void	Translate (double dx, double dy)
	Translates the canvas by the given amount.
void	Rotate (double theta, bool flipH, bool flipV, double cx, double cy)
	Rotates the canvas by the given angle around the given center. This method may add rendering overhead and should be used with care.
void	SetGradient (string color1, string color2, double x, double y, double w, double h, string direction)
	Prepares the canvas to draw a gradient.
void	SetGlassGradient (double x, double y, double w, double h)
	Prepares the canvas to draw a glass gradient.
void	Rect (double x, double y, double w, double h)
	Next fill or stroke should draw a rectangle.
void	Roundrect (double x, double y, double w, double h, double dx, double dy)
	Next fill or stroke should draw a round rectangle.
void	Ellipse (double x, double y, double w, double h)
	Next fill or stroke should draw an ellipse.
void	Image (double x, double y, double w, double h, string src, bool aspect, bool flipH, bool flipV)
	Draws the given image.
void	Text (double x, double y, double w, double h, string str, string align, string valign, bool vertical, bool wrap, string format)
	Draws the given string. Possible values for format are empty string for.
void	Begin ()
	Begins a new path.
void	MoveTo (double x, double y)
	Moves to the given path.
void	LineTo (double x, double y)
	Draws a line to the given path.
void	QuadTo (double x1, double y1, double x2, double y2)
	Draws a quadratic curve to the given point.
void	CurveTo (double x1, double y1, double x2, double y2, double x3, double y3)
	Draws a bezier curve to the given point.
void	Close ()
	Closes the current path.
void	Stroke ()
	Paints the outline of the current path.
void	Fill ()
	Fills the current path.
void	FillAndStroke ()
	Fills and paints the outline of the current path.
void	Shadow (string value, bool filled)
	Paints the current path as a shadow.
void	Clip ()
	Uses the current path for clipping.
Properties
double	StrokeWidth [set]
	Sets the stroke width. This should default to 1 if unset.
string	StrokeColor [set]
	Sets the stroke color. This should default to mxConstants.NONE if unset.
bool	Dashed [set]
	Sets the dashed state. This should default to false if unset.
string	DashPattern [set]
	Sets the dash pattern. This should default to "3 3" if unset.
string	LineCap [set]
	Sets the linecap. This should default to "flat" if unset.
string	LineJoin [set]
	Sets the linejoin. This should default to "miter" if unset.
double	MiterLimit [set]
	Sets the miterlimit. This should default to 10 if unset.
double	FontSize [set]
	Default value mxConstants.DEFAULT_FONTSIZE.
string	FontColor [set]
	Default value "#000000".
string	FontFamily [set]
	Default value mxConstants#DEFAULT_FONTFAMILY.
int	FontStyle [set]
	Default value 0. See mxConstants#STYLE_FONTSTYLE.
double	Alpha [set]
	Default value 1. This method may add rendering overhead and should be used with care.
string	FillColor [set]
	Default value mxConstants#NONE.

---

Detailed Description

Defines the requirements for a canvas that paints the vertices and edges of a graph.

---

Member Function Documentation

void com::mxgraph::mxICanvas2D::Begin

(

)

Begins a new path.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::Clip

(

)

Uses the current path for clipping.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::Close

(

)

Closes the current path.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::CurveTo	(	double	x1,
		double	y1,
		double	x2,
		double	y2,
		double	x3,
		double	y3
	)

Draws a bezier curve to the given point.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::Ellipse	(	double	x,
		double	y,
		double	w,
		double	h
	)

Next fill or stroke should draw an ellipse.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::Fill

(

)

Fills the current path.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::FillAndStroke

(

)

Fills and paints the outline of the current path.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::Image	(	double	x,
		double	y,
		double	w,
		double	h,
		string	src,
		bool	aspect,
		bool	flipH,
		bool	flipV
	)

Draws the given image.

void com::mxgraph::mxICanvas2D::LineTo	(	double	x,
		double	y
	)

Draws a line to the given path.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::MoveTo	(	double	x,
		double	y
	)

Moves to the given path.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::QuadTo	(	double	x1,
		double	y1,
		double	x2,
		double	y2
	)

Draws a quadratic curve to the given point.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::Rect	(	double	x,
		double	y,
		double	w,
		double	h
	)

Next fill or stroke should draw a rectangle.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::Restore

(

)

Restores the previous state of the canvas.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::Rotate	(	double	theta,
		bool	flipH,
		bool	flipV,
		double	cx,
		double	cy
	)

Rotates the canvas by the given angle around the given center. This method may add rendering overhead and should be used with care.

Parameters:

	theta	Rotation angle in degrees (0 - 360).
	flipH	Specifies if drawing should be flipped horizontally.
	flipV	Specifies if drawing should be flipped vertically.
	cx	X-coordinate of the center point.
	cy	Y-coordinate of the center point.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::Roundrect	(	double	x,
		double	y,
		double	w,
		double	h,
		double	dx,
		double	dy
	)

Next fill or stroke should draw a round rectangle.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::Save

(

)

Saves the current state of the canvas.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::Scale

(

double

value

)

Uniformaly scales the canvas by the given amount.

Parameters:

value

The new scale value.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::SetGlassGradient	(	double	x,
		double	y,
		double	w,
		double	h
	)

Prepares the canvas to draw a glass gradient.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::SetGradient	(	string	color1,
		string	color2,
		double	x,
		double	y,
		double	w,
		double	h,
		string	direction
	)

Prepares the canvas to draw a gradient.

void com::mxgraph::mxICanvas2D::Shadow	(	string	value,
		bool	filled
	)

Paints the current path as a shadow.

void com::mxgraph::mxICanvas2D::Stroke

(

)

Paints the outline of the current path.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::Text	(	double	x,
		double	y,
		double	w,
		double	h,
		string	str,
		string	align,
		string	valign,
		bool	vertical,
		bool	wrap,
		string	format
	)

Draws the given string. Possible values for format are empty string for.

Implemented in com::mxgraph::mxGdiCanvas2D.

void com::mxgraph::mxICanvas2D::Translate	(	double	dx,
		double	dy
	)

Translates the canvas by the given amount.

Parameters:

	dx	X-coordinate of the translation.
	dy	Y-coordinate of the translation.

Implemented in com::mxgraph::mxGdiCanvas2D.

---

Property Documentation

double com::mxgraph::mxICanvas2D::Alpha [set]

Default value 1. This method may add rendering overhead and should be used with care.

Implemented in com::mxgraph::mxGdiCanvas2D.

bool com::mxgraph::mxICanvas2D::Dashed [set]

Sets the dashed state. This should default to false if unset.

Implemented in com::mxgraph::mxGdiCanvas2D.

string com::mxgraph::mxICanvas2D::DashPattern [set]

Sets the dash pattern. This should default to "3 3" if unset.

Implemented in com::mxgraph::mxGdiCanvas2D.

string com::mxgraph::mxICanvas2D::FillColor [set]

Default value mxConstants#NONE.

Implemented in com::mxgraph::mxGdiCanvas2D.

string com::mxgraph::mxICanvas2D::FontColor [set]

Default value "#000000".

Implemented in com::mxgraph::mxGdiCanvas2D.

string com::mxgraph::mxICanvas2D::FontFamily [set]

Default value mxConstants#DEFAULT_FONTFAMILY.

Implemented in com::mxgraph::mxGdiCanvas2D.

double com::mxgraph::mxICanvas2D::FontSize [set]

Default value mxConstants.DEFAULT_FONTSIZE.

Implemented in com::mxgraph::mxGdiCanvas2D.

int com::mxgraph::mxICanvas2D::FontStyle [set]

Default value 0. See mxConstants#STYLE_FONTSTYLE.

Implemented in com::mxgraph::mxGdiCanvas2D.

string com::mxgraph::mxICanvas2D::LineCap [set]

Sets the linecap. This should default to "flat" if unset.

Implemented in com::mxgraph::mxGdiCanvas2D.

string com::mxgraph::mxICanvas2D::LineJoin [set]

Sets the linejoin. This should default to "miter" if unset.

Implemented in com::mxgraph::mxGdiCanvas2D.

double com::mxgraph::mxICanvas2D::MiterLimit [set]

Sets the miterlimit. This should default to 10 if unset.

Implemented in com::mxgraph::mxGdiCanvas2D.

string com::mxgraph::mxICanvas2D::StrokeColor [set]

Sets the stroke color. This should default to mxConstants.NONE if unset.

Implemented in com::mxgraph::mxGdiCanvas2D.

double com::mxgraph::mxICanvas2D::StrokeWidth [set]

Sets the stroke width. This should default to 1 if unset.

Implemented in com::mxgraph::mxGdiCanvas2D.

---

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

• src/canvas/mxICanvas2D.cs