当前仓库属于关闭状态,部分功能使用受限,详情请查阅 仓库状态说明
1.4K Star 7.4K Fork 8.2K

OpenHarmony/docs
关闭

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
docker
en
zh-cn
application-dev
IDL
account
ads-service/oaid
ai
application-models
application-test
arkts-utils
communication
connectivity
database
device-usage-statistics
device
dfx
faqs
file-management
internationalization
key-features/multi-device-app-dev
kit-readme
media
napi
notification
performance
public_sys-resources
quick-start
reference
apis
common_event
figures
public_sys-resources
Readme-CN.md
commonEvent-definitions.md
commonEventManager-definitions.md
development-intro.md
enterpriseDeviceManagement-overview.md
js-apis-Bundle-BundleStatusCallback.md
js-apis-Bundle-InnerBundleManager.md
js-apis-Bundle-distributedBundle.md
js-apis-Bundle.md
js-apis-EnterpriseAdminExtensionAbility.md
js-apis-WallpaperExtensionAbility.md
js-apis-WorkSchedulerExtensionAbility.md
js-apis-ability-ability.md
js-apis-ability-dataUriUtils.md
js-apis-ability-errorCode.md
js-apis-ability-featureAbility.md
js-apis-ability-particleAbility.md
js-apis-ability-wantConstant.md
js-apis-abilityAccessCtrl.md
js-apis-accessibility-GesturePath.md
js-apis-accessibility-GesturePoint.md
js-apis-accessibility-config.md
js-apis-accessibility.md
js-apis-adcomponent.md
js-apis-adsserviceextensionability.md
js-apis-advertising.md
js-apis-animator.md
js-apis-app-ability-MediaControlExtensionAbility.md
js-apis-app-ability-PrintExtensionAbility.md
js-apis-app-ability-ability.md
js-apis-app-ability-abilityConstant.md
js-apis-app-ability-abilityDelegatorRegistry.md
js-apis-app-ability-abilityLifecycleCallback.md
js-apis-app-ability-abilityManager.md
js-apis-app-ability-abilityStage.md
js-apis-app-ability-actionExtensionAbility.md
js-apis-app-ability-appManager.md
js-apis-app-ability-appRecovery.md
js-apis-app-ability-applicationStateChangeCallback.md
js-apis-app-ability-autoFillExtensionAbility.md
js-apis-app-ability-autoFillManager.md
js-apis-app-ability-autoStartupManager.md
js-apis-app-ability-childProcess.md
js-apis-app-ability-childProcessManager.md
js-apis-app-ability-common.md
js-apis-app-ability-configuration.md
js-apis-app-ability-configurationConstant.md
js-apis-app-ability-contextConstant.md
js-apis-app-ability-dataUriUtils.md
js-apis-app-ability-dialogRequest.md
js-apis-app-ability-dialogSession.md
js-apis-app-ability-driverExtensionAbility.md
js-apis-app-ability-environmentCallback.md
js-apis-app-ability-errorManager.md
js-apis-app-ability-extensionAbility.md
js-apis-app-ability-insightIntent.md
js-apis-app-ability-insightIntentContext.md
js-apis-app-ability-insightIntentDriver.md
js-apis-app-ability-insightIntentExecutor.md
js-apis-app-ability-missionManager.md
js-apis-app-ability-quickFixManager.md
js-apis-app-ability-serviceExtensionAbility.md
js-apis-app-ability-shareExtensionAbility.md
js-apis-app-ability-startOptions.md
js-apis-app-ability-uiAbility.md
js-apis-app-ability-uiExtensionAbility.md
js-apis-app-ability-uiExtensionContentSession.md
js-apis-app-ability-want.md
js-apis-app-ability-wantAgent.md
js-apis-app-ability-wantConstant.md
js-apis-app-form-formAgent.md
js-apis-app-form-formBindingData.md
js-apis-app-form-formExtensionAbility.md
js-apis-app-form-formHost.md
js-apis-app-form-formInfo.md
js-apis-app-form-formObserver.md
js-apis-app-form-formProvider.md
js-apis-appAccount.md
js-apis-appControl.md
js-apis-application-StaticSubscriberExtensionContext.md
js-apis-application-abilityDelegatorRegistry.md
js-apis-application-abilityManager.md
js-apis-application-accessibilityExtensionAbility.md
js-apis-application-appManager.md
js-apis-application-backupExtensionAbility.md
js-apis-application-configuration.md
js-apis-application-configurationConstant.md
js-apis-application-dataShareExtensionAbility.md
js-apis-application-formBindingData.md
js-apis-application-formError.md
js-apis-application-formHost.md
js-apis-application-formInfo.md
js-apis-application-formProvider.md
js-apis-application-missionManager.md
js-apis-application-staticSubscriberExtensionAbility.md
js-apis-application-testRunner.md
js-apis-application-want.md
js-apis-application-windowExtensionAbility.md
js-apis-arkui-UIContext.md
js-apis-arkui-componentSnapshot.md
js-apis-arkui-componentUtils.md
js-apis-arkui-dragController.md
js-apis-arkui-drawableDescriptor.md
js-apis-arkui-inspector.md
js-apis-arkui-observer.md
js-apis-arkui-performancemonitor.md
js-apis-arraylist.md
js-apis-audio.md
js-apis-audioHaptic.md
js-apis-autoadcomponent.md
js-apis-avsession.md
js-apis-backgroundTaskManager.md
js-apis-base.md
js-apis-battery-info.md
js-apis-batteryStatistics.md
js-apis-bluetooth-a2dp.md
js-apis-bluetooth-access.md
js-apis-bluetooth-baseProfile.md
js-apis-bluetooth-ble.md
js-apis-bluetooth-connection.md
js-apis-bluetooth-constant.md
js-apis-bluetooth-hfp.md
js-apis-bluetooth-hid.md
js-apis-bluetooth-map.md
js-apis-bluetooth-pan.md
js-apis-bluetooth-pbap.md
js-apis-bluetooth-socket.md
js-apis-bluetooth-wearDetection.md
js-apis-bluetooth.md
js-apis-bluetoothManager.md
js-apis-brightness.md
js-apis-buffer.md
js-apis-bundle-AbilityInfo.md
js-apis-bundle-ApplicationInfo.md
js-apis-bundle-BundleInfo.md
js-apis-bundle-BundleInstaller.md
js-apis-bundle-CustomizeData.md
js-apis-bundle-ElementName.md
js-apis-bundle-HapModuleInfo.md
js-apis-bundle-LauncherAbilityInfo.md
js-apis-bundle-ModuleInfo.md
js-apis-bundle-PermissionDef.md
js-apis-bundle-ShortcutInfo.md
js-apis-bundle-remoteAbilityInfo.md
js-apis-bundleManager-AppProvisionInfo.md
js-apis-bundleManager-BundlePackInfo.md
js-apis-bundleManager-BundleResourceInfo.md
js-apis-bundleManager-LauncherAbilityResourceInfo.md
js-apis-bundleManager-abilityInfo.md
js-apis-bundleManager-applicationInfo.md
js-apis-bundleManager-bundleInfo.md
js-apis-bundleManager-businessAbilityInfo.md
js-apis-bundleManager-dispatchInfo.md
js-apis-bundleManager-elementName.md
js-apis-bundleManager-extensionAbilityInfo.md
js-apis-bundleManager-hapModuleInfo.md
js-apis-bundleManager-launcherAbilityInfo.md
js-apis-bundleManager-metadata.md
js-apis-bundleManager-overlayModuleInfo.md
js-apis-bundleManager-permissionDef.md
js-apis-bundleManager-recoverableApplicationInfo.md
js-apis-bundleManager-remoteAbilityInfo.md
js-apis-bundleManager-sharedBundleInfo.md
js-apis-bundleManager-shortcutInfo.md
js-apis-bundleManager.md
js-apis-bundleMonitor.md
js-apis-bundleResourceManager.md
js-apis-businessAbilityRouter.md
js-apis-bytrace.md
js-apis-calendarManager.md
js-apis-call.md
js-apis-camera.md
js-apis-cardEmulation.md
js-apis-cert.md
js-apis-certManager.md
js-apis-charger.md
js-apis-colorSpaceManager.md
js-apis-commonEvent.md
js-apis-commonEventManager.md
js-apis-configPolicy.md
js-apis-connectedTag.md
js-apis-contact.md
js-apis-continuation-continuationExtraParams.md
js-apis-continuation-continuationManager.md
js-apis-continuation-continuationResult.md
js-apis-convertxml.md
js-apis-cooperate.md
js-apis-cryptoFramework.md
js-apis-curve.md
js-apis-data-DataShareResultSet.md
js-apis-data-ability.md
js-apis-data-cloudData.md
js-apis-data-cloudExtension.md
js-apis-data-commonType.md
js-apis-data-dataShare.md
js-apis-data-dataSharePredicates.md
js-apis-data-distributedobject.md
js-apis-data-preferences.md
js-apis-data-rdb.md
js-apis-data-relationalStore.md
js-apis-data-resultset.md
js-apis-data-storage.md
js-apis-data-unifiedDataChannel.md
js-apis-data-uniformTypeDescriptor.md
js-apis-data-valuesBucket.md
js-apis-defaultAppManager.md
js-apis-deque.md
js-apis-device-info.md
js-apis-device-manager.md
js-apis-deviceAttest.md
js-apis-deviceUsageStatistics.md
js-apis-devicestatus-cooperate.md
js-apis-devicestatus-draginteraction.md
js-apis-display.md
js-apis-distributed-account.md
js-apis-distributed-data.md
js-apis-distributedBundleManager.md
js-apis-distributedDeviceManager.md
js-apis-distributedHardwareManager.md
js-apis-distributedKVStore.md
js-apis-distributedMissionManager.md
js-apis-dlppermission.md
js-apis-document.md
js-apis-driver-deviceManager.md
js-apis-effectKit.md
js-apis-emitter.md
js-apis-enterprise-accountManager.md
js-apis-enterprise-adminManager.md
js-apis-enterprise-applicationManager.md
js-apis-enterprise-bluetoothManager.md
js-apis-enterprise-browser.md
js-apis-enterprise-bundleManager.md
js-apis-enterprise-dateTimeManager.md
js-apis-enterprise-deviceControl.md
js-apis-enterprise-deviceInfo.md
js-apis-enterprise-deviceSettings.md
js-apis-enterprise-locationManager.md
js-apis-enterprise-networkManager.md
js-apis-enterprise-restrictions.md
js-apis-enterprise-securityManager.md
js-apis-enterprise-systemManager.md
js-apis-enterprise-usbManager.md
js-apis-enterprise-wifiManager.md
js-apis-faultLogger.md
js-apis-file-backup.md
js-apis-file-cloudsync.md
js-apis-file-cloudsyncmanager.md
js-apis-file-environment.md
js-apis-file-fileuri.md
js-apis-file-fs.md
js-apis-file-hash.md
js-apis-file-picker.md
js-apis-file-recent.md
js-apis-file-securityLabel.md
js-apis-file-statvfs.md
js-apis-file-storage-statistics.md
js-apis-file-trash.md
js-apis-file-volumemanager.md
js-apis-fileAccess.md
js-apis-fileExtensionInfo.md
js-apis-fileShare.md
js-apis-fileio.md
js-apis-font.md
js-apis-freeInstall.md
js-apis-geoLocationManager.md
js-apis-geolocation.md
js-apis-getContext.md
js-apis-graphics-displaySync.md
js-apis-hashmap.md
js-apis-hashset.md
js-apis-hdrCapability.md
js-apis-hiappevent.md
js-apis-hichecker.md
js-apis-hidebug.md
js-apis-hilog.md
js-apis-hisysevent.md
js-apis-hitracechain.md
js-apis-hitracemeter.md
js-apis-hiviewdfx-hiappevent.md
js-apis-http.md
js-apis-huks.md
js-apis-i18n.md
js-apis-image.md
js-apis-inner-ability-abilityResult.md
js-apis-inner-ability-connectOptions.md
js-apis-inner-ability-dataAbilityHelper.md
js-apis-inner-ability-dataAbilityOperation.md
js-apis-inner-ability-dataAbilityResult.md
js-apis-inner-ability-startAbilityParameter.md
js-apis-inner-ability-want.md
js-apis-inner-app-appVersionInfo.md
js-apis-inner-app-context.md
js-apis-inner-app-processInfo.md
js-apis-inner-application-MediaControlExtensionContext.md
js-apis-inner-application-WorkSchedulerExtensionContext.md
js-apis-inner-application-abilityDelegator.md
js-apis-inner-application-abilityDelegatorArgs.md
js-apis-inner-application-abilityForegroundStateObserver.md
js-apis-inner-application-abilityMonitor.md
js-apis-inner-application-abilityRunningInfo.md
js-apis-inner-application-abilityStageContext.md
js-apis-inner-application-abilityStageMonitor.md
js-apis-inner-application-abilityStartCallback.md
js-apis-inner-application-abilityStateData.md
js-apis-inner-application-accessibilityExtensionContext.md
js-apis-inner-application-appForegroundStateObserver.md
js-apis-inner-application-appStateData.md
js-apis-inner-application-applicationContext.md
js-apis-inner-application-applicationStateObserver.md
js-apis-inner-application-autoFillExtensionContext.md
js-apis-inner-application-autoFillRequest.md
js-apis-inner-application-autoFillType.md
js-apis-inner-application-autoStartupCallback.md
js-apis-inner-application-autoStartupInfo.md
js-apis-inner-application-baseContext.md
js-apis-inner-application-context.md
js-apis-inner-application-continuableInfo.md
js-apis-inner-application-continueCallback.md
js-apis-inner-application-continueDeviceInfo.md
js-apis-inner-application-continueMissionInfo.md
js-apis-inner-application-driverExtensionContext.md
js-apis-inner-application-errorObserver.md
js-apis-inner-application-eventHub.md
js-apis-inner-application-extensionContext.md
js-apis-inner-application-extensionRunningInfo.md
js-apis-inner-application-formExtensionContext.md
js-apis-inner-application-missionCallbacks.md
js-apis-inner-application-missionDeviceInfo.md
js-apis-inner-application-missionInfo.md
js-apis-inner-application-missionListener.md
js-apis-inner-application-missionParameter.md
js-apis-inner-application-missionSnapshot.md
js-apis-inner-application-pageNodeInfo.md
js-apis-inner-application-processData.md
js-apis-inner-application-processInformation.md
js-apis-inner-application-processRunningInfo.md
js-apis-inner-application-serviceExtensionContext.md
js-apis-inner-application-shellCmdResult.md
js-apis-inner-application-uiAbilityContext.md
js-apis-inner-application-uiExtensionContext.md
js-apis-inner-application-viewData.md
js-apis-inner-application-windowExtensionContext.md
js-apis-inner-commonEvent-commonEventData.md
js-apis-inner-commonEvent-commonEventPublishData.md
js-apis-inner-commonEvent-commonEventSubscribeInfo.md
js-apis-inner-commonEvent-commonEventSubscriber.md
js-apis-inner-multimedia-ringtonePlayer.md
js-apis-inner-multimedia-soundPool.md
js-apis-inner-multimedia-systemTonePlayer.md
js-apis-inner-notification-notificationActionButton.md
js-apis-inner-notification-notificationCommonDef.md
js-apis-inner-notification-notificationContent.md
js-apis-inner-notification-notificationFlags.md
js-apis-inner-notification-notificationRequest.md
js-apis-inner-notification-notificationSlot.md
js-apis-inner-notification-notificationSorting.md
js-apis-inner-notification-notificationSortingMap.md
js-apis-inner-notification-notificationSubscribeInfo.md
js-apis-inner-notification-notificationSubscriber.md
js-apis-inner-notification-notificationTemplate.md
js-apis-inner-notification-notificationUserInput.md
js-apis-inner-wantAgent-triggerInfo.md
js-apis-inner-wantAgent-wantAgentInfo.md
js-apis-inputconsumer.md
js-apis-inputdevice.md
js-apis-inputevent.md
js-apis-inputeventclient.md
js-apis-inputmethod-extension-ability.md
js-apis-inputmethod-extension-context.md
js-apis-inputmethod-panel.md
js-apis-inputmethod-subtype.md
js-apis-inputmethod.md
js-apis-inputmethodengine.md
js-apis-inputmethodlist.md
js-apis-inputmonitor.md
js-apis-installer.md
js-apis-intelligentVoice.md
js-apis-intentioncode.md
js-apis-intl.md
js-apis-keycode.md
js-apis-keyevent.md
js-apis-launcherBundleManager.md
js-apis-lightweightmap.md
js-apis-lightweightset.md
js-apis-linkedlist.md
js-apis-list.md
js-apis-loglibrary.md
js-apis-logs.md
js-apis-matrix4.md
js-apis-measure.md
js-apis-media.md
js-apis-medialibrary.md
js-apis-mediaquery.md
js-apis-mindSporeLite.md
js-apis-mouseevent.md
js-apis-multimodalinput-gestureevent.md
js-apis-net-connection.md
js-apis-net-ethernet.md
js-apis-net-mdns.md
js-apis-net-policy.md
js-apis-net-sharing.md
js-apis-net-statistics.md
js-apis-net-vpn.md
js-apis-networkSecurity.md
js-apis-nfcController.md
js-apis-nfcTag.md
js-apis-nfctech.md
js-apis-notification.md
js-apis-notificationManager.md
js-apis-notificationSubscribe.md
js-apis-oaid.md
js-apis-observer.md
js-apis-osAccount.md
js-apis-overlay.md
js-apis-pasteboard.md
js-apis-permissionrequestresult.md
js-apis-photoAccessHelper.md
js-apis-pipWindow.md
js-apis-plainarray.md
js-apis-plugincomponent.md
js-apis-pointer.md
js-apis-postCardAction.md
js-apis-power.md
js-apis-print.md
js-apis-privacyManager.md
js-apis-process.md
js-apis-prompt.md
js-apis-promptAction.md
js-apis-queue.md
js-apis-radio.md
js-apis-reminderAgent.md
js-apis-reminderAgentManager.md
js-apis-request.md
js-apis-resource-manager.md
js-apis-resourceschedule-backgroundTaskManager.md
js-apis-resourceschedule-deviceStandby.md
js-apis-resourceschedule-deviceUsageStatistics.md
js-apis-resourceschedule-workScheduler.md
js-apis-router.md
js-apis-rpc.md
js-apis-runninglock.md
js-apis-screen-lock.md
js-apis-screen.md
js-apis-screenshot.md
js-apis-secureElement.md
js-apis-sensor.md
js-apis-settings.md
js-apis-shortKey.md
js-apis-sim.md
js-apis-sms.md
js-apis-socket.md
js-apis-stack.md
js-apis-statfs.md
js-apis-stationary.md
js-apis-syscap.md
js-apis-system-app.md
js-apis-system-battery.md
js-apis-system-bluetooth.md
js-apis-system-brightness.md
js-apis-system-capability.md
js-apis-system-cipher.md
js-apis-system-configuration.md
js-apis-system-date-time.md
js-apis-system-device.md
js-apis-system-fetch.md
js-apis-system-file.md
js-apis-system-location.md
js-apis-system-mediaquery.md
js-apis-system-network.md
js-apis-system-notification.md
js-apis-system-package.md
js-apis-system-parameter.md
js-apis-system-parameterEnhance.md
js-apis-system-prompt.md
js-apis-system-request.md
js-apis-system-router.md
js-apis-system-sensor.md
js-apis-system-storage.md
js-apis-system-time.md
js-apis-system-timer.md
js-apis-system-vibrate.md
js-apis-systemSoundManager.md
js-apis-tagSession.md
js-apis-taskpool.md
js-apis-telephony-data.md
js-apis-thermal.md
js-apis-timer.md
js-apis-touchevent.md
js-apis-treemap.md
js-apis-treeset.md
js-apis-uiappearance.md
js-apis-uitest.md
js-apis-update.md
js-apis-uri.md
js-apis-uripermissionmanager.md
js-apis-url.md
js-apis-usb-deprecated.md
js-apis-usbManager.md
js-apis-userFileManager.md
js-apis-useriam-faceauth.md
js-apis-useriam-userauth.md
js-apis-util.md
js-apis-vcard.md
js-apis-vector.md
js-apis-vibrator.md
js-apis-wallpaper.md
js-apis-wantAgent.md
js-apis-webSocket.md
js-apis-webview.md
js-apis-wifi.md
js-apis-wifiManager.md
js-apis-wifiManagerExt.md
js-apis-wifiext.md
js-apis-window.md
js-apis-windowAnimationManager.md
js-apis-worker.md
js-apis-xml.md
js-apis-zlib.md
arkui-js-lite
arkui-js
arkui-ts
errorcodes
figures
js-service-widget-ui
native-apis
native-lib
Readme-CN.md
native-api-intro.md
syscap-list.md
syscap.md
security
task-management
telephony
tools
ui
web
webgl
windowmanager
Readme-CN.md
Samples.md
application-dev-guide-for-gitee.md
application-dev-guide.md
website.md
contribute
design
device-dev
figures
readme
release-notes
third-party-cases
third-party-components
Legal-Notices.md
OpenHarmony-Overview_zh.md
glossary.md
readme.md
website.md
.gitattributes
.gitignore
CODEOWNERS
DCO.txt
LICENSE
OAT.xml
README.md
README_zh.md
image.png
克隆/下载
js-apis-pointer.md 76.69 KB
一键复制 编辑 原始数据 按行查看 历史

