Class InkEditorConfiguration

constructor

• new InkEditorConfiguration(
      configuration?: {
          grabber?: {
              delayLongTouch?: number;
              listenerOptions?: { capture?: boolean; passive?: boolean };
              timestampFloatPrecision?: number;
              xyFloatPrecision?: number;
          };
          logger?: {
              CONVERTER?: LoggerLevel;
              EDITOR?: LoggerLevel;
              EDITOR_EVENT?: LoggerLevel;
              GESTURE?: LoggerLevel;
              GRABBER?: LoggerLevel;
              HISTORY?: LoggerLevel;
              MENU?: LoggerLevel;
              MODEL?: LoggerLevel;
              RECOGNIZER?: LoggerLevel;
              RENDERER?: LoggerLevel;
              SELECTION?: LoggerLevel;
              SMARTGUIDE?: LoggerLevel;
              STYLE?: LoggerLevel;
              SVGDEBUG?: LoggerLevel;
              SYMBOL?: LoggerLevel;
              TRANSFORMER?: LoggerLevel;
              WRITE?: LoggerLevel;
          };
          penStyle?: {
              color?: string;
              fill?: string;
              opacity?: number;
              width?: number;
              [key: string]: undefined
              | string
              | number;
          };
          recognition?: {
              convert?: { force?: { "on-stylesheet-change"?: boolean } };
              export?: {
                  image?: {
                      guides?: boolean;
                      viewport?: {
                          height?: (...) | (...);
                          width?: (...) | (...);
                          x?: (...) | (...);
                          y?: (...) | (...);
                      };
                  };
                  "image-resolution"?: number;
                  jiix?: {
                      "bounding-box"?: boolean;
                      "full-stroke-ids"?: boolean;
                      ids?: boolean;
                      strokes?: boolean;
                      style?: boolean;
                      text?: {
                          chars?: (...)
                          | (...)
                          | (...);
                          lines?: (...) | (...) | (...);
                          words?: (...) | (...) | (...);
                      };
                  };
                  mathml?: { flavor?: { name?: (...)
                  | (...) } };
              };
              lang?: string;
              math?: {
                  customGrammar?: string;
                  customGrammarContent?: string;
                  customGrammarId?: string;
                  eraser?: { "erase-precisely"?: boolean };
                  margin?: {
                      bottom?: number;
                      left?: number;
                      right?: number;
                      top?: number;
                  };
                  mimeTypes?: (
                      | undefined
                      | "application/vnd.myscript.jiix"
                      | "application/x-latex"
                      | "application/mathml+xml"
                  )[];
                  "recognition-timeout"?: number;
                  "session-time"?: number;
                  solver?: {
                      "angle-unit"?: TAngleUnit;
                      "decimal-separator"?: string;
                      enable?: boolean;
                      "fractional-part-digits"?: number;
                      options?: TSolverOptions;
                      "rounding-mode"?: TRoundingMode;
                  };
                  "undo-redo"?: { mode?: TUndoRedoMode };
              };
              "raw-content"?: {
                  classification?: {
                      types?: ((...) | (...) | (...) | (...) | (...) | (...))[];
                  };
                  eraser?: { "erase-precisely"?: boolean };
                  recognition?: { types?: ((...) | (...) | (...) | (...) | (...))[] };
                  "session-time"?: number;
                  text?: {
                      addLKText?: boolean;
                      customLexicon?: ((...) | (...))[];
                      customResources?: ((...) | (...))[];
                  };
              };
              shape?: {
                  beautification?: { enable?: true };
                  convert?: { "match-text-size"?: boolean; types?: ((...) | (...))[] };
                  "enable-sub-blocks"?: boolean;
                  eraser?: { "erase-precisely"?: boolean };
                  mimeTypes?: (
                      | undefined
                      | "application/vnd.myscript.jiix"
                      | "application/vnd.openxmlformats-officedocument.presentationml.presentation"
                      | "image/svg+xml"
                  )[];
                  "session-time"?: number;
              };
              text?: {
                  configuration?: {
                      addLKText?: boolean;
                      customLexicon?: ((...) | (...))[];
                      customResources?: ((...) | (...))[];
                  };
                  eraser?: { "erase-precisely"?: boolean };
                  guides?: {
                      enable?: boolean;
                      "line-gap-mm"?: number;
                      "origin-y-mm"?: number;
                  };
                  margin?: {
                      bottom?: number;
                      left?: number;
                      right?: number;
                      top?: number;
                  };
                  mimeTypes?: (undefined | "text/plain" | "application/vnd.myscript.jiix")[];
                  text?: boolean;
              };
              type?: TRecognitionType;
          };
          renderer?: {
              guides?: { enable?: boolean; gap?: number };
              minHeight?: number;
              minWidth?: number;
          };
          server?: {
              applicationKey?: string;
              hmacKey?: string;
              host?: string;
              scheme?: TScheme;
              version?: string;
          };
          triggers?: {
              exportContent?: "QUIET_PERIOD"
              | "POINTER_UP"
              | "DEMAND";
              exportContentDelay?: number;
              resizeTriggerDelay?: number;
          };
          "undo-redo"?: { maxStackSize?: number };
      },
  ): InkEditorConfiguration

