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:{icon?: LocationIconStyle, text?: LocationDescription, buttonType?: ButtonType}) 25 26创建包含指定元素的位置按钮。 27 28**参数:** 29 30| 参数名 | 参数类型 | 必填 | 参数描述 | 31| -------- | -------- | -------- | -------- | 32| icon | [LocationIconStyle](#locationiconstyle枚举说明) | 否 | 设置位置按钮的图标风格<br/>不传入该参数表示没有图标,icon和text至少存在一个。 | 33| text | [LocationDescription](#locationdescription枚举说明) | 否 | 设置位置按钮的文本描述<br/>不传入该参数表示没有文字描述,icon和text至少存在一个。 | 34| buttonType | [ButtonType](ts-basic-components-button.md#ButtonType枚举说明) | 否 | 设置位置按钮的背景样式<br/>不传入该参数表示没有背景。 | 35 36 37## LocationIconStyle枚举说明 38 39| 名称 | 描述 | 40| -------- | -------- | 41| FULL_FILLED | 位置按钮展示填充样式图标。 | 42| LINES | 位置按钮展示线条样式图标。 | 43 44 45## LocationDescription枚举说明 46 47| 名称 | 描述 | 48| -------- | -------- | 49| CURRENT_LOCATION | 位置按钮的文字描述为“当前位置”。 | 50| ADD_LOCATION | 位置按钮的文字描述为“添加位置”。 | 51| SELECT_LOCATION | 位置按钮的文字描述为“选择位置”。 | 52| SHARE_LOCATION | 位置按钮的文字描述为“共享位置”。 | 53| SEND_LOCATION | 位置按钮的文字描述为“发送位置”。 | 54| LOCATING | 位置按钮的文字描述为“定位”。 | 55| LOCATION | 位置按钮的文字描述为“位置”。 | 56| SEND_CURRENT_LOCATION | 位置按钮的文字描述为“发送实时位置”。 | 57| RELOCATION | 位置按钮的文字描述为“重定位”。 | 58| PUNCH_IN | 位置按钮的文字描述为“打卡定位”。 | 59| CURRENT_POSITION | 位置按钮的文字描述为“所在位置”。 | 60 61 62## LocationButtonOnClickResult枚举说明 63 64| 名称 | 描述 | 65| -------- | -------- | 66| SUCCESS | 位置按钮点击成功。 | 67| TEMPORARY_AUTHORIZATION_FAILED | 位置按钮点击后位置权限授权失败。 | 68 69 70## 属性 71 72不支持通用属性,仅继承[安全控件通用属性](ts-securitycomponent-attributes.md#属性)。 73 74 75## 事件 76 77不支持通用事件,仅支持以下事件: 78 79| 名称 | 功能描述 | 80| -------- | -------- | 81| onClick(event: (event: [ClickEvent](ts-universal-events-click.md#clickevent对象说明)), result: [LocationButtonOnClickResult](#locationbuttononclickresult枚举说明)) => void) | 点击动作触发该回调。<br/>result:位置权限的授权结果。<br/>event:见ClickEvent对象说明。 | 82 83 84## 示例 85 86``` 87// xxx.ets 88@Entry 89@Component 90struct Index { 91 build() { 92 Row() { 93 Column({space:10}) { 94 // 默认参数下,图标、文字、背景都存在 95 LocationButton().onClick((event: ClickEvent, result: LocationButtonOnClickResult)=>{ 96 console.info("result " + result) 97 }) 98 // 传入参数即表示元素存在,不传入的参数表示元素不存在,例如:只显示图标 99 LocationButton({icon:LocationIconStyle.LINES}) 100 // 只显示图标+背景 101 LocationButton({icon:LocationIconStyle.LINES, buttonType:ButtonType.Capsule}) 102 // 图标、文字、背景都存在 103 LocationButton({icon:LocationIconStyle.LINES, text:LocationDescription.CURRENT_LOCATION, buttonType:ButtonType.Capsule}) 104 }.width('100%') 105 }.height('100%') 106 } 107} 108``` 109 110 111