mxLabel

Extends mxShape to implement an image shape with a label. This shape is registered under mxConstants.SHAPE_LABEL in mxCellRenderer.

Summary

mxLabel	Extends mxShape to implement an image shape with a label.
Functions
mxLabel	Constructs a new label shape.
Variables
vmlNodes	Adds local references to mxShape.vmlNodes.
imageSize	Default width and height for the image.
spacing	Default value for spacing.
indicatorSize	Default width and height for the indicicator.
indicatorSpacing	Default spacing between image and indicator.
opaqueVmlImages	Specifies if all VML images should be rendered without transparency, that is, if the current opacity should be ignored for images.
Functions
init	Initializes the shape and adds it to the container.
reconfigure	Reconfigures this shape.
createHtml	Creates and returns the HTML node to represent this shape.
createVml	Creates and returns the VML node to represent this shape.
createVmlImage	Creates an image node for the given image src and opacity to be used in VML.
createSvg	Creates and returns the SVG node to represent this shape.
redraw	Overrides redraw to define a unified implementation for redrawing all supported dialects.

Functions

mxLabel

function mxLabel( bounds,
fill,
stroke,
strokewidth )

Constructs a new label shape.

Parameters

bounds	mxRectangle that defines the bounds. This is stored in mxShape.bounds.
fill	String that defines the fill color. This is stored in <fill>.
stroke	String that defines the stroke color. This is stored in <stroke>.
strokewidth	Optional integer that defines the stroke width. Default is 1. This is stored in <strokewidth>.

Variables

vmlNodes

mxLabel.prototype.vmlNodes

Adds local references to mxShape.vmlNodes.

imageSize

mxLabel.prototype.imageSize

Default width and height for the image. Default is mxConstants.DEFAULT_IMAGESIZE.

spacing

mxLabel.prototype.spacing

Default value for spacing. Default is 2.

indicatorSize

mxLabel.prototype.indicatorSize

Default width and height for the indicicator. Default is 10.

indicatorSpacing

mxLabel.prototype.indicatorSpacing

Default spacing between image and indicator. Default is 2.

opaqueVmlImages

mxLabel.prototype.opaqueVmlImages

Specifies if all VML images should be rendered without transparency, that is, if the current opacity should be ignored for images. Default is false.

Functions

init

mxLabel.prototype.init = function( container )

Initializes the shape and adds it to the container. This function is overridden so that the node is already in the DOM when the indicator is added. This is required to access the ownerSVGelement of the container in the init function of the indicator.

reconfigure

mxLabel.prototype.reconfigure = function()

Reconfigures this shape. This will update the colors of the indicator and reconfigure it if required.

createHtml

mxLabel.prototype.createHtml = function()

Creates and returns the HTML node to represent this shape.

createVml

mxLabel.prototype.createVml = function()

Creates and returns the VML node to represent this shape.

createVmlImage

mxLabel.prototype.createVmlImage = function( src,
opacity )

Creates an image node for the given image src and opacity to be used in VML.

createSvg

mxLabel.prototype.createSvg = function()

Creates and returns the SVG node to represent this shape.

redraw

mxLabel.prototype.redraw = function()

Overrides redraw to define a unified implementation for redrawing all supported dialects.