Class InkCanvasDeprecated

Deprecated

Use InkCanvas instead.

Constructors

constructor

new InkCanvasDeprecated(
rootElement: HTMLElement,
options?: TInkCanvasDeprecatedOptions,
): InkCanvasDeprecated
Parameters
- rootElement: HTMLElement
- Optionaloptions: TInkCanvasDeprecatedOptions
Returns InkCanvasDeprecated
Overrides AbstractCanvas.constructor
- Defined in canvas/variants/InkCanvasDeprecated.ts:52

Properties

client

client: HTTPClientV1

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: CanvasRenderer

styleManager

styleManager: StyleManager

Accessors

configuration

get configuration(): InkCanvasDeprecatedConfiguration
Returns InkCanvasDeprecatedConfiguration
- Defined in canvas/variants/InkCanvasDeprecated.ts:213

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/InkCanvasDeprecated.ts:183

initializationPromise

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

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/InkCanvasDeprecated.ts:179

penStyle

get penStyle(): TPenStyle
Returns TPenStyle
- Defined in canvas/variants/InkCanvasDeprecated.ts:187
set penStyle(penStyle: TPenStyle | undefined): void
Parameters
- penStyle: TPenStyle | undefined
Returns void
- Defined in canvas/variants/InkCanvasDeprecated.ts:190

penStyleClasses

get penStyleClasses(): string
Returns string
- Defined in canvas/variants/InkCanvasDeprecated.ts:195
set penStyleClasses(penStyleClasses: string | undefined): void
Parameters
- penStyleClasses: string | undefined
Returns void
- Defined in canvas/variants/InkCanvasDeprecated.ts:198

theme

get theme(): TTheme
Returns TTheme
- Defined in canvas/variants/InkCanvasDeprecated.ts:205
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/InkCanvasDeprecated.ts:208

tool

get tool(): CanvasTool
Returns CanvasTool
- Defined in canvas/variants/InkCanvasDeprecated.ts:158
set tool(i: CanvasTool): void
Parameters
- i: CanvasTool
Returns void
- Defined in canvas/variants/InkCanvasDeprecated.ts:161

Methods

clear

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

`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; mimeTypes?: string[] },
): Promise<Model>
Parameters
- Optionalparams: { conversionState?: TConverstionState; mimeTypes?: string[] }
Returns Promise<Model>
- Defined in canvas/variants/InkCanvasDeprecated.ts:311

destroy

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

drawCurrentStroke

drawCurrentStroke(): void
Returns void
- Defined in canvas/variants/InkCanvasDeprecated.ts:248

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/InkCanvasDeprecated.ts:295

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

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/InkCanvasDeprecated.ts:324

initialize

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

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`onPointerDown

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

`Protected`onPointerMove

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

`Protected`onPointerUp

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

redo

redo(): Promise<void>
Returns Promise<void>
- Defined in canvas/variants/InkCanvasDeprecated.ts:417

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/InkCanvasDeprecated.ts:389

`Protected`setCursorStyle

setCursorStyle(): void
Returns void
- Defined in canvas/variants/InkCanvasDeprecated.ts:166

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

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<void>
Returns Promise<void>
- Defined in canvas/variants/InkCanvasDeprecated.ts:405

updateModelRendering

updateModelRendering(): Promise<Model>
Returns Promise<Model>
- Defined in canvas/variants/InkCanvasDeprecated.ts:255

Class InkCanvasDeprecated

Deprecated

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns InkCanvasDeprecated

Properties

client

event

grabber

history

Optionalinfo

layers

logger

renderer

styleManager

Accessors

configuration

Returns InkCanvasDeprecatedConfiguration

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

importPointEvents

Parameters

Returns Promise<Model>

initialize

Returns Promise<void>

loadInfo

`Optional`info

`Protected`clearOperation

`Protected`manageConnectionStatus

`Protected`manageIdleState

`Protected`markConnectedOnce

`Protected`onPointerDown

`Protected`onPointerMove

`Protected`onPointerUp

`Protected`setCursorStyle

`Protected`startResizeObserver

`Protected`stopResizeObserver