mxShape

Base class for all shapes. A shape in mxGraph is a separate implementation for SVG, VML and HTML. Which implementation to use is controlled by the dialect property which is assigned from within the mxCellRenderer when the shape is created. The dialect must be assigned for a shape, and it does normally depend on the browser and the confiuration of the graph (see mxGraph rendering hint).

For each supported shape in SVG and VML, a corresponding shape exists in mxGraph, namely for text, image, rectangle, rhombus, ellipse and polyline. The other shapes are a combination of these shapes (eg. label and swimlane) or they consist of one or more (filled) path objects (eg. actor and cylinder). The HTML implementation is optional but may be required for a HTML-only view of the graph.

Custom Shapes

To extend from this class, the basic code looks as follows. In the special case where the custom shape consists only of one filled region or one filled region and an additional stroke the mxActor and mxCylinder should be subclassed, respectively.

function CustomShape() { }

CustomShape.prototype = new mxShape();
CustomShape.prototype.constructor = CustomShape;

To register a custom shape in an existing graph instance, one must register the shape under a new name in the graph’s cell renderer as follows:

mxCellRenderer.registerShape('customShape', CustomShape);

The second argument is the name of the constructor.

In order to use the shape you can refer to the given name above in a stylesheet. For example, to change the shape for the default vertex style, the following code is used:

var style = graph.getStylesheet().getDefaultVertexStyle();
style[mxConstants.STYLE_SHAPE] = 'customShape';

Summary

mxShape	Base class for all shapes.
Functions
mxShape	Constructs a new shape.
Variables
dialect	Holds the dialect in which the shape is to be painted.
scale	Holds the scale in which the shape is being painted.
bounds	Holds the mxRectangle that specifies the bounds of this shape.
points	Holds the array of mxPoints that specify the points of this shape.
node	Holds the outermost DOM node that represents this shape.
state	Optional reference to the corresponding mxCellState.
style	Optional reference to the style of the corresponding mxCellState.
boundingBox	Contains the bounding box of the shape, that is, the smallest rectangle that includes all pixels of the shape.
stencil	Holds the mxStencil that defines the shape.
svgStrokeTolerance	Event-tolerance for SVG strokes (in px).
pointerEvents	Specifies if pointer events should be handled.
svgPointerEvents	Specifies if pointer events should be handled.
shapePointerEvents	Specifies if pointer events outside of shape should be handled.
stencilPointerEvents	Specifies if pointer events outside of stencils should be handled.
vmlScale	Scale for improving the precision of VML rendering.
outline	Specifies if the shape should be drawn as an outline.
visible	Specifies if the shape is visible.
Functions
init	Initializes the shape by creaing the DOM node using create and adding it into the given container.
isParseVml	Specifies if any VML should be added via insertAdjacentHtml to the DOM.
isHtmlAllowed	Returns true if HTML is allowed for this shape.
getSvgScreenOffset	Returns 0, or 0.5 if <strokewidth> % 2 == 1.
create	Creates and returns the DOM node(s) for the shape in the given container.
createSvg	Creates and returns the SVG node(s) to represent this shape.
createVml	Creates and returns the VML node to represent this shape.
createHtml	Creates and returns the HTML DOM node(s) to represent this shape.
reconfigure	Reconfigures this shape.
redraw	Creates and returns the SVG node(s) to represent this shape.
clear	Removes all child nodes and resets all CSS.
updateBoundsFromPoints	Updates the bounds based on the points.
getLabelBounds	Returns the mxRectangle for the label bounds of this shape, based on the given scaled and translated bounds of the shape.
checkBounds	Returns true if the bounds are not null and all of its variables are numeric.
createVmlGroup	Returns the temporary element used for rendering in IE8 standards mode.
redrawShape	Updates the SVG or VML shape.
createCanvas	Destroys the given canvas which was used for drawing.
createSvgCanvas	Creates and returns an mxSvgCanvas2D for rendering this shape.
createVmlCanvas	Creates and returns an mxVmlCanvas2D for rendering this shape.
updateVmlContainer	Updates the bounds of the VML container.
redrawHtml	Allow optimization by replacing VML with HTML.
updateHtmlFilters	Allow optimization by replacing VML with HTML.
mixedModeHtml	Allow optimization by replacing VML with HTML.
mixedModeHtml	Allow optimization by replacing VML with HTML.
destroyCanvas	Destroys the given canvas which was used for drawing.
paint	Generic rendering code.
configureCanvas	Sets the state of the canvas for drawing the shape.
getGradientBounds	Returns the bounding box for the gradient box for this shape.
updateTransform	Sets the scale and rotation on the given canvas.
paintVertexShape	Paints the vertex shape.
paintBackground	Hook for subclassers.
paintForeground	Hook for subclassers.
paintEdgeShape	Hook for subclassers.
getArcSize	Returns the arc size for the given dimension.
paintGlassEffect	Paints the glass gradient effect.
addPoints	Paints the given points with rounded corners.
apply	Applies the style of the given mxCellState to the shape.
setCursor	Sets the cursor on the given shape.
getCursor	Returns the current cursor.
updateBoundingBox	Updates the boundingBox for this shape using createBoundingBox and augmentBoundingBox and stores the result in boundingBox.
createBoundingBox	Returns a new rectangle that represents the bounding box of the bare shape with no shadows or strokewidths.
augmentBoundingBox	Augments the bounding box with the strokewidth and shadow offsets.
isPaintBoundsInverted	Returns true if the bounds should be inverted.
getRotation	Returns the rotation from the style.
getTextRotation	Returns the rotation for the text label.
getShapeRotation	Returns the actual rotation of the shape.
createTransparentSvgRectangle	Adds a transparent rectangle that catches all events.
setTransparentBackgroundImage	Sets a transparent background CSS style to catch all events.
releaseSvgGradients	Paints the line shape.
destroy	Destroys the shape by removing it from the DOM and releasing the DOM node associated with the shape using mxEvent.release.

