Constructs a new image shape.
mxRectangle that defines the bounds. This is stored in mxShape.bounds.
String that specifies the URL of the image. This is stored in
Variable: antiAlias
Rendering hint for configuring the canvas.
Variable: boundingBox
Contains the bounding box of the shape, that is, the smallest rectangle that includes all pixels of the shape.
Variable: bounds
Holds the
Variable: dialect
Holds the dialect in which the shape is to be painted.
This can be one of the DIALECT constants in
Specify the direction of certain shapes (eg. mxTriangle). Possible values are mxConstants.DIRECTION_EAST (default),
mxConstants.DIRECTION_WEST, mxConstants.DIRECTION_NORTH, and mxConstants.DIRECTION_SOUTH.
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Possible values are all constants with an ARROW-prefix.
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Size of the end marker in pixels.
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Fill color.
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Fill opacity. Possible range is 0-100.
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply implementation).
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply implementation).
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Gradient color.
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Gradient direction.
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
For edges this determines whether or not joins between edges segments are smoothed to a rounded finish.
For vertices that have the rectangle shape, this determines whether or not the rectangle is rounded.
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Variable: minSvgStrokeWidth
Minimum stroke width for SVG output.
Variable: node
Holds the outermost DOM node that represents this shape.
Opacity. Possible range is 0-100.
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Variable: 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
Variable: pointerEvents
Specifies if pointer events should be handled. Default is true.
Variable: points
Holds the array of
Switch to preserve image aspect. Default is true.
Possible range is 0-360.
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Variable: scale
Holds the scale in which the shape is being painted.
Variable: shapePointerEvents
Specifies if pointer events outside of shape should be handled. Default is false.
The value represents the spacing, in pixels, added to each side of a label in a vertex (style applies to vertices only).
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Possible values are all constants with an ARROW-prefix.
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Size of the start marker or the size of the swimlane title region depending on the shape it is used for.
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Variable: state
Optional reference to the corresponding
Variable: stencil
Holds the
Variable: 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.
Stroke color.
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Stroke opacity. Possible range is 0-100.
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Stroke width.
Note: this property is not documented in the JavaScript API but it does exist and is necessary (see apply).
Variable: style
Optional reference to the style of the corresponding
Variable: svgPointerEvents
Specifies if pointer events should be handled. Default is true.
Variable: svgStrokeTolerance
Event-tolerance for SVG strokes (in px). Default is 8. This is only passed
to the canvas in
Variable: useSvgBoundingBox
Allows to use the SVG bounding box in SVG. Default is false for performance reasons.
Variable: visible
Specifies if the shape is visible. Default is true.
Variable: vmlScale
Scale for improving the precision of VML rendering. Default is 1.
Paints the given points with rounded corners.
Overrides mxShape.apply to replace the fill and stroke colors with the respective values from mxConstants.STYLE_IMAGE_BACKGROUND and mxConstants.STYLE_IMAGE_BORDER.
Applies the style of the given mxCellState to the shape. This implementation assigns the following styles to local fields:
mxCellState of the corresponding cell.
Augments the bounding box with the strokewidth and shadow offsets.
Function: checkBounds
Returns true if the bounds are not null and all of its variables are numeric.
Function: clear
Removes all child nodes and resets all CSS.
Sets the state of the canvas for drawing the shape.
Function: create
Creates and returns the DOM node(s) for the shape in
the given container. This implementation invokes
Parameters:
container - DOM node that will contain the shape.
Function: createBoundingBox
Returns a new rectangle that represents the bounding box of the bare shape with no shadows or strokewidths.
Function: createCanvas
Creates a new canvas for drawing this shape. May return null.
Creates and returns the HTML DOM node(s) to represent
this shape. This implementation falls back to
Function: createSvg
Creates and returns the SVG node(s) to represent this shape.
Function: createSvgCanvas
Creates and returns an
Function: createTransparentSvgRectangle
Adds a transparent rectangle that catches all events.
Function: createVml
Creates and returns the VML node to represent this shape.
Function: createVmlCanvas
Creates and returns an
Function: createVmlGroup
Returns the temporary element used for rendering in IE8 standards mode.
Function: destroy
Destroys the shape by removing it from the DOM and releasing the DOM node associated with the shape using <mxEvent.release>.
Function: getArcSize
Returns the arc size for the given dimension.
Function: getCursor
Returns the current cursor.
Function: getGradientBounds
Returns the bounding box for the gradient box for this shape.
Function: getLabelBounds
Returns the
Function: getLabelMargins
Returns the scaled top, left, bottom and right margin to be used for
computing the label bounds as an
Function: getRotation
Returns the rotation from the style.
Function: getShapeRotation
Returns the actual rotation of the shape.
Disables offset in IE9 for crisper image output.
Function: getTextRotation
Returns the rotation for the text label.
Function: init
Initializes the shape by creaing the DOM node using
Parameters:
container - DOM node that will contain the shape.
Function: initStyles
Sets the styles to their default values.
Returns true if HTML is allowed for this shape. This implementation always returns false.
Function: isPaintBoundsInverted
Returns true if the bounds should be inverted.
Function: isParseVml
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.
Disables inherited roundable support.
Generic rendering code.
Generic background painting implementation.
Function: paintEdgeShape
Hook for subclassers. This implementation is empty.
Generic background painting implementation.
Function: paintGlassEffect
Paints the glass gradient effect.
Generic background painting implementation.
Function: reconfigure
Reconfigures this shape. This will update the colors etc in addition to the bounds or points.
Function: redraw
Creates and returns the SVG node(s) to represent this shape.
Overrides <mxShape.redraw> to preserve the aspect ratio of images.
Function: redrawShape
Updates the SVG or VML shape.
Function: releaseSvgGradients
Paints the line shape.
Function: resetStyles
Resets all styles.
Function: setCursor
Sets the cursor on the given shape.
Parameters:
cursor - The cursor to be used.
Function: setTransparentBackgroundImage
Sets a transparent background CSS style to catch all events.
Paints the line shape.
Function: updateBoundingBox
Updates the
Function: updateBoundsFromPoints
Updates the bounds based on the points.
Function: mixedModeHtml
Allow optimization by replacing VML with HTML.
Function: mixedModeHtml
Allow optimization by replacing VML with HTML.
Function: updateHtmlFilters
Allow optimization by replacing VML with HTML.
Function: updateTransform
Sets the scale and rotation on the given canvas.
Function: updateVmlContainer
Updates the bounds of the VML container.
Generated using TypeDoc
Extends mxShape to implement an image shape. This shape is registered under mxConstants.SHAPE_IMAGE in mxCellRenderer.