Skip to content

Latest commit

 

History

History
100 lines (86 loc) · 2.82 KB

README.md

File metadata and controls

100 lines (86 loc) · 2.82 KB
Raw

jqScribble

jqScribble is a jquery plugin that will allow you to draw on an HTML5 canvas element. It works with standard mouse input and also touch input. It is designed to be extremely extensible, allowing for custom brushes and saving. I have also provided with this plugin a sample PHP file that will demonstrate turning drawn images into actual images.

Usage

To use the jqScribble plugin first select a jquery element to attach to scribble canvas to. Then specify any options you wish.

$('#test').jqScribble(options);

Available Options

width: The width of the Canvas element if not specified then the width of the parent is used DEFAULT - 300

height: The height of the Canvas element if not specified then the height of the parent is used. DEFAULT - 250

backgroundImage: An image to add to the background of the canvas. DEFAULT - false

backgroundImageX: The X offset in the canvas to put the specified background image DEFAULT - 0

backgroundImageY: The Y offset in the canvas to put the specified background image DEFAULT - 0

backgroundColor: The hex color value to set the background as. DEFAULT - #ffffff

saveMimeType: If the image is saved the mime type that will be used. DEFAULT - image/png

saveFunction: The function to use when saving the drawing. DEFAULT - BasicCanvasSave

brush: The brush to used when drawing on the Canvas. DEFAULT - BasicBrush

brushSize: The size of the brush that is used. DEFAULT - 2

brushColor: The color of the brush stroke. DEFAULT - rgb(0,0,0)

Creating Brushes

New brushes should inherit from the jqScribbleBrush object as follows:

NewBrush.prototype = new jqScribbleBrush.
NewBrush(){...}

They should also implement the following methods:

strokeBegin(x, y)
strokeMove(x, y)

and can optionally implement

strokeEnd()

Image Saving

A save function will be passed the image data of the canvas, provided the canvas is not empty.

function mySave(imageData)

The specified save function will not be called until the canvas is not empty and you call the jqScribble save function.

$('').jqScribble.save()

You can also specify a save function at the time of saving by calling save with a function parameter.

$('').jqScribble.save(function(imageData){...});

Updating jqScribble Options

Updates can be passed to the jqscribble by calling

$('').jqScribble.update(options)

Where options are any of the original options specified above.

Clearing The Canvas

To reset the canvas call

$('').jqScribble.clear()

jqScribble Attributes

You can also access the canvas element jqScribble is using by calling

$('').jqScribble.canvas

You can check if the canvas has been drawn on by checking

$('').jqScribble.blank