# capacitor-plugin-screen-orientation

**Repository Path**: 3433/capacitor-plugin-screen-orientation

## Basic Information

- **Project Name**: capacitor-plugin-screen-orientation
- **Description**: 屏幕方向插件屏幕方向插件
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-06-02
- **Last Updated**: 2022-08-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# capacitor-plugin-screen-orientation

屏幕方向

## Install

```bash
npm install capacitor-plugin-screen-orientation
npx cap sync
```

## API

<docgen-index>

* [`echo(...)`](#echo)
* [`type()`](#type)
* [`lock(...)`](#lock)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)

</docgen-index>

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

### echo(...)

```typescript
echo(options: { value: string; }) => Promise<{ value: string; }>
```

| Param         | Type                            |
| ------------- | ------------------------------- |
| **`options`** | <code>{ value: string; }</code> |

**Returns:** <code>Promise&lt;{ value: string; }&gt;</code>

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


### type()

```typescript
type() => Promise<typeResult>
```

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

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


### lock(...)

```typescript
lock(options: lockOption) => void
```

| Param         | Type                                              |
| ------------- | ------------------------------------------------- |
| **`options`** | <code><a href="#lockoption">lockOption</a></code> |

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


### Interfaces


#### typeResult

| Prop              | Type                                                          |
| ----------------- | ------------------------------------------------------------- |
| **`orientation`** | <code><a href="#orientationvalue">orientationValue</a></code> |
| **`setting`**     | <code><a href="#settingvalue">settingValue</a></code>         |


#### lockOption

| Prop              | Type                                                          |
| ----------------- | ------------------------------------------------------------- |
| **`setting`**     | <code><a href="#settingvalue">settingValue</a></code>         |
| **`orientation`** | <code><a href="#orientationvalue">orientationValue</a></code> |


### Type Aliases


#### orientationValue

<code>'landscape' | 'portrait' | ''</code>


#### settingValue

<code>'any' | 'portrait-primary' | 'portrait-secondary' | 'landscape-primary' | 'landscape-secondary' | 'portrait' | 'landscape' | number</code>

</docgen-api>