mxArrow

Extends mxShape to implement an arrow shape.  (The shape is used to represent edges, not vertices.)  This shape is registered under mxConstants.SHAPE_ARROW in mxCellRenderer.

Summary
mxArrowExtends mxShape to implement an arrow shape.
Functions
mxArrowConstructs a new arrow shape.
Variables
addPipeSpecifies if a SVG path should be created around any path to increase the tolerance for mouse events.
enableFillSpecifies if fill colors should be ignored.
Functions
configureTransparentBackgroundOveridden to remove transparent background.
updateBoundingBoxUpdates the <boundingBox> for this shape.
createVmlExtends <mxShape.createVml> to ignore fill if enableFill is false.
createSvgExtends mxActor.createSvg to ignore fill if enableFill is false and create an event handling shape if <this.addPipe> is true.
reconfigureExtends <mxActor.reconfigure> to ignore fill if enableFill is false.
redrawSvgExtends mxActor.redrawSvg to update the event handling shape if one exists.
redrawPathDraws the path for this shape.

Functions

mxArrow

function mxArrow(points,
fill,
stroke,
strokewidth,
arrowWidth,
spacing,
endSize)

Constructs a new arrow shape.

Parameters

pointsArray of mxPoints that define the points.  This is stored in mxShape.points.
fillString that defines the fill color.  This is stored in <fill>.
strokeString that defines the stroke color.  This is stored in <stroke>.
strokewidthOptional integer that defines the stroke width.  Default is 1.  This is stored in <strokewidth>.
arrowWidthOptional integer that defines the arrow width.  Default is mxConstants.ARROW_WIDTH.  This is stored in <arrowWidth>.
spacingOptional integer that defines the spacing between the arrow shape and its endpoints.  Default is mxConstants.ARROW_SPACING.  This is stored in <spacing>.
endSizeOptional integer that defines the size of the arrowhead.  Default is mxConstants.ARROW_SIZE.  This is stored in <endSize>.

Variables

addPipe

mxArrow.prototype.addPipe

Specifies if a SVG path should be created around any path to increase the tolerance for mouse events.  Default is false since this shape is filled.

enableFill

mxArrow.prototype.enableFill

Specifies if fill colors should be ignored.  This must be set to true for shapes that are stroked only.  Default is true since this shape is filled.

Functions

configureTransparentBackground

mxArrow.prototype.configureTransparentBackground = function(node)

Overidden to remove transparent background.

updateBoundingBox

Updates the <boundingBox> for this shape.

createVml

mxArrow.prototype.createVml = function()

Extends <mxShape.createVml> to ignore fill if enableFill is false.

createSvg

mxArrow.prototype.createSvg = function()

Extends mxActor.createSvg to ignore fill if enableFill is false and create an event handling shape if <this.addPipe> is true.

reconfigure

mxArrow.prototype.reconfigure = function()

Extends <mxActor.reconfigure> to ignore fill if enableFill is false.

redrawSvg

mxArrow.prototype.redrawSvg = function()

Extends mxActor.redrawSvg to update the event handling shape if one exists.

redrawPath

mxArrow.prototype.redrawPath = function(path,
x,
y,
w,
h)

Draws the path for this shape.  This method uses the mxPath abstraction to paint the shape for VML and SVG.

Base class for all shapes.
function mxArrow(points,
fill,
stroke,
strokewidth,
arrowWidth,
spacing,
endSize)
Constructs a new arrow shape.
mxArrow.prototype.addPipe
Specifies if a SVG path should be created around any path to increase the tolerance for mouse events.
mxArrow.prototype.enableFill
Specifies if fill colors should be ignored.
mxArrow.prototype.configureTransparentBackground = function(node)
Overidden to remove transparent background.
mxArrow.prototype.createVml = function()
Extends mxShape.createVml to ignore fill if enableFill is false.
mxArrow.prototype.createSvg = function()
Extends mxActor.createSvg to ignore fill if enableFill is false and create an event handling shape if this.addPipe is true.
mxActor.prototype.createSvg = function()
Creates and returns the SVG node(s) to represent this shape.
mxArrow.prototype.reconfigure = function()
Extends mxActor.reconfigure to ignore fill if enableFill is false.
mxArrow.prototype.redrawSvg = function()
Extends mxActor.redrawSvg to update the event handling shape if one exists.
mxActor.prototype.redrawSvg = function()
Updates the SVG node(s) to reflect the latest bounds and scale.
mxArrow.prototype.redrawPath = function(path,
x,
y,
w,
h)
Draws the path for this shape.
Name under which mxArrow is registered in mxCellRenderer.
Renders cells into a document object model.
Implements a 2-dimensional vector with double precision coordinates.
mxShape.prototype.points
Holds the array of mxPoints that specify the points of this shape.
Defines the width of the arrow shape.
Defines the spacing between the arrow shape and its terminals.
Defines the size of the arrowhead in the arrow shape.
An abstraction for creating VML and SVG paths.
Close