Class RecognizerWebSocket

Accessors

mimeTypes

Constructors

constructor

Methods

addStrokes buildAddStrokesMessage buildEraseStrokesMessage buildReplaceStrokesMessage buildTransformMatrixMessage buildTransformRotateMessage buildTransformScaleMessage buildTransformTranslateMessage buildUndoRedoChanges clear clearSocketListener close closeCallback destroy eraseStrokes export init initPing manageAuthenticated manageContentChangedMessage manageContextlessGesture manageErrorMessage manageExportMessage manageGestureDetected manageHMACChallenge manageNewPartMessage managePartChangeMessage manageSessionDescriptionMessage manageWaitForIdle messageCallback newSession openCallback recognizeGesture redo rejectDeferredPending replaceStrokes resetAllDeferred send transformMatrix transformRotate transformScale transformTranslate undo waitForIdle

Properties

addStrokeDeferred? clearDeferred? closeDeferred? configuration contextlessGestureDeferred currentErrorCode? currentPartId? eraseStrokeDeferred? event exportDeferredMap initialized pingCount pingWorker? reconnectionCount redoDeferred? replaceStrokeDeferred? sessionId? socket transformStrokeDeferred? undoDeferred? url waitForIdleDeferred?

Accessors

mimeTypes

  • get mimeTypes(): string[]

  • Returns string[]

Constructors

constructor

  • new RecognizerWebSocket(
        config: {
            recognition?: {
                export?: {
                    image?: {
                        guides?: boolean;
                        viewport?: { height?: number; width?: number; x?: number; y?: number };
                    };
                    "image-resolution"?: number;
                    jiix?: {
                        "bounding-box"?: boolean;
                        "full-stroke-ids"?: boolean;
                        ids?: boolean;
                        strokes?: boolean;
                        style?: boolean;
                        text?: { chars?: boolean; lines?: boolean; words?: boolean };
                    };
                    mathml?: { flavor?: { name?: string } };
                };
                gesture?: { enable?: boolean; ignoreGestureStrokes?: boolean };
                lang?: string;
                "raw-content"?: {
                    classification?: { types?: (undefined | "shape" | "text")[] };
                    gestures?: (
                        | undefined
                        | "join"
                        | "surround"
                        | "underline"
                        | "insert"
                        | "scratch-out"
                        | "strike-through"
                    )[];
                    recognition?: { types?: (undefined | "shape" | "text")[] };
                    "session-time"?: number;
                    text?: {
                        addLKText?: boolean;
                        customLexicon?: (undefined | string)[];
                        customResources?: (undefined | string)[];
                    };
                };
            };
            server?: {
                applicationKey?: string;
                hmacKey?: string;
                host?: string;
                scheme?: TScheme;
                version?: string;
                websocket?: {
                    autoReconnect?: boolean;
                    fileChunkSize?: number;
                    maxPingLostCount?: number;
                    maxRetryCount?: number;
                    pingDelay?: number;
                    pingEnabled?: boolean;
                };
            };
        },
        event?: RecognizerEvent,
    ): RecognizerWebSocket

  • Parameters

    • config: {
          recognition?: {
              export?: {
                  image?: {
                      guides?: boolean;
                      viewport?: { height?: number; width?: number; x?: number; y?: number };
                  };
                  "image-resolution"?: number;
                  jiix?: {
                      "bounding-box"?: boolean;
                      "full-stroke-ids"?: boolean;
                      ids?: boolean;
                      strokes?: boolean;
                      style?: boolean;
                      text?: { chars?: boolean; lines?: boolean; words?: boolean };
                  };
                  mathml?: { flavor?: { name?: string } };
              };
              gesture?: { enable?: boolean; ignoreGestureStrokes?: boolean };
              lang?: string;
              "raw-content"?: {
                  classification?: { types?: (undefined | "shape" | "text")[] };
                  gestures?: (
                      | undefined
                      | "join"
                      | "surround"
                      | "underline"
                      | "insert"
                      | "scratch-out"
                      | "strike-through"
                  )[];
                  recognition?: { types?: (undefined | "shape" | "text")[] };
                  "session-time"?: number;
                  text?: {
                      addLKText?: boolean;
                      customLexicon?: (undefined | string)[];
                      customResources?: (undefined | string)[];
                  };
              };
          };
          server?: {
              applicationKey?: string;
              hmacKey?: string;
              host?: string;
              scheme?: TScheme;
              version?: string;
              websocket?: {
                  autoReconnect?: boolean;
                  fileChunkSize?: number;
                  maxPingLostCount?: number;
                  maxRetryCount?: number;
                  pingDelay?: number;
                  pingEnabled?: boolean;
              };
          };
      }
    • Optionalevent: RecognizerEvent

    Returns RecognizerWebSocket

Methods

addStrokes

ProtectedbuildAddStrokesMessage