@ohos.multimodalInput.pointer (鼠标指针)

鼠标指针管理模块,用于查询和设置鼠标指针相关属性。

说明

本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import pointer from '@ohos.multimodalInput.pointer';

pointer.setPointerVisible

setPointerVisible(visible: boolean, callback: AsyncCallback<void>): void

设置鼠标指针显示或者隐藏,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

参数

参数名 类型 必填 说明
visible boolean 鼠标指针是否显示。true表示显示,false表示不显示
callback AsyncCallback<void> 回调函数。

示例

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

pointer.setPointerVisible

setPointerVisible(visible: boolean): Promise<void>

设置鼠标指针显示或者隐藏,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

参数

参数名 类型 必填 说明
visible boolean 鼠标指针是否显示。true表示显示,false表示不显示。

返回值

参数 说明
Promise<void> Promise对象。

示例

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

pointer.setPointerVisibleSync10+

setPointerVisibleSync(visible: boolean): void

使用同步方式设置鼠标指针显示或者隐藏。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

参数

参数名 类型 必填 说明
visible boolean 鼠标指针是否显示。true表示显示,false表示不显示。

示例

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

pointer.isPointerVisible

isPointerVisible(callback: AsyncCallback<boolean>): void

获取鼠标指针显示或隐藏状态,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

