Class InteractiveInkSSRCanvas

Constructors

constructor

new InteractiveInkSSRCanvas(
rootElement: HTMLElement,
options?: TInteractiveInkSSRCanvasOptions,
): InteractiveInkSSRCanvas
Parameters
- rootElement: HTMLElement
- Optionaloptions: TInteractiveInkSSRCanvasOptions
Returns InteractiveInkSSRCanvas
Overrides AbstractCanvas.constructor
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:53

Properties

client

client: WebSocketSSRClient

event

event: CanvasEvent

Event bus for subscribing to canvas lifecycle and content events.

Server API information (version, etc.) loaded on first connection.

layers

layers: CanvasLayer

DOM layer manager handling rendering, UI, and modal elements.

logger

logger: Logger = ...

Logger instance for this canvas.

renderer

renderer: InteractiveInkSSRSVGRenderer

`Optional`smartGuide

smartGuide?: InteractiveInkSSRSmartGuide

styleManager

styleManager: StyleManager

Accessors

configuration

get configuration(): InteractiveInkSSRCanvasConfiguration
Returns InteractiveInkSSRCanvasConfiguration
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:109

connectionState

get connectionState(): TCanvasConnectionState
Derived, UI-oriented canvas state — see TCanvasConnectionState. Listen to event.addConnectionStateChangedListener for change notifications.

Returns TCanvasConnectionState
Inherited from AbstractCanvas.connectionState
- Defined in canvas/AbstractCanvas.ts:135

currentPenStyle

get currentPenStyle(): TPenStyle
Returns TPenStyle
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:113

initializationPromise

get initializationPromise(): Promise<void>
Returns Promise<void>
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:80

loggerConfiguration

get loggerConfiguration(): TLoggerConfiguration
Returns TLoggerConfiguration
Inherited from AbstractCanvas.loggerConfiguration
- Defined in canvas/AbstractCanvas.ts:237
set loggerConfiguration(loggerConfig: TLoggerConfiguration): void
Parameters
- loggerConfig: TLoggerConfiguration
Returns void
Inherited from AbstractCanvas.loggerConfiguration
- Defined in canvas/AbstractCanvas.ts:241

model

get model(): Model
Returns Model
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:105

penStyle

get penStyle(): TPenStyle
Returns TPenStyle
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:117
set penStyle(
    penStyle: {
        "-myscript-pen-fill-color"?: string;
        "-myscript-pen-fill-style"?: string;
        "-myscript-pen-width"?: number;
        color?: string;
        fill?: string;
        opacity?: number;
        width?: number;
        [key: string]: string | number | undefined;
    },
): void
Parameters
- penStyle: {
      "-myscript-pen-fill-color"?: string;
      "-myscript-pen-fill-style"?: string;
      "-myscript-pen-width"?: number;
      color?: string;
      fill?: string;
      opacity?: number;
      width?: number;
      [key: string]: string | number | undefined;
  }
Returns void
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:120

penStyleClasses

get penStyleClasses(): string
Returns string
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:127
set penStyleClasses(penClass: string): void
Parameters
- penClass: string
Returns void
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:130

theme

get theme(): TTheme
Returns TTheme
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:139
set theme(
    theme: {
        ".math"?: { "font-family"?: string };
        ".math-solved"?: { color?: string; "font-family"?: string };
        ".text"?: { "font-family"?: string; "font-size"?: number };
        ink?: {
            "-myscript-pen-fill-color"?: string;
            "-myscript-pen-fill-style"?: string;
            "-myscript-pen-width"?: number;
            color?: string;
            fill?: string;
            opacity?: number;
            width?: number;
            [key: string]: string | number | undefined;
        };
        [key: string]: unknown;
    },
): void
Parameters
- theme: {
      ".math"?: { "font-family"?: string };
      ".math-solved"?: { color?: string; "font-family"?: string };
      ".text"?: { "font-family"?: string; "font-size"?: number };
      ink?: {
          "-myscript-pen-fill-color"?: string;
          "-myscript-pen-fill-style"?: string;
          "-myscript-pen-width"?: number;
          color?: string;
          fill?: string;
          opacity?: number;
          width?: number;
          [key: string]: string | number | undefined;
      };
      [key: string]: unknown;
  }
Returns void
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:142

tool

get tool(): CanvasTool
Returns CanvasTool
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:84
set tool(i: CanvasTool): void
Parameters
- i: CanvasTool
Returns void
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:87

Methods

clear

clear(): Promise<void>
Returns Promise<void>
Overrides AbstractCanvas.clear
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:507

`Protected`clearOperation

