API Docs for:
Show:

InkPaper Class

Defined in: /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:5
Module: MyScript

InkPaper

Constructor

InkPaper

(
  • element
  • [options]
  • [callback]
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:5

Parameters:

  • element Element
  • [options] Object optional
  • [callback] Function optional

    callback function

    • data Object

      The recognition result

    • err Object

      The err to the callback

Methods

_down

(
  • x
  • y
  • [t]
)
private

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:843

Parameters:

  • x Number

    X coordinate

  • y Number

    Y coordinate

  • [t] Date optional

    timeStamp

_move

(
  • x
  • y
  • [t]
)
private

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:896

Parameters:

  • x Number

    X coordinate

  • y Number

    Y coordinate

  • [t] Date optional

    timeStamp

_move

(
  • x
  • y
  • [t]
)
private

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:884

Parameters:

  • x Number

    X coordinate

  • y Number

    Y coordinate

  • [t] Date optional

    timeStamp

canRedo

() Boolean

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:769

Return true if you can redo

Returns:

Boolean:

canUndo

() Boolean

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:724

Return true if you can undo

Returns:

Boolean:

getAnalyzerParameters

() AnalyzerParameter

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:491

Get analyzer recognition parameters

Returns:

AnalyzerParameter:

analyzerParameters

getApplicationKey

() String

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:307

Get the application key

Returns:

String:

getAvailableLanguages

(
  • [inputMode]
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:548

Get available languages

Parameters:

  • [inputMode] String optional

    input mode

getComponents

() Array

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:285

Get the default components

Returns:

Array:

components

getHmacKey

() String

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:327

Get the HMAC key

Returns:

String:

getInkGrabber

() InkGrabber

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:578

Get the ink capturer

Returns:

InkGrabber:

getMathParameters

() MathParameter

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:400

Get math recognition parameters

Returns:

MathParameter:

mathParameters

getMusicParameters

() MusicParameter

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:461

Get music recognition parameters

Returns:

MusicParameter:

musicParameters

getPenParameters

() PenParameters

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:524

Get pen parameters

Returns:

PenParameters:

penParameters

getShapeParameters

() ShapeParameter

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:430

Get shape recognition parameters

Returns:

ShapeParameter:

shapeParameters

getTextParameters

() TextParameter

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:369

Get text recognition parameters

Returns:

TextParameter:

textParameters

getTimeout

() Number

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:249

Get the recognition timeout

Returns:

Number:

getType

() 'TEXT' | 'MATH' | 'SHAPE' | 'MUSIC' | 'ANALYZER'

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:224

Get recognition type

Returns:

'TEXT' | 'MATH' | 'SHAPE' | 'MUSIC' | 'ANALYZER':

type

recognize

() Promise

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:620

Recognize

Returns:

Promise:

setAnalyzerParameters

(
  • analyzerParameters
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:471

Set analyzer recognition parameters

Parameters:

setApplicationKey

(
  • applicationKey
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:317

Set the application key

Parameters:

  • applicationKey String

setChangeCallback

(
  • callback
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:598

Set the change callback

Parameters:

  • callback Function

    callback function

    • data Object

      The inkPaper state

setComponents

(
  • components
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:295

Set the default components

Parameters:

  • components Array

setHeight

(
  • height
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:131

Set the height

Parameters:

  • height Number

setHmacKey

(
  • hmacKey
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:337

Set the HMAC key

Parameters:

  • hmacKey String

setMathParameters

(
  • mathParameters
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:379

Set math recognition parameters

Parameters:

setMusicParameters

(
  • musicParameters
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:440

Set music recognition parameters

Parameters:

setPenParameters

(
  • penParameters
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:501

Set pen parameters

Parameters:

setPrecision

(
  • precision
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:269

Set the recognition precision

Parameters:

  • precision Number

setResultCallback

(
  • callback
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:609

Set the recognition result callback

Parameters:

  • callback Function

    callback function

    • data Object

      The recognition result

setShapeParameters

(
  • shapeParameters
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:410

Set shape recognition parameters

Parameters:

setTextParameters

(
  • textParameters
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:347

Set text recognition parameters

Parameters:

setTimeout

(
  • timeout
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:259

Set the recognition timeout

Parameters:

  • timeout Number

setType

(
  • type
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:186

Set recognition type

Parameters:

  • type 'TEXT' | 'MATH' | 'SHAPE' | 'MUSIC' | 'ANALYZER'

setTypeset

(
  • typeset
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:534

Enable / disable typeset

Parameters:

  • typeset Boolean

setWidth

(
  • width
)

Defined in /home/padewitte/projets/webcomponents/myscript-js/src/inkPaper.js:112

Set the width

Parameters:

  • width Number