1# LocationButton 2 3 4安全控件的位置控件，用户通过点击该位置按钮，可以临时获取精准定位权限，而不需要权限弹框授权确认。 5 6 7> **说明：** 8> 9> 该组件从API Version 10开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 10 11 12## 子组件 13 14不支持。 15 16 17## 接口 18### LocationButton 19LocationButton() 20 21默认创建带有图标、文本、背景的位置按钮。 22 23### LocationButton 24LocationButton(option:LocationButtonOptions) 25 26创建包含指定元素的位置按钮。 27 28**参数：** 29 30| 参数名 | 参数类型 | 必填 | 参数描述 | 31| -------- | -------- | -------- | -------- | 32| option | [LocationButtonOptions](#locationbuttonoptions) | 否 | 创建包含指定元素的位置按钮。 | 33 34## LocationButtonOptions 35 36| 名称 | 类型 | 必填 | 描述 | 37| -------- | -------- | -------- | -------- | 38| icon | [LocationIconStyle](#locationiconstyle枚举说明) | 否 | 设置位置按钮的图标风格<br/>不传入该参数表示没有图标，icon和text至少存在一个。 | 39| text | [LocationDescription](#locationdescription枚举说明) | 否 | 设置位置按钮的文本描述<br/>不传入该参数表示没有文字描述，icon和text至少存在一个。 | 40| buttonType | [ButtonType](ts-basic-components-button.md#buttontype枚举说明) | 否 | 设置位置按钮的背景样式<br/>不传入该参数表示没有背景。 | 41 42 43## LocationIconStyle枚举说明 44 45| 名称 | 枚举值 | 描述 | 46| -------- | -------- | -------- | 47| FULL_FILLED | 0 | 位置按钮展示填充样式图标。 | 48| LINES | 1 | 位置按钮展示线条样式图标。 | 49 50 51## LocationDescription枚举说明 52 53| 名称 | 枚举值 | 描述 | 54| -------- | -------- | -------- | 55| CURRENT_LOCATION | 0 | 位置按钮的文字描述为“当前位置”。 | 56| ADD_LOCATION | 1 | 位置按钮的文字描述为“添加位置”。 | 57| SELECT_LOCATION | 2 | 位置按钮的文字描述为“选择位置”。 | 58| SHARE_LOCATION | 3 | 位置按钮的文字描述为“共享位置”。 | 59| SEND_LOCATION | 4 | 位置按钮的文字描述为“发送位置”。 | 60| LOCATING | 5 | 位置按钮的文字描述为“定位”。 | 61| LOCATION | 6 | 位置按钮的文字描述为“位置”。 | 62| SEND_CURRENT_LOCATION | 7 | 位置按钮的文字描述为“发送实时位置”。 | 63| RELOCATION | 8 | 位置按钮的文字描述为“重定位”。 | 64| PUNCH_IN | 9 | 位置按钮的文字描述为“打卡定位”。 | 65| CURRENT_POSITION | 10 | 位置按钮的文字描述为“所在位置”。 | 66 67 68## LocationButtonOnClickResult枚举说明 69 70| 名称 | 枚举值 | 描述 | 71| -------- | -------- | -------- | 72| SUCCESS | 0 | 位置按钮点击成功。 | 73| TEMPORARY_AUTHORIZATION_FAILED | 1 | 位置按钮点击后位置权限授权失败。 | 74 75 76## 属性 77 78不支持通用属性，仅继承[安全控件通用属性](ts-securitycomponent-attributes.md#属性)。 79 80 81## 事件 82 83不支持通用事件，仅支持以下事件： 84 85| 名称 | 功能描述 | 86| -------- | -------- | 87| onClick(event: (event: [ClickEvent](ts-universal-events-click.md#clickevent对象说明), result: [LocationButtonOnClickResult](#locationbuttononclickresult枚举说明)) => void) | 点击动作触发该回调。<br/>result：位置权限的授权结果。<br/>event：见ClickEvent对象说明。 | 88 89 90## 示例 91 92``` 93// xxx.ets 94@Entry 95@Component 96struct Index { 97 build() { 98 Row() { 99 Column({space:10}) { 100 // 默认参数下，图标、文字、背景都存在 101 LocationButton().onClick((event: ClickEvent, result: LocationButtonOnClickResult)=>{ 102 console.info("result " + result) 103 }) 104 // 传入参数即表示元素存在，不传入的参数表示元素不存在，例如：只显示图标 105 LocationButton({icon:LocationIconStyle.LINES}) 106 // 只显示图标+背景 107 LocationButton({icon:LocationIconStyle.LINES, buttonType:ButtonType.Capsule}) 108 // 图标、文字、背景都存在 109 LocationButton({icon:LocationIconStyle.LINES, text:LocationDescription.CURRENT_LOCATION, buttonType:ButtonType.Capsule}) 110 }.width('100%') 111 }.height('100%') 112 } 113} 114``` 115 116 117