Functions

mxShape

function mxShape( stencil )

Constructs a new shape.

Variables

dialect

mxShape.prototype.dialect

Holds the dialect in which the shape is to be painted. This can be one of the DIALECT constants in mxConstants.

scale

mxShape.prototype.scale

Holds the scale in which the shape is being painted.

bounds

mxShape.prototype.bounds

Holds the mxRectangle that specifies the bounds of this shape.

points

mxShape.prototype.points

Holds the array of mxPoints that specify the points of this shape.

node

mxShape.prototype.node

Holds the outermost DOM node that represents this shape.

state

mxShape.prototype.state

Optional reference to the corresponding mxCellState.

style

mxShape.prototype.style

Optional reference to the style of the corresponding mxCellState.

boundingBox

mxShape.prototype.boundingBox

Contains the bounding box of the shape, that is, the smallest rectangle that includes all pixels of the shape.

stencil

mxShape.prototype.stencil

Holds the mxStencil that defines the shape.

svgStrokeTolerance

mxShape.prototype.svgStrokeTolerance

Event-tolerance for SVG strokes (in px). Default is 8. This is only passed to the canvas in createSvgCanvas if pointerEvents is true.

pointerEvents

mxShape.prototype.pointerEvents

Specifies if pointer events should be handled. Default is true.

svgPointerEvents

mxShape.prototype.svgPointerEvents

Specifies if pointer events should be handled. Default is true.

shapePointerEvents

mxShape.prototype.shapePointerEvents

Specifies if pointer events outside of shape should be handled. Default is false.

stencilPointerEvents

mxShape.prototype.stencilPointerEvents

Specifies if pointer events outside of stencils should be handled. Default is false. Set this to true for backwards compatibility with the 1.x branch.

vmlScale

mxShape.prototype.vmlScale

Scale for improving the precision of VML rendering. Default is 1.

outline

mxShape.prototype.outline

Specifies if the shape should be drawn as an outline. This disables all fill colors and can be used to disable other drawing states that should not be painted for outlines. Default is false. This should be set before calling apply.

visible

mxShape.prototype.visible

Specifies if the shape is visible. Default is true.

