Class IIRecognizedText

Hierarchy (View Summary)

Accessors

bounds edges snapPoints vertices

Constructors

constructor

Methods

clone containsStroke create isIntersected overlaps removeStrokes toJSON updateChildrenStyle

Properties

baseline creationTime decorators deleting id isClosed kind label? modificationDate selected strokes style transform type xHeight

Accessors

bounds

  • get bounds(): Box

  • Returns Box

edges

  • get edges(): TSegment[]

  • Returns TSegment[]

snapPoints

  • get snapPoints(): TPoint[]

  • Returns TPoint[]

vertices

  • get vertices(): TPoint[]

  • Returns TPoint[]

Constructors

constructor

  • new IIRecognizedText(
        strokes: IIStroke[],
        lines: { baseline: number; xHeight: number },
        style?: {
            color?: string;
            fill?: string;
            opacity?: number;
            width?: number;
            [key: string]: undefined | string | number;
        },
    ): IIRecognizedText

  • Parameters

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

    Returns IIRecognizedText

Methods

clone

containsStroke

  • containsStroke(strokeId: string): boolean

  • Parameters

    • strokeId: string

    Returns boolean

Staticcreate

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

  • Parameters

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

    Returns IIRecognizedText

isIntersected

overlaps

removeStrokes

toJSON

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

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

updateChildrenStyle

Properties

baseline

baseline: number

creationTime

creationTime: number

decorators

decorators: IIDecorator[]

deleting

deleting: boolean

id

id: string

ReadonlyisClosed

isClosed: false

Readonlykind

kind: Text

Optionallabel

label?: string

modificationDate

modificationDate: number

selected

selected: boolean

strokes

strokes: IIStroke[]

style

style: TStyle

transform

transform: MatrixTransform

Readonlytype

type: Recognized

xHeight

xHeight: number

Settings

Member Visibility

On This Page

Accessors
Constructors
Methods
Properties