iink-ts - v3.2.1
    Preparing search index...

    Class IIRecognizedText

    Hierarchy (View Summary)

    Index

    Accessors

    • get bounds(): Box

      Returns Box

    • get edges(): TSegment[]

      Returns TSegment[]

    • get snapPoints(): TPoint[]

      Returns TPoint[]

    • get vertices(): TPoint[]

      Returns TPoint[]

    Constructors

    • Parameters

      • strokes: IIStroke[]
      • lines: { baseline: number; xHeight: number }
      • Optionalstyle: {
            color?: string;
            fill?: string;
            opacity?: number;
            width?: number;
            [key: string]: string | number | undefined;
        }

      Returns IIRecognizedText

    Methods

    • Parameters

      • strokeId: string

      Returns boolean

    • Parameters

      • partial: {
            baseline?: number;
            bounds?: {
                center?: { x?: number; y?: number };
                contains?: {};
                containsPoint?: {};
                corners?: ({ x?: number; y?: number } | undefined)[];
                height?: number;
                isContained?: {};
                overlaps?: {};
                side?: ({ x?: number; y?: number } | undefined)[];
                snapPoints?: ({ x?: number; y?: number } | undefined)[];
                width?: number;
                x?: number;
                xMax?: number;
                xMid?: number;
                xMin?: number;
                y?: number;
                yMax?: number;
                yMid?: number;
                yMin?: number;
            };
            clone?: {};
            containsStroke?: {};
            creationTime?: number;
            decorators?: (
                | {
                    clone?: {};
                    id?: string;
                    kind?: DecoratorKind;
                    style?: {
                        color?: string;
                        fill?: string;
                        opacity?: number;
                        width?: number;
                        [key: string]: string
                        | number
                        | undefined;
                    };
                }
                | undefined
            )[];
            deleting?: boolean;
            edges?: (
                | { p1?: { x?: number; y?: number }; p2?: { x?: number; y?: number } }
                | undefined
            )[];
            id?: string;
            isClosed?: false;
            isIntersected?: {};
            kind?: Text;
            label?: string;
            modificationDate?: number;
            overlaps?: {};
            removeStrokes?: {};
            selected?: boolean;
            snapPoints?: ({ x?: number; y?: number } | undefined)[];
            strokes?: (
                | {
                    addPointer?: {};
                    bounds?: {
                        center?: { x?: number; y?: number };
                        contains?: {};
                        containsPoint?: {};
                        corners?: ({ x?: ...; y?: ... } | undefined)[];
                        height?: number;
                        isContained?: {};
                        overlaps?: {};
                        side?: ({ x?: ...; y?: ... } | undefined)[];
                        snapPoints?: ({ x?: ...; y?: ... } | undefined)[];
                        width?: number;
                        x?: number;
                        xMax?: number;
                        xMid?: number;
                        xMin?: number;
                        y?: number;
                        yMax?: number;
                        yMid?: number;
                        yMin?: number;
                    };
                    clone?: {};
                    creationTime?: number;
                    decorators?: (
                        | {
                            clone?: {};
                            id?: string;
                            kind?: DecoratorKind;
                            style?: {
                                color?: ...;
                                fill?: ...;
                                opacity?: ...;
                                width?: ...;
                                [key: ...]: ...;
                            };
                        }
                        | undefined
                    )[];
                    deleting?: boolean;
                    edges?: (
                        { p1?: { x?: ...; y?: ... }; p2?: { x?: ...; y?: ... } }
                        | undefined
                    )[];
                    formatToSend?: {};
                    id?: string;
                    isClosed?: false;
                    isIntersected?: {};
                    length?: number;
                    modificationDate?: number;
                    overlaps?: {};
                    pointers?: (
                        { p?: number; t?: number; x?: number; y?: number }
                        | undefined
                    )[];
                    pointerType?: string;
                    selected?: boolean;
                    snapPoints?: ({ x?: number; y?: number } | undefined)[];
                    style?: {
                        color?: string;
                        fill?: string;
                        opacity?: number;
                        width?: number;
                        [key: string]: string | number | undefined;
                    };
                    toJSON?: {};
                    transform?: {
                        applyToPoint?: {};
                        clone?: {};
                        invert?: {};
                        multiply?: {};
                        rotate?: {};
                        scale?: {};
                        toCssString?: {};
                        translate?: {};
                        tx?: number;
                        ty?: number;
                        xx?: number;
                        xy?: number;
                        yx?: number;
                        yy?: number;
                    };
                    type?: Stroke;
                    vertices?: ({ x?: number; y?: number } | undefined)[];
                }
                | undefined
            )[];
            style?: {
                color?: string;
                fill?: string;
                opacity?: number;
                width?: number;
                [key: string]: string
                | number
                | undefined;
            };
            toJSON?: {};
            transform?: {
                applyToPoint?: {};
                clone?: {};
                invert?: {};
                multiply?: {};
                rotate?: {};
                scale?: {};
                toCssString?: {};
                translate?: {};
                tx?: number;
                ty?: number;
                xx?: number;
                xy?: number;
                yx?: number;
                yy?: number;
            };
            type?: Recognized;
            updateChildrenStyle?: {};
            vertices?: ({ x?: number; y?: number } | undefined)[];
            xHeight?: number;
        }

      Returns IIRecognizedText

    • Returns {
          baseline?: number;
          bounds?: {
              center?: { x?: number; y?: number };
              contains?: {};
              containsPoint?: {};
              corners?: ({ x?: number; y?: number } | undefined)[];
              height?: number;
              isContained?: {};
              overlaps?: {};
              side?: ({ x?: number; y?: number } | undefined)[];
              snapPoints?: ({ x?: number; y?: number } | undefined)[];
              width?: number;
              x?: number;
              xMax?: number;
              xMid?: number;
              xMin?: number;
              y?: number;
              yMax?: number;
              yMid?: number;
              yMin?: number;
          };
          clone?: {};
          containsStroke?: {};
          creationTime?: number;
          decorators?: (
              | {
                  clone?: {};
                  id?: string;
                  kind?: DecoratorKind;
                  style?: {
                      color?: string;
                      fill?: string;
                      opacity?: number;
                      width?: number;
                      [key: string]: string
                      | number
                      | undefined;
                  };
              }
              | undefined
          )[];
          deleting?: boolean;
          edges?: (
              | { p1?: { x?: number; y?: number }; p2?: { x?: number; y?: number } }
              | undefined
          )[];
          id?: string;
          isClosed?: false;
          isIntersected?: {};
          kind?: Text;
          label?: string;
          modificationDate?: number;
          overlaps?: {};
          removeStrokes?: {};
          selected?: boolean;
          snapPoints?: ({ x?: number; y?: number } | undefined)[];
          strokes?: (
              | {
                  addPointer?: {};
                  bounds?: {
                      center?: { x?: number; y?: number };
                      contains?: {};
                      containsPoint?: {};
                      corners?: ({ x?: ...; y?: ... } | undefined)[];
                      height?: number;
                      isContained?: {};
                      overlaps?: {};
                      side?: ({ x?: ...; y?: ... } | undefined)[];
                      snapPoints?: ({ x?: ...; y?: ... } | undefined)[];
                      width?: number;
                      x?: number;
                      xMax?: number;
                      xMid?: number;
                      xMin?: number;
                      y?: number;
                      yMax?: number;
                      yMid?: number;
                      yMin?: number;
                  };
                  clone?: {};
                  creationTime?: number;
                  decorators?: (
                      | {
                          clone?: {};
                          id?: string;
                          kind?: DecoratorKind;
                          style?: {
                              color?: ...;
                              fill?: ...;
                              opacity?: ...;
                              width?: ...;
                              [key: ...]: ...;
                          };
                      }
                      | undefined
                  )[];
                  deleting?: boolean;
                  edges?: (
                      { p1?: { x?: ...; y?: ... }; p2?: { x?: ...; y?: ... } }
                      | undefined
                  )[];
                  formatToSend?: {};
                  id?: string;
                  isClosed?: false;
                  isIntersected?: {};
                  length?: number;
                  modificationDate?: number;
                  overlaps?: {};
                  pointers?: (
                      { p?: number; t?: number; x?: number; y?: number }
                      | undefined
                  )[];
                  pointerType?: string;
                  selected?: boolean;
                  snapPoints?: ({ x?: number; y?: number } | undefined)[];
                  style?: {
                      color?: string;
                      fill?: string;
                      opacity?: number;
                      width?: number;
                      [key: string]: string | number | undefined;
                  };
                  toJSON?: {};
                  transform?: {
                      applyToPoint?: {};
                      clone?: {};
                      invert?: {};
                      multiply?: {};
                      rotate?: {};
                      scale?: {};
                      toCssString?: {};
                      translate?: {};
                      tx?: number;
                      ty?: number;
                      xx?: number;
                      xy?: number;
                      yx?: number;
                      yy?: number;
                  };
                  type?: Stroke;
                  vertices?: ({ x?: number; y?: number } | undefined)[];
              }
              | undefined
          )[];
          style?: {
              color?: string;
              fill?: string;
              opacity?: number;
              width?: number;
              [key: string]: string
              | number
              | undefined;
          };
          toJSON?: {};
          transform?: {
              applyToPoint?: {};
              clone?: {};
              invert?: {};
              multiply?: {};
              rotate?: {};
              scale?: {};
              toCssString?: {};
              translate?: {};
              tx?: number;
              ty?: number;
              xx?: number;
              xy?: number;
              yx?: number;
              yy?: number;
          };
          type?: Recognized;
          updateChildrenStyle?: {};
          vertices?: ({ x?: number; y?: number } | undefined)[];
          xHeight?: number;
      }

    Properties

    baseline: number
    creationTime: number
    decorators: IIDecorator[]
    deleting: boolean
    id: string
    isClosed: false
    kind: Text
    label?: string
    modificationDate: number
    selected: boolean
    strokes: IIStroke[]
    style: TStyle
    transform: MatrixTransform
    xHeight: number