clearOperation(label: TCanvasOperationLabel): void
Force label fully inactive regardless of how many startOperation calls are pending. For level-triggered signals with a single external "done" event (e.g. the client's idle event) rather than one end call per start call.
Parameters
- label: TCanvasOperationLabel
Returns void
Inherited from AbstractCanvas.clearOperation
- Defined in canvas/AbstractCanvas.ts:186

convert

convert(params?: { conversionState?: TConverstionState }): Promise<Model>
Parameters
- Optionalparams: { conversionState?: TConverstionState }
Returns Promise<Model>
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:340

destroy

destroy(): Promise<void>
Returns Promise<void>
Overrides AbstractCanvas.destroy
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:517

drawCurrentStroke

drawCurrentStroke(): void
Returns void
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:280

endOperation

endOperation(label: TCanvasOperationLabel): void
Mark one occurrence of label as finished. Must be paired with a prior startOperation.
Parameters
- label: TCanvasOperationLabel
Returns void
Inherited from AbstractCanvas.endOperation
- Defined in canvas/AbstractCanvas.ts:171

export

export(mimeTypes?: string[]): Promise<Model>
Parameters
- OptionalmimeTypes: string[]
Returns Promise<Model>
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:313

hasOperation

hasOperation(label: TCanvasOperationLabel): boolean
Whether label is currently active (at least one unmatched startOperation call).
Parameters
- label: TCanvasOperationLabel
Returns boolean
Inherited from AbstractCanvas.hasOperation
- Defined in canvas/AbstractCanvas.ts:192

import

import(data: string | TJIIXExport | Blob, mimeType?: string): Promise<Model>
Parameters
- data: string | TJIIXExport | Blob
- OptionalmimeType: string
Returns Promise<Model>
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:355

importPointEvents

importPointEvents(
    strokes: {
        creationTime?: number;
        id?: string;
        length?: number;
        modificationDate?: number;
        pointers?: (
            { p?: number; t?: number; x?: number; y?: number }
            | undefined
        )[];
        pointerType?: string;
        style?: {
            "-myscript-pen-fill-color"?: string;
            "-myscript-pen-fill-style"?: string;
            "-myscript-pen-width"?: number;
            color?: string;
            fill?: string;
            opacity?: number;
            width?: number;
            [key: string]: string | number | undefined;
        };
        type?: string;
    }[],
): Promise<Model>
Parameters
- strokes: {
      creationTime?: number;
      id?: string;
      length?: number;
      modificationDate?: number;
      pointers?: ({ p?: number; t?: number; x?: number; y?: number } | undefined)[];
      pointerType?: string;
      style?: {
          "-myscript-pen-fill-color"?: string;
          "-myscript-pen-fill-style"?: string;
          "-myscript-pen-width"?: number;
          color?: string;
          fill?: string;
          opacity?: number;
          width?: number;
          [key: string]: string | number | undefined;
      };
      type?: string;
  }[]
Returns Promise<Model>
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:376

initialize

initialize(): Promise<void>
Returns Promise<void>
Overrides AbstractCanvas.initialize
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:234

`Protected`initializeSmartGuide

initializeSmartGuide(): void
Returns void
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:204

loadInfo

loadInfo(server: TServerHTTPConfiguration): Promise<TApiInfos>
Parameters
- server: TServerHTTPConfiguration
Returns Promise<TApiInfos>
Inherited from AbstractCanvas.loadInfo
- Defined in canvas/AbstractCanvas.ts:271

`Protected`manageConnectionStatus

manageConnectionStatus(
status: TConnectionStatus,
offlineQueueLength?: number,
): void
Only relevant for WebSocket-backed canvas; other variants never call this.
Parameters
- status: TConnectionStatus
- offlineQueueLength: number = 0
Returns void
Inherited from AbstractCanvas.manageConnectionStatus
- Defined in canvas/AbstractCanvas.ts:203

`Protected`manageIdleState

manageIdleState(idle: boolean): void
Parameters
- idle: boolean
Returns void

Remarks
The client's idle event only fires in response to an explicit client.waitForIdle() call (a request/response pair, not a push notification) — it does NOT fire automatically after every addStrokes()/transform/etc. So it cannot be used to end a "Recognizing" operation reliably. This only preserves the public event.emitIdle passthrough for consumers who call waitForIdle() themselves.
Inherited from AbstractCanvas.manageIdleState
- Defined in canvas/AbstractCanvas.ts:160

`Protected`markConnectedOnce

markConnectedOnce(): void
Called once the canvas has connected to its backend for the first time.

Returns void
Inherited from AbstractCanvas.markConnectedOnce
- Defined in canvas/AbstractCanvas.ts:197

`Protected`onContentChanged

onContentChanged(undoRedoContext: THistoryContext): void
Parameters
- undoRedoContext: THistoryContext
Returns void
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:224

`Protected`onError

onError(error: Error): void
Parameters
- error: Error
Returns void
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:229

`Protected`onExport

onExport(exports: TExport): void
Parameters
- exports: TExport
Returns void
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:157

`Protected`onPointerDown

onPointerDown(info: TPointerInfo): void
Parameters
- info: TPointerInfo
Returns void
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:167

`Protected`onPointerMove

onPointerMove(info: TPointerInfo): void
Parameters
- info: TPointerInfo
Returns void
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:177

`Protected`onPointerUp

onPointerUp(info: TPointerInfo): Promise<void>
Parameters
- info: TPointerInfo
Returns Promise<void>
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:186

`Protected`onSVGPatch

onSVGPatch(evt: TWebSocketSSRClientMessageSVGPatch): void
Parameters
- evt: TWebSocketSSRClientMessageSVGPatch
Returns void
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:199

redo

redo(): Promise<Model>
Returns Promise<Model>
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:494

resize

resize(__namedParameters?: { height?: number; width?: number }): Promise<void>
Parameters
- __namedParameters: { height?: number; width?: number } = {}
Returns Promise<void>
Overrides AbstractCanvas.resize
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:439

`Protected`setCursorStyle

setCursorStyle(): void
Returns void
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:92

startOperation

startOperation(label: TCanvasOperationLabel): void
Mark label as active. Prefer trackOperation unless the operation isn't promise-shaped.
Parameters
- label: TCanvasOperationLabel
Returns void
Inherited from AbstractCanvas.startOperation
- Defined in canvas/AbstractCanvas.ts:165

`Protected`startResizeObserver

startResizeObserver(): void
Returns void
Inherited from AbstractCanvas.startResizeObserver
- Defined in canvas/AbstractCanvas.ts:257

`Protected`stopResizeObserver

stopResizeObserver(): void
Returns void
Inherited from AbstractCanvas.stopResizeObserver
- Defined in canvas/AbstractCanvas.ts:265

synchronizeModelWithBackend

synchronizeModelWithBackend(): Promise<Model>
Returns Promise<Model>
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:290

`Protected`syncStyle

syncStyle(): Promise<void>
Returns Promise<void>
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:149

trackOperation

trackOperation<T>(
label: TCanvasOperationLabel,
fn: () => Promise<T>,
): Promise<T>
Run fn, marking label as an active operation for the duration (shown on the canvas state badge tooltip). Safe against overlapping/concurrent calls with the same or different labels, and against fn throwing (the operation is always ended).
Type Parameters
- T
Parameters
- label: TCanvasOperationLabel
- fn: () => Promise<T>
Returns Promise<T>
Inherited from AbstractCanvas.trackOperation
- Defined in canvas/AbstractCanvas.ts:144

undo

undo(): Promise<Model>
Returns Promise<Model>
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:482

waitForIdle

waitForIdle(): Promise<void>
Returns Promise<void>
- Defined in canvas/variants/InteractiveInkSSRCanvas.ts:309

Class InteractiveInkSSRCanvas

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns InteractiveInkSSRCanvas

Properties

client

event

grabber

history

Optionalinfo

layers

logger

renderer

OptionalsmartGuide

styleManager

Accessors

configuration

Returns InteractiveInkSSRCanvasConfiguration

connectionState

Returns TCanvasConnectionState

currentPenStyle

Returns TPenStyle

initializationPromise

Returns Promise<void>

loggerConfiguration

Returns TLoggerConfiguration

Parameters

Returns void

model

Returns Model

penStyle

Returns TPenStyle

Parameters

Returns void

penStyleClasses

Returns string

Parameters

Returns void

theme

Returns TTheme

Parameters

Returns void

tool

Returns CanvasTool

Parameters

Returns void

Methods

clear

Returns Promise<void>

ProtectedclearOperation

Parameters

Returns void

convert

Parameters

Returns Promise<Model>

destroy

Returns Promise<void>

drawCurrentStroke

Returns void

endOperation

Parameters

Returns void

export

Parameters

Returns Promise<Model>

hasOperation

Parameters

Returns boolean

import

Parameters

Returns Promise<Model>

importPointEvents

Parameters

Returns Promise<Model>

`Optional`info

`Optional`smartGuide

`Protected`clearOperation

`Protected`initializeSmartGuide

`Protected`manageConnectionStatus

`Protected`manageIdleState

`Protected`markConnectedOnce

`Protected`onContentChanged

`Protected`onError

`Protected`onExport

`Protected`onPointerDown

`Protected`onPointerMove

`Protected`onPointerUp

`Protected`onSVGPatch

`Protected`setCursorStyle

`Protected`startResizeObserver

`Protected`stopResizeObserver

`Protected`syncStyle