harmony 鸿蒙@ohos.multimodalInput.pointer (Mouse Pointer) (System API)

2025-06-12
浏览 (4)

@ohos.multimodalInput.pointer (Mouse Pointer) (System API)

The pointer module provides APIs related to pointer attribute management.

NOTE

The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

This topic describes only system APIs provided by the module. For details about its public APIs, see @ohos.multimodalInput.pointer (Mouse Pointer).

Modules to Import

import { pointer } from '@kit.InputKit';

pointer.setPointerSpeed

setPointerSpeed(speed: number, callback: AsyncCallback<void>): void

Sets the moving speed of the mouse pointer. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
speed	number	Yes	Moving speed of the mouse pointer. The value ranges from 1 to 20. The default value is 10.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.2.Incorrect parameter types.3.Parameter verification failed.

Example

try {
  pointer.setPointerSpeed(5, (error: Error) => {
    if (error) {
      console.error(`Set pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`Set pointer speed success`);
  });
} catch (error) {
  console.error(`Set pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setPointerSpeed

setPointerSpeed(speed: number): Promise<void>

Sets the moving speed of the mouse pointer. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
speed	number	Yes	Moving speed of the mouse pointer. The value ranges from 1 to 20. The default value is 10.

Return value

Name	Description
Promise<void>	Promise used to return the result.

Error codes

For details about the following error codes, see Screen Hopping Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified.2.Incorrect parameter types.3.Parameter verification failed.

Example

try {
  pointer.setPointerSpeed(5).then(() => {
    console.log(`Set pointer speed success`);
  });
} catch (error) {
  console.error(`Set pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setPointerSpeedSync¹⁰⁺

setPointerSpeedSync(speed: number): void

Sets the moving speed of the mouse pointer. This API returns the result synchronously.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
speed	number	Yes	Moving speed of the mouse pointer. The value ranges from 1 to 20. The default value is 10.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  let speed = pointer.setPointerSpeedSync(5);
  console.log(`Set pointer speed success`);
} catch (error) {
  console.error(`Set pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getPointerSpeed

getPointerSpeed(callback: AsyncCallback<number>): void

Obtains the moving speed of the mouse pointer. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<number>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getPointerSpeed((error: Error, speed: number) => {
    if (error) {
      console.error(`Get pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`Get pointer speed success, speed: ${JSON.stringify(speed)}`);
  });
} catch (error) {
  console.error(`Get pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getPointerSpeed

getPointerSpeed(): Promise<number>

Obtains the moving speed of the mouse pointer. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Return value

Name	Description
Promise<number>	Promise used to return the result.

Example

try {
  pointer.getPointerSpeed().then(speed => {
    console.log(`Get pointer speed success, speed: ${JSON.stringify(speed)}`);
  });
} catch (error) {
  console.error(`Get pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getPointerSpeedSync¹⁰⁺

getPointerSpeedSync(): number

Obtains the moving speed of the mouse pointer. This API returns the result synchronously.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Return value

Name	Description
number	Moving speed of the mouse pointer.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  let speed = pointer.getPointerSpeedSync();
  console.log(`Get pointer speed success, speed: ${JSON.stringify(speed)}`);
} catch (error) {
  console.error(`Get pointer speed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setHoverScrollState¹⁰⁺

setHoverScrollState(state: boolean, callback: AsyncCallback<void>): void

Sets the status of the mouse hover scroll switch. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
state	boolean	Yes	Status of the mouse hover scroll switch. The value true indicates that the switch is enabled, and the value false indicates the opposite.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setHoverScrollState(true, (error: Error) => {
    if (error) {
      console.error(`Set the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`Set the mouse hover scroll success`);
  });
} catch (error) {
  console.error(`Set the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setHoverScrollState¹⁰⁺

setHoverScrollState(state: boolean): Promise<void>

Sets the status of the mouse hover scroll switch. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
state	boolean	Yes	Status of the mouse hover scroll switch. The value true indicates that the switch is enabled, and the value false indicates the opposite.

Return value

Name	Description
Promise<void>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setHoverScrollState(true).then(() => {
    console.log(`Set the mouse hover scroll success`);
  });
} catch (error) {
  console.error(`Set the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getHoverScrollState¹⁰⁺

getHoverScrollState(callback: AsyncCallback<boolean>): void

Obtains the status of the mouse hover scroll switch. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. The value true indicates that the switch is enabled, and the value false indicates the opposite.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getHoverScrollState((error: Error, state: boolean) => {
    console.log(`Get the mouse hover scroll success, state: ${JSON.stringify(state)}`);
  });
} catch (error) {
  console.error(`Get the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getHoverScrollState¹⁰⁺

getHoverScrollState(): Promise<boolean>

Obtains the status of the mouse hover scroll switch. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Return value

Name	Description
Promise<boolean>	Promise used to return the result. The value true indicates that the switch is enabled, and the value false indicates the opposite.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getHoverScrollState().then((state: boolean) => {
    console.log(`Get the mouse hover scroll success, state: ${JSON.stringify(state)}`);
  });
} catch (error) {
  console.error(`Get the mouse hover scroll failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setMousePrimaryButton¹⁰⁺

setMousePrimaryButton(primary: PrimaryButton, callback: AsyncCallback<void>): void

Sets the primary button of the mouse. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
primary	PrimaryButton	Yes	ID of the primary mouse button.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setMousePrimaryButton(pointer.PrimaryButton.RIGHT, (error: Error) => {
    if (error) {
      console.error(`Set mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`Set mouse primary button success`);
  });
} catch (error) {
  console.error(`Set mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setMousePrimaryButton¹⁰⁺

setMousePrimaryButton(primary: PrimaryButton): Promise<void>

Sets the primary button of the mouse. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
primary	PrimaryButton	Yes	ID of the primary mouse button.

Return value

Name	Description
Promise<void>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setMousePrimaryButton(pointer.PrimaryButton.RIGHT).then(() => {
    console.log(`Set mouse primary button success`);
  });
} catch (error) {
  console.error(`Set mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getMousePrimaryButton¹⁰⁺

getMousePrimaryButton(callback: AsyncCallback<PrimaryButton>): void

Obtains the primary button of the mouse. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<PrimaryButton>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getMousePrimaryButton((error: Error, primary: pointer.PrimaryButton) => {
    console.log(`Get mouse primary button success, primary: ${JSON.stringify(primary)}`);
  });
} catch (error) {
  console.error(`Get mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getMousePrimaryButton¹⁰⁺

getMousePrimaryButton(): Promise<PrimaryButton>

Obtains the primary button of the mouse. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Return value

Name	Description
Promise<PrimaryButton>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getMousePrimaryButton().then((primary: pointer.PrimaryButton) => {
    console.log(`Get mouse primary button success, primary: ${JSON.stringify(primary)}`);
  });
} catch (error) {
  console.error(`Get mouse primary button failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setMouseScrollRows¹⁰⁺

setMouseScrollRows(rows: number, callback: AsyncCallback<void>): void

Sets the number of mouse scroll rows. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
rows	number	Yes	Number of mouse scroll rows. The value ranges from 1 to 100. The default value is 3.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setMouseScrollRows(1, (error: Error) => {
    if (error) {
      console.error(`setMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`setMouseScrollRows success`);
  });
} catch (error) {
  console.error(`setMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setMouseScrollRows¹⁰⁺

setMouseScrollRows(rows: number): Promise<void>

Sets the number of mouse scroll rows. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
rows	number	Yes	Number of mouse scroll rows. The value ranges from 1 to 100. The default value is 3.

Return value

Name	Description
Promise<void>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setMouseScrollRows(20).then(() => {
    console.log(`setMouseScrollRows success`);
  });
} catch (error) {
  console.error(`setMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getMouseScrollRows¹⁰⁺

getMouseScrollRows(callback: AsyncCallback<number>): void

Obtains the number of mouse scroll rows. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<number>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getMouseScrollRows((error: Error, rows: number) => {
    console.log(`getMouseScrollRows success, rows: ${JSON.stringify(rows)}`);
  });
} catch (error) {
  console.error(`getMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getMouseScrollRows¹⁰⁺

getMouseScrollRows(): Promise<number>

Obtains the moving speed of the mouse pointer. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Return value

Name	Description
Promise<number>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getMouseScrollRows().then((rows: number) => {
    console.log(`getMouseScrollRows success, rows: ${JSON.stringify(rows)}`);
  });
} catch (error) {
  console.error(`getMouseScrollRows failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setTouchpadScrollSwitch¹⁰⁺

setTouchpadScrollSwitch(state: boolean, callback: AsyncCallback<void>): void

Sets the scroll switch of the touchpad. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
state	boolean	Yes	Scroll switch status. The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setTouchpadScrollSwitch(true, (error: Error) => {
    if (error) {
      console.error(`setTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`setTouchpadScrollSwitch success`);
  });
} catch (error) {
  console.error(`setTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setTouchpadScrollSwitch¹⁰⁺

setTouchpadScrollSwitch(state: boolean): Promise<void>

Sets the scroll switch of the touchpad. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
state	boolean	Yes	Scroll switch status. The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.

Return value

Name	Description
Promise<void>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setTouchpadScrollSwitch(false).then(() => {
    console.log(`setTouchpadScrollSwitch success`);
  });
} catch (error) {
  console.error(`setTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getTouchpadScrollSwitch¹⁰⁺

getTouchpadScrollSwitch(callback: AsyncCallback<boolean>): void

Obtains the scroll switch status of the touchpad. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getTouchpadScrollSwitch((error: Error, state: boolean) => {
    console.log(`getTouchpadScrollSwitch success, state: ${JSON.stringify(state)}`);
  });
} catch (error) {
  console.error(`getTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getTouchpadScrollSwitch¹⁰⁺

getTouchpadScrollSwitch(): Promise<boolean>

Obtains the scroll switch status of the touchpad. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Return value

Name	Description
Promise<boolean>	Promise used to return the result. The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getTouchpadScrollSwitch().then((state) => {
    console.log(`getTouchpadScrollSwitch success, state: ${JSON.stringify(state)}`);
  });
} catch (error) {
  console.error(`getTouchpadScrollSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setTouchpadScrollDirection¹⁰⁺

setTouchpadScrollDirection(state: boolean, callback: AsyncCallback<void>): void

Sets the scroll direction of the touchpad. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
state	boolean	Yes	Scroll direction of the touchpad. The value true indicates that the scroll direction is the same as the finger moving direction, and the value false indicates the opposite. The default value is true.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setTouchpadScrollDirection(true, (error: Error) => {
    if (error) {
      console.error(`setTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`setTouchpadScrollDirection success`);
  });
} catch (error) {
  console.error(`setTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setTouchpadScrollDirection¹⁰⁺

setTouchpadScrollDirection(state: boolean): Promise<void>

Sets the scroll direction of the touchpad. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
state	boolean	Yes	Scroll direction of the touchpad. The value true indicates that the scroll direction is the same as the finger moving direction, and the value false indicates the opposite. The default value is true.

Return value

Name	Description
Promise<void>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setTouchpadScrollDirection (false).then(() => {
    console.log(`setTouchpadScrollDirection success`);
  });
} catch (error) {
  console.error(`setTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getTouchpadScrollDirection¹⁰⁺

getTouchpadScrollDirection(callback: AsyncCallback<boolean>): void

Obtains the scroll direction of the touchpad. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. The value true indicates that the scroll direction is the same as the finger moving direction, and the value false indicates the opposite. The default value is true.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getTouchpadScrollDirection ((error: Error, state: boolean) => {
    console.log(`getTouchpadScrollDirection success, state: ${JSON.stringify(state)}`);
  });
} catch (error) {
  console.error(`getTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getTouchpadScrollDirection¹⁰⁺

getTouchpadScrollDirection(): Promise<boolean>

Obtains the scroll direction of the touchpad. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Return value

Name	Description
Promise<boolean>	Promise used to return the result. The value true indicates that the scroll direction is the same as the finger moving direction, and the value false indicates the opposite. The default value is true.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getTouchpadScrollDirection().then((state: boolean) => {
    console.log(`getTouchpadScrollDirection success, state: ${JSON.stringify(state)}`);
  });
} catch (error) {
  console.error(`getTouchpadScrollDirection failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setTouchpadTapSwitch¹⁰⁺

setTouchpadTapSwitch(state: boolean, callback: AsyncCallback<void>): void

Sets the tap switch of the touchpad. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
state	boolean	Yes	Tap switch status of the touchpad The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setTouchpadTapSwitch(true, (error: Error) => {
    if (error) {
      console.error(`setTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`setTouchpadTapSwitch success`);
  });
} catch (error) {
  console.error(`setTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setTouchpadTapSwitch ¹⁰⁺

setTouchpadTapSwitch(state: boolean): Promise<void>

Sets the tap switch of the touchpad. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
state	boolean	Yes	Tap switch status of the touchpad. The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.

Return value

Name	Description
Promise<void>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setTouchpadTapSwitch(false).then(() => {
    console.log(`setTouchpadTapSwitch success`);
  });
} catch (error) {
  console.error(`setTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getTouchpadTapSwitch¹⁰⁺

getTouchpadTapSwitch(callback: AsyncCallback<boolean>): void

Obtains the tap switch status of the touchpad. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getTouchpadTapSwitch((error: Error, state: boolean) => {
    console.log(`getTouchpadTapSwitch success, state: ${JSON.stringify(state)}`);
  });
} catch (error) {
  console.error(`getTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getTouchpadTapSwitch¹⁰⁺

getTouchpadTapSwitch(): Promise<boolean>

Obtains the tap switch status of the touchpad. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Return value

Name	Description
Promise<boolean>	Promise used to return the result. The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getTouchpadTapSwitch().then((state: boolean) => {
    console.log(`getTouchpadTapSwitch success, state: ${JSON.stringify(state)}`);
  });
} catch (error) {
  console.error(`getTouchpadTapSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setTouchpadPointerSpeed¹⁰⁺

setTouchpadPointerSpeed(speed: number, callback: AsyncCallback<void>): void

Sets the mouse pointer moving speed of the touchpad. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
speed	number	Yes	Mouse pointer moving speed of the touchpad. The value range is [1,11]. The default value is 6.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setTouchpadPointerSpeed(1, (error: Error) => {
    if (error) {
      console.error(`setTouchpadPointerSpeedfailed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`setTouchpadPointerSpeed success`);
  });
} catch (error) {
  console.error(`setTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setTouchpadPointerSpeed¹⁰⁺

setTouchpadPointerSpeed(speed: number): Promise<void>

Sets the mouse pointer moving speed of the touchpad. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
speed	number	Yes	Mouse pointer moving speed of the touchpad. The value range is [1,11]. The default value is 6.

Return value

Name	Description
Promise<void>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setTouchpadPointerSpeed(10).then(() => {
    console.log(`setTouchpadPointerSpeed success`);
  });
} catch (error) {
  console.error(`setTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getTouchpadPointerSpeed¹⁰⁺

getTouchpadPointerSpeed(callback: AsyncCallback<number>): void

Obtains the mouse pointer moving speed of the touchpad. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<number>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getTouchpadPointerSpeed((error: Error, speed: number) => {
    console.log(`getTouchpadPointerSpeed success, speed: ${JSON.stringify(speed)}`);
  });
} catch (error) {
  console.error(`getTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getTouchpadPointerSpeed¹⁰⁺

getTouchpadPointerSpeed(): Promise<number>

Obtains the mouse pointer moving speed of the touchpad. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Return value

Name	Description
Promise<number>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getTouchpadPointerSpeed().then((speed: number) => {
    console.log(`getTouchpadPointerSpeed success, speed: ${JSON.stringify(speed)}`);
  });
} catch (error) {
  console.error(`getTouchpadPointerSpeed failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setTouchpadPinchSwitch¹⁰⁺

setTouchpadPinchSwitch(state: boolean, callback: AsyncCallback<void>): void

Sets the pinch switch of the touchpad. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
state	boolean	Yes	Pinch switch status of the touchpad. The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setTouchpadTapSwitch(true, (error: Error) => {
    if (error) {
      console.error(`setTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`setTouchpadPinchSwitch success`);
  });
} catch (error) {
  console.error(`setTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setTouchpadPinchSwitch¹⁰⁺

setTouchpadPinchSwitch(state: boolean): Promise<void>

Sets the pinch switch of the touchpad. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
state	boolean	Yes	Pinch switch status of the touchpad. The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.

Return value

Name	Description
Promise<void>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setTouchpadPinchSwitch(false).then(() => {
    console.log(`setTouchpadPinchSwitch success`);
  });
} catch (error) {
  console.error(`setTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getTouchpadPinchSwitch¹⁰⁺

getTouchpadPinchSwitch(callback: AsyncCallback<boolean>): void

Obtains the pinch switch status of the touchpad. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getTouchpadPinchSwitch((error: Error, state: boolean) => {
    console.log(`getTouchpadPinchSwitch success, state: ${JSON.stringify(state)}`);
  });
} catch (error) {
  console.error(`getTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getTouchpadPinchSwitch¹⁰⁺

getTouchpadPinchSwitch(): Promise<boolean>

Obtains the pinch switch status of the touchpad. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Return value

Name	Description
Promise<boolean>	Promise used to return the result. The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getTouchpadPinchSwitch().then((state: boolean) => {
    console.log(`getTouchpadPinchSwitch success, state: ${JSON.stringify(state)}`);
  });
} catch (error) {
  console.error(`getTouchpadPinchSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setTouchpadSwipeSwitch¹⁰⁺

setTouchpadSwipeSwitch(state: boolean, callback: AsyncCallback<void>): void

Sets the multi-finger swipe switch of the touchpad. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
state	boolean	Yes	Swipe switch status of the touchpad. The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setTouchpadSwipeSwitch(true, (error: Error) => {
    if (error) {
      console.error(`setTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`setTouchpadSwipeSwitch success`);
  });
} catch (error) {
  console.error(`setTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setTouchpadSwipeSwitch¹⁰⁺

setTouchpadSwipeSwitch(state: boolean): Promise<void>

Sets the swipe switch of the touchpad. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
state	boolean	Yes	Swipe switch status of the touchpad. The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.

Return value

Name	Description
Promise<void>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setTouchpadSwipeSwitch(false).then(() => {
    console.log(`setTouchpadSwipeSwitch success`);
  });
} catch (error) {
  console.error(`setTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getTouchpadSwipeSwitch¹⁰⁺

getTouchpadSwipeSwitch(callback: AsyncCallback<boolean>): void

Obtains the multi-finger swipe switch status of the touchpad. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getTouchpadSwipeSwitch((error: Error, state: boolean) => {
    console.log(`getTouchpadSwipeSwitch success, state: ${JSON.stringify(state)}`);
  });
} catch (error) {
  console.error(`getTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getTouchpadSwipeSwitch¹⁰⁺

getTouchpadSwipeSwitch(): Promise<boolean>

Obtains the multi-finger swipe switch status of the touchpad. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Return value

Name	Description
Promise<boolean>	Promise used to return the result. The value true indicates that the switch is enabled, and the value false indicates the opposite. The default value is true.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getTouchpadSwipeSwitch().then((state: boolean) => {
    console.log(`getTouchpadSwipeSwitch success, state: ${JSON.stringify(state)}`);
  });
} catch (error) {
  console.error(`getTouchpadSwipeSwitch failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setTouchpadRightClickType¹⁰⁺

setTouchpadRightClickType(type: RightClickType, callback: AsyncCallback<void>): void

Sets the shortcut menu type of the touchpad. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	RightClickType	Yes	Shortcut menu type of the touchpad. - TOUCHPAD_RIGHT_BUTTON: Tapping the right-button area of the touchpad. - TOUCHPAD_LEFT_BUTTON: Tapping the left-button area of the touchpad. - TOUCHPAD_TWO_FINGER_TAP: Tapping or pressing the touchpad with two fingers. - TOUCHPAD_TWO_FINGER_TAP_OR_RIGHT_BUTTON²⁰⁺: Tapping or pressing the touchpad with two fingers, or tapping the right-button area of the touchpad. - TOUCHPAD_TWO_FINGER_TAP_OR_LEFT_BUTTON²⁰⁺: Tapping or pressing the touchpad with two fingers, or tapping the left-button area of the touchpad. The default value is TOUCHPAD_TWO_FINGER_TAP_OR_RIGHT_BUTTON.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setTouchpadRightClickType(pointer.RightClickType.TOUCHPAD_RIGHT_BUTTON , (error: Error) => {
    if (error) {
      console.error(`setTouchpadRightClickType, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`setTouchpadRightClickType success`);
  });
} catch (error) {
  console.error(`setTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setTouchpadRightClickType¹⁰⁺

setTouchpadRightClickType(type: RightClickType): Promise<void>

Sets the shortcut menu type of the touchpad. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
type	RightClickType	Yes	Shortcut menu type of the touchpad. - TOUCHPAD_RIGHT_BUTTON: Tapping the right-button area of the touchpad. - TOUCHPAD_LEFT_BUTTON: Tapping the left-button area of the touchpad. - TOUCHPAD_TWO_FINGER_TAP: Tapping or pressing the touchpad with two fingers. - TOUCHPAD_TWO_FINGER_TAP_OR_RIGHT_BUTTON²⁰⁺: Tapping or pressing the touchpad with two fingers, or tapping the right-button area of the touchpad. - TOUCHPAD_TWO_FINGER_TAP_OR_LEFT_BUTTON²⁰⁺: Tapping or pressing the touchpad with two fingers, or tapping the left-button area of the touchpad. The default value is TOUCHPAD_TWO_FINGER_TAP_OR_RIGHT_BUTTON.

Return value

Name	Description
Promise<void>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setTouchpadRightClickType(pointer.RightClickType.TOUCHPAD_RIGHT_BUTTON).then(() => {
    console.log(`setTouchpadRightClickType success`);
  });
} catch (error) {
  console.error(`setTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getTouchpadRightClickType¹⁰⁺

getTouchpadRightClickType(callback: AsyncCallback<RightClickType>): void

Obtains the shortcut menu type of the touchpad. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<RightClickType>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getTouchpadRightClickType((error: Error, type: pointer.RightClickType) => {
    console.log(`getTouchpadRightClickType success, type: ${JSON.stringify(type)}`);
  });
} catch (error) {
  console.error(`getTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getTouchpadRightClickType¹⁰⁺

getTouchpadRightClickType(): Promise<RightClickType>

Obtains the shortcut menu type of the touchpad. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Return value

Name	Description
Promise<RightClickType >	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getTouchpadRightClickType().then((type: pointer.RightClickType) => {
    console.log(`getTouchpadRightClickType success, typeed: ${JSON.stringify(type)}`);
  });
} catch (error) {
  console.error(`getTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setPointerSize¹⁰⁺

setPointerSize(size: number, callback: AsyncCallback<void>): void

Sets the pointer size. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
size	number	Yes	Pointer size. The value ranges from 1 to 7. The default value is 1.
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setPointerSize(1, (error: Error) => {
    if (error) {
      console.error(`setPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`setPointerSize success`);
  });
} catch (error) {
  console.error(`setPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setPointerSize¹⁰⁺

setPointerSize(size: number): Promise<void>

Sets the pointer size. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
size	number	Yes	Pointer size. The value ranges from 1 to 7. The default value is 1.

Return value

Name	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setPointerSize(3).then(() => {
    console.log(`setPointerSize success`);
  });
} catch (error) {
  console.error(`setPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setPointerSizeSync¹⁰⁺

setPointerSizeSync(size: number): void

Sets the pointer size. This API returns the result synchronously.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
size	number	Yes	Pointer size. The value ranges from 1 to 7. The default value is 1.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setPointerSizeSync(5);
  console.log(`setPointerSizeSync success`);
} catch (error) {
  console.error(`setPointerSizeSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getPointerSize¹⁰⁺

getPointerSize(callback: AsyncCallback<number>): void

Obtains the pointer size. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<number>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getPointerSize((error: Error, size: number) => {
    console.log(`getPointerSize success, size: ${JSON.stringify(size)}`);
  });
} catch (error) {
  console.error(`getPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getPointerSize¹⁰⁺

getPointerSize(): Promise<number>

Obtains the pointer size. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Return value

Name	Description
Promise<number>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.

Example

try {
  pointer.getPointerSize().then((size: number) => {
    console.log(`getPointerSize success, size: ${JSON.stringify(size)}`);
  });
} catch (error) {
  console.error(`getPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getPointerSizeSync¹⁰⁺

getPointerSizeSync(): number

Obtains the pointer size. This API returns the result synchronously.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Return value

Name	Description
number	Pointer size.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.

Example

try {
  let pointerSize = pointer.getPointerSizeSync();
  console.log(`getPointerSizeSync success, pointerSize: ${JSON.stringify(pointerSize)}`);
} catch (error) {
  console.error(`getPointerSizeSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setPointerColor¹⁰⁺

setPointerColor(color: number, callback: AsyncCallback<void>): void

Sets the pointer color. This API uses an asynchronous callback to return the result.

NOTE > > When performing this operation, you need to connect an external device, such as a mouse or Bluetooth device.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
color	number	Yes	Pointer color. The default value is black (0x000000).
callback	AsyncCallback<void>	Yes	Callback used to return the result. If the operation is successful, err is undefined. Otherwise, err is an error object.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setPointerColor(0xF6C800, (error: Error) => {
    if (error) {
      console.error(`setPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`setPointerColor success`);
  });
} catch (error) {
  console.error(`setPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setPointerColor¹⁰⁺

setPointerColor(color: number): Promise<void>

Sets the pointer color. This API uses a promise to return the result.

NOTE > > When performing this operation, you need to connect an external device, such as a mouse or Bluetooth device.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
color	number	Yes	Pointer color. The default value is black (0x000000).

Return value

Name	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setPointerColor(0xF6C800).then(() => {
    console.log(`setPointerColor success`);
  });
} catch (error) {
  console.error(`setPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setPointerColorSync¹⁰⁺

setPointerColorSync(color: number): void

Sets the pointer color. This API returns the result synchronously.

NOTE > > When performing this operation, you need to connect an external device, such as a mouse or Bluetooth device.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
color	number	Yes	Pointer color. The default value is black (0x000000).

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setPointerColorSync(0xF6C800);
  console.log(`setPointerColorSync success`);
} catch (error) {
  console.error(`setPointerColorSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getPointerColor¹⁰⁺

getPointerColor(callback: AsyncCallback<number>): void

Obtains the pointer color. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<number>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getPointerColor((error: Error, color: number) => {
    console.log(`getPointerColor success, color: ${JSON.stringify(color)}`);
  });
} catch (error) {
  console.error(`getPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getPointerColor¹⁰⁺

getPointerColor(): Promise<number>

Obtains the pointer color. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Return value

Name	Description
Promise<number>	Promise used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.

Example

try {
  pointer.getPointerColor().then((color: number) => {
    console.log(`getPointerColor success, color: ${JSON.stringify(color)}`);
  });
} catch (error) {
  console.error(`getPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getPointerColorSync¹⁰⁺

getPointerColorSync(): number

Obtains the pointer color. This API returns the result synchronously.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Return value

Name	Description
number	Pointer color.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.

Example

try {
  let pointerColor = pointer.getPointerColorSync();
  console.log(`getPointerColorSync success, pointerColor: ${JSON.stringify(pointerColor)}`);
} catch (error) {
  console.error(`getPointerColorSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setTouchpadDoubleTapAndDragState¹⁴⁺

setTouchpadDoubleTapAndDragState(isOpen: boolean, callback: AsyncCallback<void>): void

Sets the double-tap and drag switch for the touchpad. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
isOpen	boolean	Yes	Status of the double-tap and drag switch. The value true indicates that the switch is enabled, and the value false indicates the opposite.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setTouchpadDoubleTapAndDragState(true, (error: Error) => {
    if (error) {
      console.error(`setTouchpadDoubleTapAndDragState failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      return;
    }
    console.log(`setTouchpadDoubleTapAndDragState success`);
  });
} catch (error) {
  console.error(`setTouchpadDoubleTapAndDragState failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setTouchpadDoubleTapAndDragState¹⁴⁺

setTouchpadDoubleTapAndDragState(isOpen: boolean): Promise<void>

Sets the double-tap and drag switch for the touchpad. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
state	boolean	Yes	Status of the double-tap and drag switch. The value true indicates that the switch is enabled, and the value false indicates the opposite.

Return value

Name	Description
Promise<void>	Promise that returns no value.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.setTouchpadDoubleTapAndDragState(false).then(() => {
    console.log(`setTouchpadDoubleTapAndDragState success`);
  });
} catch (error) {
  console.error(`setTouchpadDoubleTapAndDragState failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getTouchpadDoubleTapAndDragState¹⁴⁺

getTouchpadDoubleTapAndDragState(callback: AsyncCallback<boolean>): void

Obtains the status of the double-tap and drag switch for the touchpad. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the status of the double-tap drag switch. The value true indicates that the switch is enabled, and the value false indicates the opposite.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;2. Incorrect parameter types; 3. Parameter verification failed.

Example

try {
  pointer.getTouchpadDoubleTapAndDragState((error: Error, state: boolean) => {
    console.log(`getTouchpadDoubleTapAndDragState success, state: ${JSON.stringify(state)}`);
  });
} catch (error) {
  console.error(`getTouchpadDoubleTapAndDragState failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.getTouchpadDoubleTapAndDragState¹⁴⁺

getTouchpadDoubleTapAndDragState(): Promise<boolean>

Obtains the status of the double-tap and drag switch for the touchpad. This API uses a promise to return the result.

System capability: SystemCapability.MultimodalInput.Input.Pointer

System API: This is a system API.

Return value

Name	Description
Promise<boolean>	Promise used to return the status of the touchpad double-tap drag switch. The value true indicates that the switch is enabled, and the value false indicates the opposite.

Error codes

For details about the error codes, see Universal Error Codes.

ID	Error Message
202	SystemAPI permission error.

Example

try {
  pointer.getTouchpadDoubleTapAndDragState().then((state) => {
    console.log(`getTouchpadDoubleTapAndDragState success, state: ${JSON.stringify(state)}`);
  });
} catch (error) {
  console.error(`getTouchpadDoubleTapAndDragState failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Input Kit

harmony 鸿蒙Input_DeviceListener

harmony 鸿蒙Input_InterceptorEventCallback

harmony 鸿蒙Input_AxisEvent

harmony 鸿蒙Input_DeviceInfo

harmony 鸿蒙Input_DeviceListener

harmony 鸿蒙Input_Hotkey

harmony 鸿蒙Input_InterceptorEventCallback

harmony 鸿蒙Input_InterceptorOptions

harmony 鸿蒙Input_KeyEvent

0 赞

所属分类： 后端技术
本文标签：
版权声明： 原创文章如转载，请注明本文链接: https://www.seaxiang.com/blog/bWF8fq

harmony 鸿蒙@ohos.multimodalInput.pointer (Mouse Pointer) (System API)

@ohos.multimodalInput.pointer (Mouse Pointer) (System API)

Modules to Import

pointer.setPointerSpeed

pointer.setPointerSpeed

pointer.setPointerSpeedSync10+

pointer.getPointerSpeed

pointer.getPointerSpeed

pointer.getPointerSpeedSync10+

pointer.setHoverScrollState10+

pointer.setHoverScrollState10+

pointer.getHoverScrollState10+

pointer.getHoverScrollState10+

pointer.setMousePrimaryButton10+

pointer.setMousePrimaryButton10+

pointer.getMousePrimaryButton10+

pointer.getMousePrimaryButton10+

pointer.setMouseScrollRows10+

pointer.setMouseScrollRows10+

pointer.getMouseScrollRows10+

pointer.getMouseScrollRows10+

pointer.setTouchpadScrollSwitch10+

pointer.setTouchpadScrollSwitch10+

pointer.getTouchpadScrollSwitch10+

pointer.getTouchpadScrollSwitch10+

pointer.setTouchpadScrollDirection10+

pointer.setTouchpadScrollDirection10+

pointer.getTouchpadScrollDirection10+

pointer.getTouchpadScrollDirection10+

pointer.setTouchpadTapSwitch10+

pointer.setTouchpadTapSwitch 10+

pointer.getTouchpadTapSwitch10+

pointer.getTouchpadTapSwitch10+

pointer.setTouchpadPointerSpeed10+

pointer.setTouchpadPointerSpeed10+

pointer.getTouchpadPointerSpeed10+

pointer.getTouchpadPointerSpeed10+

pointer.setTouchpadPinchSwitch10+

pointer.setTouchpadPinchSwitch10+

pointer.getTouchpadPinchSwitch10+

pointer.getTouchpadPinchSwitch10+

pointer.setTouchpadSwipeSwitch10+

pointer.setTouchpadSwipeSwitch10+

pointer.getTouchpadSwipeSwitch10+

pointer.getTouchpadSwipeSwitch10+

pointer.setTouchpadRightClickType10+

pointer.setTouchpadRightClickType10+

pointer.getTouchpadRightClickType10+

pointer.getTouchpadRightClickType10+

pointer.setPointerSize10+

pointer.setPointerSize10+

pointer.setPointerSizeSync10+

pointer.getPointerSize10+

pointer.getPointerSize10+

pointer.getPointerSizeSync10+

pointer.setPointerColor10+

pointer.setPointerColor10+

pointer.setPointerColorSync10+

pointer.getPointerColor10+

pointer.getPointerColor10+

pointer.getPointerColorSync10+

pointer.setTouchpadDoubleTapAndDragState14+

pointer.setTouchpadDoubleTapAndDragState14+

pointer.getTouchpadDoubleTapAndDragState14+

pointer.getTouchpadDoubleTapAndDragState14+

你可能感兴趣的鸿蒙文章

热门推荐

标签云

最新文章

本文目录

pointer.setPointerSpeedSync¹⁰⁺

pointer.getPointerSpeedSync¹⁰⁺

pointer.setHoverScrollState¹⁰⁺

pointer.setHoverScrollState¹⁰⁺

pointer.getHoverScrollState¹⁰⁺

pointer.getHoverScrollState¹⁰⁺

pointer.setMousePrimaryButton¹⁰⁺

pointer.setMousePrimaryButton¹⁰⁺

pointer.getMousePrimaryButton¹⁰⁺

pointer.getMousePrimaryButton¹⁰⁺

pointer.setMouseScrollRows¹⁰⁺

pointer.setMouseScrollRows¹⁰⁺

pointer.getMouseScrollRows¹⁰⁺

pointer.getMouseScrollRows¹⁰⁺

pointer.setTouchpadScrollSwitch¹⁰⁺

pointer.setTouchpadScrollSwitch¹⁰⁺

pointer.getTouchpadScrollSwitch¹⁰⁺

pointer.getTouchpadScrollSwitch¹⁰⁺

pointer.setTouchpadScrollDirection¹⁰⁺

pointer.setTouchpadScrollDirection¹⁰⁺

pointer.getTouchpadScrollDirection¹⁰⁺

pointer.getTouchpadScrollDirection¹⁰⁺

pointer.setTouchpadTapSwitch¹⁰⁺

pointer.setTouchpadTapSwitch ¹⁰⁺

pointer.getTouchpadTapSwitch¹⁰⁺

pointer.getTouchpadTapSwitch¹⁰⁺

pointer.setTouchpadPointerSpeed¹⁰⁺

pointer.setTouchpadPointerSpeed¹⁰⁺

pointer.getTouchpadPointerSpeed¹⁰⁺

pointer.getTouchpadPointerSpeed¹⁰⁺

pointer.setTouchpadPinchSwitch¹⁰⁺

pointer.setTouchpadPinchSwitch¹⁰⁺

pointer.getTouchpadPinchSwitch¹⁰⁺

pointer.getTouchpadPinchSwitch¹⁰⁺

pointer.setTouchpadSwipeSwitch¹⁰⁺

pointer.setTouchpadSwipeSwitch¹⁰⁺

pointer.getTouchpadSwipeSwitch¹⁰⁺

pointer.getTouchpadSwipeSwitch¹⁰⁺

pointer.setTouchpadRightClickType¹⁰⁺

pointer.setTouchpadRightClickType¹⁰⁺

pointer.getTouchpadRightClickType¹⁰⁺

pointer.getTouchpadRightClickType¹⁰⁺

pointer.setPointerSize¹⁰⁺

pointer.setPointerSize¹⁰⁺

pointer.setPointerSizeSync¹⁰⁺

pointer.getPointerSize¹⁰⁺

pointer.getPointerSize¹⁰⁺

pointer.getPointerSizeSync¹⁰⁺

pointer.setPointerColor¹⁰⁺

pointer.setPointerColor¹⁰⁺

pointer.setPointerColorSync¹⁰⁺

pointer.getPointerColor¹⁰⁺

pointer.getPointerColor¹⁰⁺

pointer.getPointerColorSync¹⁰⁺

pointer.setTouchpadDoubleTapAndDragState¹⁴⁺

pointer.setTouchpadDoubleTapAndDragState¹⁴⁺

pointer.getTouchpadDoubleTapAndDragState¹⁴⁺

pointer.getTouchpadDoubleTapAndDragState¹⁴⁺