ProtectedbuildEraseStrokesMessage

ProtectedbuildReplaceStrokesMessage

ProtectedbuildTransformMatrixMessage

ProtectedbuildTransformRotateMessage

  • buildTransformRotateMessage(
        strokeIds: string[],
        angle: number,
        x0?: number,
        y0?: number,
    ): TRecognizerWebSocketMessage

  • Parameters

    • strokeIds: string[]
    • angle: number
    • x0: number = 0
    • y0: number = 0

    Returns TRecognizerWebSocketMessage

ProtectedbuildTransformScaleMessage

  • buildTransformScaleMessage(
        strokeIds: string[],
        scaleX: number,
        scaleY: number,
        x0?: number,
        y0?: number,
    ): TRecognizerWebSocketMessage

  • Parameters

    • strokeIds: string[]
    • scaleX: number
    • scaleY: number
    • x0: number = 0
    • y0: number = 0

    Returns TRecognizerWebSocketMessage

ProtectedbuildTransformTranslateMessage

ProtectedbuildUndoRedoChanges

clear

  • clear(): Promise<void>

  • Returns Promise<void>

ProtectedclearSocketListener

  • clearSocketListener(): void

  • Returns void

close

  • close(code: number, reason: string): Promise<void>

  • Parameters

    • code: number
    • reason: string

    Returns Promise<void>

ProtectedcloseCallback

  • closeCallback(evt: CloseEvent): void

  • Parameters

    • evt: CloseEvent

    Returns void

destroy

  • destroy(): Promise<void>

  • Returns Promise<void>

eraseStrokes

  • eraseStrokes(strokeIds: string[]): Promise<void>

  • Parameters

    • strokeIds: string[]

    Returns Promise<void>

export

  • export(requestedMimeTypes?: string[]): Promise<TExport>

  • Parameters

    • OptionalrequestedMimeTypes: string[]

    Returns Promise<TExport>

init

  • init(): Promise<void>

  • Returns Promise<void>

ProtectedinitPing

  • initPing(): void

  • Returns void

ProtectedmanageAuthenticated

  • manageAuthenticated(): void

  • Returns void

ProtectedmanageContentChangedMessage

ProtectedmanageContextlessGesture

ProtectedmanageErrorMessage

ProtectedmanageExportMessage

ProtectedmanageGestureDetected

ProtectedmanageHMACChallenge

ProtectedmanageNewPartMessage

ProtectedmanagePartChangeMessage

ProtectedmanageSessionDescriptionMessage

ProtectedmanageWaitForIdle

  • manageWaitForIdle(): void

  • Returns void

ProtectedmessageCallback

  • messageCallback(message: MessageEvent<string>): void

  • Parameters

    • message: MessageEvent<string>

    Returns void

newSession

  • newSession(
        config: {
            recognition?: {
                export?: {
                    image?: {
                        guides?: boolean;
                        viewport?: { height?: number; width?: number; x?: number; y?: number };
                    };
                    "image-resolution"?: number;
                    jiix?: {
                        "bounding-box"?: boolean;
                        "full-stroke-ids"?: boolean;
                        ids?: boolean;
                        strokes?: boolean;
                        style?: boolean;
                        text?: { chars?: boolean; lines?: boolean; words?: boolean };
                    };
                    mathml?: { flavor?: { name?: string } };
                };
                gesture?: { enable?: boolean; ignoreGestureStrokes?: boolean };
                lang?: string;
                "raw-content"?: {
                    classification?: { types?: (undefined | "shape" | "text")[] };
                    gestures?: (
                        | undefined
                        | "join"
                        | "surround"
                        | "underline"
                        | "insert"
                        | "scratch-out"
                        | "strike-through"
                    )[];
                    recognition?: { types?: (undefined | "shape" | "text")[] };
                    "session-time"?: number;
                    text?: {
                        addLKText?: boolean;
                        customLexicon?: (undefined | string)[];
                        customResources?: (undefined | string)[];
                    };
                };
            };
            server?: {
                applicationKey?: string;
                hmacKey?: string;
                host?: string;
                scheme?: TScheme;
                version?: string;
                websocket?: {
                    autoReconnect?: boolean;
                    fileChunkSize?: number;
                    maxPingLostCount?: number;
                    maxRetryCount?: number;
                    pingDelay?: number;
                    pingEnabled?: boolean;
                };
            };
        },
    ): Promise<void>

  • Parameters

    • config: {
          recognition?: {
              export?: {
                  image?: {
                      guides?: boolean;
                      viewport?: { height?: number; width?: number; x?: number; y?: number };
                  };
                  "image-resolution"?: number;
                  jiix?: {
                      "bounding-box"?: boolean;
                      "full-stroke-ids"?: boolean;
                      ids?: boolean;
                      strokes?: boolean;
                      style?: boolean;
                      text?: { chars?: boolean; lines?: boolean; words?: boolean };
                  };
                  mathml?: { flavor?: { name?: string } };
              };
              gesture?: { enable?: boolean; ignoreGestureStrokes?: boolean };
              lang?: string;
              "raw-content"?: {
                  classification?: { types?: (undefined | "shape" | "text")[] };
                  gestures?: (
                      | undefined
                      | "join"
                      | "surround"
                      | "underline"
                      | "insert"
                      | "scratch-out"
                      | "strike-through"
                  )[];
                  recognition?: { types?: (undefined | "shape" | "text")[] };
                  "session-time"?: number;
                  text?: {
                      addLKText?: boolean;
                      customLexicon?: (undefined | string)[];
                      customResources?: (undefined | string)[];
                  };
              };
          };
          server?: {
              applicationKey?: string;
              hmacKey?: string;
              host?: string;
              scheme?: TScheme;
              version?: string;
              websocket?: {
                  autoReconnect?: boolean;
                  fileChunkSize?: number;
                  maxPingLostCount?: number;
                  maxRetryCount?: number;
                  pingDelay?: number;
                  pingEnabled?: boolean;
              };
          };
      }

    Returns Promise<void>

