mxAbstractCanvas2D

Base class for all canvases. A description of the public API is available in mxXmlCanvas2D. All color values of mxConstants.NONE will be converted to null in the state.

Summary

mxAbstractCanvas2D	Base class for all canvases.
Functions
mxAbstractCanvas2D	Constructs a new abstract canvas.
Variables
converter	Holds the mxUrlConverter to convert image URLs.
state	Holds the current state.
states	Stack of states.
path	Holds the current path as an array.
rotateHtml	Switch for rotation of HTML.
lastX	Holds the last x coordinate.
lastY	Holds the last y coordinate.
moveOp	Contains the string used for moving in paths.
lineOp	Contains the string used for moving in paths.
quadOp	Contains the string used for quadratic paths.
curveOp	Contains the string used for bezier curves.
closeOp	Holds the operator for closing curves.
pointerEvents	Boolean value that specifies if events should be handled.
Functions
createUrlConverter	Create a new mxUrlConverter and returns it.
reset	Resets the state of this canvas.
createState	Creates the state of the this canvas.
format	Rounds all numbers to integers.
addOp	Adds the given operation to the path.
rotatePoint	Rotates the given point and returns the result as an mxPoint.
save	Saves the current state.
restore	Restores the current state.
setLink	Sets the current link.
scale	Scales the current state.
translate	Translates the current state.
rotate	Rotates the current state.
setAlpha	Sets the current alpha.
setFillAlpha	Sets the current solid fill alpha.
setStrokeAlpha	Sets the current stroke alpha.
setFillColor	Sets the current fill color.
setGradient	Sets the current gradient.
setStrokeColor	Sets the current stroke color.
setStrokeWidth	Sets the current stroke width.
setDashed	Enables or disables dashed lines.
setDashPattern	Sets the current dash pattern.
setLineCap	Sets the current line cap.
setLineJoin	Sets the current line join.
setMiterLimit	Sets the current miter limit.
setFontColor	Sets the current font color.
setFontBackgroundColor	Sets the current font background color.
setFontBorderColor	Sets the current font border color.
setFontSize	Sets the current font size.
setFontFamily	Sets the current font family.
setFontStyle	Sets the current font style.
setShadow	Enables or disables and configures the current shadow.
setShadowColor	Enables or disables and configures the current shadow.
setShadowAlpha	Enables or disables and configures the current shadow.
setShadowOffset	Enables or disables and configures the current shadow.
begin	Starts a new path.
moveTo	Moves the current path the given coordinates.
lineTo	Draws a line to the given coordinates.
quadTo	Adds a quadratic curve to the current path.
curveTo	Adds a bezier curve to the current path.
arcTo	Adds the given arc to the current path.
close	Closes the current path.
end	Empty implementation for backwards compatibility.

Functions

mxAbstractCanvas2D

function mxAbstractCanvas2D()

Constructs a new abstract canvas.

Variables

converter

this.converter

Holds the mxUrlConverter to convert image URLs.

state

mxAbstractCanvas2D.prototype.state

Holds the current state.

states

mxAbstractCanvas2D.prototype.states

Stack of states.

path

mxAbstractCanvas2D.prototype.path

Holds the current path as an array.

rotateHtml

mxAbstractCanvas2D.prototype.rotateHtml

Switch for rotation of HTML. Default is false.

lastX

mxAbstractCanvas2D.prototype.lastX

Holds the last x coordinate.

lastY

mxAbstractCanvas2D.prototype.lastY

Holds the last y coordinate.

moveOp

mxAbstractCanvas2D.prototype.moveOp

Contains the string used for moving in paths. Default is ‘M’.

lineOp

mxAbstractCanvas2D.prototype.lineOp

Contains the string used for moving in paths. Default is ‘L’.

quadOp

mxAbstractCanvas2D.prototype.quadOp

Contains the string used for quadratic paths. Default is ‘Q’.

curveOp

mxAbstractCanvas2D.prototype.curveOp

Contains the string used for bezier curves. Default is ‘C’.

closeOp

mxAbstractCanvas2D.prototype.closeOp

Holds the operator for closing curves. Default is ‘Z’.

pointerEvents

mxAbstractCanvas2D.prototype.pointerEvents

Boolean value that specifies if events should be handled. Default is false.

Functions

createUrlConverter

mxAbstractCanvas2D.prototype.createUrlConverter = function()

Create a new mxUrlConverter and returns it.

reset

mxAbstractCanvas2D.prototype.reset = function()

Resets the state of this canvas.

createState

mxAbstractCanvas2D.prototype.createState = function()

Creates the state of the this canvas.

format

mxAbstractCanvas2D.prototype.format = function( value )

Rounds all numbers to integers.

addOp

mxAbstractCanvas2D.prototype.addOp = function()

Adds the given operation to the path.

