Type Alias TInteractiveInkCanvas

Structural type for InteractiveInkCanvas used by all managers. Managers depend on this type rather than the concrete class to enable isolation testing and future canvas variants.

type TInteractiveInkCanvas = {
    addSymbol(sym: TSymbol, addToHistory?: boolean): Promise<TSymbol>;
    addSymbols(symList: TSymbol[], addToHistory?: boolean): Promise<TSymbol[]>;
    changeLanguage(code: string): Promise<void>;
    changeOrderSymbols(
        symbols: TSymbol[],
        position: "first" | "last" | "forward" | "backward",
    ): void;
    clear(): Promise<void>;
    client: WebSocketClient;
    configuration: InteractiveInkCanvasConfiguration;
    get connectionState(): TCanvasConnectionState;
    connector: IIConnectorManager;
    convert(symbols?: TSymbol[]): Promise<void>;
    converter: IIConversionManager;
    copy(): void;
    createSymbols(partialSymbols: TPartialDeep<TSymbol>[]): Promise<TSymbol[]>;
    cut(): Promise<void>;
    destroy(): Promise<void>;
    dom: typeof DOMFactory;
    downloadAsJson(selection?: boolean): void;
    downloadAsPNG(selection?: boolean): void;
    downloadAsSVG(selection?: boolean): void;
    downloadAsText(selection?: boolean): void;
    duplicate(symbols?: TSymbol[]): Promise<TSymbol[]>;
    endOperation(label: TCanvasOperationLabel): void;
    eraser: EraseManager;
    event: CanvasEvent;
    export(mimeTypes?: string[]): Promise<TExport>;
    extractStrokesFromSymbols(symbols: TSymbol[] | undefined): TStroke[];
    gesture: IIGestureManager;
    getSymbolsBounds(symbols: TSymbol[], margin?: number): TBox;
    getSymbolUtil<T extends TBaseSymbol>(
        type: string,
    ): SymbolUtil<T> | undefined;
    hasOperation(label: TCanvasOperationLabel): boolean;
    history: IIHistoryManager;
    jiix: IIJiixQueryManager;
    keyboard: IIKeyboardManager;
    layers: CanvasLayer;
    manageError(error: Error): void;
    math: IIMathManager;
    menu: IIMenuManager;
    model: IIModel;
    move: IIMoveManager;
    overlays: IIOverlayManager;
    paste(): Promise<void>;
    get penStyle(): TStyle;
    set penStyle(
        v: {
            color?: string;
            fill?: string;
            opacity?: number;
            width?: number;
            [key: string]: string | number | undefined;
        },
    ): void;
    playback: IIPlaybackManager;
    readOnly: boolean;
    redo(): Promise<IIModel>;
    registerSymbolUtil<T extends TBaseSymbol>(util: SymbolUtil<T>): void;
    removeSymbol(id: string, addToHistory?: boolean): Promise<void>;
    removeSymbols(ids: string[], addToHistory?: boolean): Promise<TSymbol[]>;
    renderer: SVGRenderer;
    set renderingConfiguration(v: TIIRendererConfiguration): void;
    replaceSymbols(
        oldSymbols: TSymbol[],
        newSymbols: TSymbol[],
        addToHistory?: boolean,
    ): Promise<void>;
    resize(dims?: { height?: number; width?: number }): Promise<void>;
    select(ids: string[]): void;
    selectAll(): void;
    selector: IISelectionManager;
    setCssVars(vars: Record<string, string> | undefined): void;
    snaps: IISnapManager;
    startOperation(label: TCanvasOperationLabel): void;
    synchronizer: IISynchronizerManager;
    tool: CanvasTool;
    trackOperation<T>(
        label: TCanvasOperationLabel,
        fn: () => Promise<T>,
    ): Promise<T>;
    transform: IITransformManager;
    typeset: IITypesetManager;
    undo(): Promise<IIModel>;
    unselectAll(): void;
    updateSymbol(sym: TSymbol, addToHistory?: boolean): Promise<TSymbol>;
    updateSymbols(
        symList: TSymbol[],
        addToHistory?: boolean,
    ): Promise<TSymbol[]>;
    updateSymbolsStyle(
        symbolIds: string[],
        style: {
            color?: string;
            fill?: string;
            opacity?: number;
            width?: number;
            [key: string]: string | number | undefined;
        },
        addToHistory?: boolean,
    ): void;
    updateTextFontStyle(
        textIds: string[],
        opts: { fontSize?: number; fontWeight?: "normal" | "bold" | "auto" },
    ): void;
    writer: IIWriterManager;
    zoom(zoom: number, centerX?: number, centerY?: number): void;
    zoomToFit(symbols?: TSymbol[]): void;
}