ProtectedopenCallback

  • openCallback(): void

  • Returns void

recognizeGesture

redo

ProtectedrejectDeferredPending

  • rejectDeferredPending(error: string | Error): void

  • Parameters

    • error: string | Error

    Returns void

replaceStrokes

  • replaceStrokes(oldStrokeIds: string[], newStrokes: IIStroke[]): Promise<void>

  • Parameters

    • oldStrokeIds: string[]
    • newStrokes: IIStroke[]

    Returns Promise<void>

ProtectedresetAllDeferred

  • resetAllDeferred(): void

  • Returns void

send

transformMatrix

  • transformMatrix(strokeIds: string[], matrix: TMatrixTransform): Promise<void>

  • Parameters

    Returns Promise<void>

transformRotate

  • transformRotate(
        strokeIds: string[],
        angle: number,
        x0?: number,
        y0?: number,
    ): Promise<void>

  • Parameters

    • strokeIds: string[]
    • angle: number
    • x0: number = 0
    • y0: number = 0

    Returns Promise<void>

transformScale

  • transformScale(
        strokeIds: string[],
        scaleX: number,
        scaleY: number,
        x0?: number,
        y0?: number,
    ): Promise<void>

  • Parameters

    • strokeIds: string[]
    • scaleX: number
    • scaleY: number
    • x0: number = 0
    • y0: number = 0

    Returns Promise<void>

transformTranslate

  • transformTranslate(strokeIds: string[], tx: number, ty: number): Promise<void>

  • Parameters

    • strokeIds: string[]
    • tx: number
    • ty: number

    Returns Promise<void>

undo

waitForIdle

  • waitForIdle(): Promise<void>

  • Returns Promise<void>

Properties

Protected OptionaladdStrokeDeferred

addStrokeDeferred?: DeferredPromise<
    undefined
    | TRecognizerWebSocketMessageGesture,
>

Protected OptionalclearDeferred

clearDeferred?: DeferredPromise<void>

Protected OptionalcloseDeferred

closeDeferred?: DeferredPromise<void>

configuration

configuration: RecognizerWebSocketConfiguration

ProtectedcontextlessGestureDeferred

contextlessGestureDeferred: Map<
    string,
    DeferredPromise<TRecognizerWebSocketMessageContextlessGesture>,
>

Protected OptionalcurrentErrorCode

currentErrorCode?: string | number

Protected OptionalcurrentPartId

currentPartId?: string

Protected OptionaleraseStrokeDeferred

eraseStrokeDeferred?: DeferredPromise<void>

event

event: RecognizerEvent

ProtectedexportDeferredMap

exportDeferredMap: Map<string, DeferredPromise<TExport>>

initialized

initialized: DeferredPromise<void>

ProtectedpingCount

pingCount: number = 0

Protected OptionalpingWorker

pingWorker?: Worker

ProtectedreconnectionCount

reconnectionCount: number = 0

Protected OptionalredoDeferred

redoDeferred?: DeferredPromise<void>

Protected OptionalreplaceStrokeDeferred

replaceStrokeDeferred?: DeferredPromise<void>

Protected OptionalsessionId

sessionId?: string

Protectedsocket

socket: WebSocket

Protected OptionaltransformStrokeDeferred

transformStrokeDeferred?: DeferredPromise<void>

Protected OptionalundoDeferred

undoDeferred?: DeferredPromise<void>

url

url: string

Protected OptionalwaitForIdleDeferred

waitForIdleDeferred?: DeferredPromise<void>

Settings

Member Visibility

On This Page

Accessors
Constructors
Methods
Properties