harmony 鸿蒙LocationButton

  • 2025-06-12
  • 浏览 (4)

LocationButton

安全控件的位置控件。用户点击位置控件，应用可以临时获取精准定位权限，而不需要权限弹框授权确认。

说明：

  • 该组件从API Version 10开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。

  • 从API Version 15开始，位置控件不再维护，推荐调用requestPermissionsFromUser拉起权限弹窗，请求用户授权。

子组件

不支持。

接口

LocationButton

LocationButton()

默认创建带有图标、文本、背景的位置控件。

为避免控件样式不合法导致授权失败，请开发者先了解安全控件样式的约束与限制。

原子化服务API： 从API version 11开始，该接口支持在元服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

LocationButton

LocationButton(options: LocationButtonOptions)

创建包含指定元素的位置控件。

为避免控件样式不合法导致授权失败，请开发者先了解安全控件样式的约束与限制。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名 类型 必填 说明
options LocationButtonOptions 是 创建包含指定元素的位置控件。

LocationButtonOptions

用于指定位置控件的图标、文本等指定元素。

说明：

  • icon或text需至少传入一个。
  • 如果icon、text都不传入，LocationButton中的options参数不起效，创建的LocationButton为默认样式，默认样式：

LocationIconStyle默认样式为LINES；

LocationDescription默认样式为CURRENT_LOCATION；

ButtonType默认样式为Capsule。 - icon、text、buttonType不支持动态修改。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称 类型 必填 说明
icon LocationIconStyle 否 设置位置控件的图标风格。
不传入该参数表示没有图标。
text LocationDescription 否 设置位置控件的文本描述。
不传入该参数表示没有文字描述。
buttonType ButtonType 否 设置位置控件的背景样式。
不传入该参数，系统默认提供Capsule类型按钮。

LocationIconStyle枚举说明

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称 值 说明
FULL_FILLED 0 位置控件展示填充样式图标。
LINES 1 位置控件展示线条样式图标。

LocationDescription枚举说明

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称 值 说明
CURRENT_LOCATION 0 位置控件的文字描述为“当前位置”。
ADD_LOCATION 1 位置控件的文字描述为“添加位置”。
SELECT_LOCATION 2 位置控件的文字描述为“选择位置”。
SHARE_LOCATION 3 位置控件的文字描述为“共享位置”。
SEND_LOCATION 4 位置控件的文字描述为“发送位置”。
LOCATING 5 位置控件的文字描述为“定位”。
LOCATION 6 位置控件的文字描述为“位置”。
SEND_CURRENT_LOCATION 7 位置控件的文字描述为“发送实时位置”。
RELOCATION 8 位置控件的文字描述为“重定位”。
PUNCH_IN 9 位置控件的文字描述为“打卡定位”。
CURRENT_POSITION 10 位置控件的文字描述为“所在位置”。

LocationButtonOnClickResult枚举说明

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称 值 说明
SUCCESS 0 位置控件点击后权限授权成功。
TEMPORARY_AUTHORIZATION_FAILED 1 位置控件点击后位置权限授权失败。

LocationButtonCallback18+

type LocationButtonCallback = (event: ClickEvent, result: LocationButtonOnClickResult, error?: BusinessError<void>) => void

点击位置控件触发该回调。

原子化服务API： 从API version 18开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数名 类型 必填 说明
event ClickEvent 是 见ClickEvent对象说明。
result LocationButtonOnClickResult 是 位置权限的授权结果。
error BusinessError<void> 否 点击按钮时的错误码和错误信息。
错误码0表示点击位置控件授权成功。
错误码1表示系统内部错误。
错误码2表示属性设置错误，包括但不限于：
1. 字体或图标设置过小。
2. 字体或图标与背托颜色相近。
3. 字体或图标颜色过于透明。
4. padding为负值。
5. 按钮被其他组件或窗口遮挡。
6. 文本超出背托范围。
7. 按钮超出窗口或屏幕。
8. 按钮整体尺寸过大。
9. 按钮文本被截断，显示不全。
10. 相关属性设置影响安全控件显示。

属性

不支持通用属性，仅继承安全控件通用属性。

事件

不支持通用事件，仅支持以下事件：

onClick

onClick(event: LocationButtonCallback)

点击动作触发该回调。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

