API Docs for: 0.0.2
Show:

canvas.Node Class

Defined in: api/src/canvas/node.js:5
Module: Canvas

Factory for new svg DOM nodes

Constructor

canvas.Node

(
  • tag
  • properties
  • text
)

Defined in api/src/canvas/node.js:5

Parameters:

Example:

var paint = new ludo.canvas.Paint({ 'stroke-color' : '#000' }); var node = new ludo.canvas.Node('rect', { id:'myRect', x:20,y:20,width:100,height:100 , "class": paint, filter:filter });

or

var node = new ludo.canvas.Node('title', {}, 'My title' );

Methods

_addEvent

(
  • ev
  • fn
  • el
)
private

Defined in api/src/canvas/node.js:99

Add event to DOM element el is optional, default this.el

Parameters:

add

(
  • tagName
  • properties
  • text
)
ludo.canvas.Node

Defined in api/src/canvas/node.js:265

Adds a new child DOM node

Parameters:

Returns:

ludo.canvas.Node: added node

Example:

var filter = new ludo.canvas.Filter(); filter.add('feGaussianBlur', { 'stdDeviation' : 2, result:'blur' });

addClass

(
  • className
)

Defined in api/src/canvas/node.js:295

Add css class to SVG node

Parameters:

addMask

(
  • mask
)

Defined in api/src/canvas/node.js:223

Apply mask to node

Parameters:

adopt

(
  • node
)
canvas.Node

Defined in api/src/canvas/node.js:147

Adopt a new node

Parameters:

Returns:

canvas.Node: parent

applyClipPath

(
  • clip
)

Defined in api/src/canvas/node.js:232

Apply clip path to node

Parameters:

applyFilter

(
  • filter
)

Defined in api/src/canvas/node.js:215

Apply filter to node

Parameters:

getBBox

() Object

Defined in api/src/canvas/node.js:337

Returns bounding box of el as an object with x,y, width and height.

Returns:

Object:

getCanvas

() ludo.canvas.Node.el

Defined in api/src/canvas/node.js:361

The nearest ancestor 'svg' element. Null if the given element is the outermost svg element.

Returns:

ludo.canvas.Node.el: svg

getSize

() Object

Defined in api/src/canvas/node.js:346

Returns rectangular size of element, i.e. bounding box width - bounding box x and bounding box width - bounding box y. Values are returned as { x : 100, y : 150 } where x is width and y is height.

Returns:

Object: size x and y

getViewPort

() ludo.canvas.Node.el

Defined in api/src/canvas/node.js:369

The element which established the current viewport. Often, the nearest ancestor ‘svg’ element. Null if the given element is the outermost svg element

Returns:

ludo.canvas.Node.el: svg

hasClass

(
  • className
)
Boolean

Defined in api/src/canvas/node.js:303

Returns true if svg node has given css class name

Parameters:

Returns:

Boolean:

Example:

var node = new ludo.canvas.Node('rect', { id:'myId2'}); ludo.dom.addClass(node, 'myClass'); alert(node.hasClass('myClass'));

removeClass

(
  • className
)

Defined in api/src/canvas/node.js:316

Remove css class name from css Node

Parameters:

Example:

var node = new ludo.canvas.Node('rect', { id:'myId2'}); ludo.dom.addClass(node, 'myClass'); ludo.dom.addClass(node, 'secondClass'); node.removeClass('myClass');

text

(
  • text
)

Defined in api/src/canvas/node.js:257

Update text content of node

Parameters:

url

(
  • key
  • to
)

Defined in api/src/canvas/node.js:241

Create url reference

Parameters:

Example:

node.url('filter', filterObj); // sets node property filter="url(#<filterObj->id>)" node.url('mask', 'MyMask'); // sets node property mask="url(#MyMask)"

Attributes

id

String

Defined in api\src\canvas\node.js:31

Id of node