参数

参数名 类型 必填 说明
callback AsyncCallback<boolean> 回调函数,异步返回鼠标指针显示或隐藏状态。

示例

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

pointer.isPointerVisible

isPointerVisible(): Promise<boolean>

获取鼠标指针显示或隐藏状态,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

返回值

参数 说明
Promise<boolean> Promise对象,异步返回鼠标指针显示或隐藏状态。

示例

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

pointer.isPointerVisibleSync10+

isPointerVisibleSync(): boolean

使用同步方式获取鼠标指针显示或者隐藏。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

返回值

参数 说明
boolean 返回鼠标指针显示或隐藏状态。true代表显示状态,false代表隐藏状态。

示例

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

pointer.setPointerSpeed

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

设置鼠标移动速度,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
speed number 鼠标移动速度,范围1-11,默认为5。
callback AsyncCallback<void> 回调函数。

示例

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

pointer.setPointerSpeed

setPointerSpeed(speed: number): Promise<void>

设置鼠标移动速度,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
speed number 鼠标移动速度,范围1-11,默认为5。

返回值

参数 说明
Promise<void> Promise对象。

示例

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

pointer.setPointerSpeedSync10+

setPointerSpeedSync(speed: number): void

使用同步方式设置鼠标移动速度。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
speed number 鼠标移动速度,范围1-11,默认为5。