Functions

init

mxShape.prototype.init = function( container )

Initializes the shape by creaing the DOM node using create and adding it into the given container.

Parameters

container

DOM node that will contain the shape.

isParseVml

mxShape.prototype.isParseVml = function()

Specifies if any VML should be added via insertAdjacentHtml to the DOM. This is only needed in IE8 and only if the shape contains VML markup. This method returns true.

isHtmlAllowed

mxShape.prototype.isHtmlAllowed = function()

Returns true if HTML is allowed for this shape. This implementation always returns false.

getSvgScreenOffset

mxShape.prototype.getSvgScreenOffset = function()

Returns 0, or 0.5 if <strokewidth> % 2 == 1.

create

mxShape.prototype.create = function( container )

Creates and returns the DOM node(s) for the shape in the given container. This implementation invokes createSvg, createHtml or createVml depending on the dialect and style settings.

Parameters

container

DOM node that will contain the shape.

createSvg

mxShape.prototype.createSvg = function()

Creates and returns the SVG node(s) to represent this shape.

createVml

mxShape.prototype.createVml = function()

Creates and returns the VML node to represent this shape.

createHtml

mxShape.prototype.createHtml = function()

Creates and returns the HTML DOM node(s) to represent this shape. This implementation falls back to createVml so that the HTML creation is optional.

reconfigure

mxShape.prototype.reconfigure = function()

Reconfigures this shape. This will update the colors etc in addition to the bounds or points.

redraw

mxShape.prototype.redraw = function()

Creates and returns the SVG node(s) to represent this shape.

clear

mxShape.prototype.clear = function()

Removes all child nodes and resets all CSS.

updateBoundsFromPoints

mxShape.prototype.updateBoundsFromPoints = function()

Updates the bounds based on the points.

getLabelBounds

mxShape.prototype.getLabelBounds = function( rect )

Returns the mxRectangle for the label bounds of this shape, based on the given scaled and translated bounds of the shape. This method should not change the rectangle in-place. This implementation returns the given rect.

checkBounds

mxShape.prototype.checkBounds = function()

Returns true if the bounds are not null and all of its variables are numeric.

createVmlGroup

mxShape.prototype.createVmlGroup = function()

Returns the temporary element used for rendering in IE8 standards mode.

redrawShape

mxShape.prototype.redrawShape = function()

Updates the SVG or VML shape.

createCanvas

mxShape.prototype.createCanvas = function()

Destroys the given canvas which was used for drawing. This implementation increments the reference counts on all shared gradients used in the canvas.

createSvgCanvas

mxShape.prototype.createSvgCanvas = function()

Creates and returns an mxSvgCanvas2D for rendering this shape.

createVmlCanvas

mxShape.prototype.createVmlCanvas = function()

Creates and returns an mxVmlCanvas2D for rendering this shape.

updateVmlContainer

mxShape.prototype.updateVmlContainer = function()

Updates the bounds of the VML container.

redrawHtml

mxShape.prototype.redrawHtmlShape = function()

Allow optimization by replacing VML with HTML.

updateHtmlFilters

mxShape.prototype.updateHtmlFilters = function( node )

Allow optimization by replacing VML with HTML.

mixedModeHtml

Allow optimization by replacing VML with HTML.

mixedModeHtml

Allow optimization by replacing VML with HTML.

destroyCanvas

mxShape.prototype.destroyCanvas = function( canvas )

Destroys the given canvas which was used for drawing. This implementation increments the reference counts on all shared gradients used in the canvas.

paint

mxShape.prototype.paint = function( c )

Generic rendering code.

configureCanvas

mxShape.prototype.configureCanvas = function( c,
x,
y,
w,
h )

Sets the state of the canvas for drawing the shape.

getGradientBounds

mxShape.prototype.getGradientBounds = function( c,
x,
y,
w,
h )

Returns the bounding box for the gradient box for this shape.

updateTransform

mxShape.prototype.updateTransform = function( c,
x,
y,
w,
h )

Sets the scale and rotation on the given canvas.

paintVertexShape

