mxXmlCanvas2D | mxGraph Typescript Declarations

Hierarchy

mxAbstractCanvas2D
- mxXmlCanvas2D

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new mxXmlCanvas2D(root: Element): mxXmlCanvas2D

Overrides mxAbstractCanvas2D.constructor
- Defined in util/mxXmlCanvas2D.d.ts:2
Parameters
- root: Element
Returns mxXmlCanvas2D

Properties

closeOp

closeOp: string

Holds the operator for closing curves.

default: 'Z'

compressed

compressed: boolean

Specifies if the output should be compressed by removing redundant calls.

default: true

curveOp

curveOp: string

Contains the string used for bezier curves.

default: 'C'

lastX

lastX: number

Holds the last x coordinate.

default: 0

lastY

lastY: number

Holds the last y coordinate.

default: 0

lineOp

lineOp: string

Contains the string used for moving in paths.

default: 'L'

moveOp

moveOp: string

Contains the string used for moving in paths.

default: 'M'

path

path: string[]

Holds the current path as an array.

pointerEvents

pointerEvents: boolean

Boolean value that specifies if events should be handled.

default: false

quadOp

quadOp: string

Contains the string used for quadratic paths.

default: 'Q'

root

root: Element

Reference to the container for the SVG content.

rotateHtml

rotateHtml: boolean

Switch for rotation of HTML.

default: true

state

state: mxCanvas2DState

Holds the current state.

states

states: mxCanvas2DState[]

Stack of states.

textEnabled

textEnabled: boolean

Specifies if text output should be enabled.

default: true

Methods

addOp

addOp(): void

Inherited from mxAbstractCanvas2D.addOp
- Defined in util/mxAbstractCanvas2D.d.ts:160
Adds the given operation to the path.

Returns void

arcTo

arcTo(rx: number, ry: number, angle: number, largeArcFlag: number, sweepFlag: number, x: number, y: number): void

Inherited from mxAbstractCanvas2D.arcTo
- Defined in util/mxAbstractCanvas2D.d.ts:348
Adds the given arc to the current path. This is a synthetic operation that is broken down into curves.

Parameters
- rx: number
- ry: number
- angle: number
- largeArcFlag: number
- sweepFlag: number
- x: number
- y: number
Returns void

begin

begin(): void

Overrides mxAbstractCanvas2D.begin
- Defined in util/mxXmlCanvas2D.d.ts:331
Starts a new path and puts it into the drawing buffer.

Returns void

close

close(): void

Overrides mxAbstractCanvas2D.close
- Defined in util/mxXmlCanvas2D.d.ts:374
Closes the current path.

Returns void

createElement

createElement(name: string): Element

- Defined in util/mxXmlCanvas2D.d.ts:35
Creates the given element using the owner document of root.

Parameters
- name: string
Returns Element

createState

createState(): mxCanvas2DState

Inherited from mxAbstractCanvas2D.createState
- Defined in util/mxAbstractCanvas2D.d.ts:150
Creates the state of the this canvas.

Returns mxCanvas2DState

createUrlConverter

createUrlConverter(): mxUrlConverter

Inherited from mxAbstractCanvas2D.createUrlConverter
- Defined in util/mxAbstractCanvas2D.d.ts:140
Create a new mxUrlConverter and returns it.

Returns mxUrlConverter

curveTo

curveTo(x1: number, y1: number, x2: number, y2: number, x3: number, y3: number): void

Overrides mxAbstractCanvas2D.curveTo
- Defined in util/mxXmlCanvas2D.d.ts:369
Adds a bezier curve to the current path.

Parameters
- x1: number
  
  Number that represents the x-coordinate of the first control point.
- y1: number
  
  Number that represents the y-coordinate of the first control point.
- x2: number
  
  Number that represents the x-coordinate of the second control point.
- y2: number
  
  Number that represents the y-coordinate of the second control point.
- x3: number
  
  Number that represents the x-coordinate of the endpoint.
- y3: number
  
  Number that represents the y-coordinate of the endpoint.
Returns void

ellipse

ellipse(x: number, y: number, w: number, h: number): void

Overrides mxAbstractCanvas2D.ellipse
- Defined in util/mxXmlCanvas2D.d.ts:303
Puts an ellipse into the drawing buffer.

Parameters
- x: number
  
  Number that represents the x-coordinate of the ellipse.
- y: number
  
  Number that represents the y-coordinate of the ellipse.
