Function
| Static Public Summary | ||
| public |
Mutate a stroke by adding a point to it. |
|
| public |
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 |
Mutate the model by adding a point to the current pending stroke. |
|
| public |
Listen for the desired events |
|
| public |
Populate the dom element |
|
| public |
Attach the renderer to 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 |
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 |
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(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 server context. |
|
| public |
clear(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) Clear action |
|
| 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, code: Number, reason: String) Close the websocket |
|
| public |
close(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) Close and free all resources that will no longer be used by the recognizer. |
|
| public |
|
|
| 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) Convert action |
|
| public |
Create a new recognizer context |
|
| public |
createModel(configuration: Configuration): Model Create a new model |
|
| public |
createStrokeComponent(properties: Object): Stroke Create a new stroke |
|
| public |
createUndoRedoContext(configuration: Configuration): UndoRedoContext Create a new undo/redo context |
|
| public |
|
|
| public |
Detach the renderer from the DOM element |
|
| public |
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 |
Draw a line |
|
| public |
drawMathSymbol(context: Object, symbol: Object, model: Model, stroker: Stroker) Draw a math symbol |
|
| public |
Draw all symbols contained into the model |
|
| public |
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 svg tag, using quadratics |
|
| public |
drawStroke(context: Object, stroke: Stroke, stroker: Stroker) Draw a stroke 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 |
drawTextSymbol(context: Object, symbol: Object) Draw a text symbol |
|
| public |
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 |
exportContent(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) Export content |
|
| public |
exportContent(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) Export content |
|
| public |
exportContent(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) Export content |
|
| public |
exportContent(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) Export action |
|
| public |
exportContent(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) Export content |
|
| public |
exportContent(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) Export content |
|
| public |
exportContent(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback): * Export content |
|
| public |
exportContent(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(configuration: Configuration, sortByValue: Boolean): Promise<Object> 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 |
Generate a PNG image data url from the model |
|
| public |
Get info |
|
| 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 |
Get the configuration supported by this recognizer |
|
| 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 |
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 |
Get style for the strokes matching the ink ranges |
|
| public |
getSymbolsBounds(symbols: Array, bounds: Bounds): Bounds Get the box enclosing the given symbols |
|
| public |
importContent(recognizerContext: RecognizerContext, model: Model, point: {x: Number, y: Number}, data: Blob, callback: RecognizerCallback) Import action |
|
| public |
importInk(recognizerContext: RecognizerContext, model: Model, strokes: Array<Stroke>, callback: RecognizerCallback) Import ink |
|
| 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 |
init(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) Initialize recognition |
|
| public |
init(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) Initialize recognition |
|
| 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 |
isResetRequired(recognizerContext: RecognizerContext, model: Model): Boolean Return true if a reset is required, false otherwise |
|
| public |
loadFromConfiguration(configuration: *): * |
|
| 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 |
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 server context. |
|
| public |
reset(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) Reset the recognition 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 |
Update the rendering context size |
|
| public |
Update the rendering context size |
|
| public |
resize(recognizerContext: RecognizerContext, model: Model, element: Element, callback: RecognizerCallback) Resize |
|
| public |
retry(func: *, recognizerContext: *, model: *, callback: *) |
|
| 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 |
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 a stroke and return the sliced part of it |
|
| public |
toCSS(theme: *): * |
|
| public |
toCSS(penStyle: *): * |
|
| public |
Get a JSON copy of a stroke by filtering its properties |
|
| public |
toJSON(theme: *): * |
|
| public |
toJSON(penStyle: *): * |
|
| public |
undo(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) Undo last action |
|
| public |
undo(undoRedoContext: UndoRedoContext, model: Model, callback: function(err: Object, res: Model, types: ...String)) Undo |
|
| 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 |
|
Static Public
public addPoint(stroke: Stroke, point: {x: Number, y: Number, t: Number}): Stroke source
import {addPoint} from 'myscript/src/model/StrokeComponent.js'Mutate a stroke by adding a point to it.
public addStroke(model: Model, stroke: Stroke): Model source
import {addStroke} from 'myscript/src/model/InkModel.js'Mutate the model given in parameter by adding the new strokeToAdd.
public addStrokes(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {addStrokes} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Add strokes to the model
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognition context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public appendToPendingStroke(model: Model, point: {x: Number, y: Number, t: Number}): Model source
import {appendToPendingStroke} from 'myscript/src/model/InkModel.js'Mutate the model by adding a point to the current pending stroke.
public attach(element: Element, editor: Editor, offsetTop: Number, offsetLeft: Number): GrabberContext source
import {attach} from 'myscript/src/grabber/PointerEventGrabber.js'Listen for the desired events
Listen:
pointermove: a pointer moves, similar to touchmove or mousemove. |
|
pointerdown: a pointer is activated, or a device button held. |
|
pointerup: a pointer is deactivated, or a device button released. |
|
pointerover: a pointer has moved onto an element. |
|
pointerout: a pointer is no longer on an element it once was. |
|
pointerenter: a pointer enters the bounding box of an element. |
|
pointerleave: a pointer leaves the bounding box of an element. |
|
pointercancel: a pointer will no longer generate events. |
public attach(element: Element): Object source
import {attach} from 'myscript/src/renderer/svg/SVGRenderer.js'Populate the dom element
Params:
| Name | Type | Attribute | Description |
| element | Element | DOM element to attach the rendering elements |
public attach(element: Element): Object source
import {attach} from 'myscript/src/renderer/canvas/CanvasRenderer.js'Attach the renderer to the DOM element
Params:
| Name | Type | Attribute | Description |
| element | Element | DOM element to attach the rendering elements |
public buildConfiguration(configuration: *): * source
import {buildConfiguration} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Params:
| Name | Type | Attribute | Description |
| configuration | * |
Return:
| * |
public buildInput(recognizerContext: RecognizerContext, model: Model): Object source
import {buildInput} from 'myscript/src/recognizer/rest/v3/Cdkv3RestTextRecognizer.js'Internal function to build the payload to ask for a recognition.
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | ||
| model | Model |
public buildNewContentPackageInput(configuration: *, element: *): {"type": string, "applicationKey": *, "xDpi": *, "yDpi": *, "viewSizeHeight": *, "viewSizeWidth": *} source
import {buildNewContentPackageInput} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Params:
| Name | Type | Attribute | Description |
| configuration | * | ||
| element | * |
Return:
| {"type": string, "applicationKey": *, "xDpi": *, "yDpi": *, "viewSizeHeight": *, "viewSizeWidth": *} |
public buildNewContentPart(configuration: *): {"type": string, "contentType": *, "mimeTypes": *} source
import {buildNewContentPart} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Params:
| Name | Type | Attribute | Description |
| configuration | * |
public buildOpenContentPart(configuration: *, partId: *): {"type": string, "id": *, "mimeTypes": *} source
import {buildOpenContentPart} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Params:
| Name | Type | Attribute | Description |
| configuration | * | ||
| partId | * |
public buildRestoreIInkSessionInput(configuration: *, element: *, sessionId: *): {"type": string, "iinkSessionId": *, "applicationKey": *, "xDpi": *, "yDpi": *, "viewSizeHeight": *, "viewSizeWidth": *} source
import {buildRestoreIInkSessionInput} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Params:
| Name | Type | Attribute | Description |
| configuration | * | ||
| element | * | ||
| sessionId | * |
Return:
| {"type": string, "iinkSessionId": *, "applicationKey": *, "xDpi": *, "yDpi": *, "viewSizeHeight": *, "viewSizeWidth": *} |
public buildSetPenStyle(penStyle: *): {"type": string, "style": *} source
import {buildSetPenStyle} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Params:
| Name | Type | Attribute | Description |
| penStyle | * |
public buildSetTheme(theme: *): {"type": string, "theme": *} source
import {buildSetTheme} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Params:
| Name | Type | Attribute | Description |
| theme | * |
public buildWebSocketCallback(destructuredPromise: DestructuredPromise, recognizerContext: RecognizerContext): function source
import {buildWebSocketCallback} from 'myscript/src/recognizer/websocket/v3/Cdkv3WSBuilder.js'This function bind the right behaviour when a message is receive by the websocket.
Params:
| Name | Type | Attribute | Description |
| destructuredPromise | DestructuredPromise | ||
| recognizerContext | RecognizerContext | Current recognizer context |
public buildWebSocketCallback(destructuredPromise: DestructuredPromise, recognizerContext: RecognizerContext): function source
import {buildWebSocketCallback} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSBuilder.js'This function bind the right behaviour when a message is receive by the websocket.
Params:
| Name | Type | Attribute | Description |
| destructuredPromise | DestructuredPromise | ||
| recognizerContext | RecognizerContext | Current recognizer context |
public clear(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {clear} from 'myscript/src/recognizer/websocket/CdkWSRecognizerUtil.js'Do what is needed to clean the server context.
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public clear(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {clear} from 'myscript/src/recognizer/rest/v3/Cdkv3RestShapeRecognizer.js'Do what is needed to clean the server context.
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public clear(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {clear} from 'myscript/src/recognizer/DefaultRecognizer.js'Clear server context. Currently nothing to do there.
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public clear(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {clear} from 'myscript/src/recognizer/websocket/v3/Cdkv3WSMathRecognizer.js'Clear server context. Currently nothing to do there.
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public clear(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {clear} from 'myscript/src/recognizer/websocket/v3/Cdkv3WSTextRecognizer.js'Clear server context. Currently nothing to do there.
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public clear(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {clear} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Clear action
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognition context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public clearModel(model: Model): Model source
import {clearModel} from 'myscript/src/model/InkModel.js'Clear the model.
Params:
| Name | Type | Attribute | Description |
| model | Model | Current model |
public cloneModel(model: Model): Model source
import {cloneModel} from 'myscript/src/model/InkModel.js'Clone model
Params:
| Name | Type | Attribute | Description |
| model | Model | Current model |
public close(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {close} from 'myscript/src/recognizer/websocket/CdkWSRecognizerUtil.js'Close and free all resources that will no longer be used by the recognizer.
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | ||
| model | Model | ||
| callback | RecognizerCallback |
public close(recognizerContext: RecognizerContext, code: Number, reason: String) source
import {close} from 'myscript/src/recognizer/websocket/networkWSInterface.js'Close the websocket
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| code | Number | Exit code |
|
| reason | String | Exit reason |
public close(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {close} from 'myscript/src/recognizer/DefaultRecognizer.js'Close and free all resources that will no longer be used by the recognizer.
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public computeAxeAngle(begin: {x: Number, y: Number}, end: {x: Number, y: Number}): Number source
import {computeAxeAngle} from 'myscript/src/renderer/QuadraticUtils.js'public computeHmac(input: Object, applicationKey: String, hmacKey: String): String source
import {computeHmac} from 'myscript/src/recognizer/CryptoHelper.js'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}] source
import {computeLinksPoints} from 'myscript/src/renderer/QuadraticUtils.js'Return:
| [{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} source
import {computeMiddlePoint} from 'myscript/src/renderer/QuadraticUtils.js'public computeStats(model: Model): Stats source
import {computeStats} from 'myscript/src/util/ModelStats.js'Params:
| Name | Type | Attribute | Description |
| model | Model | Current model |
public convert(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {convert} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Convert action
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognition context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public createEmptyRecognizerContext(editor: Editor): RecognizerContext source
import {createEmptyRecognizerContext} from 'myscript/src/model/RecognizerContext.js'Create a new recognizer context
Params:
| Name | Type | Attribute | Description |
| editor | Editor |
public createModel(configuration: Configuration): Model source
import {createModel} from 'myscript/src/model/InkModel.js'Create a new model
Params:
| Name | Type | Attribute | Description |
| configuration | Configuration |
|
Parameters to use to populate default recognition symbols |
public createStrokeComponent(properties: Object): Stroke source
import {createStrokeComponent} from 'myscript/src/model/StrokeComponent.js'Create a new stroke
Params:
| Name | Type | Attribute | Description |
| properties | Object | Properties to be applied to the stroke. |
public createUndoRedoContext(configuration: Configuration): UndoRedoContext source
import {createUndoRedoContext} from 'myscript/src/model/UndoRedoContext.js'Create a new undo/redo context
Params:
| Name | Type | Attribute | Description |
| configuration | Configuration | Current configuration |
public destructurePromise(): DestructuredPromise source
import {destructurePromise} from 'myscript/src/util/PromiseHelper.js'public detach(element: Element, context: Object) source
import {detach} from 'myscript/src/renderer/canvas/CanvasRenderer.js'Detach the renderer from the DOM element
public detach(element: Element, context: Object) source
import {detach} from 'myscript/src/renderer/svg/SVGRenderer.js'Detach the renderer from the DOM element
public detach(element: *, context: *) source
import {detach} from 'myscript/src/grabber/PointerEventGrabber.js'Params:
| Name | Type | Attribute | Description |
| element | * | ||
| context | * |
public drawCurrentStroke(context: Object, model: Model, stroker: Stroker): Model source
import {drawCurrentStroke} from 'myscript/src/renderer/svg/SVGRenderer.js'Draw the current stroke from the model
public drawCurrentStroke(context: Object, model: Model, stroker: Stroker): Model source
import {drawCurrentStroke} from 'myscript/src/renderer/canvas/CanvasRenderer.js'Draw the current stroke from the model
public drawLine(context: Object, p1: {x: Number, y: Number}, p2: {x: Number, y: Number}) source
import {drawLine} from 'myscript/src/renderer/canvas/symbols/ShapeSymbolCanvasRenderer.js'Draw a line
public drawMathSymbol(context: Object, symbol: Object, model: Model, stroker: Stroker) source
import {drawMathSymbol} from 'myscript/src/renderer/canvas/symbols/MathSymbolCanvasRenderer.js'Draw a math symbol
public drawModel(context: Object, model: Model, stroker: Stroker): Model source
import {drawModel} from 'myscript/src/renderer/svg/SVGRenderer.js'Draw all symbols contained into the model
public drawModel(context: Object, model: Model, stroker: Stroker): Model source
import {drawModel} from 'myscript/src/renderer/canvas/CanvasRenderer.js'Draw all symbols contained into the model
public drawMusicSymbol(context: Object, symbol: Object) source
import {drawMusicSymbol} from 'myscript/src/renderer/canvas/symbols/MusicSymbolCanvasRenderer.js'Draw a music symbol
public drawShapeSymbol(context: Object, symbol: Object) source
import {drawShapeSymbol} from 'myscript/src/renderer/canvas/symbols/ShapeSymbolCanvasRenderer.js'Draw a shape symbol
public drawStroke(context: Object, stroke: Stroke) source
import {drawStroke} from 'myscript/src/renderer/svg/stroker/QuadraticSVGStroker.js'Draw a stroke on a svg tag, using quadratics
public drawStroke(context: Object, stroke: Stroke, stroker: Stroker) source
import {drawStroke} from 'myscript/src/renderer/canvas/symbols/StrokeSymbolCanvasRenderer.js'Draw a stroke symbol
public drawStroke(context: Object, stroke: Stroke) source
import {drawStroke} from 'myscript/src/renderer/canvas/stroker/QuadraticCanvasStroker.js'Draw a stroke on a canvas, using quadratics
public drawStroke(context: Object, stroke: Stroke, stroker: Stroker) source
import {drawStroke} from 'myscript/src/renderer/svg/symbols/StrokeSymbolSVGRenderer.js'Draw a stroke symbol
public drawTextSymbol(context: Object, symbol: Object) source
import {drawTextSymbol} from 'myscript/src/renderer/canvas/symbols/TextSymbolCanvasRenderer.js'Draw a text symbol
public endPendingStroke(model: Model, point: {x: Number, y: Number, t: Number}): Model source
import {endPendingStroke} from 'myscript/src/model/InkModel.js'Mutate the model by adding the new point on a initPendingStroke.
public eventCallback(type: String, data: Object) source
import eventCallback from 'myscript/src/callback/EventCallback.js'Emits an event when the editor state change
Emit:
public exportContent(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {exportContent} from 'myscript/src/recognizer/websocket/v3/Cdkv3WSTextRecognizer.js'Export content
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public exportContent(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {exportContent} from 'myscript/src/recognizer/websocket/v3/Cdkv3WSMathRecognizer.js'Export content
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public exportContent(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {exportContent} from 'myscript/src/recognizer/rest/v3/Cdkv3RestTextRecognizer.js'Export content
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public exportContent(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {exportContent} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Export action
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognition context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public exportContent(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {exportContent} from 'myscript/src/recognizer/rest/v3/Cdkv3RestShapeRecognizer.js'Export content
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public exportContent(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {exportContent} from 'myscript/src/recognizer/rest/v3/Cdkv3RestMusicRecognizer.js'Export content
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public exportContent(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback): * source
import {exportContent} from 'myscript/src/recognizer/rest/v3/Cdkv3RestMathRecognizer.js'Export content
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
Return:
| * |
public exportContent(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback): * source
import {exportContent} from 'myscript/src/recognizer/rest/v3/Cdkv3RestAnalyzerRecognizer.js'Export content
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
Return:
| * |
public extractExports(model: Model): Object source
import {extractExports} from 'myscript/src/recognizer/common/v3/Cdkv3CommonTextRecognizer.js'Extract the exports
Params:
| Name | Type | Attribute | Description |
| model | Model | Current model |
public extractExports(model: Model): Object source
import {extractExports} from 'myscript/src/recognizer/common/v3/Cdkv3CommonShapeRecognizer.js'Extract the exports
Params:
| Name | Type | Attribute | Description |
| model | Model | Current model |
public extractExports(model: Model): Object source
import {extractExports} from 'myscript/src/recognizer/common/CdkCommonUtil.js'Extract the exports
Params:
| Name | Type | Attribute | Description |
| model | Model | Current model |
public extractPendingRecognizedSymbols(model: Model, position: Number): Array<Object> source
import {extractPendingRecognizedSymbols} from 'myscript/src/model/InkModel.js'Get the symbols that needs to be rendered
public extractPendingStrokes(model: Model, position: Number): Array<Stroke> source
import {extractPendingStrokes} from 'myscript/src/model/InkModel.js'Get the strokes that needs to be recognized
public extractRecognizedSymbols(model: Model): Array<Object> source
import {extractRecognizedSymbols} from 'myscript/src/recognizer/common/v3/Cdkv3CommonShapeRecognizer.js'Extract the recognized symbols
Params:
| Name | Type | Attribute | Description |
| model | Model | Current model |
public extractRecognizedSymbols(model: Model): Array<Object> source
import {extractRecognizedSymbols} from 'myscript/src/recognizer/common/v3/Cdkv3CommonMathRecognizer.js'Extract the recognized symbols
Params:
| Name | Type | Attribute | Description |
| model | Model | Current model |
public extractShapeSymbols(model: Model, segment: Object): Array<Object> source
import {extractShapeSymbols} from 'myscript/src/recognizer/common/v3/Cdkv3CommonShapeRecognizer.js'Extract recognized symbols from recognition output
public extractStrokesFromInkRange(model: Model, firstStroke: Number, lastStroke: Number, firstPoint: Number, lastPoint: Number): Array<Stroke> source
import {extractStrokesFromInkRange} from 'myscript/src/model/InkModel.js'Extract strokes from an ink range
public get(recognizerContext: RecognizerContext, url: String, params: Object): Promise source
import {get} from 'myscript/src/recognizer/rest/networkInterface.js'Get request
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Recognizer context |
|
| url | String | URL |
|
| params | Object | Query properties |
public getAvailableLanguageList(configuration: Configuration, sortByValue: Boolean): Promise<Object> source
import {getAvailableLanguageList} from 'myscript/src/EditorFacade.js'Return the list of available recognition languages
Params:
| Name | Type | Attribute | Description |
| configuration | Configuration | Current configuration |
|
| sortByValue | Boolean |
|
True if the language list should be sort by value, false otherwise |
public getBorderCoordinates(model: Model): Bounds source
import {getBorderCoordinates} from 'myscript/src/model/InkModel.js'Get the bounds of the current model.
Params:
| Name | Type | Attribute | Description |
| model | Model | Current model |
public getDefaultSymbols(configuration: Configuration): Array source
import {getDefaultSymbols} from 'myscript/src/model/Symbol.js'Get the default symbols for the current recognition type
Params:
| Name | Type | Attribute | Description |
| configuration | Configuration | Current recognition parameters from which extract default symbols |
public getImage(model: Model, stroker: Stroker, margin: Number): String source
import {getImage} from 'myscript/src/renderer/canvas/ImageRenderer.js'Generate a PNG image data url from the model
public getInfo(): StrokerInfo source
import {getInfo} from 'myscript/src/renderer/canvas/stroker/QuadraticCanvasStroker.js'Get info
public getInfo(): RecognizerInfo source
import {getInfo} from 'myscript/src/recognizer/rest/v3/Cdkv3RestMathRecognizer.js'Get the configuration supported by this recognizer
public getInfo(): RecognizerInfo source
import {getInfo} from 'myscript/src/recognizer/rest/v3/Cdkv3RestMusicRecognizer.js'Get the configuration supported by this recognizer
public getInfo(): StrokerInfo source
import {getInfo} from 'myscript/src/renderer/svg/stroker/QuadraticSVGStroker.js'Get info
public getInfo(): RecognizerInfo source
import {getInfo} from 'myscript/src/recognizer/rest/v3/Cdkv3RestAnalyzerRecognizer.js'Get the configuration supported by this recognizer
public getInfo(): RendererInfo source
import {getInfo} from 'myscript/src/renderer/svg/SVGRenderer.js'Get info
public getInfo(): RecognizerInfo source
import {getInfo} from 'myscript/src/recognizer/websocket/v3/Cdkv3WSMathRecognizer.js'Get the configuration supported by this recognizer
public getInfo(): RendererInfo source
import {getInfo} from 'myscript/src/renderer/canvas/CanvasRenderer.js'Get info
public getInfo(): RecognizerInfo source
import {getInfo} from 'myscript/src/recognizer/rest/v3/Cdkv3RestTextRecognizer.js'Get the configuration supported by this recognizer
public getInfo(): RecognizerInfo source
import {getInfo} from 'myscript/src/recognizer/rest/v3/Cdkv3RestShapeRecognizer.js'Get the configuration supported by this recognizer
public getInfo(): RecognizerInfo source
import {getInfo} from 'myscript/src/recognizer/websocket/v3/Cdkv3WSTextRecognizer.js'Get the configuration supported by this recognizer
public getInfo(): RecognizerInfo source
import {getInfo} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Get the configuration supported by this recognizer
public getModel(undoRedoContext: UndoRedoContext, callback: function(err: Object, res: Model, types: ...String), clone: Boolean, types: ...String) source
import {getModel} from 'myscript/src/model/UndoRedoManager.js'Get current model in stack
public getMusicClefElements(): Array<Element> source
import {getMusicClefElements} from 'myscript/src/renderer/canvas/symbols/MusicSymbolCanvasRenderer.js'Retrieve music symbols elements
public getPointByIndex(stroke: Stroke, index: Number): {x: Number, y: Number, t: Number, p: Number, l: Number} source
import {getPointByIndex} from 'myscript/src/model/StrokeComponent.js'Extract point by index
public getStyleFromInkRanges(model: Model, inkRanges: Array<Object>): {color: String, width: Number} source
import {getStyleFromInkRanges} from 'myscript/src/recognizer/common/v3/Cdkv3CommonShapeRecognizer.js'Get style for the strokes matching the ink ranges
public getSymbolsBounds(symbols: Array, bounds: Bounds): Bounds source
import {getSymbolsBounds} from 'myscript/src/model/Symbol.js'Get the box enclosing the given symbols
public importContent(recognizerContext: RecognizerContext, model: Model, point: {x: Number, y: Number}, data: Blob, callback: RecognizerCallback) source
import {importContent} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Import action
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognition context |
|
| model | Model | Current model |
|
| point | {x: Number, y: Number} | Insert point coordinates |
|
| data | Blob | Import data |
|
| callback | RecognizerCallback |
public importInk(recognizerContext: RecognizerContext, model: Model, strokes: Array<Stroke>, callback: RecognizerCallback) source
import {importInk} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Import ink
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognition context |
|
| model | Model | Current model |
|
| strokes | Array<Stroke> | Ink to be imported |
|
| callback | RecognizerCallback |
public init(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {init} from 'myscript/src/recognizer/websocket/v3/Cdkv3WSMathRecognizer.js'Initialize recognition
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public init(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {init} from 'myscript/src/recognizer/DefaultRecognizer.js'Initialize recognition
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public init(suffixUrl: String, recognizerContext: RecognizerContext, buildWebSocketCallback: BuildWebSocketFunction, reconnect: function(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback)): Promise source
import {init} from 'myscript/src/recognizer/websocket/CdkWSRecognizerUtil.js'Init the websocket recognizer. Open the connexion and proceed to the hmac challenge.
Params:
| Name | Type | Attribute | Description |
| suffixUrl | String | ||
| recognizerContext | RecognizerContext | ||
| buildWebSocketCallback | BuildWebSocketFunction | ||
| reconnect | function(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) |
public init(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {init} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Initialize recognition
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public init(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {init} from 'myscript/src/recognizer/websocket/v3/Cdkv3WSTextRecognizer.js'Initialize recognition
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public initPendingStroke(model: Model, point: {x: Number, y: Number, t: Number}, properties: Object, dpi: Number): Model source
import {initPendingStroke} from 'myscript/src/model/InkModel.js'Mutate the model by adding a point and close the current stroke.
public isResetRequired(recognizerContext: RecognizerContext, model: Model): Boolean source
import {isResetRequired} from 'myscript/src/model/RecognizerContext.js'Return true if a reset is required, false otherwise
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | ||
| model | Model |
public loadFromConfiguration(configuration: *): * source
import {loadFromConfiguration} from 'myscript/src/util/FontLoader.js'Params:
| Name | Type | Attribute | Description |
| configuration | * |
Return:
| * |
public mergeModels(models: ...Model): Model source
import {mergeModels} from 'myscript/src/model/InkModel.js'Merge models
Params:
| Name | Type | Attribute | Description |
| models | ...Model | Models to merge (ordered) |
public needRedraw(model: Model): Boolean source
import {needRedraw} from 'myscript/src/model/InkModel.js'Check if the model needs to be redrawn.
Params:
| Name | Type | Attribute | Description |
| model | Model | Current model |
public newContentPart(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {newContentPart} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Create a new content part
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognition context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public openContentPart(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {openContentPart} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Open the recognizer context content part
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognition context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public openWebSocket(recognizerContext: RecognizerContext): WebSocket source
import {openWebSocket} from 'myscript/src/recognizer/websocket/networkWSInterface.js'Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Recognizer context |
Return:
| WebSocket | Opened WebSocket |
public overrideDefaultBehaviors(behaviors: Behaviors): Behaviors source
import {overrideDefaultBehaviors} from 'myscript/src/configuration/DefaultBehaviors.js'Generate behaviors
Params:
| Name | Type | Attribute | Description |
| behaviors | Behaviors | Behaviors to be used |
public overrideDefaultConfiguration(configuration: Configuration): Configuration source
import {overrideDefaultConfiguration} from 'myscript/src/configuration/DefaultConfiguration.js'Generate parameters
Params:
| Name | Type | Attribute | Description |
| configuration | Configuration | Configuration to be used |
public overrideDefaultPenStyle(style: PenStyle): PenStyle source
import {overrideDefaultPenStyle} from 'myscript/src/configuration/DefaultPenStyle.js'Generate style
Params:
| Name | Type | Attribute | Description |
| style | PenStyle | Custom style to be applied |
public overrideDefaultTheme(theme: Theme): Theme source
import {overrideDefaultTheme} from 'myscript/src/configuration/DefaultTheme.js'Generate theme
Params:
| Name | Type | Attribute | Description |
| theme | Theme | Custom theme to be applied |
public post(recognizerContext: RecognizerContext, url: String, data: Object): Promise source
import {post} from 'myscript/src/recognizer/rest/networkInterface.js'Post request
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Recognizer context |
|
| url | String | URL |
|
| data | Object | Data to be sent |
public postMessage(suffixUrl: String, recognizerContext: RecognizerContext, model: Model, buildMessage: function(recognizerContext: RecognizerContext, model: Model): Object): Promise<Model> source
import {postMessage} from 'myscript/src/recognizer/rest/v3/Cdkv3RestRecognizerUtil.js'Params:
| Name | Type | Attribute | Description |
| suffixUrl | String | ||
| recognizerContext | RecognizerContext | ||
| model | Model | ||
| buildMessage | function(recognizerContext: RecognizerContext, model: Model): Object |
public redo(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {redo} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Redo last action
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognition context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public redo(undoRedoContext: UndoRedoContext, model: Model, callback: function(err: Object, res: Model, types: ...String)) source
import {redo} from 'myscript/src/model/UndoRedoManager.js'Redo
public register(element: Element, configuration: Configuration, penStyle: PenStyle, theme: Theme, behaviors: Behaviors): Editor source
import {register} from 'myscript/src/EditorFacade.js'Attach an Editor to a DOMElement
Params:
| Name | Type | Attribute | Description |
| element | Element | DOM element to attach an editor |
|
| configuration | Configuration |
|
Configuration to apply |
| penStyle | PenStyle |
|
Pen style to apply |
| theme | Theme |
|
Theme to apply |
| behaviors | Behaviors |
|
Custom behaviors to apply |
public reset(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {reset} from 'myscript/src/recognizer/DefaultRecognizer.js'Reset server context. Currently nothing to do there.
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public reset(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {reset} from 'myscript/src/recognizer/rest/v3/Cdkv3RestShapeRecognizer.js'Reset server context.
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public reset(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {reset} from 'myscript/src/recognizer/websocket/v3/Cdkv3WSTextRecognizer.js'Reset the recognition context
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public reset(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {reset} from 'myscript/src/recognizer/websocket/v3/Cdkv3WSMathRecognizer.js'Reset the recognition context
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public resetModelPositions(model: Model): Model source
import {resetModelPositions} from 'myscript/src/model/InkModel.js'Reset model lastReceivedPosition and lastSentPosition
Params:
| Name | Type | Attribute | Description |
| model | Model |
public resetModelRendererPosition(model: Model): Model source
import {resetModelRendererPosition} from 'myscript/src/model/InkModel.js'Reset model lastRenderedPosition
Params:
| Name | Type | Attribute | Description |
| model | Model |
public resize(context: Object, model: Model, stroker: Stroker): Model source
import {resize} from 'myscript/src/renderer/canvas/CanvasRenderer.js'Update the rendering context size
public resize(context: Object, model: Model, stroker: Stroker): Model source
import {resize} from 'myscript/src/renderer/svg/SVGRenderer.js'Update the rendering context size
public resize(recognizerContext: RecognizerContext, model: Model, element: Element, callback: RecognizerCallback) source
import {resize} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Resize
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognition context |
|
| model | Model | Current model |
|
| element | Element | Current element |
|
| callback | RecognizerCallback |
public retry(func: *, recognizerContext: *, model: *, callback: *) source
import {retry} from 'myscript/src/recognizer/websocket/CdkWSRecognizerUtil.js'Params:
| Name | Type | Attribute | Description |
| func | * | ||
| recognizerContext | * | ||
| model | * | ||
| callback | * |
public send(recognizerContext: RecognizerContext, message: Object) source
import {send} from 'myscript/src/recognizer/websocket/networkWSInterface.js'Send data message
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| message | Object | Data message |
public sendMessage(recognizerContext: RecognizerContext, buildMessage: function(params: ...Object): Object, params: ...Object): Promise source
import {sendMessage} from 'myscript/src/recognizer/websocket/CdkWSRecognizerUtil.js'Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | ||
| buildMessage | function(params: ...Object): Object | ||
| params | ...Object |
public setPenStyle(recognizerContext: RecognizerContext, model: Model, penStyle: PenStyle, callback: RecognizerCallback) source
import {setPenStyle} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'SetPenStyle action
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognition context |
|
| model | Model | Current model |
|
| penStyle | PenStyle | Current penStyle |
|
| callback | RecognizerCallback |
public setRecognitionContext(recognizerContext: RecognizerContext, recognitionContext: RecognitionContext): RecognizerContext source
import {setRecognitionContext} from 'myscript/src/model/RecognizerContext.js'Set the recognition context
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| recognitionContext | RecognitionContext |
public setTheme(recognizerContext: RecognizerContext, model: Model, theme: Theme, callback: RecognizerCallback) source
import {setTheme} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'SetTheme action
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognition context |
|
| model | Model | Current model |
|
| theme | Theme | Current theme |
|
| callback | RecognizerCallback |
public shouldAttemptImmediateReconnect(recognizerContext: RecognizerContext): Boolean source
import {shouldAttemptImmediateReconnect} from 'myscript/src/model/RecognizerContext.js'Test if it should attempt immediate reconnect
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext |
public slice(stroke: Stroke, start: Number, end: Number): Stroke source
import {slice} from 'myscript/src/model/StrokeComponent.js'Slice a stroke and return the sliced part of it
public toCSS(theme: *): * source
import {toCSS} from 'myscript/src/configuration/DefaultTheme.js'Params:
| Name | Type | Attribute | Description |
| theme | * |
Return:
| * |
public toCSS(penStyle: *): * source
import {toCSS} from 'myscript/src/configuration/DefaultPenStyle.js'Params:
| Name | Type | Attribute | Description |
| penStyle | * |
Return:
| * |
public toJSON(stroke: Stroke): {type: String, x: Array<Number>, y: Array<Number>, t: Array<Number>} source
import {toJSON} from 'myscript/src/model/StrokeComponent.js'Get a JSON copy of a stroke by filtering its properties
Params:
| Name | Type | Attribute | Description |
| stroke | Stroke | Current stroke |
public toJSON(theme: *): * source
import {toJSON} from 'myscript/src/configuration/DefaultTheme.js'Params:
| Name | Type | Attribute | Description |
| theme | * |
Return:
| * |
public toJSON(penStyle: *): * source
import {toJSON} from 'myscript/src/configuration/DefaultPenStyle.js'Params:
| Name | Type | Attribute | Description |
| penStyle | * |
Return:
| * |
public undo(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {undo} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Undo last action
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognition context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public undo(undoRedoContext: UndoRedoContext, model: Model, callback: function(err: Object, res: Model, types: ...String)) source
import {undo} from 'myscript/src/model/UndoRedoManager.js'Undo
public updateModel(undoRedoContext: UndoRedoContext, model: Model, callback: function(err: Object, res: Model, types: ...String)) source
import {updateModel} from 'myscript/src/model/UndoRedoManager.js'Mutate the undoRedo stack by adding a new model to it.
public updateModelReceivedPosition(model: Model): Model source
import {updateModelReceivedPosition} from 'myscript/src/model/InkModel.js'Update model lastReceivedPosition regarding to lastSentPosition
Params:
| Name | Type | Attribute | Description |
| model | Model |
public updateModelRenderedPosition(model: Model, position: Number): Model source
import {updateModelRenderedPosition} from 'myscript/src/model/InkModel.js'Update model lastRenderedPosition
public updateModelSentPosition(model: Model, position: Number): Model source
import {updateModelSentPosition} from 'myscript/src/model/InkModel.js'Update model lastSentPosition
public updateRecognitionPositions(recognizerContext: RecognizerContext, positions: RecognitionPositions): RecognizerContext source
import {updateRecognitionPositions} from 'myscript/src/model/RecognizerContext.js'Update the recognition context positions
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognizer context |
|
| positions | RecognitionPositions | Current recognition positions |
public updateUndoRedoState(undoRedoContext: UndoRedoContext): UndoRedoContext source
import {updateUndoRedoState} from 'myscript/src/model/UndoRedoContext.js'Update the undo/redo state
Params:
| Name | Type | Attribute | Description |
| undoRedoContext | UndoRedoContext | Current undo/redo context |
public waitForIdle(recognizerContext: RecognizerContext, model: Model, callback: RecognizerCallback) source
import {waitForIdle} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'WaitForIdle action
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognition context |
|
| model | Model | Current model |
|
| callback | RecognizerCallback |
public zoom(recognizerContext: RecognizerContext, model: Model, value: Number, callback: RecognizerCallback) source
import {zoom} from 'myscript/src/recognizer/websocket/v4/Cdkv4WSIInkRecognizer.js'Zoom action
Params:
| Name | Type | Attribute | Description |
| recognizerContext | RecognizerContext | Current recognition context |
|
| model | Model | Current model |
|
| value | Number |
|
Zoom value |
| callback | RecognizerCallback |