References

Class Summary

Static Public Class Summary
public	Editor 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	clearModel(model: Model): Model Clear the model.
public	cloneModel(model: Model): Model 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	computeStats(model: Model): Stats
public	convert(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback, conversionState: String) Convert action
public	createEmptyRecognizerContext(editor: Editor): RecognizerContext Create a new recognizer context
public	createModel(configuration: Configuration): Model Create a new model
public	createSmartGuide(editor: Editor): SmartGuide Create a new smart guide
public	createStrokeComponent(properties: Object): Stroke Create a new stroke
public	createUndoRedoContext(configuration: Configuration): UndoRedoContext Create a new undo/redo context
public	destructurePromise(): DestructuredPromise
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	extractExports(model: Model): Object Extract the exports
public	extractExports(model: Model): Object Extract the exports
public	extractExports(model: Model): Object Extract the exports
public	extractPendingRecognizedSymbols(model: Model, position: Number): Array<Object> Get the symbols that needs to be rendered
public	extractPendingStrokes(model: Model, position: Number): Array<Stroke> Get the strokes that needs to be recognized
public	extractRecognizedSymbols(model: Model): Array<Object> Extract the recognized symbols
public	extractRecognizedSymbols(model: Model): Array<Object> Extract the recognized symbols
public	extractShapeSymbols(model: Model, segment: Object): Array<Object> 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	getAvailableLanguageList(): JSON Return the list of available recognition languages
public	getBorderCoordinates(model: Model): Bounds 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	getInfo(): StrokerInfo Get info
public	getInfo(): RendererInfo Get info
public	getInfo(): RecognizerInfo Get the configuration supported by this recognizer
public	getInfo(): RecognizerInfo Get the configuration supported by this recognizer
public	getInfo(): RecognizerInfo Get the configuration supported by this recognizer
public	getInfo(): RecognizerInfo Get the configuration supported by this recognizer
public	getInfo(): RecognizerInfo Get the configuration supported by this recognizer
public	getInfo(): RecognizerInfo Get the configuration supported by this recognizer
public	getInfo(): RecognizerInfo Get the configuration supported by this recognizer
public	getInfo(): StrokerInfo Get info
public	getInfo(): RecognizerInfo Get the configuration supported by this recognizer
public	getInfo(): RendererInfo Get info
public	getModel(undoRedoContext: UndoRedoContext, callback: function(err: Object, res: Model, types: ...String), clone: Boolean, types: ...String) Get current model in stack
public	getMusicClefElements(): Array<Element> 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	insertSmartGuide(smartGuide: SmartGuide) 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	needRedraw(model: Model): Boolean 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	overrideDefaultBehaviors(behaviors: Behaviors): Behaviors Generate behaviors
public	overrideDefaultConfiguration(configuration: Configuration): Configuration Generate parameters
public	overrideDefaultPenStyle(style: PenStyle): PenStyle Generate style
public	overrideDefaultTheme(theme: Theme): Theme 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	resetModelPositions(model: Model): Model Reset model lastReceivedPosition and lastSentPosition
public	resetModelRendererPosition(model: Model): Model 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	setRecognitionContext(recognizerContext: RecognizerContext, recognitionContext: RecognitionContext): RecognizerContext Set the recognition context
public	setTheme(recognizerContext: RecognizerContext, model: Model, theme: Theme, callback: RecognizerCallback) SetTheme action
public	shouldAttemptImmediateReconnect(recognizerContext: RecognizerContext): Boolean 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	updateModelReceivedPosition(model: Model): Model Update model lastReceivedPosition regarding to lastSentPosition
public	updateModelRenderedPosition(model: Model, position: Number): Model Update model lastRenderedPosition
public	updateModelSentPosition(model: Model, position: Number): Model Update model lastSentPosition
public	updateRecognitionPositions(recognizerContext: RecognizerContext, positions: RecognitionPositions): RecognizerContext Update the recognition context positions
public	updateUndoRedoState(undoRedoContext: UndoRedoContext): UndoRedoContext 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	CLOSE_RECOGNIZER_MESSAGE: String Explicit close message
public	IInkWebSocketV4Configuration: RecognizerInfo Recognizer configuration
public	LOST_CONNEXION_MESSAGE: {type: string} 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	analyzerRestV3Configuration: RecognizerInfo Recognizer configuration
public	callbackLogger: Object Log callback events
public	defaultBehaviors: Behaviors Default behaviors
public	defaultConfiguration: Configuration Default configuration
public	defaultPenStyle: PenStyle Default style
public	defaultTheme: Theme Default theme
public	editorLogger: Object Log editor events
public	grabberLogger: Object Log grabber events
public	log: Object Main log instance
public	mathRestV3Configuration: RecognizerInfo Recognizer configuration
public	mathWebSocketV3Configuration: RecognizerInfo Recognizer configuration
public	modelLogger: Object Log model events
public	musicRestV3Configuration: RecognizerInfo Recognizer configuration
public	recognizerLogger: Object Log recognizer events
public	rendererLogger: Object Log grabber events
public	shapeRestV3Configuration: RecognizerInfo Recognizer configuration
public	smartGuideLogger: Object Log editor events
public	testLogger: Object Log tests events
public	textRestV3Configuration: RecognizerInfo Recognizer configuration
public	textWebSocketV3Configuration: RecognizerInfo Recognizer configuration
public	utilLogger: Object Log util events

Typedef Summary

Static Public Typedef Summary
public	Behavior: Object Current behavior
public	Behaviors: Object Set of behaviors to be used by the Editor
public	Bounds: Object Bounding box
public	BuildWebSocketFunction(destructuredPromise: DestructuredPromise, recognizerContext: RecognizerContext): Callback: function Build websocket function
public	Callback(err: Object, res: Object): function Simple callback
public	Constants: Object
public	DestructuredPromise: Object
public	GeneratedTheme: Object
public	Grabber: Object Grab pointerDown, pointerMove and pointerUp events
public	GrabberContext: Object Grabber context
public	GrabberListener: Object Grabber listener
public	InkTheme: PenStyle
public	MathTheme: Object
public	Model: Object Editor model
public	PenStyle: Object
public	RawResults: Object Raw results
public	RecognitionContext: Object Recognition context
public	RecognitionPositions: Object Recognition positions
public	Recognizer: Object Recognition service entry point
public	RecognizerCallback(err: Object, model: Model, types: ...String): function Recognizer callback
public	RecognizerContext: Object Recognizer context
public	RecognizerInfo: Object Recognizer info
public	Renderer: Object Default renderer
public	RendererInfo: Object Renderer info
public	SmartGuide: Object Smart guide
public	Stats: Object
public	Stroke: Object Stroke symbol
public	Stroker: Object Define how a stroke should be drawn
public	StrokerInfo: Object Stroker info
public	TextTheme: Object
public	Theme: Object
public	Triggers: Object Triggers
public	UndoRedoContext: Object Undo/redo context
public	UndoRedoManager: Object Undo/redo manager
public	pointerEvents: Object pointerEvents symbol