- w: number
  
  Number that represents the width of the ellipse.
- h: number
  
  Number that represents the height of the ellipse.
Returns void

end

end(): void

Inherited from mxAbstractCanvas2D.end
- Defined in util/mxAbstractCanvas2D.d.ts:362
Empty implementation for backwards compatibility. This will be removed.

Returns void

fill

fill(): void

Overrides mxAbstractCanvas2D.fill
- Defined in util/mxXmlCanvas2D.d.ts:421
Fills the current drawing buffer.

Returns void

fillAndStroke

fillAndStroke(): void

Overrides mxAbstractCanvas2D.fillAndStroke
- Defined in util/mxXmlCanvas2D.d.ts:426
Fills the current drawing buffer and its outline.

Returns void

format

format(value: string): number

Overrides mxAbstractCanvas2D.format
- Defined in util/mxXmlCanvas2D.d.ts:30
Returns a formatted number with 2 decimal places.

Parameters
- value: string
Returns number

image

image(x: number, y: number, w: number, h: number, src: string, aspect: boolean, flipH: boolean, flipV: boolean): void

Overrides mxAbstractCanvas2D.image
- Defined in util/mxXmlCanvas2D.d.ts:317
Paints an image.

Parameters
- x: number
  
  Number that represents the x-coordinate of the image.
- y: number
  
  Number that represents the y-coordinate of the image.
- w: number
  
  Number that represents the width of the image.
- h: number
  
  Number that represents the height of the image.
- src: string
  
  String that specifies the URL of the image.
- aspect: boolean
  
  Boolean indicating if the aspect of the image should be preserved.
- flipH: boolean
  
  Boolean indicating if the image should be flipped horizontally.
- flipV: boolean
  
  Boolean indicating if the image should be flipped vertically.
Returns void

lineTo

lineTo(x: number, y: number): void

Overrides mxAbstractCanvas2D.lineTo
- Defined in util/mxXmlCanvas2D.d.ts:347
Draws a line to the given coordinates.

Parameters
- x: number
  
  Number that represents the x-coordinate of the endpoint.
- y: number
  
  Number that represents the y-coordinate of the endpoint.
Returns void

moveTo

moveTo(x: number, y: number): void

Overrides mxAbstractCanvas2D.moveTo
- Defined in util/mxXmlCanvas2D.d.ts:339
Moves the current path the given point.

Parameters
- x: number
  
  Number that represents the x-coordinate of the point.
- y: number
  
  Number that represents the y-coordinate of the point.
Returns void

quadTo

quadTo(x1: number, y1: number, x2: number, y2: number): void

Overrides mxAbstractCanvas2D.quadTo
- Defined in util/mxXmlCanvas2D.d.ts:357
Adds a quadratic curve to the current path.

Parameters
- x1: number
  
  Number that represents the x-coordinate of the control point.
- y1: number
  
  Number that represents the y-coordinate of the control point.
- x2: number
  
  Number that represents the x-coordinate of the endpoint.
- y2: number
  
  Number that represents the y-coordinate of the endpoint.
Returns void

rect

rect(x: number, y: number, w: number, h: number): void

Overrides mxAbstractCanvas2D.rect
- Defined in util/mxXmlCanvas2D.d.ts:281
Puts a rectangle into the drawing buffer.

Parameters
- x: number
  
  Number that represents the x-coordinate of the rectangle.
- y: number
  
  Number that represents the y-coordinate of the rectangle.
- w: number
  
  Number that represents the width of the rectangle.
- h: number
  
  Number that represents the height of the rectangle.
Returns void

reset

reset(): void

Inherited from mxAbstractCanvas2D.reset
- Defined in util/mxAbstractCanvas2D.d.ts:145
Resets the state of this canvas.

Returns void

restore

restore(): void

Overrides mxAbstractCanvas2D.restore
- Defined in util/mxXmlCanvas2D.d.ts:45
Restores the drawing state.

Returns void

rotate

rotate(theta: number, flipH: boolean, flipV: boolean, cx: number, cy: number): void

Overrides mxAbstractCanvas2D.rotate
- Defined in util/mxXmlCanvas2D.d.ts:72
Rotates and/or flips the output around a given center. (Note: Due to limitations in VML, the rotation cannot be concatenated.)

Parameters
- theta: number
  
  Number that represents the angle of the rotation (in degrees).
- flipH: boolean
  
  Boolean indicating if the output should be flipped horizontally.
