WetCanvas class
Represents a canvas suitable for "wet ink", i.e. an ongoing stroke.
- Extends
Constructors
| Wet |
Creates a new InkingCanvas instance, attached to the provided HTMLElement. |
Properties
| brush | Gets the canvas' brush. |
| canvas | Gets the underlying HTML5 Canvas element. |
| offset | Gets the offset from the canvas' reference point, in pixels. |
| scale | Gets the canvas' scale. Defaults to 1. |
Inherited Properties
| fade |
Configures the time it takes, in milliseconds, for an InkingCanvas to fade out. |
| highlighter |
Configures the opacity of highlighter strokes. |
| laser |
Configures the opacity of the laser stroke shadow. |
| reference |
The canvas' reference point. |
Inherited Methods
| add |
Adds a points to the current stroke. |
| begin |
Begins a stroke in the canvas. |
| cancel |
Cancels the current stroke. |
| clear() | Clears the canvas. |
| end |
Ends the current stroke in the canvas. |
| fade |
Fades the canvas out by decreasing its opacity, and eventually removes it from the DOM. |
| remove |
Removes the canvas from the DOM. |
| render |
Renders the specified stroke onto the canvas. |
| resize(number, number) | Resizes this canvas. |
| set |
Sets the current brush for the canvas. |
Constructor Details
WetCanvas(HTMLElement)
Creates a new InkingCanvas instance, attached to the provided HTMLElement.
new WetCanvas(_parentElement?: HTMLElement)Parameters
- _parentElement
-
HTMLElement
The HTML element this canvas is attached to. InkingCanvas
dynamically creates an HTML5 Canvas element and adds it as a child to parentElement.
Property Details
brush
canvas
Gets the underlying HTML5 Canvas element.
HTMLCanvasElement canvasProperty Value
HTMLCanvasElement
offset
Gets the offset from the canvas' reference point, in pixels.
Readonly<IPoint> offsetProperty Value
Readonly<IPoint>
scale
Gets the canvas' scale. Defaults to 1.
number scaleProperty Value
number
Inherited Property Details
fadeOutDuration
Configures the time it takes, in milliseconds, for an InkingCanvas to fade out.
static fadeOutDuration: numberProperty Value
number
Inherited From DryWetCanvas.fadeOutDuration
highlighterOpacity
Configures the opacity of highlighter strokes.
static highlighterOpacity: numberProperty Value
number
Inherited From DryWetCanvas.highlighterOpacity
laserShadowOpacity
Configures the opacity of the laser stroke shadow.
static laserShadowOpacity: numberProperty Value
number
Inherited From DryWetCanvas.laserShadowOpacity
referencePoint
The canvas' reference point.
referencePoint: CanvasReferencePointProperty Value
Inherited From DryWetCanvas.referencePoint
Inherited Method Details
addPoint(IPointerPoint)
Adds a points to the current stroke.
function addPoint(p: IPointerPoint)Parameters
The point to add to the current stroke.
Inherited From DryWetCanvas.addPoint
beginStroke(IPointerPoint)
Begins a stroke in the canvas.
function beginStroke(p: IPointerPoint)Parameters
The starting point of the stroke.
Inherited From DryWetCanvas.beginStroke
cancelStroke()
clear()
endStroke(IPointerPoint)
Ends the current stroke in the canvas.
function endStroke(p?: IPointerPoint)Parameters
Optional. The end point of the stroke. If not specified, the end point is the last one added.
Inherited From DryWetCanvas.endStroke
fadeOut()
Fades the canvas out by decreasing its opacity, and eventually removes it from the DOM.
function fadeOut()Inherited From DryWetCanvas.fadeOut
removeFromDOM()
renderStroke(IStroke)
Renders the specified stroke onto the canvas.
function renderStroke(stroke: IStroke)Parameters
- stroke
- IStroke
The stroke to render.
Inherited From DryWetCanvas.renderStroke
resize(number, number)
Resizes this canvas.
function resize(width: number, height: number)Parameters
- width
-
number
The new width of the canvas, in pixels.
- height
-
number
The new height of the canvas, in pixels.
Inherited From DryWetCanvas.resize
setBrush(IBrush)
Sets the current brush for the canvas.
function setBrush(value: IBrush)Parameters
- value
- IBrush
The brush.
Inherited From DryWetCanvas.setBrush