rotatePoint

mxAbstractCanvas2D.prototype.rotatePoint = function( x,
y,
theta,
cx,
cy )

Rotates the given point and returns the result as an mxPoint.

save

mxAbstractCanvas2D.prototype.save = function()

Saves the current state.

restore

mxAbstractCanvas2D.prototype.restore = function()

Restores the current state.

setLink

mxAbstractCanvas2D.prototype.setLink = function( link )

Sets the current link. Hook for subclassers.

scale

mxAbstractCanvas2D.prototype.scale = function( value )

Scales the current state.

translate

mxAbstractCanvas2D.prototype.translate = function( dx,
dy )

Translates the current state.

rotate

mxAbstractCanvas2D.prototype.rotate = function( theta,
flipH,
flipV,
cx,
cy )

Rotates the current state.

setAlpha

mxAbstractCanvas2D.prototype.setAlpha = function( value )

Sets the current alpha.

setFillAlpha

mxAbstractCanvas2D.prototype.setFillAlpha = function( value )

Sets the current solid fill alpha.

setStrokeAlpha

mxAbstractCanvas2D.prototype.setStrokeAlpha = function( value )

Sets the current stroke alpha.

setFillColor

mxAbstractCanvas2D.prototype.setFillColor = function( value )

Sets the current fill color.

setGradient

mxAbstractCanvas2D.prototype.setGradient = function( color1,
color2,
x,
y,
w,
h,
direction,
alpha1,
alpha2 )

Sets the current gradient.

setStrokeColor

mxAbstractCanvas2D.prototype.setStrokeColor = function( value )

Sets the current stroke color.

setStrokeWidth

mxAbstractCanvas2D.prototype.setStrokeWidth = function( value )

Sets the current stroke width.

setDashed

mxAbstractCanvas2D.prototype.setDashed = function( value,
fixDash )

Enables or disables dashed lines.

setDashPattern

mxAbstractCanvas2D.prototype.setDashPattern = function( value )

Sets the current dash pattern.

setLineCap

mxAbstractCanvas2D.prototype.setLineCap = function( value )

Sets the current line cap.

setLineJoin

mxAbstractCanvas2D.prototype.setLineJoin = function( value )

Sets the current line join.

setMiterLimit

mxAbstractCanvas2D.prototype.setMiterLimit = function( value )

Sets the current miter limit.

setFontColor

mxAbstractCanvas2D.prototype.setFontColor = function( value )

Sets the current font color.

setFontBackgroundColor

mxAbstractCanvas2D.prototype.setFontBackgroundColor = function( value )

Sets the current font background color.

setFontBorderColor

mxAbstractCanvas2D.prototype.setFontBorderColor = function( value )

Sets the current font border color.

setFontSize

mxAbstractCanvas2D.prototype.setFontSize = function( value )

Sets the current font size.

setFontFamily

mxAbstractCanvas2D.prototype.setFontFamily = function( value )

Sets the current font family.

setFontStyle

mxAbstractCanvas2D.prototype.setFontStyle = function( value )

Sets the current font style.

setShadow

mxAbstractCanvas2D.prototype.setShadow = function( enabled )

Enables or disables and configures the current shadow.

setShadowColor

mxAbstractCanvas2D.prototype.setShadowColor = function( value )

Enables or disables and configures the current shadow.

setShadowAlpha

mxAbstractCanvas2D.prototype.setShadowAlpha = function( value )

Enables or disables and configures the current shadow.

setShadowOffset

mxAbstractCanvas2D.prototype.setShadowOffset = function( dx,
dy )

Enables or disables and configures the current shadow.

begin

mxAbstractCanvas2D.prototype.begin = function()

Starts a new path.

moveTo

mxAbstractCanvas2D.prototype.moveTo = function( x,
y )

Moves the current path the given coordinates.

lineTo

mxAbstractCanvas2D.prototype.lineTo = function( x,
y )

Draws a line to the given coordinates. Uses moveTo with the op argument.

quadTo

mxAbstractCanvas2D.prototype.quadTo = function( x1,
y1,
x2,
y2 )

Adds a quadratic curve to the current path.

curveTo

mxAbstractCanvas2D.prototype.curveTo = function( x1,
y1,
x2,
y2,
x3,
y3 )

Adds a bezier curve to the current path.

arcTo

mxAbstractCanvas2D.prototype.arcTo = function( rx,
ry,
angle,
largeArcFlag,
sweepFlag,
x,
y )

Adds the given arc to the current path. This is a synthetic operation that is broken down into curves.

close

mxAbstractCanvas2D.prototype.close = function( x1,
y1,
x2,
y2,
x3,
y3 )

Closes the current path.

end

mxAbstractCanvas2D.prototype.end = function()

Empty implementation for backwards compatibility. This will be removed.