1# @ohos.multimodalInput.pointer (鼠标指针)(系统接口)
2
3鼠标指针管理模块,用于查询和设置鼠标指针相关属性。
4
5> **说明**:
6>
7> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8>
9> 当前页面仅包含本模块的系统接口,其他公开接口参见[@ohos.multimodalInput.pointer (鼠标指针)](js-apis-pointer.md)。
10
11## 导入模块
12
13```js
14import { pointer } from '@kit.InputKit';
15```
16
17## pointer.setPointerSpeed
18
19setPointerSpeed(speed: number, callback: AsyncCallback<void>): void
20
21设置鼠标移动速度,使用AsyncCallback异步方式返回结果。
22
23**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
24
25**系统API**: 此接口为系统接口。
26
27**参数**:
28
29| 参数名       | 类型                        | 必填   | 说明                                    |
30| -------- | ------------------------- | ---- | ------------------------------------- |
31| speed    | number                    | 是    | 鼠标移动速度,范围1-11,默认为7。   |
32| callback | AsyncCallback<void> | 是    | 回调函数。 |
33
34**错误码:**
35
36以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
37
38| 错误码ID | 错误信息          |
39| -------- | ----------------- |
40| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.2.Incorrect parameter types.3.Parameter verification failed. |
41
42
43**示例**:
44
45```js
46try {
47  pointer.setPointerSpeed(5, (error: Error) => {
48    if (error) {
49      console.log(`Set pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
50      return;
51    }
52    console.log(`Set pointer speed success`);
53  });
54} catch (error) {
55  console.log(`Set pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
56}
57```
58
59## pointer.setPointerSpeed
60
61setPointerSpeed(speed: number): Promise<void>
62
63设置鼠标移动速度,使用Promise异步方式返回结果。
64
65**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
66
67**系统API**: 此接口为系统接口。
68
69**参数**:
70
71| 参数名    | 类型     | 必填   | 说明                                  |
72| ----- | ------ | ---- | ----------------------------------- |
73| speed | number | 是    | 鼠标移动速度,范围1-11,默认为7。 |
74
75**返回值**:
76
77| 参数                  | 说明               |
78| ------------------- | ---------------- |
79| Promise<void> | Promise对象。 |
80
81**错误码:**
82
83以下错误码的详细介绍请参见[ohos.devicestatus错误码](../apis-distributedservice-kit/errorcode-devicestatus.md)。
84
85| 错误码ID | 错误信息          |
86| -------- | ----------------- |
87| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.2.Incorrect parameter types.3.Parameter verification failed. |
88
89
90**示例**:
91
92```js
93try {
94  pointer.setPointerSpeed(5).then(() => {
95    console.log(`Set pointer speed success`);
96  });
97} catch (error) {
98  console.log(`Set pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
99}
100```
101
102## pointer.setPointerSpeedSync<sup>10+</sup>
103
104setPointerSpeedSync(speed: number): void
105
106使用同步方式设置鼠标移动速度。
107
108**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
109
110**系统API**: 此接口为系统接口。
111
112**参数**:
113
114| 参数名    | 类型     | 必填   | 说明                                  |
115| ----- | ------ | ---- | ----------------------------------- |
116| speed | number | 是    | 鼠标移动速度,范围1-11,默认为7。 |
117
118**错误码**:
119
120以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
121
122| 错误码ID  | 错误信息             |
123| ---- | --------------------- |
124| 202  | SystemAPI permission error.  |
125| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
126
127**示例**:
128
129```js
130try {
131  let speed = pointer.setPointerSpeedSync(5);
132  console.log(`Set pointer speed success`);
133} catch (error) {
134  console.log(`Set pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
135}
136```
137
138## pointer.getPointerSpeed
139
140getPointerSpeed(callback: AsyncCallback&lt;number&gt;): void
141
142获取鼠标移动速度,使用AsyncCallback异步方式返回结果。
143
144**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
145
146**系统API**: 此接口为系统接口。
147
148**参数**:
149
150| 参数名       | 类型                          | 必填   | 说明             |
151| -------- | --------------------------- | ---- | -------------- |
152| callback | AsyncCallback&lt;number&gt; | 是    | 回调函数,异步返回鼠标移动速度。 |
153
154**错误码**:
155
156以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
157
158| 错误码ID  | 错误信息             |
159| ---- | --------------------- |
160| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
161
162
163**示例**:
164
165```js
166try {
167  pointer.getPointerSpeed((error: Error, speed: number) => {
168    if (error) {
169      console.log(`Get pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
170      return;
171    }
172    console.log(`Get pointer speed success, speed: ${JSON.stringify(speed)}`);
173  });
174} catch (error) {
175  console.log(`Get pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
176}
177```
178
179## pointer.getPointerSpeed
180
181getPointerSpeed(): Promise&lt;number&gt;
182
183获取当前鼠标移动速度,使用Promise异步方式返回结果。
184
185**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
186
187**系统API**: 此接口为系统接口。
188
189**返回值**:
190
191| 参数                    | 说明                  |
192| --------------------- | ------------------- |
193| Promise&lt;number&gt; | Promise实例,异步返回鼠标移动速度。 |
194
195**示例**:
196
197```js
198try {
199  pointer.getPointerSpeed().then(speed => {
200    console.log(`Get pointer speed success, speed: ${JSON.stringify(speed)}`);
201  });
202} catch (error) {
203  console.log(`Get pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
204}
205```
206
207## pointer.getPointerSpeedSync<sup>10+</sup>
208
209getPointerSpeedSync(): number
210
211使用同步方式获取当前鼠标移动速度。
212
213**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
214
215**系统API**: 此接口为系统接口。
216
217**返回值**:
218
219| 参数                    | 说明                  |
220| --------------------- | ------------------- |
221| number | 返回鼠标移动速度。 |
222
223**错误码**:
224
225以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
226
227| 错误码ID  | 错误信息             |
228| ---- | --------------------- |
229| 202  | SystemAPI permission error.  |
230| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
231
232**示例**:
233
234```js
235try {
236  let speed = pointer.getPointerSpeedSync();
237  console.log(`Get pointer speed success, speed: ${JSON.stringify(speed)}`);
238} catch (error) {
239  console.log(`Get pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
240}
241```
242
243## pointer.setHoverScrollState<sup>10+</sup>
244
245setHoverScrollState(state: boolean, callback: AsyncCallback&lt;void&gt;): void
246
247设置鼠标悬停滚动开关状态,使用AsyncCallback异步方式返回结果。
248
249**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
250
251**系统API**: 此接口为系统接口。
252
253**参数**:
254
255| 参数名       | 类型                        | 必填   | 说明                                    |
256| -------- | ------------------------- | ---- | ------------------------------------- |
257| state    | boolean                    | 是    | 鼠标悬停滚动开关状态。true代表开关开启,false代表开关关闭,默认开启。   |
258| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。 |
259
260**错误码**:
261
262以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
263
264| 错误码ID  | 错误信息             |
265| ---- | --------------------- |
266| 202  | SystemAPI permission error.  |
267| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
268
269**示例**:
270
271```js
272try {
273  pointer.setHoverScrollState(true, (error: Error) => {
274    if (error) {
275      console.log(`Set the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
276      return;
277    }
278    console.log(`Set the mouse hover scroll success`);
279  });
280} catch (error) {
281  console.log(`Set the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
282}
283```
284
285## pointer.setHoverScrollState<sup>10+</sup>
286
287setHoverScrollState(state: boolean): Promise&lt;void&gt;
288
289设置鼠标悬停滚动开关状态,使用Promise异步方式返回结果。
290
291**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
292
293**系统API**: 此接口为系统接口。
294
295**参数**:
296
297| 参数名    | 类型     | 必填   | 说明                                  |
298| ----- | ------ | ---- | ----------------------------------- |
299| state | boolean | 是    | 鼠标悬停滚动开关状态。true代表开关开启,false代表开关关闭,默认开启。 |
300
301**返回值**:
302
303| 参数                  | 说明               |
304| ------------------- | ---------------- |
305| Promise&lt;void&gt; | Promise对象。 |
306
307**错误码**:
308
309以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
310
311| 错误码ID  | 错误信息             |
312| ---- | --------------------- |
313| 202  | SystemAPI permission error.  |
314| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
315
316**示例**:
317
318```js
319try {
320  pointer.setHoverScrollState(true).then(() => {
321    console.log(`Set the mouse hover scroll success`);
322  });
323} catch (error) {
324  console.log(`Set the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
325}
326```
327
328## pointer.getHoverScrollState<sup>10+</sup>
329
330getHoverScrollState(callback: AsyncCallback&lt;boolean&gt;): void
331
332获取鼠标悬停滚动开关状态,使用AsyncCallback异步方式返回结果。
333
334**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
335
336**系统API**: 此接口为系统接口。
337
338**参数**:
339
340| 参数名       | 类型                          | 必填   | 说明             |
341| -------- | --------------------------- | ---- | -------------- |
342| callback | AsyncCallback&lt;boolean&gt; | 是    | 回调函数,异步返回鼠标悬停滚动开关状态。true代表开关开启,false代表开关关闭,默认开启。 |
343
344**错误码**:
345
346以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
347
348| 错误码ID  | 错误信息             |
349| ---- | --------------------- |
350| 202  | SystemAPI permission error.  |
351| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
352
353**示例**:
354
355```js
356try {
357  pointer.getHoverScrollState((error: Error, state: boolean) => {
358    console.log(`Get the mouse hover scroll success, state: ${JSON.stringify(state)}`);
359  });
360} catch (error) {
361  console.log(`Get the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
362}
363```
364
365## pointer.getHoverScrollState<sup>10+</sup>
366
367getHoverScrollState(): Promise&lt;boolean&gt;
368
369获取当前鼠标悬停滚动开关状态,使用Promise异步方式返回结果。
370
371**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
372
373**系统API**: 此接口为系统接口。
374
375**返回值**:
376
377| 参数                    | 说明                  |
378| --------------------- | ------------------- |
379| Promise&lt;boolean&gt; | Promise实例,异步返回鼠标悬停滚动开关状态。true代表开关开启,false代表开关关闭,默认开启。 |
380
381**错误码**:
382
383以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
384
385| 错误码ID  | 错误信息             |
386| ---- | --------------------- |
387| 202  | SystemAPI permission error.  |
388| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
389
390**示例**:
391
392```js
393try {
394  pointer.getHoverScrollState().then((state: boolean) => {
395    console.log(`Get the mouse hover scroll success, state: ${JSON.stringify(state)}`);
396  });
397} catch (error) {
398  console.log(`Get the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
399}
400```
401
402## pointer.setMousePrimaryButton<sup>10+</sup>
403
404setMousePrimaryButton(primary: PrimaryButton, callback: AsyncCallback&lt;void&gt;): void
405
406设置鼠标主键,使用AsyncCallback异步方式返回结果。
407
408**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
409
410**系统API**: 此接口为系统接口。
411
412**参数**:
413
414| 参数名    | 类型                      | 必填  | 说明                                    |
415| -------- | ------------------------- | ----  | ------------------------------------- |
416| primary  | [PrimaryButton](js-apis-pointer.md#primarybutton10)   | 是    | 鼠标主键id。   |
417| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。 |
418
419**错误码**:
420
421以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
422
423| 错误码ID  | 错误信息             |
424| ---- | --------------------- |
425| 202  | SystemAPI permission error.  |
426| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
427
428**示例**:
429
430```js
431try {
432  pointer.setMousePrimaryButton(pointer.PrimaryButton.RIGHT, (error: Error) => {
433    if (error) {
434      console.log(`Set mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
435      return;
436    }
437    console.log(`Set mouse primary button success`);
438  });
439} catch (error) {
440  console.log(`Set mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
441}
442```
443
444## pointer.setMousePrimaryButton<sup>10+</sup>
445
446setMousePrimaryButton(primary: PrimaryButton): Promise&lt;void&gt;
447
448设置鼠标主键,使用Promise异步方式返回结果。
449
450**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
451
452**系统API**: 此接口为系统接口。
453
454**参数**:
455
456| 参数名    | 类型     | 必填   | 说明                                  |
457| ----- | ------ | ---- | ----------------------------------- |
458| primary | [PrimaryButton](js-apis-pointer.md#primarybutton10) | 是    | 鼠标主键id。 |
459
460**返回值**:
461
462| 参数                  | 说明               |
463| ------------------- | ---------------- |
464| Promise&lt;void&gt; | Promise对象。 |
465
466**错误码**:
467
468以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
469
470| 错误码ID  | 错误信息             |
471| ---- | --------------------- |
472| 202  | SystemAPI permission error.  |
473| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
474
475**示例**:
476
477```js
478try {
479  pointer.setMousePrimaryButton(pointer.PrimaryButton.RIGHT).then(() => {
480    console.log(`Set mouse primary button success`);
481  });
482} catch (error) {
483  console.log(`Set mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
484}
485```
486
487## pointer.getMousePrimaryButton<sup>10+</sup>
488
489getMousePrimaryButton(callback: AsyncCallback&lt;PrimaryButton&gt;): void
490
491获取当前鼠标主键,使用AsyncCallback异步方式返回结果。
492
493**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
494
495**系统API**: 此接口为系统接口。
496
497**参数**:
498
499| 参数名       | 类型                          | 必填   | 说明             |
500| -------- | --------------------------- | ---- | -------------- |
501| callback | AsyncCallback&lt;[PrimaryButton](js-apis-pointer.md#primarybutton10)&gt; | 是    | 回调函数,异步返回鼠标主键。 |
502
503**错误码**:
504
505以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
506
507| 错误码ID  | 错误信息             |
508| ---- | --------------------- |
509| 202  | SystemAPI permission error.  |
510| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
511
512**示例**:
513
514```js
515try {
516  pointer.getMousePrimaryButton((error: Error, primary: pointer.PrimaryButton) => {
517    console.log(`Get mouse primary button success, primary: ${JSON.stringify(primary)}`);
518  });
519} catch (error) {
520  console.log(`Get mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
521}
522```
523
524## pointer.getMousePrimaryButton<sup>10+</sup>
525
526getMousePrimaryButton(): Promise&lt;PrimaryButton&gt;
527
528获取当前鼠标主键,使用Promise异步方式返回结果。
529
530**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
531
532**系统API**: 此接口为系统接口。
533
534**返回值**:
535
536| 参数                    | 说明                  |
537| --------------------- | ------------------- |
538| Promise&lt;[PrimaryButton](js-apis-pointer.md#primarybutton10)&gt; | Promise实例,异步返回鼠标主键。 |
539
540**错误码**:
541
542以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
543
544| 错误码ID  | 错误信息             |
545| ---- | --------------------- |
546| 202  | SystemAPI permission error.  |
547| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
548
549**示例**:
550
551```js
552try {
553  pointer.getMousePrimaryButton().then((primary: pointer.PrimaryButton) => {
554    console.log(`Get mouse primary button success, primary: ${JSON.stringify(primary)}`);
555  });
556} catch (error) {
557  console.log(`Get mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
558}
559```
560
561## pointer.setMouseScrollRows<sup>10+</sup>
562
563setMouseScrollRows(rows: number, callback: AsyncCallback&lt;void&gt;): void
564
565设置鼠标滚动行数,使用AsyncCallback异步方式返回结果。
566
567**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
568
569**系统API**: 此接口为系统接口。
570
571**参数**:
572
573| 参数名       | 类型                        | 必填   | 说明                                    |
574| -------- | ------------------------- | ---- | ------------------------------------- |
575| rows     | number                    | 是    | 鼠标滚动行数,范围1-100,默认为3。   |
576| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数。 |
577
578**错误码**:
579
580以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
581
582| 错误码ID  | 错误信息             |
583| ---- | --------------------- |
584| 202  | SystemAPI permission error.  |
585| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
586
587**示例**:
588
589```js
590try {
591  pointer.setMouseScrollRows(1, (error: Error) => {
592    if (error) {
593      console.log(`setMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
594      return;
595    }
596    console.log(`setMouseScrollRows success`);
597  });
598} catch (error) {
599  console.log(`setMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
600}
601```
602
603## pointer.setMouseScrollRows<sup>10+</sup>
604
605setMouseScrollRows(rows: number): Promise&lt;void&gt;
606
607设置鼠标滚动行数,使用Promise异步方式返回结果。
608
609**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
610
611**系统API**: 此接口为系统接口。
612
613**参数**:
614
615| 参数名    | 类型     | 必填   | 说明                                  |
616| ----- | ------ | ---- | ----------------------------------- |
617| rows  | number | 是    | 鼠标滚动行数,范围1-100,默认为3。 |
618
619**返回值**:
620
621| 参数                  | 说明               |
622| ------------------- | ---------------- |
623| Promise&lt;void&gt; | Promise对象。 |
624
625**错误码**:
626
627以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
628
629| 错误码ID  | 错误信息             |
630| ---- | --------------------- |
631| 202  | SystemAPI permission error.  |
632| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
633
634**示例**:
635
636```js
637try {
638  pointer.setMouseScrollRows(20).then(() => {
639    console.log(`setMouseScrollRows success`);
640  });
641} catch (error) {
642  console.log(`setMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
643}
644```
645
646## pointer.getMouseScrollRows<sup>10+</sup>
647
648getMouseScrollRows(callback: AsyncCallback&lt;number&gt;): void
649
650获取鼠标滚动行数,使用AsyncCallback异步方式返回结果。
651
652**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
653
654**系统API**: 此接口为系统接口。
655
656**参数**:
657
658| 参数名       | 类型                          | 必填   | 说明             |
659| -------- | --------------------------- | ---- | -------------- |
660| callback | AsyncCallback&lt;number&gt; | 是    | 回调函数,异步返回鼠标滚动行数。 |
661
662**错误码**:
663
664以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
665
666| 错误码ID  | 错误信息             |
667| ---- | --------------------- |
668| 202  | SystemAPI permission error.  |
669| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
670
671**示例**:
672
673```js
674try {
675  pointer.getMouseScrollRows((error: Error, rows: number) => {
676    console.log(`getMouseScrollRows success, rows: ${JSON.stringify(rows)}`);
677  });
678} catch (error) {
679  console.log(`getMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
680}
681```
682
683## pointer.getMouseScrollRows<sup>10+</sup>
684
685getMouseScrollRows(): Promise&lt;number&gt;
686
687获取当前鼠标滚动行数,使用Promise异步方式返回结果。
688
689**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
690
691**系统API**: 此接口为系统接口。
692
693**返回值**:
694
695| 参数                    | 说明                  |
696| --------------------- | ------------------- |
697| Promise&lt;number&gt; | Promise实例,异步返回鼠标滚动行数。 |
698
699**错误码**:
700
701以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
702
703| 错误码ID  | 错误信息             |
704| ---- | --------------------- |
705| 202  | SystemAPI permission error.  |
706| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
707
708**示例**:
709
710```js
711try {
712  pointer.getMouseScrollRows().then((rows: number) => {
713    console.log(`getMouseScrollRows success, rows: ${JSON.stringify(rows)}`);
714  });
715} catch (error) {
716  console.log(`getMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
717}
718```
719
720## pointer.setTouchpadScrollSwitch<sup>10+</sup>
721
722setTouchpadScrollSwitch(state: boolean, callback: AsyncCallback\<void>): void
723
724设置触控板滚轴开关,使用AsyncCallback异步方式返回结果。
725
726**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
727
728**系统API**: 此接口为系统接口。
729
730**参数**:
731
732| 参数名       | 类型                        | 必填   | 说明                                    |
733| -------- | ------------------------- | ---- | ------------------------------------- |
734| state | boolean | 是    | 滚轴开关开启的状态,true代表开启,false代表关闭,默认为开启   |
735| callback | AsyncCallback\<void> | 是    | 回调函数。 |
736
737**错误码**:
738
739以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
740
741| 错误码ID  | 错误信息             |
742| ---- | --------------------- |
743| 202  | SystemAPI permission error.  |
744| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
745
746**示例**:
747
748```js
749try {
750  pointer.setTouchpadScrollSwitch(true, (error: Error) => {
751    if (error) {
752      console.log(`setTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
753      return;
754    }
755    console.log(`setTouchpadScrollSwitch success`);
756  });
757} catch (error) {
758  console.log(`setTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
759}
760```
761
762## pointer.setTouchpadScrollSwitch<sup>10+</sup>
763
764setTouchpadScrollSwitch(state: boolean): Promise\<void>
765
766设置触控板滚轴开关,使用Promise异步方式返回结果。
767
768**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
769
770**系统API**: 此接口为系统接口。
771
772**参数**:
773
774| 参数名    | 类型     | 必填   | 说明                                  |
775| ----- | ------ | ---- | ----------------------------------- |
776| state | boolean| 是    |  滚轴开关开启的状态,true代表开启,false代表关闭,默认为开启 |
777
778**返回值**:
779
780| 参数                  | 说明               |
781| ------------------- | ---------------- |
782| Promise\<void> | Promise对象。 |
783
784**错误码**:
785
786以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
787
788| 错误码ID  | 错误信息             |
789| ---- | --------------------- |
790| 202  | SystemAPI permission error.  |
791| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
792
793**示例**:
794
795```js
796try {
797  pointer.setTouchpadScrollSwitch(false).then(() => {
798    console.log(`setTouchpadScrollSwitch success`);
799  });
800} catch (error) {
801  console.log(`setTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
802}
803```
804
805## pointer.getTouchpadScrollSwitch<sup>10+</sup>
806
807getTouchpadScrollSwitch(callback:  AsyncCallback\<boolean>): void
808
809获取触控板滚轴能力开启状态,使用AsyncCallback异步方式返回结果。
810
811**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
812
813**系统API**: 此接口为系统接口。
814
815**参数**:
816
817| 参数名       | 类型                          | 必填   | 说明             |
818| -------- | --------------------------- | ---- | -------------- |
819| callback | AsyncCallback\<boolean> | 是    | 回调函数,异步返回触控板滚轴能力开启状态。true代表开启,false代表关闭,默认为开启。 |
820
821**错误码**:
822
823以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
824
825| 错误码ID  | 错误信息             |
826| ---- | --------------------- |
827| 202  | SystemAPI permission error.  |
828| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
829
830**示例**:
831
832```js
833try {
834  pointer.getTouchpadScrollSwitch((error: Error, state: boolean) => {
835    console.log(`getTouchpadScrollSwitch success, state: ${JSON.stringify(state)}`);
836  });
837} catch (error) {
838  console.log(`getTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
839}
840```
841
842## pointer.getTouchpadScrollSwitch<sup>10+</sup>
843
844getTouchpadScrollSwitch(): Promise\<boolean>
845
846获取触控板滚轴能力开启状态,使用Promise异步方式返回结果。
847
848**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
849
850**系统API**: 此接口为系统接口。
851
852**返回值**:
853
854| 参数                    | 说明                  |
855| --------------------- | ------------------- |
856| Promise\<boolean> | Promise实例,异步返回触控板滚轴能力开启状态。true代表开启,false代表关闭,默认为开启。 |
857
858**错误码**:
859
860以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
861
862| 错误码ID  | 错误信息             |
863| ---- | --------------------- |
864| 202  | SystemAPI permission error.  |
865| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
866
867**示例**:
868
869```js
870try {
871  pointer.getTouchpadScrollSwitch().then((state) => {
872    console.log(`getTouchpadScrollSwitch success, state: ${JSON.stringify(state)}`);
873  });
874} catch (error) {
875  console.log(`getTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
876}
877```
878
879## pointer.setTouchpadScrollDirection<sup>10+</sup>
880
881setTouchpadScrollDirection(state: boolean, callback: AsyncCallback\<void>): void
882
883设置触控板滚轴的方向,使用AsyncCallback异步方式返回结果。
884
885**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
886
887**系统API**: 此接口为系统接口。
888
889**参数**:
890
891| 参数名       | 类型                        | 必填   | 说明                                    |
892| -------- | ------------------------- | ---- | ------------------------------------- |
893| state | boolean | 是    | state为触控板滚轴的方向。<br>true与手指滑动的方向一致,false与手指滑动的方向相反,<br>默认为true。   |
894| callback | AsyncCallback\<void> | 是    | 回调函数。 |
895
896**错误码**:
897
898以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
899
900| 错误码ID  | 错误信息             |
901| ---- | --------------------- |
902| 202  | SystemAPI permission error.  |
903| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
904
905**示例**:
906
907```js
908try {
909  pointer.setTouchpadScrollDirection(true, (error: Error) => {
910    if (error) {
911      console.log(`setTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
912      return;
913    }
914    console.log(`setTouchpadScrollDirection success`);
915  });
916} catch (error) {
917  console.log(`setTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
918}
919```
920
921## pointer.setTouchpadScrollDirection<sup>10+</sup>
922
923setTouchpadScrollDirection(state: boolean): Promise\<void>
924
925设置触控板滚轴的方向,使用Promise异步方式返回结果。
926
927**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
928
929**系统API**: 此接口为系统接口。
930
931**参数**:
932
933| 参数名    | 类型     | 必填   | 说明                                  |
934| ----- | ------ | ---- | ----------------------------------- |
935| state | boolean| 是    |  state为触控板滚轴的方向。<br>true与手指滑动的方向一致,false与手指滑动的方向相反。<br>默认为true|
936
937**返回值**:
938
939| 参数                  | 说明               |
940| ------------------- | ---------------- |
941| Promise\<void> | Promise对象。 |
942
943**错误码**:
944
945以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
946
947| 错误码ID  | 错误信息             |
948| ---- | --------------------- |
949| 202  | SystemAPI permission error.  |
950| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
951
952**示例**:
953
954```js
955try {
956  pointer.setTouchpadScrollDirection (false).then(() => {
957    console.log(`setTouchpadScrollDirection success`);
958  });
959} catch (error) {
960  console.log(`setTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
961}
962```
963
964## pointer.getTouchpadScrollDirection<sup>10+</sup>
965
966getTouchpadScrollDirection(callback:  AsyncCallback\<boolean>): void
967
968获取触控板滚轴方向,使用AsyncCallback异步方式返回结果。
969
970**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
971
972**系统API**: 此接口为系统接口。
973
974**参数**:
975
976| 参数名       | 类型                          | 必填   | 说明             |
977| -------- | --------------------------- | ---- | -------------- |
978| callback | AsyncCallback\<boolean> | 是    | 回调函数,异步返回触控板滚轴方向。<br>true与手指滑动的方向一致,false与手指滑动的方向相反。<br>默认为true |
979
980**错误码**:
981
982以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
983
984| 错误码ID  | 错误信息             |
985| ---- | --------------------- |
986| 202  | SystemAPI permission error.  |
987| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
988
989**示例**:
990
991```js
992try {
993  pointer.getTouchpadScrollDirection ((error: Error, state: boolean) => {
994    console.log(`getTouchpadScrollDirection success, state: ${JSON.stringify(state)}`);
995  });
996} catch (error) {
997  console.log(`getTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
998}
999```
1000
1001## pointer.getTouchpadScrollDirection<sup>10+</sup>
1002
1003getTouchpadScrollDirection(): Promise\<boolean>
1004
1005获取触控板滚轴方向,使用Promise异步方式返回结果。
1006
1007**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1008
1009**系统API**: 此接口为系统接口。
1010
1011**返回值**:
1012
1013| 参数                    | 说明                  |
1014| --------------------- | ------------------- |
1015| Promise\<boolean> | Promise实例,异步返回触控板滚轴方向。<br>true与手指滑动的方向一致,false与手指滑动的方向相反。<br>默认为true |
1016
1017**错误码**:
1018
1019以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1020
1021| 错误码ID  | 错误信息             |
1022| ---- | --------------------- |
1023| 202  | SystemAPI permission error.  |
1024| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1025
1026**示例**:
1027
1028```js
1029try {
1030  pointer.getTouchpadScrollDirection().then((state: boolean) => {
1031    console.log(`getTouchpadScrollDirection success, state: ${JSON.stringify(state)}`);
1032  });
1033} catch (error) {
1034  console.log(`getTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1035}
1036```
1037
1038## pointer.setTouchpadTapSwitch<sup>10+</sup>
1039
1040setTouchpadTapSwitch(state: boolean, callback: AsyncCallback\<void>): void
1041
1042设置触控板轻触功能开关,使用AsyncCallback异步方式返回结果。
1043
1044**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1045
1046**系统API**: 此接口为系统接口。
1047
1048**参数**:
1049
1050| 参数名       | 类型                        | 必填   | 说明                                    |
1051| -------- | ------------------------- | ---- | ------------------------------------- |
1052| state | boolean | 是    |触控板轻触功能开关开启状态。 true代表轻触开启,false代表轻触关闭,默认开启。   |
1053| callback | AsyncCallback\<void> | 是    | 回调函数。 |
1054
1055**错误码**:
1056
1057以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1058
1059| 错误码ID  | 错误信息             |
1060| ---- | --------------------- |
1061| 202  | SystemAPI permission error.  |
1062| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1063
1064**示例**:
1065
1066```js
1067try {
1068  pointer.setTouchpadTapSwitch(true, (error: Error) => {
1069    if (error) {
1070      console.log(`setTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1071      return;
1072    }
1073    console.log(`setTouchpadTapSwitch success`);
1074  });
1075} catch (error) {
1076  console.log(`setTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1077}
1078```
1079
1080## pointer.setTouchpadTapSwitch <sup>10+</sup>
1081
1082setTouchpadTapSwitch(state: boolean): Promise\<void>
1083
1084设置触控板轻触功能开关,使用Promise异步方式返回结果。
1085
1086**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1087
1088**系统API**: 此接口为系统接口。
1089
1090**参数**:
1091
1092| 参数名    | 类型     | 必填   | 说明                                  |
1093| ----- | ------ | ---- | ----------------------------------- |
1094| state | boolean| 是    |  触控板轻触功能开关开启状态, true代表轻触开启,false代表轻触关闭,默认开启。  |
1095
1096**返回值**:
1097
1098| 参数                  | 说明               |
1099| ------------------- | ---------------- |
1100| Promise\<void> | Promise对象。 |
1101
1102**错误码**:
1103
1104以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1105
1106| 错误码ID  | 错误信息             |
1107| ---- | --------------------- |
1108| 202  | SystemAPI permission error.  |
1109| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1110
1111**示例**:
1112
1113```js
1114try {
1115  pointer.setTouchpadTapSwitch(false).then(() => {
1116    console.log(`setTouchpadTapSwitch success`);
1117  });
1118} catch (error) {
1119  console.log(`setTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1120}
1121```
1122
1123## pointer.getTouchpadTapSwitch<sup>10+</sup>
1124
1125getTouchpadTapSwitch(callback:  AsyncCallback\<boolean>): void
1126
1127获取触控板轻触能力开启状态,使用AsyncCallback异步方式返回结果。
1128
1129**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1130
1131**系统API**: 此接口为系统接口。
1132
1133**参数**:
1134
1135| 参数名       | 类型                          | 必填   | 说明             |
1136| -------- | --------------------------- | ---- | -------------- |
1137| callback | AsyncCallback\<boolean> | 是    | 回调函数,异步返回触控板轻触功能开启状态, true代表开启,false代表关闭,默认开启。 |
1138
1139**错误码**:
1140
1141以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1142
1143| 错误码ID  | 错误信息             |
1144| ---- | --------------------- |
1145| 202  | SystemAPI permission error.  |
1146| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1147
1148**示例**:
1149
1150```js
1151try {
1152  pointer.getTouchpadTapSwitch((error: Error, state: boolean) => {
1153    console.log(`getTouchpadTapSwitch success, state: ${JSON.stringify(state)}`);
1154  });
1155} catch (error) {
1156  console.log(`getTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1157}
1158```
1159
1160## pointer.getTouchpadTapSwitch<sup>10+</sup>
1161
1162getTouchpadTapSwitch(): Promise\<boolean>
1163
1164获取触控板轻触功能开启状态,使用Promise异步方式返回结果。
1165
1166**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1167
1168**系统API**: 此接口为系统接口。
1169
1170**返回值**:
1171
1172| 参数                    | 说明                  |
1173| --------------------- | ------------------- |
1174| Promise\<boolean> | Promise实例,异步返回触控板轻触功能开启状态,true代表开启,false代表关闭,默认开启。 |
1175
1176**错误码**:
1177
1178以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1179
1180| 错误码ID  | 错误信息             |
1181| ---- | --------------------- |
1182| 202  | SystemAPI permission error.  |
1183| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1184
1185**示例**:
1186
1187```js
1188try {
1189  pointer.getTouchpadTapSwitch().then((state: boolean) => {
1190    console.log(`getTouchpadTapSwitch success, state: ${JSON.stringify(state)}`);
1191  });
1192} catch (error) {
1193  console.log(`getTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1194}
1195```
1196
1197## pointer.setTouchpadPointerSpeed<sup>10+</sup>
1198
1199setTouchpadPointerSpeed(speed: number, callback: AsyncCallback\<void>): void
1200
1201设置触控板光标移动速度,使用AsyncCallback异步方式返回结果。
1202
1203**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1204
1205**系统API**: 此接口为系统接口。
1206
1207**参数**:
1208
1209| 参数名       | 类型                        | 必填   | 说明                                    |
1210| -------- | ------------------------- | ---- | ------------------------------------- |
1211| speed | number                    | 是    |speed代表光标移动速度。speed取值范围[1,11],默认6。  |
1212| callback | AsyncCallback\<void> | 是    | 回调函数。 |
1213
1214**错误码**:
1215
1216以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1217
1218| 错误码ID  | 错误信息             |
1219| ---- | --------------------- |
1220| 202  | SystemAPI permission error.  |
1221| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1222
1223**示例**:
1224
1225```js
1226try {
1227  pointer.setTouchpadPointerSpeed(1, (error: Error) => {
1228    if (error) {
1229      console.log(`setTouchpadPointerSpeedfailed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1230      return;
1231    }
1232    console.log(`setTouchpadPointerSpeed success`);
1233  });
1234} catch (error) {
1235  console.log(`setTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1236}
1237```
1238
1239## pointer.setTouchpadPointerSpeed<sup>10+</sup>
1240
1241setTouchpadPointerSpeed(speed: number): Promise\<void>
1242
1243设置触控板光标移动速度,使用Promise异步方式返回结果。
1244
1245**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1246
1247**系统API**: 此接口为系统接口。
1248
1249**参数**:
1250
1251| 参数名    | 类型     | 必填   | 说明                                  |
1252| ----- | ------ | ---- | ----------------------------------- |
1253| speed| number | 是    | speed代表光标移动速度。speed取值范围[1,11],默认6。    |
1254
1255**返回值**:
1256
1257| 参数                  | 说明               |
1258| ------------------- | ---------------- |
1259| Promise\<void> | Promise对象。 |
1260
1261**错误码**:
1262
1263以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1264
1265| 错误码ID  | 错误信息             |
1266| ---- | --------------------- |
1267| 202  | SystemAPI permission error.  |
1268| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1269
1270**示例**:
1271
1272```js
1273try {
1274  pointer.setTouchpadPointerSpeed(10).then(() => {
1275    console.log(`setTouchpadPointerSpeed success`);
1276  });
1277} catch (error) {
1278  console.log(`setTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1279}
1280```
1281
1282## pointer.getTouchpadPointerSpeed<sup>10+</sup>
1283
1284getTouchpadPointerSpeed(callback: AsyncCallback\<number>): void
1285
1286获取触控板光标移动速度,使用AsyncCallback异步方式返回结果。
1287
1288**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1289
1290**系统API**: 此接口为系统接口。
1291
1292**参数**:
1293
1294| 参数名       | 类型                          | 必填   | 说明             |
1295| -------- | --------------------------- | ---- | -------------- |
1296| callback | AsyncCallback\<number> | 是    | 回调函数,异步返回触控板光标移动速度。 |
1297
1298**错误码**:
1299
1300以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1301
1302| 错误码ID  | 错误信息             |
1303| ---- | --------------------- |
1304| 202  | SystemAPI permission error.  |
1305| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1306
1307**示例**:
1308
1309```js
1310try {
1311  pointer.getTouchpadPointerSpeed((error: Error, speed: number) => {
1312    console.log(`getTouchpadPointerSpeed success, speed: ${JSON.stringify(speed)}`);
1313  });
1314} catch (error) {
1315  console.log(`getTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1316}
1317```
1318
1319## pointer.getTouchpadPointerSpeed<sup>10+</sup>
1320
1321getTouchpadPointerSpeed(): Promise\<number>
1322
1323获取触控板光标移动速度,使用Promise异步方式返回结果。
1324
1325**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1326
1327**系统API**: 此接口为系统接口。
1328
1329**返回值**:
1330
1331| 参数                    | 说明                  |
1332| --------------------- | ------------------- |
1333| Promise\<number> | Promise实例,异步返回触控板光标移动速度。 |
1334
1335**错误码**:
1336
1337以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1338
1339| 错误码ID  | 错误信息             |
1340| ---- | --------------------- |
1341| 202  | SystemAPI permission error.  |
1342| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1343
1344**示例**:
1345
1346```js
1347try {
1348  pointer.getTouchpadPointerSpeed().then((speed: number) => {
1349    console.log(`getTouchpadPointerSpeed success, speed: ${JSON.stringify(speed)}`);
1350  });
1351} catch (error) {
1352  console.log(`getTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1353}
1354```
1355
1356## pointer.setTouchpadPinchSwitch<sup>10+</sup>
1357
1358setTouchpadPinchSwitch(state: boolean, callback: AsyncCallback\<void>): void
1359
1360设置触控板双指捏合功能开关,使用AsyncCallback异步方式返回结果。
1361
1362**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1363
1364**系统API**: 此接口为系统接口。
1365
1366**参数**:
1367
1368| 参数名       | 类型                        | 必填   | 说明                                    |
1369| -------- | ------------------------- | ---- | ------------------------------------- |
1370| state | boolean | 是    |触控板双指捏合功能开关开启状态。 true代表开启,false代表关闭,默认开启。   |
1371| callback | AsyncCallback\<void> | 是    | 回调函数。 |
1372
1373**错误码**:
1374
1375以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1376
1377| 错误码ID  | 错误信息             |
1378| ---- | --------------------- |
1379| 202  | SystemAPI permission error.  |
1380| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1381
1382**示例**:
1383
1384```js
1385try {
1386  pointer.setTouchpadTapSwitch(true, (error: Error) => {
1387    if (error) {
1388      console.log(`setTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1389      return;
1390    }
1391    console.log(`setTouchpadPinchSwitch success`);
1392  });
1393} catch (error) {
1394  console.log(`setTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1395}
1396```
1397
1398## pointer.setTouchpadPinchSwitch<sup>10+</sup>
1399
1400setTouchpadPinchSwitch(state: boolean): Promise\<void>
1401
1402设置触控板双指捏合功能开关,使用Promise异步方式返回结果。
1403
1404**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1405
1406**系统API**: 此接口为系统接口。
1407
1408**参数**:
1409
1410| 参数名    | 类型     | 必填   | 说明                                  |
1411| ----- | ------ | ---- | ----------------------------------- |
1412| state | boolean| 是    |  触控板双指捏合功能开关开启状态。 true代表开启,false代表关闭,默认开启。  |
1413
1414**返回值**:
1415
1416| 参数                  | 说明               |
1417| ------------------- | ---------------- |
1418| Promise\<void> | Promise对象。 |
1419
1420**错误码**:
1421
1422以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1423
1424| 错误码ID  | 错误信息             |
1425| ---- | --------------------- |
1426| 202  | SystemAPI permission error.  |
1427| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1428
1429**示例**:
1430
1431```js
1432try {
1433  pointer.setTouchpadPinchSwitch(false).then(() => {
1434    console.log(`setTouchpadPinchSwitch success`);
1435  });
1436} catch (error) {
1437  console.log(`setTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1438}
1439```
1440
1441## pointer.getTouchpadPinchSwitch<sup>10+</sup>
1442
1443getTouchpadPinchSwitch(callback:  AsyncCallback\<boolean>): void
1444
1445获取触控板双指捏合功能开启状态,使用AsyncCallback异步方式返回结果。
1446
1447**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1448
1449**系统API**: 此接口为系统接口。
1450
1451**参数**:
1452
1453| 参数名       | 类型                          | 必填   | 说明             |
1454| -------- | --------------------------- | ---- | -------------- |
1455| callback | AsyncCallback\<boolean> | 是    | 回调函数,异步返回触控板双指捏合功能开启状态。true代表功能开启,false代表功能关闭,默认开启。 |
1456
1457**错误码**:
1458
1459以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1460
1461| 错误码ID  | 错误信息             |
1462| ---- | --------------------- |
1463| 202  | SystemAPI permission error.  |
1464| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1465
1466**示例**:
1467
1468```js
1469try {
1470  pointer.getTouchpadPinchSwitch((error: Error, state: boolean) => {
1471    console.log(`getTouchpadPinchSwitch success, state: ${JSON.stringify(state)}`);
1472  });
1473} catch (error) {
1474  console.log(`getTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1475}
1476```
1477
1478## pointer.getTouchpadPinchSwitch<sup>10+</sup>
1479
1480getTouchpadPinchSwitch(): Promise\<boolean>
1481
1482获取触控板双指捏合功能开启状态,使用Promise异步方式返回结果。
1483
1484**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1485
1486**系统API**: 此接口为系统接口。
1487
1488**返回值**:
1489
1490| 参数                    | 说明                  |
1491| --------------------- | ------------------- |
1492| Promise\<boolean> | Promise实例,异步返回触控板双指捏合功能开启状态。true代表功能开启,false代表功能关闭,默认开启。 |
1493
1494**错误码**:
1495
1496以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1497
1498| 错误码ID  | 错误信息             |
1499| ---- | --------------------- |
1500| 202  | SystemAPI permission error.  |
1501| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1502
1503**示例**:
1504
1505```js
1506try {
1507  pointer.getTouchpadPinchSwitch().then((state: boolean) => {
1508    console.log(`getTouchpadPinchSwitch success, state: ${JSON.stringify(state)}`);
1509  });
1510} catch (error) {
1511  console.log(`getTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1512}
1513```
1514
1515## pointer.setTouchpadSwipeSwitch<sup>10+</sup>
1516
1517setTouchpadSwipeSwitch(state: boolean, callback: AsyncCallback\<void>): void
1518
1519设置触控板多指滑动功能开关,使用AsyncCallback异步方式返回结果。
1520
1521**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1522
1523**系统API**: 此接口为系统接口。
1524
1525**参数**:
1526
1527| 参数名       | 类型                        | 必填   | 说明                                    |
1528| -------- | ------------------------- | ---- | ------------------------------------- |
1529| state | boolean | 是    |触控板多指滑动开关开启状态。 true代表多指滑动开启,false代表多指滑动关闭,默认开启。   |
1530| callback | AsyncCallback\<void> | 是    | 回调函数。 |
1531
1532**错误码**:
1533
1534以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1535
1536| 错误码ID  | 错误信息             |
1537| ---- | --------------------- |
1538| 202  | SystemAPI permission error.  |
1539| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1540
1541**示例**:
1542
1543```js
1544try {
1545  pointer.setTouchpadSwipeSwitch(true, (error: Error) => {
1546    if (error) {
1547      console.log(`setTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1548      return;
1549    }
1550    console.log(`setTouchpadSwipeSwitch success`);
1551  });
1552} catch (error) {
1553  console.log(`setTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1554}
1555```
1556
1557## pointer.setTouchpadSwipeSwitch<sup>10+</sup>
1558
1559setTouchpadSwipeSwitch(state: boolean): Promise\<void>
1560
1561设置触控板多指滑动功能开关,使用Promise异步方式返回结果。
1562
1563**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1564
1565**系统API**: 此接口为系统接口。
1566
1567**参数**:
1568
1569| 参数名    | 类型     | 必填   | 说明                                  |
1570| ----- | ------ | ---- | ----------------------------------- |
1571| state | boolean| 是    |  触控板多指滑动功能开关开启状态。 true代表多指滑动开启,false代表多指滑动关闭,默认开启。  |
1572
1573**返回值**:
1574
1575| 参数                  | 说明               |
1576| ------------------- | ---------------- |
1577| Promise\<void> | Promise对象。 |
1578
1579**错误码**:
1580
1581以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1582
1583| 错误码ID  | 错误信息             |
1584| ---- | --------------------- |
1585| 202  | SystemAPI permission error.  |
1586| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1587
1588**示例**:
1589
1590```js
1591try {
1592  pointer.setTouchpadSwipeSwitch(false).then(() => {
1593    console.log(`setTouchpadSwipeSwitch success`);
1594  });
1595} catch (error) {
1596  console.log(`setTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1597}
1598```
1599
1600## pointer.getTouchpadSwipeSwitch<sup>10+</sup>
1601
1602getTouchpadSwipeSwitch(callback:  AsyncCallback\<boolean>): void
1603
1604获取触控板多指滑动功能开启状态,使用AsyncCallback异步方式返回结果。
1605
1606**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1607
1608**系统API**: 此接口为系统接口。
1609
1610**参数**:
1611
1612| 参数名       | 类型                          | 必填   | 说明             |
1613| -------- | --------------------------- | ---- | -------------- |
1614| callback | AsyncCallback\<boolean> | 是    | 回调函数,异步返回触控板多指滑动功能开启状态。 true代表多指滑动开启,false代表多指滑动关闭,默认开启。 |
1615
1616**错误码**:
1617
1618以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1619
1620| 错误码ID  | 错误信息             |
1621| ---- | --------------------- |
1622| 202  | SystemAPI permission error.  |
1623| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1624
1625**示例**:
1626
1627```js
1628try {
1629  pointer.getTouchpadSwipeSwitch((error: Error, state: boolean) => {
1630    console.log(`getTouchpadSwipeSwitch success, state: ${JSON.stringify(state)}`);
1631  });
1632} catch (error) {
1633  console.log(`getTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1634}
1635```
1636
1637## pointer.getTouchpadSwipeSwitch<sup>10+</sup>
1638
1639getTouchpadSwipeSwitch(): Promise\<boolean>
1640
1641获取触控板多指滑动功能开启状态,使用Promise异步方式返回结果。
1642
1643**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1644
1645**系统API**: 此接口为系统接口。
1646
1647**返回值**:
1648
1649| 参数                    | 说明                  |
1650| --------------------- | ------------------- |
1651| Promise\<boolean> | Promise实例,异步返回触控板多指滑动功能开启状态。 true代表多指滑动开启,false代表多指滑动关闭,默认开启。 |
1652
1653**错误码**:
1654
1655以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1656
1657| 错误码ID  | 错误信息             |
1658| ---- | --------------------- |
1659| 202  | SystemAPI permission error.  |
1660| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1661
1662**示例**:
1663
1664```js
1665try {
1666  pointer.getTouchpadSwipeSwitch().then((state: boolean) => {
1667    console.log(`getTouchpadSwipeSwitch success, state: ${JSON.stringify(state)}`);
1668  });
1669} catch (error) {
1670  console.log(`getTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1671}
1672```
1673
1674## pointer.setTouchpadRightClickType<sup>10+</sup>
1675
1676setTouchpadRightClickType(type: RightClickType, callback: AsyncCallback\<void>): void
1677
1678设置触控板右键菜单类型,使用AsyncCallback异步方式返回结果。
1679
1680**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1681
1682**系统API**: 此接口为系统接口。
1683
1684**参数**:
1685
1686| 参数名       | 类型                        | 必填   | 说明                                    |
1687| -------- | ------------------------- | ---- | ------------------------------------- |
1688| type| [RightClickType](js-apis-pointer.md#rightclicktype10)| 是    |type代表触控板右键菜单类型。<br>- TOUCHPAD_RIGHT_BUTTON:触控板右键区域。<br>- TOUCHPAD_LEFT_BUTTON:触控板左键区域。<br>- TOUCHPAD_TWO_FINGER_TAP:双指轻击或按压触控板。<br>默认为TOUCHPAD_RIGHT_BUTTON 。  |
1689| callback | AsyncCallback\<void> | 是    | 回调函数。 |
1690
1691**错误码**:
1692
1693以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1694
1695| 错误码ID  | 错误信息             |
1696| ---- | --------------------- |
1697| 202  | SystemAPI permission error.  |
1698| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1699
1700**示例**:
1701
1702```js
1703try {
1704  pointer.setTouchpadRightClickType(pointer.RightClickType.TOUCHPAD_RIGHT_BUTTON , (error: Error) => {
1705    if (error) {
1706      console.log(`setTouchpadRightClickType, error: ${JSON.stringify(error, [`code`, `message`])}`);
1707      return;
1708    }
1709    console.log(`setTouchpadRightClickType success`);
1710  });
1711} catch (error) {
1712  console.log(`setTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1713}
1714```
1715
1716## pointer.setTouchpadRightClickType<sup>10+</sup>
1717
1718setTouchpadRightClickType(type: RightClickType): Promise\<void>
1719
1720设置触控板右键菜单类型,使用Promise异步方式返回结果。
1721
1722**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1723
1724**系统API**: 此接口为系统接口。
1725
1726**参数**:
1727
1728| 参数名    | 类型     | 必填   | 说明                                  |
1729| ----- | ------ | ---- | ----------------------------------- |
1730| type| [RightClickType](js-apis-pointer.md#rightclicktype10)| 是    | type代表触控板右键菜单类型。<br>- TOUCHPAD_RIGHT_BUTTON:触控板右键区域。<br>- TOUCHPAD_LEFT_BUTTON:触控板左键区域。<br>- TOUCHPAD_TWO_FINGER_TAP:双指轻击或按压触控板。<br>默认为TOUCHPAD_RIGHT_BUTTON 。 |
1731
1732**返回值**:
1733
1734| 参数                  | 说明               |
1735| ------------------- | ---------------- |
1736| Promise\<void> | Promise对象。 |
1737
1738**错误码**:
1739
1740以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1741
1742| 错误码ID  | 错误信息             |
1743| ---- | --------------------- |
1744| 202  | SystemAPI permission error.  |
1745| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1746
1747**示例**:
1748
1749```js
1750try {
1751  pointer.setTouchpadRightClickType(pointer.RightClickType.TOUCHPAD_RIGHT_BUTTON).then(() => {
1752    console.log(`setTouchpadRightClickType success`);
1753  });
1754} catch (error) {
1755  console.log(`setTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1756}
1757```
1758
1759## pointer.getTouchpadRightClickType<sup>10+</sup>
1760
1761getTouchpadRightClickType(callback: AsyncCallback\<RightClickType>): void
1762
1763获取触控板右键菜单类型,使用AsyncCallback异步方式返回结果。
1764
1765**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1766
1767**系统API**: 此接口为系统接口。
1768
1769**参数**:
1770
1771| 参数名       | 类型                          | 必填   | 说明             |
1772| -------- | --------------------------- | ---- | -------------- |
1773| callback | AsyncCallback\<[RightClickType](js-apis-pointer.md#rightclicktype10)> | 是    | 回调函数,异步返回触控板右键菜单类型。 |
1774
1775**错误码**:
1776
1777以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1778
1779| 错误码ID  | 错误信息             |
1780| ---- | --------------------- |
1781| 202  | SystemAPI permission error.  |
1782| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1783
1784**示例**:
1785
1786```js
1787try {
1788  pointer.getTouchpadRightClickType((error: Error, type: pointer.RightClickType) => {
1789    console.log(`getTouchpadRightClickType success, type: ${JSON.stringify(type)}`);
1790  });
1791} catch (error) {
1792  console.log(`getTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1793}
1794```
1795
1796## pointer.getTouchpadRightClickType<sup>10+</sup>
1797
1798getTouchpadRightClickType(): Promise\<RightClickType>
1799
1800获取触控板右键菜单类型,使用Promise异步方式返回结果。
1801
1802**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1803
1804**系统API**: 此接口为系统接口。
1805
1806**返回值**:
1807
1808| 参数                    | 说明                  |
1809| --------------------- | ------------------- |
1810| Promise\<[RightClickType](js-apis-pointer.md#rightclicktype10) > | Promise实例,异步返回触控板右键菜单类型。 |
1811
1812**错误码**:
1813
1814以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1815
1816| 错误码ID  | 错误信息             |
1817| ---- | --------------------- |
1818| 202  | SystemAPI permission error.  |
1819| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1820
1821**示例**:
1822
1823```js
1824try {
1825  pointer.getTouchpadRightClickType().then((type: pointer.RightClickType) => {
1826    console.log(`getTouchpadRightClickType success, typeed: ${JSON.stringify(type)}`);
1827  });
1828} catch (error) {
1829  console.log(`getTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1830}
1831```
1832
1833## pointer.setPointerSize<sup>10+</sup>
1834
1835setPointerSize(size: number, callback: AsyncCallback&lt;void&gt;): void
1836
1837设置鼠标光标大小,使用AsyncCallback异步方式返回结果。
1838
1839**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1840
1841**系统API**: 此接口为系统接口。
1842
1843**参数**:
1844
1845| 参数名       | 类型                        | 必填   | 说明                                    |
1846| -------- | ------------------------- | ---- | ------------------------------------- |
1847| size     | number                    | 是    | 鼠标光标大小,范围为[1-7],默认为1。   |
1848| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数,当设置成功时,err为undefined,否则为错误对象。 |
1849
1850**错误码**:
1851
1852以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1853
1854| 错误码ID  | 错误信息             |
1855| ---- | --------------------- |
1856| 202  | SystemAPI permission error.  |
1857| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1858
1859**示例**:
1860
1861```js
1862try {
1863  pointer.setPointerSize(1, (error: Error) => {
1864    if (error) {
1865      console.log(`setPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1866      return;
1867    }
1868    console.log(`setPointerSize success`);
1869  });
1870} catch (error) {
1871  console.log(`setPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1872}
1873```
1874
1875## pointer.setPointerSize<sup>10+</sup>
1876
1877setPointerSize(size: number): Promise&lt;void&gt;
1878
1879设置鼠标光标大小,使用Promise异步方式返回结果。
1880
1881**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1882
1883**系统API**: 此接口为系统接口。
1884
1885**参数**:
1886
1887| 参数名    | 类型     | 必填   | 说明                                  |
1888| ----- | ------ | ---- | ----------------------------------- |
1889| size  | number | 是    | 鼠标光标大小,范围为[1-7],默认为1。 |
1890
1891**返回值**:
1892
1893| 参数                  | 说明               |
1894| ------------------- | ---------------- |
1895| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
1896
1897**错误码**:
1898
1899以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1900
1901| 错误码ID  | 错误信息             |
1902| ---- | --------------------- |
1903| 202  | SystemAPI permission error.  |
1904| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1905
1906**示例**:
1907
1908```js
1909try {
1910  pointer.setPointerSize(3).then(() => {
1911    console.log(`setPointerSize success`);
1912  });
1913} catch (error) {
1914  console.log(`setPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1915}
1916```
1917
1918## pointer.setPointerSizeSync<sup>10+</sup>
1919
1920setPointerSizeSync(size: number): void;
1921
1922设置鼠标光标大小,使用同步方式进行设置。
1923
1924**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1925
1926**系统API**: 此接口为系统接口。
1927
1928**参数**:
1929
1930| 参数名    | 类型     | 必填   | 说明                                  |
1931| ----- | ------ | ---- | ----------------------------------- |
1932| size  | number | 是    | 鼠标光标大小,范围为[1-7],默认为1。 |
1933
1934**错误码**:
1935
1936以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1937
1938| 错误码ID  | 错误信息             |
1939| ---- | --------------------- |
1940| 202  | SystemAPI permission error.  |
1941| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1942
1943**示例**:
1944
1945```js
1946try {
1947  pointer.setPointerSizeSync(5);
1948  console.log(`setPointerSizeSync success`);
1949} catch (error) {
1950  console.log(`setPointerSizeSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1951}
1952```
1953
1954## pointer.getPointerSize<sup>10+</sup>
1955
1956getPointerSize(callback: AsyncCallback&lt;number&gt;): void
1957
1958获取鼠标光标大小,使用AsyncCallback异步方式返回结果。
1959
1960**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1961
1962**系统API**: 此接口为系统接口。
1963
1964**参数**:
1965
1966| 参数名       | 类型                          | 必填   | 说明             |
1967| -------- | --------------------------- | ---- | -------------- |
1968| callback | AsyncCallback&lt;number&gt; | 是    | 回调函数,异步返回鼠标光标大小。 |
1969
1970**错误码**:
1971
1972以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
1973
1974| 错误码ID  | 错误信息             |
1975| ---- | --------------------- |
1976| 202  | SystemAPI permission error.  |
1977| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
1978
1979**示例**:
1980
1981```js
1982try {
1983  pointer.getPointerSize((error: Error, size: number) => {
1984    console.log(`getPointerSize success, size: ${JSON.stringify(size)}`);
1985  });
1986} catch (error) {
1987  console.log(`getPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
1988}
1989```
1990
1991## pointer.getPointerSize<sup>10+</sup>
1992
1993getPointerSize(): Promise&lt;number&gt;
1994
1995获取当前鼠标光标大小,使用Promise异步方式返回结果。
1996
1997**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
1998
1999**系统API**: 此接口为系统接口。
2000
2001**返回值**:
2002
2003| 参数                    | 说明                  |
2004| --------------------- | ------------------- |
2005| Promise&lt;number&gt; | Promise对象,异步返回鼠标光标大小。 |
2006
2007**错误码**:
2008
2009以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
2010
2011| 错误码ID  | 错误信息             |
2012| ---- | --------------------- |
2013| 202  | SystemAPI permission error.  |
2014
2015
2016**示例**:
2017
2018```js
2019try {
2020  pointer.getPointerSize().then((size: number) => {
2021    console.log(`getPointerSize success, size: ${JSON.stringify(size)}`);
2022  });
2023} catch (error) {
2024  console.log(`getPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
2025}
2026```
2027
2028## pointer.getPointerSizeSync<sup>10+</sup>
2029
2030getPointerSizeSync(): number
2031
2032获取鼠标光标大小,使用同步方式返回结果。
2033
2034**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
2035
2036**系统API**: 此接口为系统接口。
2037
2038**返回值**:
2039
2040| 参数                    | 说明                  |
2041| --------------------- | ------------------- |
2042| number | 鼠标光标大小。 |
2043
2044**错误码**:
2045
2046以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
2047
2048| 错误码ID  | 错误信息             |
2049| ---- | --------------------- |
2050| 202  | SystemAPI permission error.  |
2051
2052
2053**示例**:
2054
2055```js
2056try {
2057  let pointerSize = pointer.getPointerSizeSync();
2058  console.log(`getPointerSizeSync success, pointerSize: ${JSON.stringify(pointerSize)}`);
2059} catch (error) {
2060  console.log(`getPointerSizeSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
2061}
2062```
2063
2064## pointer.setPointerColor<sup>10+</sup>
2065
2066setPointerColor(color: number, callback: AsyncCallback&lt;void&gt;): void
2067
2068设置鼠标光标颜色,使用AsyncCallback异步方式返回结果。
2069
2070**说明**
2071>
2072> 设置和调试时,需连接外部设备,如鼠标、蓝牙等。
2073
2074**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
2075
2076**系统API**: 此接口为系统接口。
2077
2078**参数**:
2079
2080| 参数名       | 类型                        | 必填   | 说明                                    |
2081| -------- | ------------------------- | ---- | ------------------------------------- |
2082| color     | number                    | 是    | 鼠标光标颜色,默认为黑色:0x000000。   |
2083| callback | AsyncCallback&lt;void&gt; | 是    | 回调函数,当设置成功时,err为undefined,否则为错误对象。 |
2084
2085**错误码**:
2086
2087以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
2088
2089| 错误码ID  | 错误信息             |
2090| ---- | --------------------- |
2091| 202  | SystemAPI permission error.  |
2092| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
2093
2094**示例**:
2095
2096```js
2097try {
2098  pointer.setPointerColor(0xF6C800, (error: Error) => {
2099    if (error) {
2100      console.log(`setPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
2101      return;
2102    }
2103    console.log(`setPointerColor success`);
2104  });
2105} catch (error) {
2106  console.log(`setPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
2107}
2108```
2109
2110## pointer.setPointerColor<sup>10+</sup>
2111
2112setPointerColor(color: number): Promise&lt;void&gt;
2113
2114设置鼠标光标颜色,使用Promise异步方式返回结果。
2115
2116**说明**
2117>
2118> 设置和调试时,需连接外部设备,如鼠标、蓝牙等。
2119
2120**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
2121
2122**系统API**: 此接口为系统接口。
2123
2124**参数**:
2125
2126| 参数名    | 类型     | 必填   | 说明                                  |
2127| ----- | ------ | ---- | ----------------------------------- |
2128| color  | number | 是    | 鼠标光标颜色,默认为黑色:0x000000。 |
2129
2130**返回值**:
2131
2132| 参数                  | 说明               |
2133| ------------------- | ---------------- |
2134| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
2135
2136**错误码**:
2137
2138以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
2139
2140| 错误码ID  | 错误信息             |
2141| ---- | --------------------- |
2142| 202  | SystemAPI permission error.  |
2143| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
2144
2145**示例**:
2146
2147```js
2148try {
2149  pointer.setPointerColor(0xF6C800).then(() => {
2150    console.log(`setPointerColor success`);
2151  });
2152} catch (error) {
2153  console.log(`setPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
2154}
2155```
2156
2157## pointer.setPointerColorSync<sup>10+</sup>
2158
2159setPointerColorSync(color: number): void;
2160
2161设置鼠标光标颜色,使用同步方式进行设置。
2162
2163**说明**
2164>
2165> 设置和调试时,需连接外部设备,如鼠标、蓝牙等。
2166
2167**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
2168
2169**系统API**: 此接口为系统接口。
2170
2171**参数**:
2172
2173| 参数名    | 类型     | 必填   | 说明                                  |
2174| ----- | ------ | ---- | ----------------------------------- |
2175| color  | number | 是    | 鼠标光标颜色,默认为黑色:0x000000。 |
2176
2177**错误码**:
2178
2179以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
2180
2181| 错误码ID  | 错误信息             |
2182| ---- | --------------------- |
2183| 202  | SystemAPI permission error.  |
2184| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
2185
2186**示例**:
2187
2188```js
2189try {
2190  pointer.setPointerColorSync(0xF6C800);
2191  console.log(`setPointerColorSync success`);
2192} catch (error) {
2193  console.log(`setPointerColorSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
2194}
2195```
2196
2197## pointer.getPointerColor<sup>10+</sup>
2198
2199getPointerColor(callback: AsyncCallback&lt;number&gt;): void
2200
2201获取鼠标光标颜色,使用AsyncCallback异步方式返回结果。
2202
2203**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
2204
2205**系统API**: 此接口为系统接口。
2206
2207**参数**:
2208
2209| 参数名       | 类型                          | 必填   | 说明             |
2210| -------- | --------------------------- | ---- | -------------- |
2211| callback | AsyncCallback&lt;number&gt; | 是    | 回调函数,异步返回鼠标光标颜色。 |
2212
2213**错误码**:
2214
2215以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
2216
2217| 错误码ID  | 错误信息             |
2218| ---- | --------------------- |
2219| 202  | SystemAPI permission error.  |
2220| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
2221
2222**示例**:
2223
2224```js
2225try {
2226  pointer.getPointerColor((error: Error, color: number) => {
2227    console.log(`getPointerColor success, color: ${JSON.stringify(color)}`);
2228  });
2229} catch (error) {
2230  console.log(`getPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
2231}
2232```
2233
2234## pointer.getPointerColor<sup>10+</sup>
2235
2236getPointerColor(): Promise&lt;number&gt;
2237
2238获取当前鼠标光标颜色,使用Promise异步方式返回结果。
2239
2240**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
2241
2242**系统API**: 此接口为系统接口。
2243
2244**返回值**:
2245
2246| 参数                    | 说明                  |
2247| --------------------- | ------------------- |
2248| Promise&lt;number&gt; | Promise对象,异步返回鼠标光标颜色。 |
2249
2250**错误码**:
2251
2252以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
2253
2254| 错误码ID  | 错误信息             |
2255| ---- | --------------------- |
2256| 202  | SystemAPI permission error.  |
2257
2258
2259**示例**:
2260
2261```js
2262try {
2263  pointer.getPointerColor().then((color: number) => {
2264    console.log(`getPointerColor success, color: ${JSON.stringify(color)}`);
2265  });
2266} catch (error) {
2267  console.log(`getPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
2268}
2269```
2270
2271## pointer.getPointerColorSync<sup>10+</sup>
2272
2273getPointerColorSync(): number
2274
2275获取鼠标光标颜色,使用同步方式返回结果。
2276
2277**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
2278
2279**系统API**: 此接口为系统接口。
2280
2281**返回值**:
2282
2283| 参数                    | 说明                  |
2284| --------------------- | ------------------- |
2285| number | 鼠标光标颜色。 |
2286
2287**错误码**:
2288
2289以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
2290
2291| 错误码ID  | 错误信息             |
2292| ---- | --------------------- |
2293| 202  | SystemAPI permission error.  |
2294
2295
2296**示例**:
2297
2298```js
2299try {
2300  let pointerColor = pointer.getPointerColorSync();
2301  console.log(`getPointerColorSync success, pointerColor: ${JSON.stringify(pointerColor)}`);
2302} catch (error) {
2303  console.log(`getPointerColorSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
2304}
2305```
2306
2307## pointer.setTouchpadDoubleTapAndDragState<sup>14+</sup>
2308
2309setTouchpadDoubleTapAndDragState(isOpen: boolean, callback: AsyncCallback\<void>): void
2310
2311设置触控板双击拖拽开关状态,使用AsyncCallback异步方式返回结果。
2312
2313**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
2314
2315**系统API**: 此接口为系统接口。
2316
2317**参数**:
2318
2319| 参数名       | 类型                        | 必填   | 说明                                    |
2320| -------- | ------------------------- | ---- | ------------------------------------- |
2321| isOpen | boolean | 是    | 双击拖拽开关的状态,true代表开启,false代表关闭。|
2322| callback | AsyncCallback\<void> | 是    | 回调函数。|
2323
2324**错误码**:
2325
2326以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
2327
2328| 错误码ID  | 错误信息             |
2329| ---- | --------------------- |
2330| 202  | SystemAPI permission error.  |
2331| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
2332
2333**示例**:
2334
2335```js
2336try {
2337  pointer.setTouchpadDoubleTapAndDragState(true, (error: Error) => {
2338    if (error) {
2339      console.log(`setTouchpadDoubleTapAndDragState failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
2340      return;
2341    }
2342    console.log(`setTouchpadDoubleTapAndDragState success`);
2343  });
2344} catch (error) {
2345  console.log(`setTouchpadDoubleTapAndDragState failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
2346}
2347```
2348
2349## pointer.setTouchpadDoubleTapAndDragState<sup>14+</sup>
2350
2351setTouchpadDoubleTapAndDragState(isOpen: boolean): Promise\<void>
2352
2353设置触控板双击拖拽开关状态,使用Promise异步方式返回结果。
2354
2355**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
2356
2357**系统API**: 此接口为系统接口。
2358
2359**参数**:
2360
2361| 参数名    | 类型     | 必填   | 说明                                  |
2362| ----- | ------ | ---- | ----------------------------------- |
2363| state | boolean| 是    |  双击拖拽开关的状态,true代表开启,false代表关闭。 |
2364
2365**返回值**:
2366
2367| 参数                  | 说明               |
2368| ------------------- | ---------------- |
2369| Promise\<void> | 无返回结果的Promise对象。 |
2370
2371**错误码**:
2372
2373以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
2374
2375| 错误码ID  | 错误信息             |
2376| ---- | --------------------- |
2377| 202  | SystemAPI permission error.  |
2378| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
2379
2380**示例**:
2381
2382```js
2383try {
2384  pointer.setTouchpadDoubleTapAndDragState(false).then(() => {
2385    console.log(`setTouchpadDoubleTapAndDragState success`);
2386  });
2387} catch (error) {
2388  console.log(`setTouchpadDoubleTapAndDragState failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
2389}
2390```
2391
2392## pointer.getTouchpadDoubleTapAndDragState<sup>14+</sup>
2393
2394getTouchpadDoubleTapAndDragState(callback: AsyncCallback\<boolean>): void
2395
2396获取触控板双击拖拽开关的开启状态,使用AsyncCallback异步方式返回结果。
2397
2398**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
2399
2400**系统API**: 此接口为系统接口。
2401
2402**参数**:
2403
2404| 参数名       | 类型                          | 必填   | 说明             |
2405| -------- | --------------------------- | ---- | -------------- |
2406| callback | AsyncCallback\<boolean> | 是    | 回调函数,异步返回触控板双击拖拽开关的开启状态。返回true代表开启,返回false代表关闭。 |
2407
2408**错误码**:
2409
2410以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
2411
2412| 错误码ID  | 错误信息             |
2413| ---- | --------------------- |
2414| 202  | SystemAPI permission error.  |
2415| 401  | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed. |
2416
2417**示例**:
2418
2419```js
2420try {
2421  pointer.getTouchpadDoubleTapAndDragState((error: Error, state: boolean) => {
2422    console.log(`getTouchpadDoubleTapAndDragState success, state: ${JSON.stringify(state)}`);
2423  });
2424} catch (error) {
2425  console.log(`getTouchpadDoubleTapAndDragState failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
2426}
2427```
2428
2429## pointer.getTouchpadDoubleTapAndDragState<sup>14+</sup>
2430
2431getTouchpadDoubleTapAndDragState(): Promise\<boolean>
2432
2433获取触控板双击拖拽开关的开启状态,使用Promise异步方式返回结果。
2434
2435**系统能力**:SystemCapability.MultimodalInput.Input.Pointer
2436
2437**系统API**: 此接口为系统接口。
2438
2439**返回值**:
2440
2441| 参数                    | 说明                  |
2442| --------------------- | ------------------- |
2443| Promise\<boolean> | Promise实例,异步返回触控板双击拖拽开启状态。true代表开启,false代表关闭。|
2444
2445**错误码**:
2446
2447以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。
2448
2449| 错误码ID  | 错误信息             |
2450| ---- | --------------------- |
2451| 202  | SystemAPI permission error.  |
2452
2453**示例**:
2454
2455```js
2456try {
2457  pointer.getTouchpadDoubleTapAndDragState().then((state) => {
2458    console.log(`getTouchpadDoubleTapAndDragState success, state: ${JSON.stringify(state)}`);
2459  });
2460} catch (error) {
2461  console.log(`getTouchpadDoubleTapAndDragState failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
2462}
2463```