diff --git a/zh-cn/application-dev/reference/apis/js-apis-pointer.md b/zh-cn/application-dev/reference/apis/js-apis-pointer.md index 3a4617a34a5e92ec9170f119b9b1dba53f9347e9..f722711d98ddda249aa401fd578aad1c8887299a 100755 --- a/zh-cn/application-dev/reference/apis/js-apis-pointer.md +++ b/zh-cn/application-dev/reference/apis/js-apis-pointer.md @@ -1725,4 +1725,358 @@ try { } catch (error) { console.log(`getTouchpadRightClickType failed, error: ${JSON.stringify(error, [`code`, `message`])}`); } +``` + +## pointer.setPointerSize10+ + +setPointerSize(size: number, callback: AsyncCallback<void>): void + +设置鼠标光标大小,使用AsyncCallback异步方式返回结果。 + +**系统能力**:SystemCapability.MultimodalInput.Input.Pointer + +**系统API**: 此接口为系统接口。 + +**参数**: + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------------- | +| size | number | 是 | 鼠标光标大小,范围为[1-7],默认为1。 | +| callback | AsyncCallback<void> | 是 | 回调函数,当设置成功时,err为undefined,否则为错误对象。 | + +**示例**: + +```js +try { + pointer.setPointerSize(1, (error) => { + if (error) { + console.log(`setPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`); + return; + } + console.log(`setPointerSize success`); + }); +} catch (error) { + console.log(`setPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.setPointerSize10+ + +setPointerSize(size: number): Promise<void> + +设置鼠标光标大小,使用Promise异步方式返回结果。 + +**系统能力**:SystemCapability.MultimodalInput.Input.Pointer + +**系统API**: 此接口为系统接口。 + +**参数**: + +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------------------- | +| size | number | 是 | 鼠标光标大小,范围为[1-7],默认为1。 | + +**返回值**: + +| 参数 | 说明 | +| ------------------- | ---------------- | +| Promise<void> | 无返回结果的Promise对象。 | + +**示例**: + +```js +try { + pointer.setPointerSize(3).then(() => { + console.log(`setPointerSize success`); + }); +} catch (error) { + console.log(`setPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.setPointerSizeSync10+ + +setPointerSizeSync(size: number): void; + +设置鼠标光标大小,使用同步方式进行设置。 + +**系统能力**:SystemCapability.MultimodalInput.Input.Pointer + +**系统API**: 此接口为系统接口。 + +**参数**: + +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------------------- | +| size | number | 是 | 鼠标光标大小,范围为[1-7],默认为1。 | + +**示例**: + +```js +try { + pointer.setPointerSizeSync(5); + console.log(`setPointerSizeSync success`); +} catch (error) { + console.log(`setPointerSizeSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getPointerSize10+ + +getPointerSize(callback: AsyncCallback<number>): void + +获取鼠标光标大小,使用AsyncCallback异步方式返回结果。 + +**系统能力**:SystemCapability.MultimodalInput.Input.Pointer + +**系统API**: 此接口为系统接口。 + +**参数**: + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | -------------- | +| callback | AsyncCallback<number> | 是 | 回调函数,异步返回鼠标光标大小。 | + +**示例**: + +```js +try { + pointer.getPointerSize((error, size) => { + console.log(`getPointerSize success, size: ${JSON.stringify(size)}`); + }); +} catch (error) { + console.log(`getPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getPointerSize10+ + +getPointerSize(): Promise<number> + +获取当前鼠标光标大小,使用Promise异步方式返回结果。 + +**系统能力**:SystemCapability.MultimodalInput.Input.Pointer + +**系统API**: 此接口为系统接口。 + +**返回值**: + +| 参数 | 说明 | +| --------------------- | ------------------- | +| Promise<number> | Promise对象,异步返回鼠标光标大小。 | + +**示例**: + +```js +try { + pointer.getPointerSize().then((size) => { + console.log(`getPointerSize success, size: ${JSON.stringify(size)}`); + }); +} catch (error) { + console.log(`getPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getPointerSizeSync10+ + +getPointerSizeSync(): number + +获取鼠标光标大小,使用同步方式返回结果。 + +**系统能力**:SystemCapability.MultimodalInput.Input.Pointer + +**系统API**: 此接口为系统接口。 + +**返回值**: + +| 参数 | 说明 | +| --------------------- | ------------------- | +| number | 鼠标光标大小。 | + +**示例**: + +```js +try { + let pointerSize = pointer.getPointerSizeSync(); + console.log(`getPointerSizeSync success, pointerSize: ${JSON.stringify(pointerSize)}`); +} catch (error) { + console.log(`getPointerSizeSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.setPointerColor10+ + +setPointerColor(color: number, callback: AsyncCallback<void>): void + +设置鼠标光标颜色,使用AsyncCallback异步方式返回结果。 + +**系统能力**:SystemCapability.MultimodalInput.Input.Pointer + +**系统API**: 此接口为系统接口。 + +**参数**: + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------------- | +| color | number | 是 | 鼠标光标颜色,默认为黑色:0x000000。 | +| callback | AsyncCallback<void> | 是 | 回调函数,当设置成功时,err为undefined,否则为错误对象。 | + +**示例**: + +```js +try { + pointer.setPointerColor(0xF6C800, (error) => { + if (error) { + console.log(`setPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`); + return; + } + console.log(`setPointerColor success`); + }); +} catch (error) { + console.log(`setPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.setPointerColor10+ + +setPointerColor(color: number): Promise<void> + +设置鼠标光标颜色,使用Promise异步方式返回结果。 + +**系统能力**:SystemCapability.MultimodalInput.Input.Pointer + +**系统API**: 此接口为系统接口。 + +**参数**: + +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------------------- | +| color | number | 是 | 鼠标光标颜色,默认为黑色:0x000000。 | + +**返回值**: + +| 参数 | 说明 | +| ------------------- | ---------------- | +| Promise<void> | 无返回结果的Promise对象。 | + +**示例**: + +```js +try { + pointer.setPointerColor(0xF6C800).then(() => { + console.log(`setPointerColor success`); + }); +} catch (error) { + console.log(`setPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.setPointerColorSync10+ + +setPointerColorSync(color: number): void; + +设置鼠标光标颜色,使用同步方式进行设置。 + +**系统能力**:SystemCapability.MultimodalInput.Input.Pointer + +**系统API**: 此接口为系统接口。 + +**参数**: + +| 参数名 | 类型 | 必填 | 说明 | +| ----- | ------ | ---- | ----------------------------------- | +| color | number | 是 | 鼠标光标颜色,默认为黑色:0x000000。 | + +**示例**: + +```js +try { + pointer.setPointerColorSync(0xF6C800); + console.log(`setPointerColorSync success`); +} catch (error) { + console.log(`setPointerColorSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getPointerColor10+ + +getPointerColor(callback: AsyncCallback<number>): void + +获取鼠标光标颜色,使用AsyncCallback异步方式返回结果。 + +**系统能力**:SystemCapability.MultimodalInput.Input.Pointer + +**系统API**: 此接口为系统接口。 + +**参数**: + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | -------------- | +| callback | AsyncCallback<number> | 是 | 回调函数,异步返回鼠标光标颜色。 | + +**示例**: + +```js +try { + pointer.getPointerColor((error, color) => { + console.log(`getPointerColor success, color: ${JSON.stringify(color)}`); + }); +} catch (error) { + console.log(`getPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getPointerColor10+ + +getPointerColor(): Promise<number> + +获取当前鼠标光标颜色,使用Promise异步方式返回结果。 + +**系统能力**:SystemCapability.MultimodalInput.Input.Pointer + +**系统API**: 此接口为系统接口。 + +**返回值**: + +| 参数 | 说明 | +| --------------------- | ------------------- | +| Promise<number> | Promise对象,异步返回鼠标光标颜色。 | + +**示例**: + +```js +try { + pointer.getPointerColor().then((color) => { + console.log(`getPointerColor success, color: ${JSON.stringify(color)}`); + }); +} catch (error) { + console.log(`getPointerColor failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} +``` + +## pointer.getPointerColorSync10+ + +getPointerColorSync(): number + +获取鼠标光标颜色,使用同步方式返回结果。 + +**系统能力**:SystemCapability.MultimodalInput.Input.Pointer + +**系统API**: 此接口为系统接口。 + +**返回值**: + +| 参数 | 说明 | +| --------------------- | ------------------- | +| number | 鼠标光标颜色。 | + +**示例**: + +```js +try { + let pointerColor = pointer.getPointerColorSync(); + console.log(`getPointerColorSync success, pointerColor: ${JSON.stringify(pointerColor)}`); +} catch (error) { + console.log(`getPointerColorSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`); +} ``` \ No newline at end of file