Implemented by

InteractiveInkCanvas

Properties

`Readonly`dom

dom: typeof DOMFactory

`Readonly`eraser

eraser: EraseManager

`Readonly`event

event: CanvasEvent

`Readonly`gesture

gesture: IIGestureManager

`Readonly`history

history: IIHistoryManager

`Readonly`jiix

jiix: IIJiixQueryManager

`Readonly`keyboard

keyboard: IIKeyboardManager

`Readonly`layers

layers: CanvasLayer

`Readonly`math

math: IIMathManager

`Readonly`menu

menu: IIMenuManager

`Readonly`model

model: IIModel

`Readonly`move

move: IIMoveManager

`Readonly`overlays

overlays: IIOverlayManager

`Readonly`playback

playback: IIPlaybackManager

readOnly

readOnly: boolean

`Readonly`renderer

renderer: SVGRenderer

`Readonly`selector

selector: IISelectionManager

`Readonly`snaps

snaps: IISnapManager

`Readonly`synchronizer

synchronizer: IISynchronizerManager

tool

tool: CanvasTool

`Readonly`transform

transform: IITransformManager

`Readonly`typeset

typeset: IITypesetManager

`Readonly`writer

writer: IIWriterManager

Accessors

connectionState

get connectionState(): TCanvasConnectionState
Returns TCanvasConnectionState
- Defined in canvas/TInteractiveInkCanvas.ts:59

penStyle

get penStyle(): TStyle
Returns TStyle
- Defined in canvas/TInteractiveInkCanvas.ts:52
set penStyle(
    v: {
        color?: string;
        fill?: string;
        opacity?: number;
        width?: number;
        [key: string]: string | number | undefined;
    },
): void
Parameters
- v: {
      color?: string;
      fill?: string;
      opacity?: number;
      width?: number;
      [key: string]: string | number | undefined;
  }
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:53

renderingConfiguration

set renderingConfiguration(v: TIIRendererConfiguration): void
Parameters
- v: TIIRendererConfiguration
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:56

Methods

addSymbol

addSymbol(sym: TSymbol, addToHistory?: boolean): Promise<TSymbol>
Parameters
- sym: TSymbol
- OptionaladdToHistory: boolean
Returns Promise<TSymbol>
- Defined in canvas/TInteractiveInkCanvas.ts:87

addSymbols

addSymbols(symList: TSymbol[], addToHistory?: boolean): Promise<TSymbol[]>
Parameters
- symList: TSymbol[]
- OptionaladdToHistory: boolean
Returns Promise<TSymbol[]>
- Defined in canvas/TInteractiveInkCanvas.ts:88

changeLanguage

changeLanguage(code: string): Promise<void>
Parameters
- code: string
Returns Promise<void>
- Defined in canvas/TInteractiveInkCanvas.ts:128

changeOrderSymbols

changeOrderSymbols(
symbols: TSymbol[],
position: "first" | "last" | "forward" | "backward",
): void
Parameters
- symbols: TSymbol[]
- position: "first" | "last" | "forward" | "backward"
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:100

clear

clear(): Promise<void>
Returns Promise<void>
- Defined in canvas/TInteractiveInkCanvas.ts:141

convert

convert(symbols?: TSymbol[]): Promise<void>
Parameters
- Optionalsymbols: TSymbol[]
Returns Promise<void>
- Defined in canvas/TInteractiveInkCanvas.ts:127

copy

copy(): void
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:121

createSymbols

createSymbols(partialSymbols: TPartialDeep<TSymbol>[]): Promise<TSymbol[]>
Parameters
- partialSymbols: TPartialDeep<TSymbol>[]
Returns Promise<TSymbol[]>
- Defined in canvas/TInteractiveInkCanvas.ts:86

cut

cut(): Promise<void>
Returns Promise<void>
- Defined in canvas/TInteractiveInkCanvas.ts:122

destroy

destroy(): Promise<void>
Returns Promise<void>
- Defined in canvas/TInteractiveInkCanvas.ts:142

