Class WebSocketSSRClient

constructor

• new WebSocketSSRClient(
      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?: (
                      | "application/vnd.myscript.jiix"
                      | "application/x-latex"
                      | "application/mathml+xml"
                      | undefined
                  )[];
                  "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?: ("application/vnd.myscript.jiix" | "text/plain" | undefined)[];
                  text?: boolean;
              };
              type?: { readonly [key: number]: string
              | undefined };
          };
          server?: {
              applicationKey?: string;
              hmacKey?: string
              | {};
              host?: string;
              scheme?: TScheme;
              version?: string;
              websocket?: {
                  autoReconnect?: boolean;
                  fileChunkSize?: number;
                  maxPingLostCount?: number;
                  maxReconnectAttempts?: number;
                  maxRetryCount?: number;
                  offlineQueueEnabled?: boolean;
                  offlineQueueMaxSize?: number;
                  pingDelay?: number;
                  pingEnabled?: boolean;
                  reconnectDelay?: number;
              };
          };
      },
  ): WebSocketSSRClient

  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?: (
                    | "application/vnd.myscript.jiix"
                    | "application/x-latex"
                    | "application/mathml+xml"
                    | undefined
                )[];
                "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?: ("application/vnd.myscript.jiix" | "text/plain" | undefined)[];
                text?: boolean;
            };
            type?: { readonly [key: number]: string
            | undefined };
        };
        server?: {
            applicationKey?: string;
            hmacKey?: string
            | {};
            host?: string;
            scheme?: TScheme;
            version?: string;
            websocket?: {
                autoReconnect?: boolean;
                fileChunkSize?: number;
                maxPingLostCount?: number;
                maxReconnectAttempts?: number;
                maxRetryCount?: number;
                offlineQueueEnabled?: boolean;
                offlineQueueMaxSize?: number;
                pingDelay?: number;
                pingEnabled?: boolean;
                reconnectDelay?: number;
            };
        };
    }

  Returns WebSocketSSRClient

configuration

OptionalcurrentPartId

event

initialized

url

mimeTypes

• get mimeTypes(): string[]

  Returns string[]

addStrokes

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

  Parameters

  • strokes: Stroke[]

  Returns Promise<TExport>

clear

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

  Parameters

  • model: Model

  Returns Promise<Model>

close

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

  Parameters

  • code: number
  • reason: string

  Returns void

convert

• convert(model: Model, conversionState?: TConverstionState): Promise<Model>

  Parameters

  • model: Model
  • OptionalconversionState: TConverstionState

  Returns Promise<Model>

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

  • strokes: Stroke[]

  Returns Promise<TExport>

init

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

  Parameters

  • height: number
  • width: number

  Returns Promise<void>

redo

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

  Parameters

  • model: Model

  Returns Promise<Model>

resize

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

  Parameters

  • model: Model

  Returns Promise<Model>

send

• send(message: TWebSocketSSRClientMessage): Promise<void>

  Parameters

  • message: TWebSocketSSRClientMessage

  Returns Promise<void>

setPenStyle

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

  Parameters

  • penStyle: TPenStyle

  Returns Promise<void>

setPenStyleClasses

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

  Parameters

  • penStyleClasses: string

  Returns Promise<void>

setTheme

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

  Parameters

  • theme: TTheme

  Returns Promise<void>

undo

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

  Parameters

  • model: Model

  Returns Promise<Model>

waitForIdle

• waitForIdle(): Promise<void>

  Returns Promise<void>