• Parameters

  • Optionalconfiguration: {
        grabber?: {
            delayLongTouch?: number;
            listenerOptions?: { capture?: boolean; passive?: boolean };
            timestampFloatPrecision?: number;
            xyFloatPrecision?: number;
        };
        logger?: {
            CONVERTER?: LoggerLevel;
            EDITOR?: LoggerLevel;
            EDITOR_EVENT?: LoggerLevel;
            GESTURE?: LoggerLevel;
            GRABBER?: LoggerLevel;
            HISTORY?: LoggerLevel;
            MENU?: LoggerLevel;
            MODEL?: LoggerLevel;
            RECOGNIZER?: LoggerLevel;
            RENDERER?: LoggerLevel;
            SELECTION?: LoggerLevel;
            SMARTGUIDE?: LoggerLevel;
            STYLE?: LoggerLevel;
            SVGDEBUG?: LoggerLevel;
            SYMBOL?: LoggerLevel;
            TRANSFORMER?: LoggerLevel;
            WRITE?: LoggerLevel;
        };
        penStyle?: {
            color?: string;
            fill?: string;
            opacity?: number;
            width?: number;
            [key: string]: undefined
            | string
            | number;
        };
        recognition?: {
            convert?: { force?: { "on-stylesheet-change"?: boolean } };
            export?: {
                image?: {
                    guides?: boolean;
                    viewport?: {
                        height?: (...) | (...);
                        width?: (...) | (...);
                        x?: (...) | (...);
                        y?: (...) | (...);
                    };
                };
                "image-resolution"?: number;
                jiix?: {
                    "bounding-box"?: boolean;
                    "full-stroke-ids"?: boolean;
                    ids?: boolean;
                    strokes?: boolean;
                    style?: boolean;
                    text?: {
                        chars?: (...)
                        | (...)
                        | (...);
                        lines?: (...) | (...) | (...);
                        words?: (...) | (...) | (...);
                    };
                };
                mathml?: { flavor?: { name?: (...)
                | (...) } };
            };
            lang?: string;
            math?: {
                customGrammar?: string;
                customGrammarContent?: string;
                customGrammarId?: string;
                eraser?: { "erase-precisely"?: boolean };
                margin?: { bottom?: number; left?: number; right?: number; top?: number };
                mimeTypes?: (
                    | undefined
                    | "application/vnd.myscript.jiix"
                    | "application/x-latex"
                    | "application/mathml+xml"
                )[];
                "recognition-timeout"?: number;
                "session-time"?: number;
                solver?: {
                    "angle-unit"?: TAngleUnit;
                    "decimal-separator"?: string;
                    enable?: boolean;
                    "fractional-part-digits"?: number;
                    options?: TSolverOptions;
                    "rounding-mode"?: TRoundingMode;
                };
                "undo-redo"?: { mode?: TUndoRedoMode };
            };
            "raw-content"?: {
                classification?: {
                    types?: ((...) | (...) | (...) | (...) | (...) | (...))[];
                };
                eraser?: { "erase-precisely"?: boolean };
                recognition?: { types?: ((...) | (...) | (...) | (...) | (...))[] };
                "session-time"?: number;
                text?: {
                    addLKText?: boolean;
                    customLexicon?: ((...) | (...))[];
                    customResources?: ((...) | (...))[];
                };
            };
            shape?: {
                beautification?: { enable?: true };
                convert?: { "match-text-size"?: boolean; types?: ((...) | (...))[] };
                "enable-sub-blocks"?: boolean;
                eraser?: { "erase-precisely"?: boolean };
                mimeTypes?: (
                    | undefined
                    | "application/vnd.myscript.jiix"
                    | "application/vnd.openxmlformats-officedocument.presentationml.presentation"
                    | "image/svg+xml"
                )[];
                "session-time"?: number;
            };
            text?: {
                configuration?: {
                    addLKText?: boolean;
                    customLexicon?: ((...) | (...))[];
                    customResources?: ((...) | (...))[];
                };
                eraser?: { "erase-precisely"?: boolean };
                guides?: {
                    enable?: boolean;
                    "line-gap-mm"?: number;
                    "origin-y-mm"?: number;
                };
                margin?: { bottom?: number; left?: number; right?: number; top?: number };
                mimeTypes?: (undefined | "text/plain" | "application/vnd.myscript.jiix")[];
                text?: boolean;
            };
            type?: TRecognitionType;
        };
        renderer?: {
            guides?: { enable?: boolean; gap?: number };
            minHeight?: number;
            minWidth?: number;
        };
        server?: {
            applicationKey?: string;
            hmacKey?: string;
            host?: string;
            scheme?: TScheme;
            version?: string;
        };
        triggers?: {
            exportContent?: "QUIET_PERIOD"
            | "POINTER_UP"
            | "DEMAND";
            exportContentDelay?: number;
            resizeTriggerDelay?: number;
        };
        "undo-redo"?: { maxStackSize?: number };
    }

  Returns InkEditorConfiguration

grabber

logger

penStyle

recognition

renderer

server

triggers

undo-redo