Class InteractiveInkSSREditor

configuration

• get configuration(): InteractiveInkSSREditorConfiguration

  Returns InteractiveInkSSREditorConfiguration

currentPenStyle

• get currentPenStyle(): TPenStyle

  Returns TPenStyle

initializationPromise

• get initializationPromise(): Promise<void>

  Returns Promise<void>

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

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

tool

• get tool(): EditorTool

  Returns EditorTool

• set tool(i: EditorTool): void

  Parameters

  • i: EditorTool

  Returns void

constructor

• new InteractiveInkSSREditor(
      rootElement: HTMLElement,
      options?: TInteractiveInkSSREditorOptions,
  ): InteractiveInkSSREditor

  Parameters

  • rootElement: HTMLElement
  • Optionaloptions: TInteractiveInkSSREditorOptions

  Returns InteractiveInkSSREditor

clear

• clear(): Promise<void>

  Returns Promise<void>

convert

• convert(params?: { conversionState?: TConverstionState }): Promise<Model>

  Parameters

  • Optionalparams: { conversionState?: TConverstionState }

  Returns Promise<Model>

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?: (
              { 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>

initialize

• initialize(): Promise<void>

  Returns Promise<void>

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>

synchronizeModelWithBackend

• synchronizeModelWithBackend(): Promise<Model>

  Returns Promise<Model>

undo

• undo(): Promise<Model>

  Returns Promise<Model>

waitForIdle

• waitForIdle(): Promise<void>

  Returns Promise<void>

grabber

history

recognizer

renderer

OptionalsmartGuide

styleManager