Documentation

Learn all about jCanvas

Methods

This is a reference of every jCanvas method, for quick access.

addLayer

  • Syntax
    • addLayer( properties )
  • Returns
    • jQuery

addLayerToGroup

  • Syntax
    • addLayerToGroup( layerId, groupName )
  • Returns
    • jQuery

animateLayer

  • Syntax
    • animateLayer( layerId, properties [, duration ] [, easing ] [, callback ] )
    • animateLayer( layerId, properties, options )
  • Returns
    • jQuery

animateLayerGroup

  • Syntax
    • animateLayerGroup( groupId, properties [, duration ] [, easing ] [, callback ] )
    • animateLayerGroup( groupId, properties, options )
  • Returns
    • jQuery

clearCanvas

  • Syntax
    • clearCanvas( properties )
  • Returns
    • jQuery

createGradient

  • Syntax
    • createGradient( properties )
  • Returns
    • CanvasGradient

createPattern

  • Syntax
    • createPattern( properties )
  • Returns
    • CanvasPattern

delayLayer

  • Syntax
    • delayLayer( layerId [, duration ] )
  • Returns
    • jQuery

delayLayerGroup

  • Syntax
    • delayLayerGroup( groupId [, duration ] )
  • Returns
    • jQuery

detectPixelRatio

  • Syntax
    • detectPixelRatio( [ callback ] )
  • Returns
    • jQuery

draw

  • Syntax
    • draw( properties )
  • Returns
    • jQuery

drawArc

  • Syntax
    • drawArc( properties )
  • Returns
    • jQuery

drawBezier

  • Syntax
    • drawBezier( properties )
  • Returns
    • jQuery

drawEllipse

  • Syntax
    • drawEllipse( properties )
  • Returns
    • jQuery

drawImage

  • Syntax
    • drawImage( properties )
  • Returns
    • jQuery

drawLayers

  • Syntax
    • drawLayers( )
  • Returns
    • jQuery

drawLine

  • Syntax
    • drawLine( properties )
  • Returns
    • jQuery

drawPolygon

  • Syntax
    • drawPolygon( properties )
  • Returns
    • jQuery

drawQuadratic

  • Syntax
    • drawQuadratic( properties )
  • Returns
    • jQuery

drawRect

  • Syntax
    • drawRect( properties )
  • Returns
    • jQuery

drawSlice

  • Syntax
    • drawSlice( properties )
  • Returns
    • jQuery

drawText

  • Syntax
    • drawText( properties )
  • Returns
    • jQuery

drawVector

  • Syntax
    • drawVector( properties )
  • Returns
    • jQuery

getCanvasImage

  • Syntax
    • getCanvasImage( [ imageType ] )
  • Returns
    • String

getEventHooks

  • Syntax
    • getEventHooks( )
  • Returns
    • Object

getLayer

  • Syntax
    • getLayer( layerId )
  • Returns
    • Layer

getLayerGroup

  • Syntax
    • getLayerGroup( groupId )
  • Returns
    • Layer

getLayerIndex

  • Syntax
    • getLayerIndex( layerId )
  • Returns
    • Number

getLayers

  • Syntax
    • getLayers( [ callback ] )
  • Returns
    • Array

jCanvas.extend

  • Syntax
    • jCanvas.extend( properties )
  • Returns
    • Function

measureText

  • Syntax
    • measureText( properties )
    • measureText( layerId )
  • Returns
    • Object

moveLayer

  • Syntax
    • moveLayer( layerId, groupName )
  • Returns
    • jQuery

removeLayer

  • Syntax
    • removeLayer( layerId )
  • Returns
    • jQuery

removeLayerFromGroup

  • Syntax
    • removeLayerFromGroup( layerId, groupName )
  • Returns
    • jQuery

removeLayerGroup

  • Syntax
    • removeLayerGroup( groupId )
  • Returns
    • jQuery

removeLayers

  • Syntax
    • removeLayers( )
  • Returns
    • jQuery

restoreCanvas( )

rotateCanvas

  • Syntax
    • rotateCanvas( properties )
  • Returns
    • jQuery

scaleCanvas

  • Syntax
    • scaleCanvas( properties )
  • Returns
    • jQuery

setEventHooks

  • Syntax
    • setEventHooks( properties )
  • Returns
    • jQuery

setLayer

  • Syntax
    • setLayer( layerId, properties )
  • Returns
    • jQuery

setLayerGroup

  • Syntax
    • setLayerGroup( groupId, properties )
  • Returns
    • jQuery

setLayers

  • Syntax
    • setLayers( properties [, callback ] )
  • Returns
    • jQuery

setPixels

  • Syntax
    • setPixels( properties )
  • Returns
    • jQuery

stopLayer

  • Syntax
    • stopLayer( layerId [, clearQueue ] )
  • Returns
    • jQuery

stopLayerGroup

  • Syntax
    • stopLayerGroup( groupId [, clearQueue ] )
  • Returns
    • jQuery

translateCanvas

  • Syntax
    • translateCanvas( properties )
  • Returns
    • jQuery
Fish Ladybug Water