# capacitor-position

**Repository Path**: cdbadboy/capacitor-position

## Basic Information

- **Project Name**: capacitor-position
- **Description**: 定位插件
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-24
- **Last Updated**: 2024-12-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# capacitor-position

插件

## Install

```bash
npm install capacitor-position
npx cap sync
```

## API

<docgen-index>

* [`StartPosition()`](#startposition)
* [`PausePosition()`](#pauseposition)
* [`StopPosition()`](#stopposition)
* [`StartTrackService()`](#starttrackservice)
* [`StopTrackService()`](#stoptrackservice)
* [`addListener('position', ...)`](#addlistenerposition-)
* [`removeAllListeners()`](#removealllisteners)
* [Interfaces](#interfaces)

</docgen-index>

<docgen-api>
<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

### StartPosition()

```typescript
StartPosition() => Promise<void>
```

--------------------


### PausePosition()

```typescript
PausePosition() => Promise<void>
```

--------------------


### StopPosition()

```typescript
StopPosition() => Promise<void>
```

--------------------


### StartTrackService()

```typescript
StartTrackService() => Promise<void>
```

--------------------


### StopTrackService()

```typescript
StopTrackService() => Promise<void>
```

--------------------


### addListener('position', ...)

```typescript
addListener(eventName: 'position', listenerFunc: (res: PositionResult) => void) => Promise<PluginListenerHandle>
```

| Param              | Type                                                                        |
| ------------------ | --------------------------------------------------------------------------- |
| **`eventName`**    | <code>'position'</code>                                                     |
| **`listenerFunc`** | <code>(res: <a href="#positionresult">PositionResult</a>) =&gt; void</code> |

**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>

--------------------


### removeAllListeners()

```typescript
removeAllListeners() => Promise<void>
```

--------------------


### Interfaces


#### PluginListenerHandle

| Prop         | Type                                      |
| ------------ | ----------------------------------------- |
| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |


#### PositionResult

| Prop                | Type                |
| ------------------- | ------------------- |
| **`latitude`**      | <code>number</code> |
| **`longitude`**     | <code>number</code> |
| **`accuracy`**      | <code>number</code> |
| **`type`**          | <code>string</code> |
| **`track_id`**      | <code>string</code> |
| **`creation_time`** | <code>number</code> |

</docgen-api>


#### 前端镜像加速地址
``` 
http://mirrors.cloud.tencent.com/npm/
```