Class RecognizerHTTPV1Configuration

Source

export class RecognizerHTTPV1Configuration implements TRecognizerHTTPV1Configuration {
  recognition: TRecognitionHTTPV1Configuration
  server: TServerHTTPConfiguration

  constructor(configuration?: PartialDeep<TRecognizerHTTPV1Configuration>)
  {
    this.server = mergeDeep({}, DefaultRecognizerHTTPV1Configuration.server, configuration?.server)
    this.recognition = mergeDeep({}, DefaultRecognizerHTTPV1Configuration.recognition, configuration?.recognition)

    if (configuration?.recognition?.text?.mimeTypes) {
      this.recognition.text.mimeTypes = configuration.recognition.text.mimeTypes as ("text/plain" | "application/vnd.myscript.jiix")[]
    }
    this.recognition.text.mimeTypes = [...new Set(this.recognition.text.mimeTypes)]

    if (configuration?.recognition?.math?.mimeTypes) {
      this.recognition.math.mimeTypes = configuration.recognition.math.mimeTypes as ("application/vnd.myscript.jiix" | "application/x-latex" | "application/mathml+xml")[]
    }
    this.recognition.math.mimeTypes = [...new Set(this.recognition.math.mimeTypes)]

    if (configuration?.recognition?.diagram?.mimeTypes) {
      this.recognition.diagram.mimeTypes = configuration.recognition.diagram.mimeTypes as ("application/vnd.myscript.jiix" | "application/vnd.openxmlformats-officedocument.presentationml.presentation" | "image/svg+xml")[]
    }
    this.recognition.diagram.mimeTypes = [...new Set(this.recognition.diagram.mimeTypes)]

    if (configuration?.recognition?.diagram?.convert?.types) {
      this.recognition.diagram.convert!.types = configuration.recognition.diagram.convert.types as ("text" | "shape")[]
    }

    if (configuration?.recognition?.["raw-content"]?.recognition?.types) {
      this.recognition["raw-content"].recognition!.types = configuration?.recognition?.["raw-content"]?.recognition?.types as ("text" | "shape")[]
    }
    this.recognition["raw-content"].recognition.types = [...new Set(this.recognition["raw-content"].recognition.types.filter((type) => type !== "decoration"))]

    if (configuration?.recognition?.["raw-content"]?.classification?.types) {
      this.recognition["raw-content"].classification!.types = configuration?.recognition?.["raw-content"]?.classification?.types as ("text" | "shape")[]
    }

    if (this.server.version) {
      if (!isVersionSuperiorOrEqual(this.server.version, "2.3.0")) {
        delete this.recognition.convert
      }
      if (!isVersionSuperiorOrEqual(this.server.version, "3.2.0")) {
        delete this.recognition.export.jiix.text.lines
      }
    }
  }
}

Implements

Constructors

constructor

Properties

recognition server

Constructors

constructor

  • new RecognizerHTTPV1Configuration(
        configuration?: {
            recognition?: {
                convert?: { force?: { "on-stylesheet-change"?: boolean } };
                diagram?: {
                    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?: {
                        addLKText?: boolean;
                        customLexicon?: ((...) | (...))[];
                        customResources?: ((...) | (...))[];
                    };
                };
                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?: ((...) | (...))[];
                    };
                };
                renderer?: {
                    debug?: { "draw-image-boxes"?: boolean; "draw-text-boxes"?: boolean };
                };
                text?: {
                    configuration?: {
                        addLKText?: boolean;
                        customLexicon?: ((...) | (...))[];
                        customResources?: ((...) | (...))[];
                    };
                    eraser?: { "erase-precisely"?: boolean };
                    guides?: { enable?: boolean };
                    margin?: {
                        bottom?: number;
                        left?: number;
                        right?: number;
                        top?: number;
                    };
                    mimeTypes?: (undefined | "text/plain" | "application/vnd.myscript.jiix")[];
                    text?: boolean;
                };
                type?: TRecognitionType;
            };
            server?: {
                applicationKey?: string;
                hmacKey?: string;
                host?: string;
                scheme?: TScheme;
                version?: string;
            };
        },
    ): RecognizerHTTPV1Configuration

  • Parameters

    • Optionalconfiguration: {
          recognition?: {
              convert?: { force?: { "on-stylesheet-change"?: boolean } };
              diagram?: {
                  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?: {
                      addLKText?: boolean;
                      customLexicon?: ((...) | (...))[];
                      customResources?: ((...) | (...))[];
                  };
              };
              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?: ((...) | (...))[];
                  };
              };
              renderer?: {
                  debug?: { "draw-image-boxes"?: boolean; "draw-text-boxes"?: boolean };
              };
              text?: {
                  configuration?: {
                      addLKText?: boolean;
                      customLexicon?: ((...) | (...))[];
                      customResources?: ((...) | (...))[];
                  };
                  eraser?: { "erase-precisely"?: boolean };
                  guides?: { enable?: boolean };
                  margin?: { bottom?: number; left?: number; right?: number; top?: number };
                  mimeTypes?: (undefined | "text/plain" | "application/vnd.myscript.jiix")[];
                  text?: boolean;
              };
              type?: TRecognitionType;
          };
          server?: {
              applicationKey?: string;
              hmacKey?: string;
              host?: string;
              scheme?: TScheme;
              version?: string;
          };
      }

    Returns RecognizerHTTPV1Configuration

Properties

recognition

recognition: TRecognitionHTTPV1Configuration

server

server: TServerHTTPConfiguration

Settings

Member Visibility

On This Page

Constructors
Properties