Class HTTPClientV1

constructor

• new HTTPClientV1(
      config: {
          recognition?: {
              convert?: { force?: { "on-stylesheet-change"?: boolean } };
              diagram?: {
                  convert?: {
                      "match-text-size"?: boolean;
                      types?: ("text" | "shape" | undefined)[];
                  };
                  "enable-sub-blocks"?: boolean;
                  eraser?: { "erase-precisely"?: boolean };
                  mimeTypes?: (
                      | "application/vnd.myscript.jiix"
                      | "image/svg+xml"
                      | "application/vnd.openxmlformats-officedocument.presentationml.presentation"
                      | undefined
                  )[];
                  "session-time"?: number;
                  text?: {
                      addLKText?: boolean;
                      customLexicon?: (string | undefined)[];
                      customResources?: (string | undefined)[];
                  };
              };
              export?: {
                  image?: {
                      guides?: boolean;
                      viewport?: { height?: number; width?: number; x?: number; y?: number };
                  };
                  "image-resolution"?: number;
                  jiix?: {
                      "bounding-box"?: boolean;
                      "full-stroke-ids"?: boolean;
                      ids?: boolean;
                      strokes?: boolean;
                      style?: boolean;
                      text?: { chars?: boolean; lines?: boolean; words?: boolean };
                  };
                  mathml?: { flavor?: { name?: string } };
              };
              lang?: string;
              math?: {
                  customGrammar?: string;
                  customGrammarContent?: string;
                  customGrammarId?: string;
                  eraser?: { "erase-precisely"?: boolean };
                  margin?: {
                      bottom?: number;
                      left?: number;
                      right?: number;
                      top?: number;
                  };
                  mimeTypes?: (
                      | "application/vnd.myscript.jiix"
                      | "application/x-latex"
                      | "application/mathml+xml"
                      | undefined
                  )[];
                  "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?: (
                          "text"
                          | "shape"
                          | "math"
                          | "decoration"
                          | "drawing"
                          | undefined
                      )[];
                  };
                  eraser?: { "erase-precisely"?: boolean };
                  recognition?: {
                      types?: ("text" | "shape" | "math" | "decoration" | undefined)[];
                  };
                  "session-time"?: number;
                  text?: {
                      addLKText?: boolean;
                      customLexicon?: (string | undefined)[];
                      customResources?: (string | undefined)[];
                  };
              };
              renderer?: {
                  debug?: { "draw-image-boxes"?: boolean; "draw-text-boxes"?: boolean };
              };
              text?: {
                  configuration?: {
                      addLKText?: boolean;
                      customLexicon?: (string | undefined)[];
                      customResources?: (string | undefined)[];
                  };
                  eraser?: { "erase-precisely"?: boolean };
                  guides?: { enable?: boolean };
                  margin?: {
                      bottom?: number;
                      left?: number;
                      right?: number;
                      top?: number;
                  };
                  mimeTypes?: ("application/vnd.myscript.jiix" | "text/plain" | undefined)[];
                  text?: boolean;
              };
              type?: TRecognitionTypeV1;
          };
          server?: {
              applicationKey?: string;
              hmacKey?: string
              | {};
              host?: string;
              scheme?: TScheme;
              version?: string;
          };
      },
  ): HTTPClientV1

  Parameters

  • config: {
        recognition?: {
            convert?: { force?: { "on-stylesheet-change"?: boolean } };
            diagram?: {
                convert?: {
                    "match-text-size"?: boolean;
                    types?: ("text" | "shape" | undefined)[];
                };
                "enable-sub-blocks"?: boolean;
                eraser?: { "erase-precisely"?: boolean };
                mimeTypes?: (
                    | "application/vnd.myscript.jiix"
                    | "image/svg+xml"
                    | "application/vnd.openxmlformats-officedocument.presentationml.presentation"
                    | undefined
                )[];
                "session-time"?: number;
                text?: {
                    addLKText?: boolean;
                    customLexicon?: (string | undefined)[];
                    customResources?: (string | undefined)[];
                };
            };
            export?: {
                image?: {
                    guides?: boolean;
                    viewport?: { height?: number; width?: number; x?: number; y?: number };
                };
                "image-resolution"?: number;
                jiix?: {
                    "bounding-box"?: boolean;
                    "full-stroke-ids"?: boolean;
                    ids?: boolean;
                    strokes?: boolean;
                    style?: boolean;
                    text?: { chars?: boolean; lines?: boolean; words?: boolean };
                };
                mathml?: { flavor?: { name?: string } };
            };
            lang?: string;
            math?: {
                customGrammar?: string;
                customGrammarContent?: string;
                customGrammarId?: string;
                eraser?: { "erase-precisely"?: boolean };
                margin?: { bottom?: number; left?: number; right?: number; top?: number };
                mimeTypes?: (
                    | "application/vnd.myscript.jiix"
                    | "application/x-latex"
                    | "application/mathml+xml"
                    | undefined
                )[];
                "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?: (
                        "text"
                        | "shape"
                        | "math"
                        | "decoration"
                        | "drawing"
                        | undefined
                    )[];
                };
                eraser?: { "erase-precisely"?: boolean };
                recognition?: {
                    types?: ("text" | "shape" | "math" | "decoration" | undefined)[];
                };
                "session-time"?: number;
                text?: {
                    addLKText?: boolean;
                    customLexicon?: (string | undefined)[];
                    customResources?: (string | undefined)[];
                };
            };
            renderer?: {
                debug?: { "draw-image-boxes"?: boolean; "draw-text-boxes"?: boolean };
            };
            text?: {
                configuration?: {
                    addLKText?: boolean;
                    customLexicon?: (string | undefined)[];
                    customResources?: (string | undefined)[];
                };
                eraser?: { "erase-precisely"?: boolean };
                guides?: { enable?: boolean };
                margin?: { bottom?: number; left?: number; right?: number; top?: number };
                mimeTypes?: ("application/vnd.myscript.jiix" | "text/plain" | undefined)[];
                text?: boolean;
            };
            type?: TRecognitionTypeV1;
        };
        server?: {
            applicationKey?: string;
            hmacKey?: string
            | {};
            host?: string;
            scheme?: TScheme;
            version?: string;
        };
    }

  Returns HTTPClientV1

configuration

postConfig

• get postConfig(): THTTPClientV1PostConfiguration

  Returns THTTPClientV1PostConfiguration

url

• get url(): string

  Returns string

convert

• convert(
      model: Model,
      conversionState?: TConverstionState,
      requestedMimeTypes?: string[],
  ): Promise<Model>

  Parameters

  • model: Model
  • OptionalconversionState: TConverstionState
  • OptionalrequestedMimeTypes: string[]

  Returns Promise<Model>

export

• export(model: Model, requestedMimeTypes?: string[]): Promise<Model>

  Parameters

  • model: Model
  • OptionalrequestedMimeTypes: string[]

  Returns Promise<Model>

resize

• resize(model: Model): Promise<Model>

  Parameters

  • model: Model

  Returns Promise<Model>