Class ImageShape

Extends RectangleShape to implement an image shape. This shape is registered by default under SHAPE.IMAGE in CellRenderer.

Hierarchy (view full)

RectangleShape
- ImageShape

Index

Constructors

constructor

Constructors

constructor

new ImageShape(bounds, imageSrc, fill?, stroke?, strokeWidth?): ImageShape
Parameters
- bounds: Rectangle
- imageSrc: string
- fill: string = '#FFFFFF'
- stroke: string = '#000000'
- strokeWidth: number = 1
Returns ImageShape
Overrides RectangleShape.constructor
- Defined in view/geometry/node/ImageShape.ts:34

Properties

antiAlias

antiAlias: boolean = true

Rendering hint for configuring the canvas.

boundingBox

boundingBox: null | Rectangle = null

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

bounds

bounds: null | Rectangle = null

Holds the Rectangle that specifies the bounds of this shape.

cursor

cursor: string = ''

dialect

dialect: null | string = null

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

direction

direction: DirectionValue = DIRECTION.EAST

endArrow

endArrow: string = NONE

endSize

endSize: number = 1

fill

fill: string = NONE

fillOpacity

fillOpacity: number = 100

flipH

flipH: boolean = false

flipV

flipV: boolean = false

glass

glass: boolean = false

gradient

gradient: string = NONE

gradientDirection

gradientDirection: DirectionValue = DIRECTION.EAST

image

image: null | ImageBox = null

imageSrc

imageSrc: string

indicator

indicator: null | Shape = null

indicatorColor

indicatorColor: string = NONE

indicatorDirection

indicatorDirection: DirectionValue = DIRECTION.EAST

indicatorGradientColor

indicatorGradientColor: string = NONE

indicatorImageSrc

indicatorImageSrc: null | string = null

indicatorShape

indicatorShape: null | typeof Shape = null

indicatorStrokeColor

indicatorStrokeColor: string = NONE

isDashed

isDashed: boolean = false

isRounded

isRounded: boolean = false

isShadow

isShadow: boolean = false

minSvgStrokeWidth

minSvgStrokeWidth: number = 1

Minimum stroke width for SVG output.

node

node: SVGGElement

Holds the outermost DOM node that represents this shape.

oldGradients

oldGradients: GradientMap = {}

opacity

opacity: number = 100

originalPointerEvents

originalPointerEvents: null | boolean = null

outline

outline: boolean = false

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 .

overlay

overlay: null | CellOverlay = null

pointerEvents

pointerEvents: boolean = true

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

points

points: (null | Point)[] = []

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

preserveImageAspect

preserveImageAspect: boolean = true

Switch to preserve image aspect. Default is true.

Default

true

rotation

rotation: number = 0

scale

scale: number = 1

Holds the scale in which the shape is being painted.

shadow

shadow: boolean

shapePointerEvents

shapePointerEvents: boolean = false

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

spacing

spacing: number = 0

startArrow

startArrow: string = NONE

startSize

startSize: number = 1

state

state: null | CellState = null

Optional reference to the corresponding .

stencil

stencil: null | StencilShape = null

Holds the StencilShape that defines the shape.

stencilPointerEvents

stencilPointerEvents: boolean = false

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

stroke: string = NONE

strokeOpacity

strokeOpacity: number = 100

strokeWidth

strokeWidth: number = 1

style

style: null | CellStateStyle = null

Optional reference to the style of the corresponding .

svgPointerEvents

svgPointerEvents: string = 'all'

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

svgStrokeTolerance

svgStrokeTolerance: number = 8

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

Default

useSvgBoundingBox

useSvgBoundingBox: boolean = true

Allows to use the SVG bounding box in SVG. Default is false for performance reasons.

verticalTextRotation

verticalTextRotation: number = 0

visible

visible: boolean = true

Specifies if the shape is visible. Default is true.

Methods

addPoints

addPoints(c, pts, rounded?, arcSize, close?, exclude?, initialMove?): void
Paints the given points with rounded corners.
Parameters
- c: AbstractCanvas2D
- pts: Point[]
- rounded: boolean = false
- arcSize: number
- close: boolean = false
- exclude: number[] = []
- initialMove: boolean = true
Returns void
Inherited from RectangleShape.addPoints
- Defined in view/geometry/Shape.ts:812

