Skip to content
This repository was archived by the owner on Jan 4, 2021. It is now read-only.

Commit a82e53b

Browse files
yohann streibelyohann streibel
yohann streibel
authored and
yohann streibel
committed
[DEV] update documentation
1 parent d7cb9e4 commit a82e53b

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

‎myscript-text-web.html

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@
9696
/**
9797
* <b>not mutable</b><br />
9898
* The current recognition protocol (WebSocket or REST). We strongly recommend using WebSocket.
99+
* @type String
99100
* @default 'WebSocket'
100101
*/
101102
protocol: {
@@ -105,6 +106,8 @@
105106
/**
106107
* <b>not mutable</b><br />
107108
* The current recognition service host.
109+
* @type String
110+
* @default 'cloud.myscript.com'
108111
*/
109112
host: {
110113
type: String,
@@ -113,6 +116,8 @@
113116
/**
114117
* <b>not mutable</b><br />
115118
* The recognition timeout, only use in REST mode.
119+
* @type Number
120+
* @default 2000
116121
*/
117122
timeout: {
118123
type: Number,
@@ -123,6 +128,7 @@
123128
* Application key to use for recognition on MyScript handwriting recognition server.<br />
124129
* You have to create your own MyScript Developer account at http://dev.myscript.com and then generate your application key at http://cloud.myscript.com. See the Developer Guide to learn how to register.<br /><br />
125130
* <b>Warning</b>: This parameter is <b>mandatory</b> and its value should be a string.
131+
* @type String
126132
*/
127133
applicationkey: {
128134
type: String
@@ -132,13 +138,16 @@
132138
* HMAC key to use for recognition on MyScript handwriting recognition server.<br />
133139
* You have to create your own HMAC key corresponding to your own application key in your account at http://cloud.myscript.com.<br /><br />
134140
* <b>Warning</b>: This parameter may be <b>mandatory</b> if HMAC signature security is enabled for your application. The value should be a string.
141+
* @type String
135142
*/
136143
hmackey: {
137144
type: String
138145
},
139146
/**
140147
* True if undo is available
141148
* @private
149+
* @type Boolean
150+
* @default false
142151
*/
143152
canundo: {
144153
type: Boolean,
@@ -148,6 +157,8 @@
148157
/**
149158
* True if redo is available
150159
* @private
160+
* @type Boolean
161+
* @default false
151162
*/
152163
canredo: {
153164
type: Boolean,
@@ -157,6 +168,7 @@
157168
/**
158169
* True if there is something to clear
159170
* @private
171+
* @type Boolean
160172
* @default false
161173
*/
162174
canclear: {
@@ -167,6 +179,8 @@
167179
/**
168180
* <b>not mutable</b><br />
169181
* If set to true, hide the buttons (Trash, Undo, Redo).
182+
* @type Boolean
183+
* @default false
170184
*/
171185
hidebuttons: {
172186
type: Boolean,
@@ -175,6 +189,8 @@
175189
/**
176190
* <b>not mutable</b><br />
177191
* If set to true, hide the result div tag.
192+
* @type Boolean
193+
* @default false
178194
*/
179195
hideresult: {
180196
type: Boolean,
@@ -183,6 +199,8 @@
183199
},
184200
/**
185201
* The recognition language used by the recognition process.
202+
* @type String
203+
* @default 'en_US'
186204
*/
187205
language: {
188206
type: String,
@@ -192,6 +210,7 @@
192210
/**
193211
* The available recognition languages as configured for your application on MyScript Cloud or Server.
194212
* @type {Array<String>}
213+
* @default ['en_US']
195214
*/
196215
availablelanguages: {
197216
type: Array,
@@ -201,13 +220,17 @@
201220
},
202221
/**
203222
* The result detail to use (TEXT, WORD or CHARACTER).
223+
* @type String
224+
* @default TEXT
204225
*/
205226
resultdetail: {
206227
type: String,
207228
value: MyScript.ResultDetail.TEXT
208229
},
209230
/**
210231
* The input mode to use (CURSIVE, ISOLATED, SUPERIMPOSED or VERTICAL).
232+
* @type String
233+
* @default CURSIVE
211234
*/
212235
inputmode: {
213236
type: String,
@@ -216,20 +239,26 @@
216239
},
217240
/**
218241
* The desired count of recognition candidates.
242+
* @type Number
243+
* @default 1
219244
*/
220245
recognitioncandidates: {
221246
type: Number,
222247
value: 1
223248
},
224249
/**
225250
* The desired count of prediction candidates.
251+
* @type Number
252+
* @default 0
226253
*/
227254
predictioncandidates: {
228255
type: Number,
229256
value: 0
230257
},
231258
/**
232259
* The desired count of completion candidates.
260+
* @type Number
261+
* @default 0
233262
*/
234263
completioncandidates: {
235264
type: Number,
@@ -238,6 +267,7 @@
238267
/**
239268
* The content types to use for the recognition.
240269
* @type {Array<String>}
270+
* @default []
241271
*/
242272
contenttypes: {
243273
type: Array,
@@ -246,6 +276,7 @@
246276
/**
247277
* The user resources to use for the recognition.
248278
* @type {Array<String>}
279+
* @default []
249280
*/
250281
userresources: {
251282
type: Array,
@@ -269,6 +300,7 @@
269300
/**
270301
* The text recognition result document.
271302
* @private
303+
* @type {{tagItems: Array, wordCandidates: Array, charCandidates: Array}}
272304
* @default {}
273305
*/
274306
textdocument: {
@@ -309,6 +341,8 @@
309341
/**
310342
* True if SSL is activated, false otherwise
311343
* @private
344+
* @type Boolean
345+
* @default true
312346
*/
313347
ssl: {
314348
type: Boolean,
@@ -327,10 +361,18 @@
327361
},
328362
/**
329363
* Clear the current document.
364+
* @deprecated Use clear instead of delete
365+
* @private
330366
*/
331367
delete: function () {
332368
this._clear();
333369
},
370+
/**
371+
* Clear the current document.
372+
*/
373+
clear: function () {
374+
this._clear();
375+
},
334376
/**
335377
* Undo the last action.
336378
*/
@@ -361,6 +403,12 @@
361403
_onChanged: function (e) {
362404
this.fire(e.type, e.detail);
363405
},
406+
/**
407+
* Recognition success listener.
408+
*
409+
* @private
410+
* @method _onSuccess
411+
*/
364412
_onSuccess: function (e) {
365413
if (e.detail && e.detail.getDocument) {
366414
this.textdocument = e.detail.getDocument();

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy