Skip to content

Latest commit

 

History

History
88 lines (75 loc) · 1.42 KB

README.md

File metadata and controls

88 lines (75 loc) · 1.42 KB
Raw

@nativescript/mlkit-text-recognition

A plugin used with @nativescript/mlkit-core to enable Text Recognition in your app and provide TextResult type for the text recognition event data.

Contents

Installation

npm install @nativescript/mlkit-text-recognition

Use @nativescript/mlkit-text-recognition

For an example, read Use @nativescript/mlkit-core and Text Recognition.

API

TextResult

The Text Recognition event data type.

interface TextResult {
    text?: string
    bounds: Bounds
    lines: TextLine[]
    points: Point[]
}

Point

interface Point {
    x: number;
    y: number;
}

Bounds

interface Bounds {
    origin: Origin;
    size: Size;
}

Origin

interface Origin {
    x: number;
    y: number;
}

Size

interface Size {
    width: number;
    height: number;
}

TextLine

interface TextLine {
    text?: string
    bounds: Bounds
    elements: TextElement[]
    points?: Point[]
}

TextElement

interface TextElement {
    text?: string
    bounds: Bounds
}

License

Apache License Version 2.0