afterPaint

afterPaint(c): void
Invokes after paint was called.
Parameters
- c: AbstractCanvas2D
Returns void
Inherited from RectangleShape.afterPaint
- Defined in view/geometry/Shape.ts:561

apply

apply(state): void
Overrides to replace the fill and stroke colors with the respective values from imageBackground and imageBorder.

Applies the style of the given CellState to the shape. This implementation assigns the following styles to local fields:
- imageBackground => fill
- imageBorder => stroke
Parameters
- state: CellState
  CellState of the corresponding cell.
Returns void
Overrides RectangleShape.apply
- Defined in view/geometry/node/ImageShape.ts:79

augmentBoundingBox

augmentBoundingBox(bbox): void
Augments the bounding box with the strokewidth and shadow offsets.
Parameters
- bbox: Rectangle
Returns void
Inherited from RectangleShape.augmentBoundingBox
- Defined in view/geometry/Shape.ts:1079

beforePaint

beforePaint(c): void
Invoked before paint is called.
Parameters
- c: AbstractCanvas2D
Returns void
Inherited from RectangleShape.beforePaint
- Defined in view/geometry/Shape.ts:554

checkBounds

checkBounds(): null | boolean
Returns true if the bounds are not null and all of its variables are numeric.

Returns null | boolean
Inherited from RectangleShape.checkBounds
- Defined in view/geometry/Shape.ts:425

clear

clear(): void
Removes all child nodes and resets all CSS.

Returns void
Inherited from RectangleShape.clear
- Defined in view/geometry/Shape.ts:345

configureCanvas

configureCanvas(c, x, y, w, h): void
Sets the state of the canvas for drawing the shape.
Parameters
- c: AbstractCanvas2D
- x: number
- y: number
- w: number
- h: number
Returns void
Inherited from RectangleShape.configureCanvas
- Defined in view/geometry/Shape.ts:664

create

create(): SVGGElement
Creates and returns the DOM node for the shape. This implementation assumes that maxGraph produces SVG elements.

Returns SVGGElement
Inherited from RectangleShape.create
- Defined in view/geometry/Shape.ts:324

createBoundingBox

createBoundingBox(): null | Rectangle
Returns a new rectangle that represents the bounding box of the bare shape with no shadows or strokewidths.

Returns null | Rectangle
Inherited from RectangleShape.createBoundingBox
- Defined in view/geometry/Shape.ts:1061

createCanvas

createCanvas(): null | SvgCanvas2D
Creates a new canvas for drawing this shape. May return null.

Returns null | SvgCanvas2D
Inherited from RectangleShape.createCanvas
- Defined in view/geometry/Shape.ts:466

createSvgCanvas

createSvgCanvas(): null | SvgCanvas2D
Creates and returns an SvgCanvas2D for rendering this shape.

Returns null | SvgCanvas2D
Inherited from RectangleShape.createSvgCanvas
- Defined in view/geometry/Shape.ts:503

createTransparentSvgRectangle

createTransparentSvgRectangle(x, y, w, h): SVGRectElement
Adds a transparent rectangle that catches all events.
Parameters
- x: number
- y: number
- w: number
- h: number
Returns SVGRectElement
Inherited from RectangleShape.createTransparentSvgRectangle
- Defined in view/geometry/Shape.ts:1140

destroy

destroy(): void
Destroys the shape by removing it from the DOM and releasing the DOM node associated with the shape using Event#release.

Returns void
Inherited from RectangleShape.destroy
- Defined in view/geometry/Shape.ts:1186

destroyCanvas

destroyCanvas(canvas): void
Destroys the given canvas which was used for drawing. This implementation increments the reference counts on all shared gradients used in the canvas.
Parameters
- canvas: AbstractCanvas2D
Returns void
Inherited from RectangleShape.destroyCanvas
- Defined in view/geometry/Shape.ts:534

getArcSize

getArcSize(w, h): number
Returns the arc size for the given dimension.
Parameters
- w: number
- h: number
Returns number
Inherited from RectangleShape.getArcSize
- Defined in view/geometry/Shape.ts:761