参数：

参数名 类型 必填 说明
event LocationButtonCallback 是 见LocationButtonCallback。
在API10-17时，参数类型为：(event: ClickEvent, result: LocationButtonOnClickResult) => void。
从API18开始，变更为LocationButtonCallback。

示例

// xxx.ets
import { BusinessError } from '@kit.BasicServicesKit';

@Entry
@Component
struct Index {
  handleLocationButtonClick: LocationButtonCallback =
    (event: ClickEvent, result: LocationButtonOnClickResult, error?: BusinessError<void>) => {
      if (result == LocationButtonOnClickResult.SUCCESS) {
        console.info("success");
      } else {
        console.error("errCode: " + error?.code);
        console.error("errMessage: " + error?.message);
      }
    };

  build() {
    Row() {
      Column({ space: 10 }) {
        // 默认参数下，图标、文字、背景都存在。
        LocationButton().onClick(this.handleLocationButtonClick)
        // 传入参数即表示元素存在，不传入的参数表示元素不存在，如果不传入buttonType，会默认添加ButtonType.Capsule配置，显示图标+背景。
        LocationButton({ icon: LocationIconStyle.LINES })
        // 只显示图标+背景，如果设置背景色高八位的α值低于0x1A，则会被系统强制调整为0xFF。
        LocationButton({ icon: LocationIconStyle.LINES, buttonType: ButtonType.Capsule })
          .backgroundColor(0x10007dff)
        // 图标、文字、背景都存在，如果设置背景色高八位的α值低于0x1A，则会被系统强制调整为0xFF。
        LocationButton({
          icon: LocationIconStyle.LINES,
          text: LocationDescription.CURRENT_LOCATION,
          buttonType: ButtonType.Capsule
        })
        // 图标、文字、背景都存在，如果设置宽度小于当前属性组合下允许的最小宽度时，宽度仍为设置值，此时按钮文本信息会自动换行，以保证安全控件显示的完整性。
        LocationButton({
          icon: LocationIconStyle.LINES,
          text: LocationDescription.CURRENT_LOCATION,
          buttonType: ButtonType.Capsule
        })
          .fontSize(16)
          .width(30)
        // 图标、文字、背景都存在，如果设置宽度小于当前属性组合下允许的最小宽度时，宽度仍为设置值，此时按钮文本信息会自动换行，以保证安全控件显示的完整性。
        LocationButton({
          icon: LocationIconStyle.LINES,
          text: LocationDescription.CURRENT_LOCATION,
          buttonType: ButtonType.Capsule
        })
          .fontSize(16)
          .size({ width: 30, height: 30 })
        // 图标、文字、背景都存在，如果设置宽度小于当前属性组合下允许的最小宽度时，宽度仍为设置值，此时按钮文本信息会自动换行，以保证安全控件显示的完整性。
        LocationButton({
          icon: LocationIconStyle.LINES,
          text: LocationDescription.CURRENT_LOCATION,
          buttonType: ButtonType.Capsule
        })
          .fontSize(16)
          .constraintSize({
            minWidth: 0,
            maxWidth: 30,
            minHeight: 0,
            maxHeight: 30
          })
      }.width('100%')
    }.height('100%')
  }
}

zh-cn_image_0000001593518280

你可能感兴趣的鸿蒙文章

harmony 鸿蒙图像AI分析错误码

harmony 鸿蒙ArcButton

harmony 鸿蒙ArcSlider

harmony 鸿蒙Chip

harmony 鸿蒙ChipGroup

harmony 鸿蒙ComposeListItem

harmony 鸿蒙ComposeTitleBar

harmony 鸿蒙advanced.Counter

harmony 鸿蒙弹出框 (Dialog)

harmony 鸿蒙DialogV2

0  赞
  • 所属分类： 后端技术
  • 本文标签：
  • 版权声明： 原创文章如转载，请注明本文链接: https://m.seaxiang.com/blog/zqa7gX
热门推荐
标签云
Linux Java Spring Spring Boot docker 大数据 前端 生活 maven golang 软件 spring cloud fintech mac vscode 其他 区块链 以太坊 V神 开发者 技术 股票 git greenplum 分布式事务 chrome mysql flink kafka 设计模式 原理 鸿蒙 seo
最新文章
本文目录