downloadAsJson

downloadAsJson(selection?: boolean): void
Parameters
- Optionalselection: boolean
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:133

downloadAsPNG

downloadAsPNG(selection?: boolean): void
Parameters
- Optionalselection: boolean
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:132

downloadAsSVG

downloadAsSVG(selection?: boolean): void
Parameters
- Optionalselection: boolean
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:131

downloadAsText

downloadAsText(selection?: boolean): void
Parameters
- Optionalselection: boolean
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:134

duplicate

duplicate(symbols?: TSymbol[]): Promise<TSymbol[]>
Parameters
- Optionalsymbols: TSymbol[]
Returns Promise<TSymbol[]>
- Defined in canvas/TInteractiveInkCanvas.ts:104

endOperation

endOperation(label: TCanvasOperationLabel): void
Parameters
- label: TCanvasOperationLabel
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:62

export

export(mimeTypes?: string[]): Promise<TExport>
Parameters
- OptionalmimeTypes: string[]
Returns Promise<TExport>
- Defined in canvas/TInteractiveInkCanvas.ts:126

extractStrokesFromSymbols

extractStrokesFromSymbols(symbols: TSymbol[] | undefined): TStroke[]
Parameters
- symbols: TSymbol[] | undefined
Returns TStroke[]
- Defined in canvas/TInteractiveInkCanvas.ts:103

getSymbolsBounds

getSymbolsBounds(symbols: TSymbol[], margin?: number): TBox
Parameters
- symbols: TSymbol[]
- Optionalmargin: number
Returns TBox
- Defined in canvas/TInteractiveInkCanvas.ts:112

getSymbolUtil

getSymbolUtil<T extends TBaseSymbol>(type: string): SymbolUtil<T> | undefined
Type Parameters
- T extends TBaseSymbol
Parameters
- type: string
Returns SymbolUtil<T> | undefined
- Defined in canvas/TInteractiveInkCanvas.ts:138

hasOperation

hasOperation(label: TCanvasOperationLabel): boolean
Parameters
- label: TCanvasOperationLabel
Returns boolean
- Defined in canvas/TInteractiveInkCanvas.ts:63

manageError

manageError(error: Error): void
Parameters
- error: Error
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:145

paste

paste(): Promise<void>
Returns Promise<void>
- Defined in canvas/TInteractiveInkCanvas.ts:123

redo

redo(): Promise<IIModel>
Returns Promise<IIModel>
- Defined in canvas/TInteractiveInkCanvas.ts:118

registerSymbolUtil

registerSymbolUtil<T extends TBaseSymbol>(util: SymbolUtil<T>): void
Type Parameters
- T extends TBaseSymbol
Parameters
- util: SymbolUtil<T>
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:137

removeSymbol

removeSymbol(id: string, addToHistory?: boolean): Promise<void>
Parameters
- id: string
- OptionaladdToHistory: boolean
Returns Promise<void>
- Defined in canvas/TInteractiveInkCanvas.ts:101

removeSymbols

removeSymbols(ids: string[], addToHistory?: boolean): Promise<TSymbol[]>
Parameters
- ids: string[]
- OptionaladdToHistory: boolean
Returns Promise<TSymbol[]>
- Defined in canvas/TInteractiveInkCanvas.ts:102

replaceSymbols

replaceSymbols(
    oldSymbols: TSymbol[],
    newSymbols: TSymbol[],
    addToHistory?: boolean,
): Promise<void>
Parameters
- oldSymbols: TSymbol[]
- newSymbols: TSymbol[]
- OptionaladdToHistory: boolean
Returns Promise<void>
- Defined in canvas/TInteractiveInkCanvas.ts:99

resize

resize(dims?: { height?: number; width?: number }): Promise<void>
Parameters
- Optionaldims: { height?: number; width?: number }
Returns Promise<void>
- Defined in canvas/TInteractiveInkCanvas.ts:143

select

select(ids: string[]): void
Parameters
- ids: string[]
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:107

selectAll

selectAll(): void
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:108

setCssVars

setCssVars(vars: Record<string, string> | undefined): void
Parameters
- vars: Record<string, string> | undefined
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:144

startOperation

startOperation(label: TCanvasOperationLabel): void
Parameters
- label: TCanvasOperationLabel
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:61

trackOperation