getCursor

getCursor(): string
Returns the current cursor.

Returns string
Inherited from RectangleShape.getCursor
- Defined in view/geometry/Shape.ts:1006

getGradientBounds

getGradientBounds(c, x, y, w, h): Rectangle
Returns the bounding box for the gradient box for this shape.
Parameters
- c: AbstractCanvas2D
- x: number
- y: number
- w: number
- h: number
Returns Rectangle
Inherited from RectangleShape.getGradientBounds
- Defined in view/geometry/Shape.ts:710

getLabelBounds

getLabelBounds(rect): Rectangle
Returns the Rectangle 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.
Parameters
- rect: Rectangle
Returns Rectangle
Inherited from RectangleShape.getLabelBounds
- Defined in view/geometry/Shape.ts:373

getLabelMargins

getLabelMargins(rect): null | Rectangle
Returns the scaled top, left, bottom and right margin to be used for computing the label bounds as an Rectangle, where the bottom and right margin are defined in the width and height of the rectangle, respectively.
Parameters
- rect: null | Rectangle
Returns null | Rectangle
Inherited from RectangleShape.getLabelMargins
- Defined in view/geometry/Shape.ts:418

getRotation

getRotation(): number
Returns the rotation from the style.

Returns number
Inherited from RectangleShape.getRotation
- Defined in view/geometry/Shape.ts:1103

getShapeRotation

getShapeRotation(): number
Returns the actual rotation of the shape.

Returns number
Inherited from RectangleShape.getShapeRotation
- Defined in view/geometry/Shape.ts:1123

getSvgScreenOffset

getSvgScreenOffset(): number
Disables offset in IE9 for crisper image output.

Returns number
Overrides RectangleShape.getSvgScreenOffset
- Defined in view/geometry/node/ImageShape.ts:65

getTextRotation

getTextRotation(): number
Returns the rotation for the text label.

Returns number
Inherited from RectangleShape.getTextRotation
- Defined in view/geometry/Shape.ts:1110

init

init(container): void
Initializes the shape by creaing the DOM node using and adding it into the given container.
Parameters
- container: HTMLElement | SVGElement
  DOM node that will contain the shape.
Returns void
Inherited from RectangleShape.init
- Defined in view/geometry/Shape.ts:281

initStyles

initStyles(): void
Sets the styles to their default values.

Returns void
Inherited from RectangleShape.initStyles
- Defined in view/geometry/Shape.ts:290

isHtmlAllowed

isHtmlAllowed(): boolean
Returns true if HTML is allowed for this shape. This implementation always returns false.

Returns boolean
Overrides RectangleShape.isHtmlAllowed
- Defined in view/geometry/node/ImageShape.ts:95

isPaintBoundsInverted

isPaintBoundsInverted(): boolean
Returns true if the bounds should be inverted.

Returns boolean
Inherited from RectangleShape.isPaintBoundsInverted
- Defined in view/geometry/Shape.ts:1092

isRoundable

isRoundable(c, x, y, w, h): boolean
Disables inherited roundable support.
Parameters
- c: AbstractCanvas2D
- x: number
- y: number
- w: number
- h: number
Returns boolean
Overrides RectangleShape.isRoundable
- Defined in view/geometry/node/ImageShape.ts:102

paint

paint(c): void
Generic rendering code.
Parameters
- c: AbstractCanvas2D
Returns void
Inherited from RectangleShape.paint
- Defined in view/geometry/Shape.ts:568

paintBackground

paintBackground(c, x, y, w, h): void
Generic background painting implementation.
Parameters
- c: AbstractCanvas2D
- x: number
- y: number
- w: number
- h: number
Returns void
Inherited from RectangleShape.paintBackground
- Defined in view/geometry/node/RectangleShape.ts:61

paintEdgeShape

paintEdgeShape(c, pts): void
Hook for subclassers. This implementation is empty.
Parameters
- c: AbstractCanvas2D
- pts: Point[]
Returns void
Inherited from RectangleShape.paintEdgeShape
- Defined in view/geometry/Shape.ts:754

paintForeground