示例

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

pointer.getPointerSpeed

getPointerSpeed(callback: AsyncCallback<number>): void

获取鼠标移动速度,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
callback AsyncCallback<number> 回调函数,异步返回鼠标移动速度。

示例

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

pointer.getPointerSpeed

getPointerSpeed(): Promise<number>

获取当前鼠标移动速度,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

返回值

参数 说明
Promise<number> Promise实例,异步返回鼠标移动速度。

示例

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

pointer.getPointerSpeedSync10+

getPointerSpeedSync(): number

使用同步方式获取当前鼠标移动速度。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

返回值

参数 说明
number 返回鼠标移动速度。

示例

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

pointer.setHoverScrollState10+

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

设置鼠标悬停滚动开关状态,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
state boolean 鼠标悬停滚动开关状态。true代表开关开启,false代表开关关闭,默认开启。
callback AsyncCallback<void> 回调函数。

示例

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

pointer.setHoverScrollState10+

setHoverScrollState(state: boolean): Promise<void>

设置鼠标悬停滚动开关状态,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
state boolean 鼠标悬停滚动开关状态。true代表开关开启,false代表开关关闭,默认开启。

返回值

参数 说明
Promise<void> Promise对象。

示例

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

pointer.getHoverScrollState10+

getHoverScrollState(callback: AsyncCallback<boolean>): void