trackOperation<T>(
label: TCanvasOperationLabel,
fn: () => Promise<T>,
): Promise<T>
Type Parameters
- T
Parameters
- label: TCanvasOperationLabel
- fn: () => Promise<T>
Returns Promise<T>
- Defined in canvas/TInteractiveInkCanvas.ts:60

undo

undo(): Promise<IIModel>
Returns Promise<IIModel>
- Defined in canvas/TInteractiveInkCanvas.ts:117

unselectAll

unselectAll(): void
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:109

updateSymbol

updateSymbol(sym: TSymbol, addToHistory?: boolean): Promise<TSymbol>
Parameters
- sym: TSymbol
- OptionaladdToHistory: boolean
Returns Promise<TSymbol>
- Defined in canvas/TInteractiveInkCanvas.ts:89

updateSymbols

updateSymbols(symList: TSymbol[], addToHistory?: boolean): Promise<TSymbol[]>
Parameters
- symList: TSymbol[]
- OptionaladdToHistory: boolean
Returns Promise<TSymbol[]>
- Defined in canvas/TInteractiveInkCanvas.ts:90

updateSymbolsStyle

updateSymbolsStyle(
    symbolIds: string[],
    style: {
        color?: string;
        fill?: string;
        opacity?: number;
        width?: number;
        [key: string]: string | number | undefined;
    },
    addToHistory?: boolean,
): void
Parameters
- symbolIds: string[]
- style: {
      color?: string;
      fill?: string;
      opacity?: number;
      width?: number;
      [key: string]: string | number | undefined;
  }
- OptionaladdToHistory: boolean
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:91

updateTextFontStyle

updateTextFontStyle(
textIds: string[],
opts: { fontSize?: number; fontWeight?: "normal" | "bold" | "auto" },
): void
Parameters
- textIds: string[]
- opts: { fontSize?: number; fontWeight?: "normal" | "bold" | "auto" }
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:92

zoom

zoom(zoom: number, centerX?: number, centerY?: number): void
Parameters
- zoom: number
- OptionalcenterX: number
- OptionalcenterY: number
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:114

zoomToFit

zoomToFit(symbols?: TSymbol[]): void
Parameters
- Optionalsymbols: TSymbol[]
Returns void
- Defined in canvas/TInteractiveInkCanvas.ts:113

Type Alias TInteractiveInkCanvas

Implemented by

Index

Properties

Accessors

Methods

Properties

Readonlyclient

Readonlyconfiguration

Readonlyconnector

Readonlyconverter

Readonlydom

Readonlyeraser

Readonlyevent

Readonlygesture

Readonlyhistory

Readonlyjiix

Readonlykeyboard

Readonlylayers

Readonlymath

Readonlymenu

Readonlymodel

Readonlymove

Readonlyoverlays

Readonlyplayback

readOnly

Readonlyrenderer

Readonlyselector

Readonlysnaps

Readonlysynchronizer

tool

Readonlytransform

Readonlytypeset

Readonlywriter

Accessors

connectionState

Returns TCanvasConnectionState

penStyle

Returns TStyle

Parameters

Returns void

renderingConfiguration

Parameters

Returns void

Methods

addSymbol

Parameters

Returns Promise<TSymbol>

addSymbols

Parameters

Returns Promise<TSymbol[]>

changeLanguage

Parameters

Returns Promise<void>

changeOrderSymbols

Parameters

Returns void

clear

Returns Promise<void>

convert

Parameters

Returns Promise<void>

copy

Returns void

createSymbols

Parameters

Returns Promise<TSymbol[]>

cut

Returns Promise<void>

destroy

Returns Promise<void>

downloadAsJson

Parameters

Returns void

downloadAsPNG

Parameters

Returns void

downloadAsSVG

Parameters

Returns void

`Readonly`client

`Readonly`configuration

`Readonly`connector

`Readonly`converter

`Readonly`dom

`Readonly`eraser

`Readonly`event

`Readonly`gesture

`Readonly`history

`Readonly`jiix

`Readonly`keyboard

`Readonly`layers

`Readonly`math

`Readonly`menu

`Readonly`model

`Readonly`move

`Readonly`overlays

`Readonly`playback

`Readonly`renderer

`Readonly`selector

`Readonly`snaps

`Readonly`synchronizer

`Readonly`transform

`Readonly`typeset

`Readonly`writer