iink-ts - v3.2.1
    Preparing search index...

    Class RecognizerWebSocket

    Index

    Accessors

    • get mimeTypes(): string[]

      Returns string[]

    Constructors

    • 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?: ("shape" | "text" | undefined)[] };
                    gestures?: (
                        | "join"
                        | "surround"
                        | "underline"
                        | "insert"
                        | "scratch-out"
                        | "strike-through"
                        | undefined
                    )[];
                    recognition?: { types?: ("shape" | "text" | undefined)[] };
                    "session-time"?: number;
                    text?: {
                        addLKText?: boolean;
                        customLexicon?: (string | undefined)[];
                        customResources?: (string | undefined)[];
                    };
                };
            };
            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

    • Parameters

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

      Returns TRecognizerWebSocketMessage

    • Parameters

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

      Returns TRecognizerWebSocketMessage

    • Returns Promise<void>

    • Returns void

    • Parameters

      • code: number
      • reason: string

      Returns Promise<void>

    • Parameters

      • evt: CloseEvent

      Returns void

    • Returns Promise<void>

    • Parameters

      • strokeIds: string[]

      Returns Promise<void>

    • Parameters

      • OptionalrequestedMimeTypes: string[]

      Returns Promise<TExport>

    • Returns Promise<void>

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      • message: MessageEvent<string>

      Returns 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?: ("shape" | "text" | undefined)[] };
                    gestures?: (
                        | "join"
                        | "surround"
                        | "underline"
                        | "insert"
                        | "scratch-out"
                        | "strike-through"
                        | undefined
                    )[];
                    recognition?: { types?: ("shape" | "text" | undefined)[] };
                    "session-time"?: number;
                    text?: {
                        addLKText?: boolean;
                        customLexicon?: (string | undefined)[];
                        customResources?: (string | undefined)[];
                    };
                };
            };
            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>

    • Returns void

    • Parameters

      • error: string | Error

      Returns void

    • Parameters

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

      Returns Promise<void>

    • Returns void

    • Parameters

      Returns Promise<void>

    • Parameters

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

      Returns Promise<void>

    • Parameters

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

      Returns Promise<void>

    • Parameters

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

      Returns Promise<void>

    • Returns Promise<void>

    Properties

    addStrokeDeferred?: DeferredPromise<
        TRecognizerWebSocketMessageGesture
        | undefined,
    >
    clearDeferred?: DeferredPromise<void>
    closeDeferred?: DeferredPromise<void>
    contextlessGestureDeferred: Map<
        string,
        DeferredPromise<TRecognizerWebSocketMessageContextlessGesture>,
    >
    currentErrorCode?: string | number
    currentPartId?: string
    eraseStrokeDeferred?: DeferredPromise<void>
    exportDeferredMap: Map<string, DeferredPromise<TExport>>
    initialized: DeferredPromise<void>
    pingCount: number = 0
    pingWorker?: Worker
    reconnectionCount: number = 0
    redoDeferred?: DeferredPromise<void>
    replaceStrokeDeferred?: DeferredPromise<void>
    sessionId?: string
    socket: WebSocket
    transformStrokeDeferred?: DeferredPromise<void>
    undoDeferred?: DeferredPromise<void>
    url: string
    waitForIdleDeferred?: DeferredPromise<void>