Skip to content

Commit 3bf8089

Browse files
committed
chore(mlkit-object-detection): README update
1 parent 10fea40 commit 3bf8089

File tree

1 file changed

+48
-1
lines changed

1 file changed

+48
-1
lines changed
Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,59 @@
11
# @nativescript/mlkit-object-detection
22

3-
```javascript
3+
## Installation
4+
5+
```cli
46
npm install @nativescript/mlkit-object-detection
57
```
68

79
## Usage
810

911
See [@nativescript/mlkit-core](/packages/mlkit-core/README.md) Usage
12+
13+
## API
14+
15+
### ObjectResult
16+
```ts
17+
interface ObjectResult {
18+
trackingId?: number
19+
bounds: Bounds
20+
labels: ObjectLabeling[]
21+
}
22+
```
23+
#### ObjectLabeling
24+
25+
```ts
26+
interface ObjectLabeling {
27+
text?: string
28+
confidence?: number
29+
index?: number
30+
}
31+
```
32+
#### Bounds
33+
34+
```ts
35+
interface Bounds {
36+
origin: Origin;
37+
size: Size;
38+
}
39+
```
40+
#### Origin
41+
42+
```ts
43+
export interface Origin {
44+
x: number;
45+
y: number;
46+
}
47+
```
48+
#### Size
49+
50+
```ts
51+
interface Size {
52+
width: number;
53+
height: number;
54+
}
55+
```
56+
1057
## License
1158

1259
Apache License Version 2.0

0 commit comments

Comments
 (0)