- flipV: boolean
  
  Boolean indicating if the output should be flipped vertically.
- cx: number
  
  Number that represents the x-coordinate of the rotation center.
- cy: number
  
  Number that represents the y-coordinate of the rotation center.
Returns void

rotatePoint

rotatePoint(x: number, y: number, theta: number, cx: number, cy: number): void

Inherited from mxAbstractCanvas2D.rotatePoint
- Defined in util/mxAbstractCanvas2D.d.ts:165
Rotates the given point and returns the result as an .

Parameters
- x: number
- y: number
- theta: number
- cx: number
- cy: number
Returns void

roundrect

roundrect(x: number, y: number, w: number, h: number, dx: number, dy: number): void

Overrides mxAbstractCanvas2D.roundrect
- Defined in util/mxXmlCanvas2D.d.ts:293
Puts a rounded rectangle into the drawing buffer.

Parameters
- x: number
  
  Number that represents the x-coordinate of the rectangle.
- y: number
  
  Number that represents the y-coordinate of the rectangle.
- w: number
  
  Number that represents the width of the rectangle.
- h: number
  
  Number that represents the height of the rectangle.
- dx: number
  
  Number that represents the horizontal rounding.
- dy: number
  
  Number that represents the vertical rounding.
Returns void

save

save(): void

Overrides mxAbstractCanvas2D.save
- Defined in util/mxXmlCanvas2D.d.ts:40
Saves the drawing state.

Returns void

scale

scale(value: number): void

Overrides mxAbstractCanvas2D.scale
- Defined in util/mxXmlCanvas2D.d.ts:52
Scales the output.

Parameters
- value: number
Returns void

setAlpha

setAlpha(value: number): void

Overrides mxAbstractCanvas2D.setAlpha
- Defined in util/mxXmlCanvas2D.d.ts:80
Sets the current alpha.

Parameters
- value: number
  
  Number that represents the new alpha. Possible values are between 1 (opaque) and 0 (transparent).
Returns void

setDashPattern

setDashPattern(value: string): void

Overrides mxAbstractCanvas2D.setDashPattern
- Defined in util/mxXmlCanvas2D.d.ts:168
Sets the current dash pattern.

default

'3 3'

Parameters
- value: string
  
  String that represents the dash pattern, which is a sequence of numbers defining the length of the dashes and the length of the spaces between the dashes. The lengths are relative to the line width - a length of 1 is equals to the line width.
Returns void

setDashed

setDashed(value: boolean, fixDash: boolean): void

Overrides mxAbstractCanvas2D.setDashed
- Defined in util/mxXmlCanvas2D.d.ts:157
Enables or disables dashed lines.

default

false

Parameters
- value: boolean
  
  Boolean that specifies if the stroke width should be ignored for the dash pattern.
- fixDash: boolean
Returns void

setFillAlpha

setFillAlpha(value: number): void

Overrides mxAbstractCanvas2D.setFillAlpha
- Defined in util/mxXmlCanvas2D.d.ts:88
Sets the current fill alpha.

Parameters
- value: number
  
  Number that represents the new fill alpha. Possible values are between 1 (opaque) and 0 (transparent).
Returns void

setFillColor

setFillColor(value: string): void

Overrides mxAbstractCanvas2D.setFillColor
- Defined in util/mxXmlCanvas2D.d.ts:103
Sets the current fill color.

Parameters
- value: string
  
  Hexadecimal representation of the color or 'none'.
Returns void

setFontBackgroundColor

setFontBackgroundColor(value: string): void

Overrides mxAbstractCanvas2D.setFontBackgroundColor
- Defined in util/mxXmlCanvas2D.d.ts:209
Sets the current font background color.

Parameters
- value: string
  
  Hexadecimal representation of the color or 'none'.
Returns void

setFontBorderColor

setFontBorderColor(value: string): void

Overrides mxAbstractCanvas2D.setFontBorderColor
- Defined in util/mxXmlCanvas2D.d.ts:216
Sets the current font border color.

Parameters
- value: string
  
  Hexadecimal representation of the color or 'none'.
Returns void

setFontColor

setFontColor(value: string): void

Overrides mxAbstractCanvas2D.setFontColor
- Defined in util/mxXmlCanvas2D.d.ts:202
Sets the current font color.

default

'#000000'

Parameters
- value: string
  
  Hexadecimal representation of the color or 'none'.
Returns void

setFontFamily

