Class InkEditor

configuration

• get configuration(): InkEditorConfiguration

• Returns InkEditorConfiguration

initializationPromise

• get initializationPromise(): Promise<void>

• Returns Promise<void>

model

• get model(): Model

• Returns Model

penStyle

• get penStyle(): TStyle

• Returns TStyle

• set penStyle(
      penStyle: {
          color?: string;
          fill?: string;
          opacity?: number;
          width?: number;
          [key: string]: undefined | string | number;
      },
  ): void

• Parameters

  • penStyle: {
        color?: string;
        fill?: string;
        opacity?: number;
        width?: number;
        [key: string]: undefined | string | number;
    }

  Returns void

tool

• get tool(): EditorTool

• Returns EditorTool

• set tool(i: EditorTool): void

• Parameters

  • i: EditorTool

  Returns void

constructor

• new InkEditor(rootElement: HTMLElement, options?: TInkEditorOptions): InkEditor

• Parameters

  • rootElement: HTMLElement
  • Optionaloptions: TInkEditorOptions

  Returns InkEditor

clear

• clear(): Promise<void>

• Returns Promise<void>

destroy

• destroy(): Promise<void>

• Returns Promise<void>

drawCurrentStroke

• drawCurrentStroke(): void

• Returns void

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>

redo

• redo(): Promise<void>

• Returns Promise<void>

resize

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

• Parameters

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

  Returns Promise<void>

undo

• undo(): Promise<void>

• Returns Promise<void>

updateModelRendering

• updateModelRendering(): Promise<Model>

• Returns Promise<Model>

grabber

history

recognizer

renderer