Class RecognizerWebSocketSSR

Accessors

mimeTypes

Constructors

constructor

Methods

addStrokes clear close closeCallback convert destroy export import importPointEvents infinitePing init manageAckMessage manageContentChangeMessage manageContentPackageDescriptionMessage manageErrorMessage manageExportMessage managePartChangeMessage manageSVGPatchMessage manageWaitForIdle messageCallback openCallback redo rejectDeferredPending resize send setPenStyle setPenStyleClasses setTheme undo waitForIdle

Properties

ackDeferred? addStrokeDeferred? clearDeferred? configuration connected? convertDeferred? currentErrorCode? currentPartId? event exportDeferred? importDeferred? importPointEventsDeferred? initialized penStyle? penStyleClasses? pingCount reconnectionCount redoDeferred? resizeDeferred? sessionId? socket theme? undoDeferred? url viewSizeHeight viewSizeWidth waitForIdleDeferred?

Accessors

mimeTypes

  • get mimeTypes(): string[]

  • Returns string[]

Constructors

constructor

  • new RecognizerWebSocketSSR(
        config?: {
            recognition?: {
                convert?: { force?: { "on-stylesheet-change"?: boolean } };
                export?: {
                    image?: {
                        guides?: boolean;
                        viewport?: {
                            height?: (...) | (...);
                            width?: (...) | (...);
                            x?: (...) | (...);
                            y?: (...) | (...);
                        };
                    };
                    "image-resolution"?: number;
                    jiix?: {
                        "bounding-box"?: boolean;
                        "full-stroke-ids"?: boolean;
                        ids?: boolean;
                        strokes?: boolean;
                        style?: boolean;
                        text?: {
                            chars?: (...)
                            | (...)
                            | (...);
                            lines?: (...) | (...) | (...);
                            words?: (...) | (...) | (...);
                        };
                    };
                    mathml?: { flavor?: { name?: (...)
                    | (...) } };
                };
                lang?: string;
                math?: {
                    customGrammar?: string;
                    customGrammarContent?: string;
                    customGrammarId?: string;
                    eraser?: { "erase-precisely"?: boolean };
                    margin?: {
                        bottom?: number;
                        left?: number;
                        right?: number;
                        top?: number;
                    };
                    mimeTypes?: (
                        | undefined
                        | "application/vnd.myscript.jiix"
                        | "application/x-latex"
                        | "application/mathml+xml"
                    )[];
                    "recognition-timeout"?: number;
                    "session-time"?: number;
                    solver?: {
                        "angle-unit"?: TAngleUnit;
                        "decimal-separator"?: string;
                        enable?: boolean;
                        "fractional-part-digits"?: number;
                        options?: TSolverOptions;
                        "rounding-mode"?: TRoundingMode;
                    };
                    "undo-redo"?: { mode?: TUndoRedoMode };
                };
                renderer?: {
                    debug?: { "draw-image-boxes"?: boolean; "draw-text-boxes"?: boolean };
                };
                text?: {
                    configuration?: {
                        addLKText?: boolean;
                        customLexicon?: ((...) | (...))[];
                        customResources?: ((...) | (...))[];
                    };
                    eraser?: { "erase-precisely"?: boolean };
                    guides?: { enable?: boolean };
                    margin?: {
                        bottom?: number;
                        left?: number;
                        right?: number;
                        top?: number;
                    };
                    mimeTypes?: (undefined | "text/plain" | "application/vnd.myscript.jiix")[];
                    text?: boolean;
                };
                type?: { readonly [key: number]: 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;
                };
            };
        },
    ): RecognizerWebSocketSSR

  • Parameters

    • Optionalconfig: {
          recognition?: {
              convert?: { force?: { "on-stylesheet-change"?: boolean } };
              export?: {
                  image?: {
                      guides?: boolean;
                      viewport?: {
                          height?: (...) | (...);
                          width?: (...) | (...);
                          x?: (...) | (...);
                          y?: (...) | (...);
                      };
                  };
                  "image-resolution"?: number;
                  jiix?: {
                      "bounding-box"?: boolean;
                      "full-stroke-ids"?: boolean;
                      ids?: boolean;
                      strokes?: boolean;
                      style?: boolean;
                      text?: {
                          chars?: (...)
                          | (...)
                          | (...);
                          lines?: (...) | (...) | (...);
                          words?: (...) | (...) | (...);
                      };
                  };
                  mathml?: { flavor?: { name?: (...)
                  | (...) } };
              };
              lang?: string;
              math?: {
                  customGrammar?: string;
                  customGrammarContent?: string;
                  customGrammarId?: string;
                  eraser?: { "erase-precisely"?: boolean };
                  margin?: { bottom?: number; left?: number; right?: number; top?: number };
                  mimeTypes?: (
                      | undefined
                      | "application/vnd.myscript.jiix"
                      | "application/x-latex"
                      | "application/mathml+xml"
                  )[];
                  "recognition-timeout"?: number;
                  "session-time"?: number;
                  solver?: {
                      "angle-unit"?: TAngleUnit;
                      "decimal-separator"?: string;
                      enable?: boolean;
                      "fractional-part-digits"?: number;
                      options?: TSolverOptions;
                      "rounding-mode"?: TRoundingMode;
                  };
                  "undo-redo"?: { mode?: TUndoRedoMode };
              };
              renderer?: {
                  debug?: { "draw-image-boxes"?: boolean; "draw-text-boxes"?: boolean };
              };
              text?: {
                  configuration?: {
                      addLKText?: boolean;
                      customLexicon?: ((...) | (...))[];
                      customResources?: ((...) | (...))[];
                  };
                  eraser?: { "erase-precisely"?: boolean };
                  guides?: { enable?: boolean };
                  margin?: { bottom?: number; left?: number; right?: number; top?: number };
                  mimeTypes?: (undefined | "text/plain" | "application/vnd.myscript.jiix")[];
                  text?: boolean;
              };
              type?: { readonly [key: number]: 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 RecognizerWebSocketSSR

Methods

addStrokes

  • addStrokes(strokes: Stroke[]): Promise<TExport>

  • Parameters

    Returns Promise<TExport>

clear

  • clear(model: Model): Promise<Model>

  • Parameters

    Returns Promise<Model>

close

  • close(code: number, reason: string): void

  • Parameters

    • code: number
    • reason: string

    Returns void

ProtectedcloseCallback

  • closeCallback(evt: CloseEvent): void

  • Parameters

    • evt: CloseEvent

    Returns void

convert

destroy

  • destroy(): void

  • Returns void

export

  • export(model: Model, requestedMimeTypes?: string[]): Promise<Model>

  • Parameters

    • model: Model
    • OptionalrequestedMimeTypes: string[]

    Returns Promise<Model>

import

  • import(model: Model, data: Blob, mimeType?: string): Promise<Model>

  • Parameters

    • model: Model
    • data: Blob
    • OptionalmimeType: string

    Returns Promise<Model>

importPointEvents

  • importPointEvents(strokes: Stroke[]): Promise<TExport>

  • Parameters

    Returns Promise<TExport>

ProtectedinfinitePing

  • infinitePing(): void

  • Returns void

init

  • init(height: number, width: number): Promise<void>

  • Parameters

    • height: number
    • width: number

    Returns Promise<void>

ProtectedmanageAckMessage

ProtectedmanageContentChangeMessage

ProtectedmanageContentPackageDescriptionMessage

  • manageContentPackageDescriptionMessage(): Promise<void>

  • Returns Promise<void>

ProtectedmanageErrorMessage

ProtectedmanageExportMessage

ProtectedmanagePartChangeMessage

ProtectedmanageSVGPatchMessage

ProtectedmanageWaitForIdle

  • manageWaitForIdle(): Promise<void>

  • Returns Promise<void>

ProtectedmessageCallback

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

  • Parameters

    • message: MessageEvent<string>

    Returns void

ProtectedopenCallback

  • openCallback(): void

  • Returns void

redo

  • redo(model: Model): Promise<Model>

  • Parameters

    Returns Promise<Model>

ProtectedrejectDeferredPending

  • rejectDeferredPending(error: Error): void

  • Parameters

    • error: Error

    Returns void

resize

  • resize(model: Model): Promise<Model>

  • Parameters

    Returns Promise<Model>

send

setPenStyle

  • setPenStyle(penStyle: TPenStyle): Promise<void>

  • Parameters

    Returns Promise<void>

setPenStyleClasses

  • setPenStyleClasses(penStyleClasses: string): Promise<void>

  • Parameters

    • penStyleClasses: string

    Returns Promise<void>

setTheme

  • setTheme(theme: TTheme): Promise<void>

  • Parameters

    Returns Promise<void>

undo

  • undo(model: Model): Promise<Model>

  • Parameters

    Returns Promise<Model>

waitForIdle

  • waitForIdle(): Promise<void>

  • Returns Promise<void>

Properties

Protected OptionalackDeferred

ackDeferred?: DeferredPromise<void>

Protected OptionaladdStrokeDeferred

addStrokeDeferred?: DeferredPromise<TExport>

Protected OptionalclearDeferred

clearDeferred?: DeferredPromise<TExport>

configuration

configuration: TRecognizerWebSocketSSRConfiguration

Protected Optionalconnected

connected?: DeferredPromise<void>

Protected OptionalconvertDeferred

convertDeferred?: DeferredPromise<TExport>

Protected OptionalcurrentErrorCode

currentErrorCode?: string | number

OptionalcurrentPartId

currentPartId?: string

event

event: RecognizerEvent

Protected OptionalexportDeferred

exportDeferred?: DeferredPromise<TExport>

Protected OptionalimportDeferred

importDeferred?: DeferredPromise<TExport>

Protected OptionalimportPointEventsDeferred

importPointEventsDeferred?: DeferredPromise<TExport>

initialized

initialized: DeferredPromise<void>

Protected OptionalpenStyle

penStyle?: TPenStyle

Protected OptionalpenStyleClasses

penStyleClasses?: string

ProtectedpingCount

pingCount: number = 0

ProtectedreconnectionCount

reconnectionCount: number = 0

Protected OptionalredoDeferred

redoDeferred?: DeferredPromise<TExport>

Protected OptionalresizeDeferred

resizeDeferred?: DeferredPromise<void>

Protected OptionalsessionId

sessionId?: string

Protectedsocket

socket: WebSocket

Protected Optionaltheme

theme?: TTheme

Protected OptionalundoDeferred

undoDeferred?: DeferredPromise<TExport>

url

url: string

ProtectedviewSizeHeight

viewSizeHeight: number

ProtectedviewSizeWidth

viewSizeWidth: number

Protected OptionalwaitForIdleDeferred

waitForIdleDeferred?: DeferredPromise<void>

Settings

Member Visibility

On This Page

Accessors
Constructors
Methods
Properties