setFontFamily(value: string): void

Overrides mxAbstractCanvas2D.setFontFamily
- Defined in util/mxXmlCanvas2D.d.ts:233
Sets the current font family.

default

mxConstants.DEFAULT_FONTFAMILY

Parameters
- value: string
  
  String representation of the font family. This handles the same values as the CSS font-family property.
Returns void

setFontSize

setFontSize(value: number): void

Overrides mxAbstractCanvas2D.setFontSize
- Defined in util/mxXmlCanvas2D.d.ts:224
Sets the current font size.

default

mxConstants.DEFAULT_FONTSIZE

Parameters
- value: number
  
  Numeric representation of the font size.
Returns void

setFontStyle

setFontStyle(value: string): void

Overrides mxAbstractCanvas2D.setFontStyle
- Defined in util/mxXmlCanvas2D.d.ts:241
Sets the current font style.

Parameters
- value: string
  
  Numeric representation of the font family. This is the sum of the font styles from mxConstants.
Returns void

setGradient

setGradient(color1: string, color2: string, x: number, y: number, w: number, h: number, direction: string, alpha1: number, alpha2: number): void

Overrides mxAbstractCanvas2D.setGradient
- Defined in util/mxXmlCanvas2D.d.ts:123
Sets the gradient. Note that the coordinates may be ignored by some implementations.

default

1 Possible values are between 1 (opaque) and 0 (transparent).

default

1 Possible values are between 1 (opaque) and 0 (transparent).

Parameters
- color1: string
  
  Hexadecimal representation of the start color.
- color2: string
  
  Hexadecimal representation of the end color.
- x: number
  
  X-coordinate of the gradient region.
- y: number
  
  y-coordinate of the gradient region.
- w: number
  
  Width of the gradient region.
- h: number
  
  Height of the gradient region.
- direction: string
  
  One of mxConstants.DIRECTION_NORTH, mxConstants.DIRECTION_EAST, mxConstants.DIRECTION_SOUTH or mxConstants.DIRECTION_WEST.
- alpha1: number
  
  Optional alpha of the start color.
- alpha2: number
  
  Optional alpha of the end color.
Returns void

setLineCap

setLineCap(value: string): void

Overrides mxAbstractCanvas2D.setLineCap
- Defined in util/mxXmlCanvas2D.d.ts:177
Sets the line cap.

default

'flat' which corresponds to 'butt' in SVG

Parameters
- value: string
  
  String that represents the line cap. Possible values are flat, round and square.
Returns void

setLineJoin

setLineJoin(value: string): void

Overrides mxAbstractCanvas2D.setLineJoin
- Defined in util/mxXmlCanvas2D.d.ts:186
Sets the line join.

default

'miter'

Parameters
- value: string
  
  String that represents the line join. Possible values are miter, round and bevel.
Returns void

setLink

setLink(link: string): void

Inherited from mxAbstractCanvas2D.setLink
- Defined in util/mxAbstractCanvas2D.d.ts:180
Sets the current link. Hook for subclassers.

Parameters
- link: string
Returns void

setMiterLimit

setMiterLimit(value: number): void

Overrides mxAbstractCanvas2D.setMiterLimit
- Defined in util/mxXmlCanvas2D.d.ts:194
Sets the miter limit.

default

10

Parameters
- value: number
  
  Number that represents the miter limit.
Returns void

setShadow

setShadow(value: boolean): void

Overrides mxAbstractCanvas2D.setShadow
- Defined in util/mxXmlCanvas2D.d.ts:248
Enables or disables shadows.

Parameters
- value: boolean
  
  Boolean that specifies if shadows should be enabled.
Returns void

setShadowAlpha

setShadowAlpha(value: number): void

Overrides mxAbstractCanvas2D.setShadowAlpha
- Defined in util/mxXmlCanvas2D.d.ts:263
Sets the current shadows alpha. Default is mxConstants.SHADOW_OPACITY

Parameters
- value: number
  
  Number that represents the new alpha. Possible values are between 1 (opaque) and 0 (transparent).
Returns void

setShadowColor

setShadowColor(value: string): void

Overrides mxAbstractCanvas2D.setShadowColor
- Defined in util/mxXmlCanvas2D.d.ts:256
Sets the current shadow color. Default mxConstants.SHADOWCOLOR

Parameters
- value: string
  
  Hexadecimal representation of the color or 'none'.
Returns void

setShadowOffset

