Class InteractiveInkSSREditor

Hierarchy

  • AbstractEditor
    • InteractiveInkSSREditor

Accessors

configuration currentPenStyle initializationPromise loggerConfiguration model penStyle penStyleClasses theme tool

Constructors

constructor

Methods

clear convert destroy drawCurrentStroke export import importPointEvents initialize initializeSmartGuide loadInfo onContetChaned onError onExport onPointerDown onPointerMove onPointerUp onSVGPatch redo resize setCursorStyle synchronizeModelWithBackend syncStyle undo waitForIdle

Properties

event grabber history info? layers logger recognizer renderer smartGuide? styleManager

Accessors

configuration

currentPenStyle

  • get currentPenStyle(): TPenStyle

  • Returns TPenStyle

initializationPromise

  • get initializationPromise(): Promise<void>

  • Returns Promise<void>

loggerConfiguration

model

  • get model(): Model

  • Returns Model

penStyle

  • get penStyle(): TPenStyle

  • Returns TPenStyle

  • 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]: undefined | string | number;
        },
    ): 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]: undefined | string | number;
      }

    Returns void

penStyleClasses

  • get penStyleClasses(): string

  • Returns string

  • set penStyleClasses(penClass: string): void

  • Parameters

    • penClass: string

    Returns void

theme

  • get theme(): TTheme

  • Returns TTheme

  • 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]: undefined | string | number;
            };
            [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]: undefined | string | number;
          };
          [key: string]: unknown;
      }

    Returns void

tool

Constructors

constructor

Methods

clear

  • clear(): Promise<void>

  • Returns Promise<void>

convert

destroy

  • destroy(): Promise<void>

  • Returns Promise<void>

drawCurrentStroke

  • drawCurrentStroke(): void

  • Returns void

export

  • export(mimeTypes?: string[]): Promise<Model>

  • Parameters

    • OptionalmimeTypes: string[]

    Returns Promise<Model>

import

  • import(data: string | TJIIXExport | Blob, mimeType?: string): Promise<Model>

  • Parameters

    • data: string | TJIIXExport | Blob
    • OptionalmimeType: string

    Returns Promise<Model>

importPointEvents

  • importPointEvents(
        strokes: {
            creationTime?: number;
            id?: string;
            length?: number;
            modificationDate?: number;
            pointers?: (
                undefined
                | { p?: number; t?: number; x?: number; y?: number }
            )[];
            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]: undefined | string | number;
            };
            type?: string;
        }[],
    ): Promise<Model>

  • Parameters

    • strokes: {
          creationTime?: number;
          id?: string;
          length?: number;
          modificationDate?: number;
          pointers?: (undefined | { p?: number; t?: number; x?: number; y?: number })[];
          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]: undefined | string | number;
          };
          type?: string;
      }[]

    Returns Promise<Model>

initialize

  • initialize(): Promise<void>

  • Returns Promise<void>

ProtectedinitializeSmartGuide

  • initializeSmartGuide(): void

  • Returns void

loadInfo

ProtectedonContetChaned

  • onContetChaned(undoRedoContext: THistoryContext): void

  • Parameters

    Returns void

ProtectedonError

  • onError(error: Error): void

  • Parameters

    • error: Error

    Returns void

ProtectedonExport

  • onExport(exports: TExport): void

  • Parameters

    Returns void

ProtectedonPointerDown

  • onPointerDown(info: PointerInfo): void

  • Parameters

    Returns void

ProtectedonPointerMove

  • onPointerMove(info: PointerInfo): void

  • Parameters

    Returns void

ProtectedonPointerUp

  • onPointerUp(info: PointerInfo): Promise<void>

  • Parameters

    Returns Promise<void>

ProtectedonSVGPatch

redo

  • redo(): Promise<Model>

  • Returns Promise<Model>

resize

  • resize(__namedParameters?: { height?: number; width?: number }): Promise<void>

  • Parameters

    • __namedParameters: { height?: number; width?: number } = {}

    Returns Promise<void>

ProtectedsetCursorStyle

  • setCursorStyle(): void

  • Returns void

synchronizeModelWithBackend

  • synchronizeModelWithBackend(): Promise<Model>

  • Returns Promise<Model>

ProtectedsyncStyle

  • syncStyle(): Promise<void>

  • Returns Promise<void>

undo

  • undo(): Promise<Model>

  • Returns Promise<Model>

waitForIdle

  • waitForIdle(): Promise<void>

  • Returns Promise<void>

Properties

event

event: EditorEvent

grabber

grabber: PointerEventGrabber

history

history: HistoryManager

Optionalinfo

info?: TApiInfos

layers

layers: EditorLayer

logger

logger: Logger = ...

recognizer

recognizer: RecognizerWebSocketSSR

renderer

renderer: InteractiveInkSSRSVGRenderer

OptionalsmartGuide

smartGuide?: InteractiveInkSSRSmartGuide

styleManager

styleManager: StyleManager

Settings

Member Visibility

On This Page

Accessors
Constructors
Methods
Properties