获取鼠标悬停滚动开关状态,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
callback AsyncCallback<boolean> 回调函数,异步返回鼠标悬停滚动开关状态。true代表开关开启,false代表开关关闭,默认开启。

示例

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

pointer.getHoverScrollState10+

getHoverScrollState(): Promise<boolean>

获取当前鼠标悬停滚动开关状态,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

返回值

参数 说明
Promise<boolean> Promise实例,异步返回鼠标悬停滚动开关状态。true代表开关开启,false代表开关关闭,默认开启。

示例

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

pointer.setMousePrimaryButton10+

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

设置鼠标主键,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
primary PrimaryButton 鼠标主键id。
callback AsyncCallback<void> 回调函数。

示例

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

pointer.setMousePrimaryButton10+

setMousePrimaryButton(primary: PrimaryButton): Promise<void>

设置鼠标主键,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
primary PrimaryButton 鼠标主键id。

返回值

参数 说明
Promise<void> Promise对象。

示例

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

pointer.getMousePrimaryButton10+

getMousePrimaryButton(callback: AsyncCallback<PrimaryButton>): void

获取鼠标主键,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
callback AsyncCallback<PrimaryButton> 回调函数,异步返回鼠标主键。

示例

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

pointer.getMousePrimaryButton10+

getMousePrimaryButton(): Promise<PrimaryButton>

获取当前鼠标主键,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

返回值

参数 说明
Promise<PrimaryButton> Promise实例,异步返回鼠标主键。

示例

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

PrimaryButton10+

鼠标主键类型。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

名称 说明
LEFT 0 鼠标左键
RIGHT 1 鼠标右键

pointer.setMouseScrollRows10+

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

设置鼠标滚动行数,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
rows number 鼠标滚动行数,范围1-100,默认为3。
callback AsyncCallback<void> 回调函数。

示例

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

pointer.setMouseScrollRows10+

setMouseScrollRows(rows: number): Promise<void>

设置鼠标滚动行数,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
rows number 鼠标滚动行数,范围1-100,默认为3。

返回值

参数 说明
Promise<void> Promise对象。

示例

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

pointer.getMouseScrollRows10+

getMouseScrollRows(callback: AsyncCallback<number>): void

获取鼠标滚动行数,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
callback AsyncCallback<number> 回调函数,异步返回鼠标滚动行数。

示例

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

pointer.getMouseScrollRows10+

getMouseScrollRows(): Promise<number>

获取当前鼠标滚动行数,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

返回值

参数 说明
Promise<number> Promise实例,异步返回鼠标滚动行数。

示例

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

pointer.getPointerStyle

getPointerStyle(windowId: number, callback: AsyncCallback<PointerStyle>): void

获取鼠标样式类型,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

参数

参数名 类型 必填 说明
windowId number 窗口id。
callback AsyncCallback<PointerStyle> 回调函数,异步返回鼠标样式类型。

示例

import { BusinessError }  from '@ohos.base';
import window from '@ohos.window';

let context = getContext(this);
window.getLastWindow(context, (error: BusinessError, win: window.Window) => {
  if (error.code) {
    console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
    return;
  }
  let windowId = win.getWindowProperties().id;
  if (windowId < 0) {
    console.log(`Invalid windowId`);
    return;
  }
  try {
    pointer.getPointerStyle(windowId, (error: Error, style: pointer.PointerStyle) => {
      console.log(`Get pointer style success, style: ${JSON.stringify(style)}`);
    });
  } catch (error) {
    console.log(`Get pointer style failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  }
});

pointer.getPointerStyle

getPointerStyle(windowId: number): Promise<PointerStyle>

获取鼠标样式类型,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

参数

参数名 类型 必填 说明
windowId number 窗口id。

返回值

参数 说明
Promise<PointerStyle> Promise实例,异步返回鼠标样式类型。

示例

import window from '@ohos.window';
import { BusinessError }  from '@ohos.base';

let context = getContext(this);
window.getLastWindow(context, (error: BusinessError, win: window.Window) => {
  if (error.code) {
    console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
    return;
  }
  let windowId = win.getWindowProperties().id;
  if (windowId < 0) {
    console.log(`Invalid windowId`);
    return;
  }
  try {
    pointer.getPointerStyle(windowId).then((style: pointer.PointerStyle) => {
      console.log(`Get pointer style success, style: ${JSON.stringify(style)}`);
    });
  } catch (error) {
    console.log(`Get pointer style failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  }
});

pointer.getPointerStyleSync10+

getPointerStyleSync(windowId: number): PointerStyle

使用同步方式获取鼠标样式类型。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

参数

参数名 类型 必填 说明
windowId number 窗口id。

返回值

参数 说明
PointerStyle 返回鼠标样式类型。

示例

try {
  let style: pointer.PointerStyle = pointer.getPointerStyleSync(-1);
  console.log(`Get pointer style success, style: ${JSON.stringify(style)}`);
} catch (error) {
  console.log(`Get pointer style failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
}

pointer.setPointerStyle

setPointerStyle(windowId: number, pointerStyle: PointerStyle, callback: AsyncCallback<void>): void

设置鼠标样式类型,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

参数

参数名 类型 必填 说明
windowId number 窗口id。
pointerStyle PointerStyle 鼠标样式。
callback AsyncCallback<void> 回调函数。

示例

import window from '@ohos.window';
import { BusinessError }  from '@ohos.base';

window.getLastWindow(getContext(), (error: BusinessError, win: window.Window) => {
  if (error.code) {
    console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
    return;
  }
  let windowId = win.getWindowProperties().id;
  if (windowId < 0) {
    console.log(`Invalid windowId`);
    return;
  }
  try {
    pointer.setPointerStyle(windowId, pointer.PointerStyle.CROSS, error => {
      console.log(`Set pointer style success`);
    });
  } catch (error) {
    console.log(`Set pointer style failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  }
});

