Class InkEditor

configuration

• get configuration(): InkEditorConfiguration

  Returns InkEditorConfiguration

initializationPromise

• get initializationPromise(): Promise<void>

  Returns Promise<void>

model

• get model(): IModel

  Returns IModel

penStyle

• get penStyle(): TStyle

  Returns TStyle

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

  Parameters

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

  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>

export

• export(requestedMimeTypes?: string[]): Promise<TExportV2>

  Parameters

  • OptionalrequestedMimeTypes: string[]

  Returns Promise<TExportV2>

initialize

• initialize(): Promise<void>

  Returns Promise<void>

redo

• redo(): Promise<void>

  Returns Promise<void>

removeStrokes

• removeStrokes(strokeIds: string[]): Promise<void>

  Parameters

  • strokeIds: string[]

  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>

updateSymbolsStyle

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

  Parameters

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

  Returns void

debugger

eraser

history

recognizer

renderer

writer