-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocs.json
More file actions
515 lines (515 loc) · 27.6 KB
/
Copy pathdocs.json
File metadata and controls
515 lines (515 loc) · 27.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
{
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",
"name": "Supernote",
"colors": {
"primary": "#16A34A",
"light": "#07C983",
"dark": "#15803D"
},
"favicon": "/favicon.svg",
"banner": {
"content": "SDK docs version: v0.1.28",
"dismissible": false
},
"navigation": {
"languages": [
{
"language": "zh",
"default": true,
"banner": {
"content": "SDK 文档版本：v0.1.25",
"dismissible": false
},
"tabs": [
{
"tab": "Guides",
"groups": [
{
"group": "Getting started",
"pages": [
"zh/index",
"zh/principle"
]
},
{
"group": "开发指南",
"pages": [
"zh/environment",
"zh/first-plugin",
{
"group": "学习基础知识",
"pages": [
"zh/plugin-base/coordinate-system",
"zh/plugin-base/plugin-ui",
"zh/plugin-base/lasso",
{
"group": "笔记功能",
"pages": [
"zh/plugin-base/plugin-note/link",
"zh/plugin-base/plugin-note/title",
"zh/plugin-base/plugin-note/textbox"
]
},
{
"group": "文档功能",
"pages": [
"zh/plugin-base/plugin-doc/translations"
]
},
{
"group": "通用功能",
"pages": [
"zh/plugin-base/plugin-comm/geometry"
]
},
{
"group": "文件操作",
"pages": [
"zh/plugin-base/file-op/element-op"
]
}
]
}
]
}
]
},
{
"tab": "API reference",
"groups": [
{
"group": "Supernote Plugin SDK",
"pages": [
{
"group": "PluginCommAPI",
"expanded": false,
"pages": [
"zh/api-reference/supernote-plugin/plugin-comm-api/index",
"zh/api-reference/supernote-plugin/plugin-comm-api/create-trail",
"zh/api-reference/supernote-plugin/plugin-comm-api/recycle-trail",
"zh/api-reference/supernote-plugin/plugin-comm-api/clear-trail-cache",
"zh/api-reference/supernote-plugin/plugin-comm-api/save-sticker-by-lasso",
"zh/api-reference/supernote-plugin/plugin-comm-api/get-sticker-size",
"zh/api-reference/supernote-plugin/plugin-comm-api/generate-sticker-thumbnail",
"zh/api-reference/supernote-plugin/plugin-comm-api/convert-trail2-sticker",
"zh/api-reference/supernote-plugin/plugin-comm-api/insert-sticker",
"zh/api-reference/supernote-plugin/plugin-comm-api/set-lasso-box-state",
"zh/api-reference/supernote-plugin/plugin-comm-api/get-lasso-rect",
"zh/api-reference/supernote-plugin/plugin-comm-api/lasso-elements",
"zh/api-reference/supernote-plugin/plugin-comm-api/resize-lasso-rect",
"zh/api-reference/supernote-plugin/plugin-comm-api/get-lasso-data",
"zh/api-reference/supernote-plugin/plugin-comm-api/get-lasso-data-type-counts",
"zh/api-reference/supernote-plugin/plugin-comm-api/delete-lasso-data",
"zh/api-reference/supernote-plugin/plugin-comm-api/get-current-page-num",
"zh/api-reference/supernote-plugin/plugin-comm-api/get-current-file-path",
"zh/api-reference/supernote-plugin/plugin-comm-api/get-pen-info",
"zh/api-reference/supernote-plugin/plugin-comm-api/recognize-elements",
"zh/api-reference/supernote-plugin/plugin-comm-api/reload-file",
"zh/api-reference/supernote-plugin/plugin-comm-api/get-lasso-geometries",
"zh/api-reference/supernote-plugin/plugin-comm-api/insert-geometry",
"zh/api-reference/supernote-plugin/plugin-comm-api/modify-lasso-geometry",
"zh/api-reference/supernote-plugin/plugin-comm-api/get-note-system-templates",
"zh/api-reference/supernote-plugin/plugin-comm-api/insert-five-star"
]
},
{
"group": "PluginNoteAPI",
"expanded": false,
"pages": [
"zh/api-reference/supernote-plugin/plugin-note-api/index",
"zh/api-reference/supernote-plugin/plugin-note-api/get-lasso-link",
"zh/api-reference/supernote-plugin/plugin-note-api/set-lasso-stroke-link",
"zh/api-reference/supernote-plugin/plugin-note-api/insert-text-link",
"zh/api-reference/supernote-plugin/plugin-note-api/modify-lasso-link",
"zh/api-reference/supernote-plugin/plugin-note-api/save-current-note",
"zh/api-reference/supernote-plugin/plugin-note-api/set-lasso-title",
"zh/api-reference/supernote-plugin/plugin-note-api/get-lasso-title",
"zh/api-reference/supernote-plugin/plugin-note-api/modify-lasso-title",
"zh/api-reference/supernote-plugin/plugin-note-api/get-lasso-text",
"zh/api-reference/supernote-plugin/plugin-note-api/insert-text",
"zh/api-reference/supernote-plugin/plugin-note-api/modify-lasso-text",
"zh/api-reference/supernote-plugin/plugin-note-api/insert-image"
]
},
{
"group": "PluginDocAPI",
"expanded": false,
"pages": [
"zh/api-reference/supernote-plugin/plugin-doc-api/index",
"zh/api-reference/supernote-plugin/plugin-doc-api/get-selected-text",
"zh/api-reference/supernote-plugin/plugin-doc-api/get-current-doc-text",
"zh/api-reference/supernote-plugin/plugin-doc-api/get-current-total-pages"
]
},
{
"group": "PluginFileAPI",
"expanded": false,
"pages": [
"zh/api-reference/supernote-plugin/plugin-file-api/index",
"zh/api-reference/supernote-plugin/plugin-file-api/get-page-trails",
"zh/api-reference/supernote-plugin/plugin-file-api/replace-trails",
"zh/api-reference/supernote-plugin/plugin-file-api/insert-trails",
"zh/api-reference/supernote-plugin/plugin-file-api/modify-trails",
"zh/api-reference/supernote-plugin/plugin-file-api/delete-elements",
"zh/api-reference/supernote-plugin/plugin-file-api/get-titles",
"zh/api-reference/supernote-plugin/plugin-file-api/get-key-words",
"zh/api-reference/supernote-plugin/plugin-file-api/insert-key-word",
"zh/api-reference/supernote-plugin/plugin-file-api/delete-key-word",
"zh/api-reference/supernote-plugin/plugin-file-api/get-note-total-page-num",
"zh/api-reference/supernote-plugin/plugin-file-api/get-page-size",
"zh/api-reference/supernote-plugin/plugin-file-api/generate-note-png",
"zh/api-reference/supernote-plugin/plugin-file-api/search-five-stars",
"zh/api-reference/supernote-plugin/plugin-file-api/create-note",
"zh/api-reference/supernote-plugin/plugin-file-api/remove-note-page",
"zh/api-reference/supernote-plugin/plugin-file-api/insert-note-page",
"zh/api-reference/supernote-plugin/plugin-file-api/clear-page-layer-data",
"zh/api-reference/supernote-plugin/plugin-file-api/get-layers",
"zh/api-reference/supernote-plugin/plugin-file-api/modify-layers",
"zh/api-reference/supernote-plugin/plugin-file-api/insert-layer",
"zh/api-reference/supernote-plugin/plugin-file-api/delete-layers",
"zh/api-reference/supernote-plugin/plugin-file-api/sort-layers",
"zh/api-reference/supernote-plugin/plugin-file-api/get-mark-pages",
"zh/api-reference/supernote-plugin/plugin-file-api/generate-mark-thumbnails",
"zh/api-reference/supernote-plugin/plugin-file-api/clear-mark-trails",
"zh/api-reference/supernote-plugin/plugin-file-api/get-note-page-template",
"zh/api-reference/supernote-plugin/plugin-file-api/generate-note-template-png",
"zh/api-reference/supernote-plugin/plugin-file-api/get-note-type",
"zh/api-reference/supernote-plugin/plugin-file-api/get-file-machine-type",
"zh/api-reference/supernote-plugin/plugin-file-api/get-element-counts",
"zh/api-reference/supernote-plugin/plugin-file-api/get-element-num-list",
"zh/api-reference/supernote-plugin/plugin-file-api/get-element",
"zh/api-reference/supernote-plugin/plugin-file-api/get-last-element"
]
},
{
"group": "PluginManager",
"expanded": false,
"pages": [
"zh/api-reference/supernote-plugin/plugin-manager/index",
"zh/api-reference/supernote-plugin/plugin-manager/init",
"zh/api-reference/supernote-plugin/plugin-manager/register-lang-listener",
"zh/api-reference/supernote-plugin/plugin-manager/register-event-listener",
"zh/api-reference/supernote-plugin/plugin-manager/register-button",
"zh/api-reference/supernote-plugin/plugin-manager/unregister-button",
"zh/api-reference/supernote-plugin/plugin-manager/get-button-state",
"zh/api-reference/supernote-plugin/plugin-manager/set-button-state",
"zh/api-reference/supernote-plugin/plugin-manager/register-config-button",
"zh/api-reference/supernote-plugin/plugin-manager/get-plugin-dir-path",
"zh/api-reference/supernote-plugin/plugin-manager/get-plugin-name",
"zh/api-reference/supernote-plugin/plugin-manager/get-device-type",
"zh/api-reference/supernote-plugin/plugin-manager/close-plugin-view"
]
},
{
"group": "Utils",
"expanded": false,
"pages": [
"zh/api-reference/supernote-plugin/utils/point-utils/index",
"zh/api-reference/supernote-plugin/utils/point-utils/android-point2-emr",
"zh/api-reference/supernote-plugin/utils/point-utils/emr-point2-android"
]
},
{
"group": "类型",
"expanded": false,
"pages": [
"zh/api-reference/supernote-plugin/types/index",
"zh/api-reference/supernote-plugin/types/api-response",
"zh/api-reference/supernote-plugin/types/point",
"zh/api-reference/supernote-plugin/types/rect",
"zh/api-reference/supernote-plugin/types/size",
"zh/api-reference/supernote-plugin/types/trail-data-accessor",
"zh/api-reference/supernote-plugin/types/stroke",
"zh/api-reference/supernote-plugin/types/pen-info",
"zh/api-reference/supernote-plugin/types/recogn-data",
"zh/api-reference/supernote-plugin/types/recog-result-data",
"zh/api-reference/supernote-plugin/types/geometry",
"zh/api-reference/supernote-plugin/types/picture",
"zh/api-reference/supernote-plugin/types/template",
"zh/api-reference/supernote-plugin/types/key-word",
"zh/api-reference/supernote-plugin/types/layer",
"zh/api-reference/supernote-plugin/types/trail",
"zh/api-reference/supernote-plugin/types/text-link",
"zh/api-reference/supernote-plugin/types/link",
"zh/api-reference/supernote-plugin/types/lasso-link",
"zh/api-reference/supernote-plugin/types/title",
"zh/api-reference/supernote-plugin/types/text-box",
"zh/api-reference/supernote-plugin/types/button-listener",
"zh/api-reference/supernote-plugin/types/button-subscription"
]
}
]
}
]
}
]
},
{
"language": "en",
"banner": {
"content": "SDK docs version: v0.1.25",
"dismissible": false
},
"tabs": [
{
"tab": "Guides",
"groups": [
{
"group": "Getting started",
"pages": [
"en/index",
"en/principle"
]
},
{
"group": "Developer Guide",
"pages": [
"en/environment",
"en/first-plugin",
{
"group": "Basics",
"pages": [
"en/plugin-base/coordinate-system",
"en/plugin-base/plugin-ui",
"en/plugin-base/lasso",
{
"group": "Notes",
"pages": [
"en/plugin-base/plugin-note/link",
"en/plugin-base/plugin-note/title",
"en/plugin-base/plugin-note/textbox"
]
},
{
"group": "Documents",
"pages": [
"en/plugin-base/plugin-doc/translations"
]
},
{
"group": "Common",
"pages": [
"en/plugin-base/plugin-comm/geometry"
]
},
{
"group": "File Ops",
"pages": [
"en/plugin-base/file-op/element-op"
]
}
]
}
]
}
]
},
{
"tab": "API reference",
"groups": [
{
"group": "Supernote Plugin SDK",
"pages": [
{
"group": "PluginCommAPI",
"expanded": false,
"pages": [
"en/api-reference/supernote-plugin/plugin-comm-api/index",
"en/api-reference/supernote-plugin/plugin-comm-api/create-trail",
"en/api-reference/supernote-plugin/plugin-comm-api/recycle-trail",
"en/api-reference/supernote-plugin/plugin-comm-api/clear-trail-cache",
"en/api-reference/supernote-plugin/plugin-comm-api/save-sticker-by-lasso",
"en/api-reference/supernote-plugin/plugin-comm-api/get-sticker-size",
"en/api-reference/supernote-plugin/plugin-comm-api/generate-sticker-thumbnail",
"en/api-reference/supernote-plugin/plugin-comm-api/convert-trail2-sticker",
"en/api-reference/supernote-plugin/plugin-comm-api/insert-sticker",
"en/api-reference/supernote-plugin/plugin-comm-api/set-lasso-box-state",
"en/api-reference/supernote-plugin/plugin-comm-api/get-lasso-rect",
"en/api-reference/supernote-plugin/plugin-comm-api/lasso-elements",
"en/api-reference/supernote-plugin/plugin-comm-api/resize-lasso-rect",
"en/api-reference/supernote-plugin/plugin-comm-api/get-lasso-data",
"en/api-reference/supernote-plugin/plugin-comm-api/get-lasso-data-type-counts",
"en/api-reference/supernote-plugin/plugin-comm-api/delete-lasso-data",
"en/api-reference/supernote-plugin/plugin-comm-api/get-current-page-num",
"en/api-reference/supernote-plugin/plugin-comm-api/get-current-file-path",
"en/api-reference/supernote-plugin/plugin-comm-api/get-pen-info",
"en/api-reference/supernote-plugin/plugin-comm-api/recognize-elements",
"en/api-reference/supernote-plugin/plugin-comm-api/reload-file",
"en/api-reference/supernote-plugin/plugin-comm-api/get-lasso-geometries",
"en/api-reference/supernote-plugin/plugin-comm-api/insert-geometry",
"en/api-reference/supernote-plugin/plugin-comm-api/modify-lasso-geometry",
"en/api-reference/supernote-plugin/plugin-comm-api/get-note-system-templates",
"en/api-reference/supernote-plugin/plugin-comm-api/insert-five-star"
]
},
{
"group": "PluginNoteAPI",
"expanded": false,
"pages": [
"en/api-reference/supernote-plugin/plugin-note-api/index",
"en/api-reference/supernote-plugin/plugin-note-api/get-lasso-link",
"en/api-reference/supernote-plugin/plugin-note-api/set-lasso-stroke-link",
"en/api-reference/supernote-plugin/plugin-note-api/insert-text-link",
"en/api-reference/supernote-plugin/plugin-note-api/modify-lasso-link",
"en/api-reference/supernote-plugin/plugin-note-api/save-current-note",
"en/api-reference/supernote-plugin/plugin-note-api/set-lasso-title",
"en/api-reference/supernote-plugin/plugin-note-api/get-lasso-title",
"en/api-reference/supernote-plugin/plugin-note-api/modify-lasso-title",
"en/api-reference/supernote-plugin/plugin-note-api/get-lasso-text",
"en/api-reference/supernote-plugin/plugin-note-api/insert-text",
"en/api-reference/supernote-plugin/plugin-note-api/modify-lasso-text",
"en/api-reference/supernote-plugin/plugin-note-api/insert-image"
]
},
{
"group": "PluginDocAPI",
"expanded": false,
"pages": [
"en/api-reference/supernote-plugin/plugin-doc-api/index",
"en/api-reference/supernote-plugin/plugin-doc-api/get-selected-text",
"en/api-reference/supernote-plugin/plugin-doc-api/get-current-doc-text",
"en/api-reference/supernote-plugin/plugin-doc-api/get-current-total-pages"
]
},
{
"group": "PluginFileAPI",
"expanded": false,
"pages": [
"en/api-reference/supernote-plugin/plugin-file-api/index",
"en/api-reference/supernote-plugin/plugin-file-api/get-page-trails",
"en/api-reference/supernote-plugin/plugin-file-api/replace-trails",
"en/api-reference/supernote-plugin/plugin-file-api/insert-trails",
"en/api-reference/supernote-plugin/plugin-file-api/modify-trails",
"en/api-reference/supernote-plugin/plugin-file-api/delete-elements",
"en/api-reference/supernote-plugin/plugin-file-api/get-titles",
"en/api-reference/supernote-plugin/plugin-file-api/get-key-words",
"en/api-reference/supernote-plugin/plugin-file-api/insert-key-word",
"en/api-reference/supernote-plugin/plugin-file-api/delete-key-word",
"en/api-reference/supernote-plugin/plugin-file-api/get-note-total-page-num",
"en/api-reference/supernote-plugin/plugin-file-api/get-page-size",
"en/api-reference/supernote-plugin/plugin-file-api/generate-note-png",
"en/api-reference/supernote-plugin/plugin-file-api/search-five-stars",
"en/api-reference/supernote-plugin/plugin-file-api/create-note",
"en/api-reference/supernote-plugin/plugin-file-api/remove-note-page",
"en/api-reference/supernote-plugin/plugin-file-api/insert-note-page",
"en/api-reference/supernote-plugin/plugin-file-api/clear-page-layer-data",
"en/api-reference/supernote-plugin/plugin-file-api/get-layers",
"en/api-reference/supernote-plugin/plugin-file-api/modify-layers",
"en/api-reference/supernote-plugin/plugin-file-api/insert-layer",
"en/api-reference/supernote-plugin/plugin-file-api/delete-layers",
"en/api-reference/supernote-plugin/plugin-file-api/sort-layers",
"en/api-reference/supernote-plugin/plugin-file-api/get-mark-pages",
"en/api-reference/supernote-plugin/plugin-file-api/generate-mark-thumbnails",
"en/api-reference/supernote-plugin/plugin-file-api/clear-mark-trails",
"en/api-reference/supernote-plugin/plugin-file-api/get-note-page-template",
"en/api-reference/supernote-plugin/plugin-file-api/generate-note-template-png",
"en/api-reference/supernote-plugin/plugin-file-api/get-note-type",
"en/api-reference/supernote-plugin/plugin-file-api/get-file-machine-type",
"en/api-reference/supernote-plugin/plugin-file-api/get-element-counts",
"en/api-reference/supernote-plugin/plugin-file-api/get-element-num-list",
"en/api-reference/supernote-plugin/plugin-file-api/get-element",
"en/api-reference/supernote-plugin/plugin-file-api/get-last-element"
]
},
{
"group": "PluginManager",
"expanded": false,
"pages": [
"en/api-reference/supernote-plugin/plugin-manager/index",
"en/api-reference/supernote-plugin/plugin-manager/init",
"en/api-reference/supernote-plugin/plugin-manager/register-lang-listener",
"en/api-reference/supernote-plugin/plugin-manager/register-event-listener",
"en/api-reference/supernote-plugin/plugin-manager/register-button",
"en/api-reference/supernote-plugin/plugin-manager/unregister-button",
"en/api-reference/supernote-plugin/plugin-manager/get-button-state",
"en/api-reference/supernote-plugin/plugin-manager/set-button-state",
"en/api-reference/supernote-plugin/plugin-manager/register-config-button",
"en/api-reference/supernote-plugin/plugin-manager/get-plugin-dir-path",
"en/api-reference/supernote-plugin/plugin-manager/get-plugin-name",
"en/api-reference/supernote-plugin/plugin-manager/get-device-type",
"en/api-reference/supernote-plugin/plugin-manager/close-plugin-view"
]
},
{
"group": "Utils",
"expanded": false,
"pages": [
"en/api-reference/supernote-plugin/utils/point-utils/index",
"en/api-reference/supernote-plugin/utils/point-utils/android-point2-emr",
"en/api-reference/supernote-plugin/utils/point-utils/emr-point2-android"
]
},
{
"group": "Types",
"expanded": false,
"pages": [
"en/api-reference/supernote-plugin/types/index",
"en/api-reference/supernote-plugin/types/api-response",
"en/api-reference/supernote-plugin/types/point",
"en/api-reference/supernote-plugin/types/rect",
"en/api-reference/supernote-plugin/types/size",
"en/api-reference/supernote-plugin/types/trail-data-accessor",
"en/api-reference/supernote-plugin/types/stroke",
"en/api-reference/supernote-plugin/types/pen-info",
"en/api-reference/supernote-plugin/types/recogn-data",
"en/api-reference/supernote-plugin/types/recog-result-data",
"en/api-reference/supernote-plugin/types/geometry",
"en/api-reference/supernote-plugin/types/picture",
"en/api-reference/supernote-plugin/types/template",
"en/api-reference/supernote-plugin/types/key-word",
"en/api-reference/supernote-plugin/types/layer",
"en/api-reference/supernote-plugin/types/trail",
"en/api-reference/supernote-plugin/types/text-link",
"en/api-reference/supernote-plugin/types/link",
"en/api-reference/supernote-plugin/types/lasso-link",
"en/api-reference/supernote-plugin/types/title",
"en/api-reference/supernote-plugin/types/text-box",
"en/api-reference/supernote-plugin/types/plugin-button"
]
}
]
}
]
}
]
}
]
},
"logo": {
"light": "/logo/light.svg",
"dark": "/logo/dark.svg"
},
"navbar": {
"links": [
{
"label": "Support",
"href": "mailto:hi@mintlify.com"
}
],
"primary": {
"type": "button",
"label": "Dashboard",
"href": "https://dashboard.mintlify.com"
}
},
"contextual": {
"options": [
"copy",
"view",
"chatgpt",
"claude",
"perplexity",
"mcp",
"cursor",
"vscode"
]
},
"footer": {
"socials": {
"x": "https://x.com/mintlify",
"github": "https://github.com/mintlify",
"linkedin": "https://linkedin.com/company/mintlify"
}
}
}