pointer.setPointerStyle

setPointerStyle(windowId: number, pointerStyle: PointerStyle): Promise<void>

设置鼠标样式类型,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

参数

参数名 类型 必填 说明
windowId number 窗口id。
pointerStyle PointerStyle 鼠标样式。
Promise<void> void Promise对象。

示例

import window from '@ohos.window';
import { BusinessError }  from '@ohos.base';

window.getLastWindow(getContext(), (error: BusinessError, win: window.Window) => {
  if (error.code) {
    console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
    return;
  }
  let windowId = win.getWindowProperties().id;
  if (windowId < 0) {
    console.log(`Invalid windowId`);
    return;
  }
  try {
    pointer.setPointerStyle(windowId, pointer.PointerStyle.CROSS).then(() => {
      console.log(`Set pointer style success`);
    });
  } catch (error) {
    console.log(`Set pointer style failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  }
});

pointer.setPointerStyleSync10+

setPointerStyleSync(windowId: number, pointerStyle: PointerStyle): void

使用同步方式设置鼠标样式类型。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

参数

参数名 类型 必填 说明
windowId number 窗口id。
pointerStyle PointerStyle 鼠标样式。

示例

import window from '@ohos.window';
import { BusinessError }  from '@ohos.base';

window.getLastWindow(getContext(), (error: BusinessError, win: window.Window) => {
  if (error.code) {
    console.error('Failed to obtain the top window. Cause: ' + JSON.stringify(error));
    return;
  }
  let windowId = win.getWindowProperties().id;
  if (windowId < 0) {
    console.log(`Invalid windowId`);
    return;
  }
  try {
    pointer.setPointerStyleSync(windowId, pointer.PointerStyle.CROSS);
    console.log(`Set pointer style success`);
  } catch (error) {
    console.log(`getPointerSize failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
  }
});

PointerStyle

鼠标样式类型。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

名称 说明 图示
DEFAULT 0 默认 Default.png
EAST 1 向东箭头 East.png
WEST 2 向西箭头 West.png
SOUTH 3 向南箭头 South.png
NORTH 4 向北箭头 North.png
WEST_EAST 5 向西东箭头 West_East.png
NORTH_SOUTH 6 向北南箭头 North_South.png
NORTH_EAST 7 向东北箭头 North_East.png
NORTH_WEST 8 向西北箭头 North_West.png
SOUTH_EAST 9 向东南箭头 South_East.png
SOUTH_WEST 10 向西南箭头 South_West.png
NORTH_EAST_SOUTH_WEST 11 东北西南调整 North_East_South_West.png
NORTH_WEST_SOUTH_EAST 12 西北东南调整 North_West_South_East.png
CROSS 13 准确选择 Cross.png
CURSOR_COPY 14 拷贝 Copy.png
CURSOR_FORBID 15 不可用 Forbid.png
COLOR_SUCKER 16 滴管 Colorsucker.png
HAND_GRABBING 17 并拢的手 Hand_Grabbing.png
HAND_OPEN 18 张开的手 Hand_Open.png
HAND_POINTING 19 手形指针 Hand_Poniting.png
HELP 20 帮助选择 Help.png
MOVE 21 移动 Move.png
RESIZE_LEFT_RIGHT 22 内部左右调整 Resize_Left_Right.png
RESIZE_UP_DOWN 23 内部上下调整 Resize_Up_Down.png
SCREENSHOT_CHOOSE 24 截图十字准星 Screenshot_Cross.png
SCREENSHOT_CURSOR 25 截图 Screenshot_Cursor.png
TEXT_CURSOR 26 文本选择 Text_Cursor.png
ZOOM_IN 27 放大 Zoom_In.png
ZOOM_OUT 28 缩小 Zoom_Out.png
MIDDLE_BTN_EAST 29 向东滚动 MID_Btn_East.png
MIDDLE_BTN_WEST 30 向西滚动 MID_Btn_West.png
MIDDLE_BTN_SOUTH 31 向南滚动 MID_Btn_South.png
MIDDLE_BTN_NORTH 32 向北滚动 MID_Btn_North.png
MIDDLE_BTN_NORTH_SOUTH 33 向北南滚动 MID_Btn_North_South.png
MIDDLE_BTN_NORTH_EAST 34 向东北滚动 MID_Btn_North_East.png
MIDDLE_BTN_NORTH_WEST 35 向西北滚动 MID_Btn_North_West.png
MIDDLE_BTN_SOUTH_EAST 36 向东南滚动 MID_Btn_South_East.png
MIDDLE_BTN_SOUTH_WEST 37 向西南滚动 MID_Btn_South_West.png
MIDDLE_BTN_NORTH_SOUTH_WEST_EAST 38 四向锥形移动 MID_Btn_North_South_West_East.png
HORIZONTAL_TEXT_CURSOR10+ 39 垂直文本选择 Horizontal_Text_Cursor.png
CURSOR_CROSS10+ 40 十字光标 Cursor_Cross.png
CURSOR_CIRCLE10+ 41 圆形光标 Cursor_Circle.png
LOADING10+ 42 正在载入动画光标 Loading.png
RUNNING10+ 43 后台运行中动画光标 Running.png

pointer.setTouchpadScrollSwitch10+

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

设置触控板滚轴开关,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
state boolean 滚轴开关开启的状态,true代表开启,false代表关闭,默认为开启
callback AsyncCallback<void> 回调函数。

示例

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

pointer.setTouchpadScrollSwitch10+

setTouchpadScrollSwitch(state: boolean): Promise<void>

设置触控板滚轴开关,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
state boolean 滚轴开关开启的状态,true代表开启,false代表关闭,默认为开启

返回值

参数 说明
Promise<void> Promise对象。

示例

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

pointer.getTouchpadScrollSwitch10+

getTouchpadScrollSwitch(callback: AsyncCallback<boolean>): void

获取触控板滚轴能力开启状态,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
callback AsyncCallback<boolean> 回调函数,异步返回触控板滚轴能力开启状态。true代表开启,false代表关闭,默认为开启。

示例

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

pointer.getTouchpadScrollSwitch10+

getTouchpadScrollSwitch(): Promise<boolean>

获取触控板滚轴能力开启状态,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

返回值

参数 说明
Promise<boolean> Promise实例,异步返回触控板滚轴能力开启状态。true代表开启,false代表关闭,默认为开启。

示例

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

pointer.setTouchpadScrollDirection10+

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

设置触控板滚轴的方向,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
state boolean state为触控板滚轴的方向。
true与手指滑动的方向一致,false与手指滑动的方向相反,
默认为true。
callback AsyncCallback<void> 回调函数。

示例

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

pointer.setTouchpadScrollDirection10+

setTouchpadScrollDirection(state: boolean): Promise<void>

设置触控板滚轴的方向,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
state boolean state为触控板滚轴的方向。
true与手指滑动的方向一致,false与手指滑动的方向相反。
默认为true

返回值

参数 说明
Promise<void> Promise对象。

示例

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

pointer.getTouchpadScrollDirection10+

getTouchpadScrollDirection(callback: AsyncCallback<boolean>): void

获取触控板滚轴方向,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
callback AsyncCallback<boolean> 回调函数,异步返回触控板滚轴方向。
true与手指滑动的方向一致,false与手指滑动的方向相反。
默认为true

示例

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

pointer.getTouchpadScrollDirection10+

getTouchpadScrollDirection(): Promise<boolean>

获取触控板滚轴方向,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

返回值

参数 说明
Promise<boolean> Promise实例,异步返回触控板滚轴方向。
true与手指滑动的方向一致,false与手指滑动的方向相反。
默认为true

示例

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

pointer.setTouchpadTapSwitch10+

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

设置触控板轻触功能开关,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
state boolean 触控板轻触功能开关开启状态。 true代表轻触开启,false代表轻触关闭,默认开启。
callback AsyncCallback<void> 回调函数。

示例

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

pointer.setTouchpadTapSwitch 10+

setTouchpadTapSwitch(state: boolean): Promise<void>

设置触控板轻触功能开关,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
state boolean 触控板轻触功能开关开启状态, true代表轻触开启,false代表轻触关闭,默认开启。

返回值

参数 说明
Promise<void> Promise对象。

示例

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

pointer.getTouchpadTapSwitch10+

getTouchpadTapSwitch(callback: AsyncCallback<boolean>): void

获取触控板轻触能力开启状态,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
callback AsyncCallback<boolean> 回调函数,异步返回触控板轻触功能开启状态, true代表开启,false代表关闭,默认开启。

示例

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

pointer.getTouchpadTapSwitch10+

getTouchpadTapSwitch(): Promise<boolean>

获取触控板轻触功能开启状态,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

返回值

参数 说明
Promise<boolean> Promise实例,异步返回触控板轻触功能开启状态,true代表开启,false代表关闭,默认开启。

示例

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

pointer.setTouchpadPointerSpeed10+

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

设置触控板光标移动速度,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
speed number speed代表光标移动速度。speed取值范围[1,11],默认5。
callback AsyncCallback<void> 回调函数。

示例

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

pointer.setTouchpadPointerSpeed10+

setTouchpadPointerSpeed(speed: number): Promise<void>

设置触控板光标移动速度,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
speed number speed代表光标移动速度。speed取值范围[1,11],默认5。

返回值

参数 说明
Promise<void> Promise对象。

示例

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

pointer.getTouchpadPointerSpeed10+

getTouchpadPointerSpeed(callback: AsyncCallback<number>): void

获取触控板光标移动速度,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
callback AsyncCallback<number> 回调函数,异步返回触控板光标移动速度。

示例

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

pointer.getTouchpadPointerSpeed10+

getTouchpadPointerSpeed(): Promise<number>

获取触控板光标移动速度,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

返回值

参数 说明
Promise<number> Promise实例,异步返回触控板光标移动速度。

示例

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

pointer.setTouchpadPinchSwitch10+

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

设置触控板双指捏合功能开关,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
state boolean 触控板双指捏合功能开关开启状态。 true代表开启,false代表关闭,默认开启。
callback AsyncCallback<void> 回调函数。

示例

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

pointer.setTouchpadPinchSwitch10+

setTouchpadPinchSwitch(state: boolean): Promise<void>

设置触控板双指捏合功能开关,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
state boolean 触控板双指捏合功能开关开启状态。 true代表开启,false代表关闭,默认开启。

返回值

参数 说明
Promise<void> Promise对象。

示例

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

pointer.getTouchpadPinchSwitch10+

getTouchpadPinchSwitch(callback: AsyncCallback<boolean>): void

获取触控板双指捏合功能开启状态,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
callback AsyncCallback<boolean> 回调函数,异步返回触控板双指捏合功能开启状态。true代表功能开启,false代表功能关闭,默认开启。

示例

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

pointer.getTouchpadPinchSwitch10+

getTouchpadPinchSwitch(): Promise<boolean>

获取触控板双指捏合功能开启状态,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

返回值

参数 说明
Promise<boolean> Promise实例,异步返回触控板双指捏合功能开启状态。true代表功能开启,false代表功能关闭,默认开启。

示例

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

pointer.setTouchpadSwipeSwitch10+

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

设置触控板多指滑动功能开关,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
state boolean 触控板多指滑动开关开启状态。 true代表多指滑动开启,false代表多指滑动关闭,默认开启。
callback AsyncCallback<void> 回调函数。

示例

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

pointer.setTouchpadSwipeSwitch10+

setTouchpadSwipeSwitch(state: boolean): Promise<void>

设置触控板多指滑动功能开关,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
state boolean 触控板多指滑动功能开关开启状态。 true代表多指滑动开启,false代表多指滑动关闭,默认开启。

返回值

参数 说明
Promise<void> Promise对象。

示例

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

pointer.getTouchpadSwipeSwitch10+

getTouchpadSwipeSwitch(callback: AsyncCallback<boolean>): void

获取触控板多指滑动功能开启状态,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
callback AsyncCallback<boolean> 回调函数,异步返回触控板多指滑动功能开启状态。 true代表多指滑动开启,false代表多指滑动关闭,默认开启。

示例

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

pointer.getTouchpadSwipeSwitch10+

getTouchpadSwipeSwitch(): Promise<boolean>

获取触控板多指滑动功能开启状态,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

返回值

参数 说明
Promise<boolean> Promise实例,异步返回触控板多指滑动功能开启状态。 true代表多指滑动开启,false代表多指滑动关闭,默认开启。

示例

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

RightClickType10+

右键菜单触发方式。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

名称 说明
TOUCHPAD_RIGHT_BUTTON 1 触控板右键区域。
TOUCHPAD_LEFT_BUTTON 2 触控板左键区域。
TOUCHPAD_TWO_FINGER_TAP 3 双指轻击或按压触控板。

pointer.setTouchpadRightClickType10+

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

设置触控板右键菜单类型,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
type RightClickType type代表触控板右键菜单类型。
- TOUCHPAD_RIGHT_BUTTON:触控板右键区域。
- TOUCHPAD_LEFT_BUTTON:触控板左键区域。
- TOUCHPAD_TWO_FINGER_TAP:双指轻击或按压触控板。
默认为TOUCHPAD_RIGHT_BUTTON 。
callback AsyncCallback<void> 回调函数。

示例

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

pointer.setTouchpadRightClickType10+

setTouchpadRightClickType(type: RightClickType): Promise<void>

设置触控板右键菜单类型,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
type RightClickType type代表触控板右键菜单类型。
- TOUCHPAD_RIGHT_BUTTON:触控板右键区域。
- TOUCHPAD_LEFT_BUTTON:触控板左键区域。
- TOUCHPAD_TWO_FINGER_TAP:双指轻击或按压触控板。
默认为TOUCHPAD_RIGHT_BUTTON 。

返回值

参数 说明
Promise<void> Promise对象。

示例

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

pointer.getTouchpadRightClickType10+

getTouchpadRightClickType(callback: AsyncCallback<RightClickType>): void

获取触控板右键菜单类型,使用AsyncCallback异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

参数

参数名 类型 必填 说明
callback AsyncCallback<RightClickType> 回调函数,异步返回触控板右键菜单类型。

示例

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

pointer.getTouchpadRightClickType10+

getTouchpadRightClickType(): Promise<RightClickType>

获取触控板右键菜单类型,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

系统API: 此接口为系统接口。

返回值

参数 说明
Promise<RightClickType > Promise实例,异步返回触控板右键菜单类型。

示例

try {
  pointer.getTouchpadRightClickType().then((type: pointer.RightClickType) => {
    console.log(`getTouchpadRightClickType success, typeed: ${JSON.stringify(type)}`);
  });
} 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,否则为错误对象。

示例

try {
  pointer.setPointerSize(1, (error: 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对象。

示例

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。

示例

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> 回调函数,异步返回鼠标光标大小。

示例

try {
  pointer.getPointerSize((error: Error, size: number) => {
    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对象,异步返回鼠标光标大小。

示例

try {
  pointer.getPointerSize().then((size: number) => {
    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 鼠标光标大小。

示例

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,否则为错误对象。

示例

try {
  pointer.setPointerColor(0xF6C800, (error: 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对象。

示例

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。

示例

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> 回调函数,异步返回鼠标光标颜色。

示例

try {
  pointer.getPointerColor((error: Error, color: number) => {
    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对象,异步返回鼠标光标颜色。

示例

try {
  pointer.getPointerColor().then((color: number) => {
    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 鼠标光标颜色。

示例

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`])}`);
}

pointer.setCustomCursor11+

setCustomCursor(windowId: number, pixelMap: image.PixelMap, focusX?: number, focusY?: number): Promise<void>

设置自定义光标样式,使用Promise异步方式返回结果。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

参数

参数名 类型 必填 说明
windowId number 窗口id。
pixelMap image.PixelMap 自定义光标资源。
focusX number 自定义光标焦点x, 取值范围:大于等于0,默认为0。
focusY number 自定义光标焦点y,取值范围:大于等于0,默认为0。

返回值

参数 说明
Promise<void> 无返回结果的Promise对象。

示例

import image from '@ohos.multimedia.image';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';
const svgFileData = getContext().resourceManager.getMediaContent($r("app.media.icon"));
const svgBuffer = svgFileData.buffer;
let svgImagesource: image.ImageSource = image.createImageSource(svgBuffer);
let svgDecodingOptions: image.DecodingOptions = {desiredSize: { width: 50, height:50 }};
svgImagesource.createPixelMap(svgDecodingOptions).then((pixelMap) => {
  window.getLastWindow(getContext(), (error: BusinessError, win: window.Window) => {
    let windowId = win.getWindowProperties().id;
      try {
        pointer.setCustomCursor(windowId, pixelMap).then(() => {
          console.log(`setCustomCursor success`);
        });
      } catch (error) {
        console.log(`setCustomCursor failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      }
  });
});

pointer.setCustomCursorSync11+

setCustomCursorSync(windowId: number, pixelMap: image.PixelMap, focusX?: number, focusY?: number): void

设置自定义光标样式,使用同步方式进行设置。

系统能力:SystemCapability.MultimodalInput.Input.Pointer

参数

参数名 类型 必填 说明
windowId number 窗口id。
pixelMap image.PixelMap 自定义光标资源。
focusX number 自定义光标焦点x, 取值范围:大于等于0,默认为0。
focusY number 自定义光标焦点y,取值范围:大于等于0,默认为0。

示例

import image from '@ohos.multimedia.image';
import window from '@ohos.window';
import { BusinessError } from '@ohos.base';
const svgFileData = getContext().resourceManager.getMediaContent($r("app.media.icon"));
const svgBuffer = svgFileData.buffer;
let svgImagesource: image.ImageSource = image.createImageSource(svgBuffer);
let svgDecodingOptions: image.DecodingOptions = {desiredSize: { width: 50, height:50 }};
svgImagesource.createPixelMap(svgDecodingOptions).then((pixelMap) => {
  window.getLastWindow(getContext(), (error: BusinessError, win: window.Window) => {
    let windowId = win.getWindowProperties().id;
      try {
        pointer.setCustomCursorSync(windowId, pixelMap, 25, 25);
        console.log(`setCustomCursorSync success`);
      } catch (error) {
        console.log(`setCustomCursorSync failed, error: ${JSON.stringify(error, [`code`, `message`])}`);
      }
  });
});
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
其他
1
https://gitee.com/openharmony/docs.git
git@gitee.com:openharmony/docs.git
openharmony
docs
docs
OpenHarmony-4.1-Beta1

搜索帮助