setShadowOffset(dx: number, dy: number): void

Overrides mxAbstractCanvas2D.setShadowOffset
- Defined in util/mxXmlCanvas2D.d.ts:271
Sets the current shadow offset.

Parameters
- dx: number
  
  Number that represents the horizontal offset of the shadow.
- dy: number
  
  Number that represents the vertical offset of the shadow.
Returns void

setStrokeAlpha

setStrokeAlpha(value: number): void

Overrides mxAbstractCanvas2D.setStrokeAlpha
- Defined in util/mxXmlCanvas2D.d.ts:96
Sets the current stroke alpha.

Parameters
- value: number
  
  Number that represents the new stroke alpha. Possible values are between 1 (opaque) and 0 (transparent).
Returns void

setStrokeColor

setStrokeColor(value: string): void

Overrides mxAbstractCanvas2D.setStrokeColor
- Defined in util/mxXmlCanvas2D.d.ts:140
Sets the current stroke color.

Parameters
- value: string
  
  Hexadecimal representation of the color or 'none'.
Returns void

setStrokeWidth

setStrokeWidth(value: number): void

Overrides mxAbstractCanvas2D.setStrokeWidth
- Defined in util/mxXmlCanvas2D.d.ts:147
Sets the current stroke width.

Parameters
- value: number
  
  Numeric representation of the stroke width.
Returns void

stroke

stroke(): void

Overrides mxAbstractCanvas2D.stroke
- Defined in util/mxXmlCanvas2D.d.ts:416
Paints the outline of the current drawing buffer.

Returns void

text

text(x: number, y: number, w: number, h: number, str: string, align: string, valign: string, wrap: string, format: string, overflow: string, clip: string, rotation: number, dir: string): void

- Defined in util/mxXmlCanvas2D.d.ts:397
Paints the given text. Possible values for format are empty string for plain text and html for HTML markup. Background and border color as well as clipping is not available in plain text labels for VML. HTML labels are not available as part of shapes with no foreignObject support in SVG (eg. IE9, IE10).

Parameters
- x: number
  
  Number that represents the x-coordinate of the text.
- y: number
  
  Number that represents the y-coordinate of the text.
- w: number
  
  Number that represents the available width for the text or 0 for automatic width.
- h: number
  
  Number that represents the available height for the text or 0 for automatic height.
- str: string
  
  String that specifies the text to be painted.
- align: string
  
  String that represents the horizontal alignment.
- valign: string
  
  String that represents the vertical alignment.
- wrap: string
  
  Boolean that specifies if word-wrapping is enabled. Requires w > 0.
- format: string
  
  Empty string for plain text or 'html' for HTML markup.
- overflow: string
  
  Specifies the overflow behaviour of the label. Requires w > 0 and/or h > 0.
- clip: string
  
  Boolean that specifies if the label should be clipped. Requires w > 0 and/or h > 0.
- rotation: number
  
  Number that specifies the angle of the rotation around the anchor point of the text.
- dir: string
  
  Optional string that specifies the text direction. Possible values are rtl and lrt.
Returns void

translate

translate(dx: number, dy: number): void

Overrides mxAbstractCanvas2D.translate
- Defined in util/mxXmlCanvas2D.d.ts:60
Translates the output.

Parameters
- dx: number
  
  Number that specifies the horizontal translation.
- dy: number
  
  Number that specifies the vertical translation.
Returns void

writeDefaults

writeDefaults(): void

- Defined in util/mxXmlCanvas2D.d.ts:25
Writes the rendering defaults to root:

Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

root: Element

Returns mxXmlCanvas2D

Properties

closeOp

compressed

curveOp

lastX

lastY

lineOp

moveOp

path

pointerEvents

quadOp

root

rotateHtml

state

states

textEnabled

Methods

addOp

Returns void

arcTo

Parameters

rx: number

ry: number

angle: number

largeArcFlag: number

sweepFlag: number

x: number

y: number

Returns void

begin

Returns void

close

Returns void

createElement

Parameters

name: string

Returns Element

createState

Returns mxCanvas2DState

createUrlConverter

Returns mxUrlConverter

curveTo

Parameters

x1: number

y1: number

x2: number

y2: number

x3: number

y3: number

Returns void

ellipse

Parameters

x: number

y: number

w: number

h: number

Returns void

end

Returns void

fill

Returns void

fillAndStroke

Returns void

format

Parameters

value: string

Returns number

image

Parameters

x: number