Class Editor

behaviors

• get behaviors(): IBehaviors

• Returns IBehaviors

configuration

• get configuration(): TConfiguration

• Returns TConfiguration

• set configuration(configuration): void

• Parameters

  • configuration: TConfiguration

  Returns void

context

• get context(): TUndoRedoContext

• Returns TUndoRedoContext

currentPenStyle

• get currentPenStyle(): TPenStyle

• Returns TPenStyle

events

• get events(): PublicEvent

• Returns PublicEvent

grabber

• get grabber(): IGrabber

• Returns IGrabber

initializationPromise

• get initializationPromise(): Promise<void>

• Returns Promise<void>

intention

• get intention(): Intention

• Returns Intention

• set intention(i): void

• Parameters

  • i: Intention

  Returns void

internalEvents

• get internalEvents(): InternalEvent

• Returns InternalEvent

loggerConfiguration

• get loggerConfiguration(): TLoggerConfiguration

• Returns TLoggerConfiguration

• set loggerConfiguration(loggerConfig): void

• Parameters

  • loggerConfig: TLoggerConfiguration

  Returns void

model

• get model(): IModel

• Returns IModel

penStyle

• get penStyle(): TPenStyle

• Returns TPenStyle

• set penStyle(ps): void

• Parameters

  • ps: {
        -myscript-pen-fill-color?: string;
        -myscript-pen-fill-style?: string;
        -myscript-pen-width?: number;
        color?: string;
        fill?: string;
        opacity?: number;
        width?: number;
    }

    • Optional -myscript-pen-fill-color?: string

    • Optional -myscript-pen-fill-style?: string

    • Optional -myscript-pen-width?: number

    • Optional color?: string

    • Optional fill?: string

    • Optional opacity?: number

    • Optional width?: number

  Returns void

penStyleClasses

• get penStyleClasses(): string

• Returns string

• set penStyleClasses(styleClasses): void

• Parameters

  • styleClasses: string

  Returns void

theme

• get theme(): TTheme

• Returns TTheme

• set theme(theme): void

• Parameters

  • theme: {
        .math?: { "font-family"?: string | undefined; };
        .math-solved?: { "font-family"?: string | undefined; color?: string | undefined; };
        .text?: { "font-family"?: string | undefined; "font-size"?: number | undefined; };
        ink?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; "-myscript-pen-width"?: number | undefined; "-myscript-pen-fill-style"?: string | undefined; "-myscript-pen-fill-color"?: string | undefined; };
    }

    • Optional .math?: { "font-family"?: string | undefined; }

    • Optional .math-solved?: { "font-family"?: string | undefined; color?: string | undefined; }

    • Optional .text?: { "font-family"?: string | undefined; "font-size"?: number | undefined; }

    • Optional ink?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; "-myscript-pen-width"?: number | undefined; "-myscript-pen-fill-style"?: string | undefined; "-myscript-pen-fill-color"?: string | undefined; }

  Returns void

constructor

• new Editor(wrapperHTML, options, globalClassCss?): Editor

• Parameters

  • wrapperHTML: HTMLElement

  • options: {
        behaviors?: { grabber?: { attach?: {} | undefined; detach?: {} | undefined; onPointerDown?: {} | undefined; onPointerMove?: {} | undefined; onPointerUp?: {} | undefined; } | undefined; recognizer?: { ...; } | ... 2 more ... | undefined; menu?: { ...; } | undefined; gesture?: { ...; } | undefined; snap?: { ...; } | undefined; };
        configuration?: { offscreen?: boolean | undefined; server?: { protocol?: TProtocol | undefined; scheme?: TSchene | undefined; host?: string | undefined; applicationKey?: string | undefined; hmacKey?: string | undefined; version?: string | undefined; useWindowLocation?: boolean | undefined; websocket?: { ...; } | undefined; } | unde...;
        fontStyle?: { size?: number | undefined; weight?: "normal" | "bold" | undefined; };
        logger?: { readonly EDITOR?: LoggerLevel | undefined; readonly RECOGNIZER?: LoggerLevel | undefined; readonly GRABBER?: LoggerLevel | undefined; ... 16 more ...; readonly MENU?: LoggerLevel | undefined; };
        penStyle?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; };
        theme?: { [x: string]: unknown; ink?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; "-myscript-pen-width"?: number | undefined; "-myscript-pen-fill-style"?: string | undefined; "-myscript-pen-fill-color"?: string | undefined; } | undefined; ".math"?: { ......;
    }

    • Optional behaviors?: { grabber?: { attach?: {} | undefined; detach?: {} | undefined; onPointerDown?: {} | undefined; onPointerMove?: {} | undefined; onPointerUp?: {} | undefined; } | undefined; recognizer?: { ...; } | ... 2 more ... | undefined; menu?: { ...; } | undefined; gesture?: { ...; } | undefined; snap?: { ...; } | undefined; }

    • Optional configuration?: { offscreen?: boolean | undefined; server?: { protocol?: TProtocol | undefined; scheme?: TSchene | undefined; host?: string | undefined; applicationKey?: string | undefined; hmacKey?: string | undefined; version?: string | undefined; useWindowLocation?: boolean | undefined; websocket?: { ...; } | undefined; } | unde...

    • Optional fontStyle?: { size?: number | undefined; weight?: "normal" | "bold" | undefined; }

    • Optional logger?: { readonly EDITOR?: LoggerLevel | undefined; readonly RECOGNIZER?: LoggerLevel | undefined; readonly GRABBER?: LoggerLevel | undefined; ... 16 more ...; readonly MENU?: LoggerLevel | undefined; }

    • Optional penStyle?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; }

    • Optional theme?: { [x: string]: unknown; ink?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; "-myscript-pen-width"?: number | undefined; "-myscript-pen-fill-style"?: string | undefined; "-myscript-pen-fill-color"?: string | undefined; } | undefined; ".math"?: { ......

  • globalClassCss: string = "ms-editor"

  Returns Editor

clear

• clear(): Promise<IModel>

• Returns Promise<IModel>

closeMessageModal

• closeMessageModal(): Promise<void>

• Returns Promise<void>

convert

• convert(params?): Promise<IModel>

• Parameters

  • Optional params: {
        conversionState?: TConverstionState;
        mimeTypes?: string[];
    }

    • Optional conversionState?: TConverstionState

    • Optional mimeTypes?: string[]

  Returns Promise<IModel>

export

• export(mimeTypes?): Promise<IModel>

• Parameters

  • Optional mimeTypes: string[]

  Returns Promise<IModel>

import

• import(data, mimeType?): Promise<IModel>

• Parameters

  • data: string | TJIIXExport | Blob

  • Optional mimeType: string

  Returns Promise<IModel>

importPointEvents

• importPointEvents(strokes): Promise<IModel>

• Parameters

  • strokes: {
        creationTime?: number;
        id?: string;
        length?: number;
        modificationDate?: number;
        pointerType?: string;
        pointers?: (undefined | ({ x?: number | undefined; y?: number | undefined; t?: number | undefined; p?: number | undefined; }))[];
        style?: { width?: number | undefined; color?: string | undefined; opacity?: number | undefined; fill?: string | undefined; };
        type?: string;
    }[]

  Returns Promise<IModel>

initialize

• initialize(): Promise<void>

• Returns Promise<void>

redo

• redo(): Promise<IModel>

• Returns Promise<IModel>

resize

• resize(): Promise<IModel>

• Returns Promise<IModel>

showError

• showError(err): void

• Parameters

  • err: string | Error

  Returns void

showNotif

• showNotif(notif): void

• Parameters

  • notif: {
        message: string;
        timeout?: number;
    }

    • message: string

    • Optional timeout?: number

  Returns void

undo

• undo(): Promise<IModel>

• Returns Promise<IModel>

waitForIdle

• waitForIdle(): Promise<void>

• Returns Promise<void>

logger

wrapperHTML