mxShape.prototype.paintVertexShape = function( c,
x,
y,
w,
h )

Paints the vertex shape.

paintBackground

mxShape.prototype.paintBackground = function( c,
x,
y,
w,
h )

Hook for subclassers. This implementation is empty.

paintForeground

mxShape.prototype.paintForeground = function( c,
x,
y,
w,
h )

Hook for subclassers. This implementation is empty.

paintEdgeShape

mxShape.prototype.paintEdgeShape = function( c,
pts )

Hook for subclassers. This implementation is empty.

getArcSize

mxShape.prototype.getArcSize = function( w,
h )

Returns the arc size for the given dimension.

paintGlassEffect

mxShape.prototype.paintGlassEffect = function( c,
x,
y,
w,
h,
arc )

Paints the glass gradient effect.

addPoints

mxShape.prototype.addPoints = function( c,
pts,
rounded,
arcSize,
close )

Paints the given points with rounded corners.

apply

mxShape.prototype.apply = function( state )

Applies the style of the given mxCellState to the shape. This implementation assigns the following styles to local fields:

mxConstants.STYLE_FILLCOLOR => fill
mxConstants.STYLE_GRADIENTCOLOR => gradient
mxConstants.STYLE_GRADIENT_DIRECTION => gradientDirection
mxConstants.STYLE_OPACITY => opacity
mxConstants.STYLE_STROKECOLOR => stroke
mxConstants.STYLE_STROKEWIDTH => strokewidth
mxConstants.STYLE_SHADOW => isShadow
mxConstants.STYLE_DASHED => isDashed
mxConstants.STYLE_SPACING => spacing
mxConstants.STYLE_STARTSIZE => startSize
mxConstants.STYLE_ENDSIZE => endSize
mxConstants.STYLE_ROUNDED => isRounded
mxConstants.STYLE_STARTARROW => startArrow
mxConstants.STYLE_ENDARROW => endArrow
mxConstants.STYLE_ROTATION => rotation
mxConstants.STYLE_DIRECTION => direction
mxConstants.STYLE_GLASS => glass

This keeps a reference to the style. If you need to keep a reference to the cell, you can override this method and store a local reference to state.cell or the mxCellState itself. If outline should be true, make sure to set it before calling this method.

Parameters

state

mxCellState of the corresponding cell.

setCursor

mxShape.prototype.setCursor = function( cursor )

Sets the cursor on the given shape.

Parameters

cursor

The cursor to be used.

getCursor

mxShape.prototype.getCursor = function()

Returns the current cursor.

updateBoundingBox

mxShape.prototype.updateBoundingBox = function()

Updates the boundingBox for this shape using createBoundingBox and augmentBoundingBox and stores the result in boundingBox.

createBoundingBox

mxShape.prototype.createBoundingBox = function()

Returns a new rectangle that represents the bounding box of the bare shape with no shadows or strokewidths.

augmentBoundingBox

mxShape.prototype.augmentBoundingBox = function( bbox )

Augments the bounding box with the strokewidth and shadow offsets.

isPaintBoundsInverted

mxShape.prototype.isPaintBoundsInverted = function()

Returns true if the bounds should be inverted.

getRotation

mxShape.prototype.getRotation = function()

Returns the rotation from the style.

getTextRotation

mxShape.prototype.getTextRotation = function()

Returns the rotation for the text label.

getShapeRotation

mxShape.prototype.getShapeRotation = function()

Returns the actual rotation of the shape.

createTransparentSvgRectangle

mxShape.prototype.createTransparentSvgRectangle = function( x,
y,
w,
h )

Adds a transparent rectangle that catches all events.

setTransparentBackgroundImage

mxShape.prototype.setTransparentBackgroundImage = function( node )

Sets a transparent background CSS style to catch all events.

Paints the line shape.

releaseSvgGradients

mxShape.prototype.releaseSvgGradients = function( grads )

Paints the line shape.

destroy

mxShape.prototype.destroy = function()

Destroys the shape by removing it from the DOM and releasing the DOM node associated with the shape using mxEvent.release.