paintForeground(c, x, y, w, h): void
Generic background painting implementation.
Parameters
- c: AbstractCanvas2D
- x: number
- y: number
- w: number
- h: number
Returns void
Inherited from RectangleShape.paintForeground
- Defined in view/geometry/node/RectangleShape.ts:102

paintGlassEffect

paintGlassEffect(c, x, y, w, h, arc): void
Paints the glass gradient effect.
Parameters
- c: AbstractCanvas2D
- x: number
- y: number
- w: number
- h: number
- arc: number
Returns void
Inherited from RectangleShape.paintGlassEffect
- Defined in view/geometry/Shape.ts:776

paintVertexShape

paintVertexShape(c, x, y, w, h): void
Generic background painting implementation.
Parameters
- c: AbstractCanvas2D
- x: number
- y: number
- w: number
- h: number
Returns void
Overrides RectangleShape.paintVertexShape
- Defined in view/geometry/node/ImageShape.ts:109

redraw

redraw(): void
Returns void
Inherited from RectangleShape.redraw
- Defined in view/geometry/Shape.ts:328

redrawHtmlShape

redrawHtmlShape(): void
Returns void
Inherited from RectangleShape.redrawHtmlShape
- Defined in view/geometry/Shape.ts:1152

redrawShape

redrawShape(): void
Updates the SVG or VML shape.

Returns void
Inherited from RectangleShape.redrawShape
- Defined in view/geometry/Shape.ts:443

releaseSvgGradients

releaseSvgGradients(grads): void
Paints the line shape.
Parameters
- grads: GradientMap
Returns void
Inherited from RectangleShape.releaseSvgGradients
- Defined in view/geometry/Shape.ts:1168

resetStyles

resetStyles(): void
Resets all styles.

Returns void
Inherited from RectangleShape.resetStyles
- Defined in view/geometry/Shape.ts:905

setCursor

setCursor(cursor): void
Sets the cursor on the given shape.
Parameters
- cursor: string
  The cursor to be used.
Returns void
Inherited from RectangleShape.setCursor
- Defined in view/geometry/Shape.ts:998

setTransparentBackgroundImage

setTransparentBackgroundImage(node): void
Sets a transparent background CSS style to catch all events.

Paints the line shape.
Parameters
- node: SVGElement
Returns void
Inherited from RectangleShape.setTransparentBackgroundImage
- Defined in view/geometry/Shape.ts:1161

updateBoundingBox

updateBoundingBox(): void
Updates the for this shape using and and stores the result in .

Returns void
Inherited from RectangleShape.updateBoundingBox
- Defined in view/geometry/Shape.ts:1021

updateBoundsFromPoints

updateBoundsFromPoints(): void
Updates the bounds based on the points.

Returns void
Inherited from RectangleShape.updateBoundsFromPoints
- Defined in view/geometry/Shape.ts:354

updateTransform

updateTransform(c, x, y, w, h): void
Sets the scale and rotation on the given canvas.
Parameters
- c: AbstractCanvas2D
- x: number
- y: number
- w: number
- h: number
Returns void
Inherited from RectangleShape.updateTransform
- Defined in view/geometry/Shape.ts:717

Class ImageShape

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ImageShape

Properties

antiAlias

boundingBox

bounds

cursor

dialect

direction

endArrow

endSize

fill

fillOpacity

flipH

flipV

glass

gradient

gradientDirection

image

imageSrc

indicator

indicatorColor

indicatorDirection

indicatorGradientColor

indicatorImageSrc

indicatorShape

indicatorStrokeColor

isDashed

isRounded

isShadow

minSvgStrokeWidth

node

oldGradients

opacity

originalPointerEvents

outline

overlay

pointerEvents

points

preserveImageAspect

Default

rotation

scale

shadow

shapePointerEvents

spacing

startArrow

startSize

state

stencil

stencilPointerEvents

stroke

strokeOpacity

strokeWidth

style

svgPointerEvents

svgStrokeTolerance

Default

useSvgBoundingBox

verticalTextRotation

visible

Methods

addPoints

Parameters

Returns void

afterPaint

Parameters

Returns void

apply

Parameters

Returns void

augmentBoundingBox