Home Manual Reference Source

References

References

Class Summary

Static Public Class Summary
public

Editor

Function Summary

Static Public Function Summary
public

addPoint(stroke: Stroke, point: {x: Number, y: Number, t: Number}): Stroke

Mutate a stroke by adding a point to it.

public

addStroke(model: Model, stroke: Stroke): Model

Mutate the model given in parameter by adding the new strokeToAdd.

public

addStrokes(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Add strokes to the model

public

appendToPendingStroke(model: Model, point: {x: Number, y: Number, t: Number}): Model

Mutate the model by adding a point to the current pending stroke.

public

attach(element: Element, minHeight: Number, minWidth: Number): Object

Attach the renderer to the DOM element

public

attach(element: Element, editor: Editor, offsetTop: Number, offsetLeft: Number): GrabberContext

Listen for the desired events

public

attach(element: Element): Object

Populate the dom element

public

buildConfiguration(configuration: *): *

public

buildInput(recognizerContext: RecognizerContext, model: Model): Object

Internal function to build the payload to ask for a recognition.

public

buildNewContentPackageInput(configuration: *, element: *): {"type": string, "applicationKey": *, "xDpi": *, "yDpi": *, "viewSizeHeight": *, "viewSizeWidth": *}

public

buildNewContentPart(configuration: *): {"type": string, "contentType": *, "mimeTypes": *}

public

buildOpenContentPart(configuration: *, partId: *): {"type": string, "id": *, "mimeTypes": *}

public

buildRestoreIInkSessionInput(configuration: *, element: *, sessionId: *): {"type": string, "iinkSessionId": *, "applicationKey": *, "xDpi": *, "yDpi": *, "viewSizeHeight": *, "viewSizeWidth": *}

public

buildSetPenStyle(penStyle: *): {"type": string, "style": *}

public

buildSetPenStyleClasses(penStyleClasses: *): {"type": string, "styleClasses": *}

public

buildSetTheme(theme: *): {"type": string, "theme": *}

public

buildWebSocketCallback(destructuredPromise: DestructuredPromise, recognizerContext: RecognizerContext): function

This function bind the right behaviour when a message is receive by the websocket.

public

buildWebSocketCallback(destructuredPromise: DestructuredPromise, recognizerContext: RecognizerContext): function

This function bind the right behaviour when a message is receive by the websocket.

public

canReconnect(recognizerContext: RecognizerContext): Boolean

Test if it is possible to reconnect

public

clear(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Clear server context.

public

clear(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Clear server context.

public

clear(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Clear action

public

clear(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Clear server context.

public

clear(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Do what is needed to clean the server context.

public

clear(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Do what is needed to clean the server context.

public

Clear the model.

public

Clone model

public

close(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Close and free all resources that will no longer be used by the recognizer.

public

close(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Close and free all resources that will no longer be used by the recognizer.

public

close(recognizerContext: RecognizerContext, code: Number, reason: String)

Close the websocket

public

computeAxeAngle(begin: {x: Number, y: Number}, end: {x: Number, y: Number}): Number

public

computeHmac(input: Object, applicationKey: String, hmacKey: String): String

Compute HMAC signature for server authentication

public

computeLinksPoints(point: {x: Number, y: Number, p: Number}, angle: *, width: *): [{x: Number, y: Number},{x: Number, y: Number}]

public

computeMiddlePoint(point1: {x: Number, y: Number, p: Number}, point2: {x: Number, y: Number, p: Number}): {x: Number, y: Number, p: Number}

public
public

convert(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback, conversionState: String)

Convert action

public

Create a new recognizer context

public

createModel(configuration: Configuration): Model

Create a new model

public

Create a new smart guide

public

Create a new stroke

public

createUndoRedoContext(configuration: Configuration): UndoRedoContext

Create a new undo/redo context

public
public

detach(element: Element, context: Object)

Detach the renderer from the DOM element

public

detach(element: Element, context: Object)

Detach the renderer from the DOM element

public

detach(element: *, context: *)

public

drawCurrentStroke(context: Object, model: Model, stroker: Stroker): Model

Draw the current stroke from the model

public

drawCurrentStroke(context: Object, model: Model, stroker: Stroker): Model

Draw the current stroke from the model

public

drawLine(context: Object, p1: {x: Number, y: Number}, p2: {x: Number, y: Number})

Draw a line

public

drawMathSymbol(context: Object, symbol: Object, model: Model, stroker: Stroker)

Draw a math symbol

public

drawModel(context: Object, model: Model, stroker: Stroker): Model

Draw all symbols contained into the model

public

drawModel(context: Object, model: Model, stroker: Stroker): Model

Draw all symbols contained into the model

public

drawMusicSymbol(context: Object, symbol: Object)

Draw a music symbol

public

drawShapeSymbol(context: Object, symbol: Object)

Draw a shape symbol

public

drawStroke(context: Object, stroke: Stroke)

Draw a stroke on a canvas, using quadratics

public

drawStroke(context: Object, stroke: Stroke, stroker: Stroker)

Draw a stroke symbol

public

drawStroke(context: Object, stroke: Stroke, stroker: Stroker)

Draw a stroke symbol

public

drawStroke(context: Object, stroke: Stroke)

Draw a stroke on a svg tag, using quadratics

public

drawTextSymbol(context: Object, symbol: Object)

Draw a text symbol

public

endPendingStroke(model: Model, point: {x: Number, y: Number, t: Number}): Model

Mutate the model by adding the new point on a initPendingStroke.

public

eventCallback(type: String, data: Object)

Emits an event when the editor state change

public

export_(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Export content

public

export_(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Export content

public

export_(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Export content

public

export_(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback): *

Export content

public

export_(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback): *

Export content

public

export_(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Export content

public

export_(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback, requestedMimeTypes: Array[String])

Export action

public

export_(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Export content

public

Extract the exports

public

Extract the exports

public

Extract the exports

public

Get the symbols that needs to be rendered

public

Get the strokes that needs to be recognized

public

Extract the recognized symbols

public

Extract the recognized symbols

public

Extract recognized symbols from recognition output

public

extractStrokesFromInkRange(model: Model, firstStroke: Number, lastStroke: Number, firstPoint: Number, lastPoint: Number): Array<Stroke>

Extract strokes from an ink range

public

get(recognizerContext: RecognizerContext, url: String, params: Object): Promise

Get request

public

Return the list of available recognition languages

public

Get the bounds of the current model.

public

getDefaultSymbols(configuration: Configuration): Array

Get the default symbols for the current recognition type

public

getImage(model: Model, stroker: Stroker, margin: Number): String

Generate a PNG image data url from the model

public

Get info

public

Get info

public

Get the configuration supported by this recognizer

public

Get the configuration supported by this recognizer

public

Get the configuration supported by this recognizer

public

Get the configuration supported by this recognizer

public

Get the configuration supported by this recognizer

public

Get the configuration supported by this recognizer

public

Get the configuration supported by this recognizer

public

Get info

public

Get the configuration supported by this recognizer

public

Get info

public

getModel(undoRedoContext: UndoRedoContext, callback: function(err: Object, res: Model, types: ...String), clone: Boolean, types: ...String)

Get current model in stack

public

Retrieve music symbols elements

public

getPointByIndex(stroke: Stroke, index: Number): {x: Number, y: Number, t: Number, p: Number, l: Number}

Extract point by index

public

getStyleFromInkRanges(model: Model, inkRanges: Array<Object>): {color: String, width: Number}

Get style for the strokes matching the ink ranges

public

getSymbolsBounds(symbols: Array, bounds: Bounds): Bounds

Get the box enclosing the given symbols

public

import_(recognizerContext: RecognizerContext, model: Model, data: Blob, callback: RecognizerCallback)

Import action

public

init(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Initialize recognition

public

init(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Initialize recognition

public

init(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Initialize recognition

public

init(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Initialize recognition

public

init(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Initialize recognition

public

init(suffixUrl: String, recognizerContext: RecognizerContext, buildWebSocketCallback: BuildWebSocketFunction, reconnect: function(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)): Promise

Init the websocket recognizer.

public

initPendingStroke(model: Model, point: {x: Number, y: Number, t: Number}, properties: Object, dpi: Number): Model

Mutate the model by adding a point and close the current stroke.

public

inkImporter(editorParam: *, strokes: *, delayBetweenStrokes: *, lastOneDelay: *)

Function to copy past to inject ink during tutorial.

public

Insert the smart guide HTML elements in the DOM.

public

isResetRequired(recognizerContext: RecognizerContext, model: Model): Boolean

Return true if a reset is required, false otherwise

public

launchSmartGuide(smartGuide: SmartGuide, exports: Object): *

Launch the smartguide.

public

mergeModels(models: ...Model): Model

Merge models

public

Check if the model needs to be redrawn.

public

newContentPart(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Create a new content part

public

openContentPart(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Open the recognizer context content part

public

openWebSocket(recognizerContext: RecognizerContext): WebSocket

public

Generate behaviors

public

overrideDefaultConfiguration(configuration: Configuration): Configuration

Generate parameters

public

Generate style

public

Generate theme

public

pointerEvents(recognizerContext: RecognizerContext, model: Model, events: PointerEvents, callback: RecognizerCallback)

Pointer Events

public

post(recognizerContext: RecognizerContext, url: String, data: Object): Promise

Post request

public

postMessage(suffixUrl: String, recognizerContext: RecognizerContext, model: Model, buildMessage: function(recognizerContext: RecognizerContext, model: Model): Object): Promise<Model>

public

redo(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Redo last action

public

redo(undoRedoContext: UndoRedoContext, model: Model, callback: function(err: Object, res: Model, types: ...String))

Redo

public

register(element: Element, configuration: Configuration, penStyle: PenStyle, theme: Theme, behaviors: Behaviors): Editor

Attach an Editor to a DOMElement

public

reset(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Reset server context.

public

reset(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Reset the recognition context

public

reset(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Reset server context.

public

reset(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Reset the recognition context

public

Reset model lastReceivedPosition and lastSentPosition

public

Reset model lastRenderedPosition

public

resize(context: Object, model: Model, stroker: Stroker, minHeight: Number, minWidth: Number): Model

Update the rendering context size

public

resize(recognizerContext: RecognizerContext, model: Model, element: Element, callback: RecognizerCallback)

Resize

public

resize(smartGuide: *)

public

resize(context: Object, model: Model, stroker: Stroker): Model

Update the rendering context size

public

retry(func: *, recognizerContext: *, model: *, callback: *, params: ...*)

public

send(recognizerContext: RecognizerContext, message: Object)

Send data message

public

sendMessage(recognizerContext: RecognizerContext, buildMessage: function(params: ...Object): Object, params: ...Object): Promise

public

setPenStyle(recognizerContext: RecognizerContext, model: Model, penStyle: PenStyle, callback: RecognizerCallback)

SetPenStyle action

public

setPenStyleClasses(recognizerContext: RecognizerContext, model: Model, penStyleClasses: String, callback: RecognizerCallback)

setPenStyleClasses action

public

Set the recognition context

public

setTheme(recognizerContext: RecognizerContext, model: Model, theme: Theme, callback: RecognizerCallback)

SetTheme action

public

Test if it should attempt immediate reconnect

public

slice(stroke: Stroke, start: Number, end: Number): Stroke

Slice a stroke and return the sliced part of it

public

toCSS(penStyle: *): *

public

toCSS(theme: *): *

public

toJSON(theme: *): *

public

toJSON(penStyle: *): *

public

toJSON(stroke: Stroke): {type: String, x: Array<Number>, y: Array<Number>, t: Array<Number>}

Get a JSON copy of a stroke by filtering its properties

public

undo(undoRedoContext: UndoRedoContext, model: Model, callback: function(err: Object, res: Model, types: ...String))

Undo

public

undo(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

Undo last action

public

updateModel(undoRedoContext: UndoRedoContext, model: Model, callback: function(err: Object, res: Model, types: ...String))

Mutate the undoRedo stack by adding a new model to it.

public

Update model lastReceivedPosition regarding to lastSentPosition

public

Update model lastRenderedPosition

public

Update model lastSentPosition

public

Update the recognition context positions

public

Update the undo/redo state

public

waitForIdle(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)

WaitForIdle action

public

zoom(recognizerContext: RecognizerContext, model: Model, value: Number, callback: RecognizerCallback)

Zoom action

Variable Summary

Static Public Variable Summary
public

Explicit close message

public

Recognizer configuration

public

Lost connection message

public

MathSymbols: {inputCharacter: String, char: String, string: String, textLine: String}

public

MusicClefs: {F: {svg: String, getBoundingBox: function}, C: {svg: String, getBoundingBox: function}, G: {svg: String, getBoundingBox: function}}

public

MusicSymbols: {accidental: String, arpeggiate: String, bar: String, beam: String, clef: String, decoration: String, dots: String, head: String, ledgerLine: String, rest: String, staff: String, stem: String, tieOrSlur: String, timeSignature: String}

public

ShapeSymbols: {table: String, shape: String, recognizedShape: String, ellipse: String, line: String}

public

TextSymbols: {inputCharacter: String, char: String, string: String, textLine: String}

public

Recognizer configuration

public

Log callback events

public

Default behaviors

public

defaultConfiguration: Configuration

Default configuration

public

Default style

public

Default theme

public

Log editor events

public

Log grabber events

public

Main log instance

public

Recognizer configuration

public

Recognizer configuration

public

Log model events

public

Recognizer configuration

public

Log recognizer events

public

Log grabber events

public

Recognizer configuration

public

Log editor events

public

Log tests events

public

Recognizer configuration

public

Recognizer configuration

public

Log util events

Typedef Summary

Static Public Typedef Summary
public

Current behavior

public

Set of behaviors to be used by the Editor

public

Bounding box

public

BuildWebSocketFunction(destructuredPromise: DestructuredPromise, recognizerContext: RecognizerContext): Callback: function

Build websocket function

public

Simple callback

public
public
public
public

Grab pointerDown, pointerMove and pointerUp events

public

Grabber context

public

Grabber listener

public
public
public

Editor model

public
public

Raw results

public

Recognition context

public

Recognition positions

public

Recognition service entry point

public

RecognizerCallback(err: Object, model: Model, types: ...String): function

Recognizer callback

public

Recognizer context

public

Recognizer info

public

Default renderer

public

Renderer info

public

Smart guide

public
public

Stroke symbol

public

Define how a stroke should be drawn

public

Stroker info

public
public
public

Triggers

public

Undo/redo context

public

Undo/redo manager

public

pointerEvents symbol

v1.2.0

v1.2.0

Features

  • Change build task runner from grunt to gulp
  • Add accessors to host to make it mutable
  • Add accessors to protocol to make it mutable
  • Add accessors to parameters to make them mutable
  • Add accessors to components to make them mutable (@see mandatory clef on music)
  • Add enum style variables on string constants to ease implementation
  • Mark globalAlpha parameter as deprecated
  • Migrate JQuery Pointer Event Polyfill to 0.4.1

Bugs

  • Fixes parameters constructors to allow json construction, used also to copy them
  • Fixes components constructors to allow json construction, used also to copy them
  • Fixes issue on shape recognition undo/redo
  • Fixes issue on music recognition undo/redo (@see mutable components feature)
  • Fixes issue on network interfaces (@see mutable host feature)
  • Fixes missing callback call when timeout === 0
  • Fixes set parameters on WebSocket recognition (@see mutable parameters feature)
  • Fixes ink-paper positioning issue (CSS change)
  • Fixes wrong pointer events coordinates
  • Fixes getAvailableLanguages to use correct inputMode
  • Fixes high-resolution rendering