096df3209b
This PR moves the docs site to the private repo while keeping the docs content on the public repo. ### Change Type - [x] `documentation`
224 lines
3 KiB
Text
224 lines
3 KiB
Text
---
|
|
title: VideoShapeUtil
|
|
status: published
|
|
category: editor
|
|
group: Class
|
|
author: api
|
|
date: 06/23/2023
|
|
order: 195
|
|
---<Small>Public Class</Small>
|
|
|
|
<details>
|
|
<summary>Table of Contents</summary>
|
|
- [Properties](#properties)
|
|
- [canEdit](#VideoShapeUtil-canEdit-member)
|
|
- [isAspectRatioLocked](#VideoShapeUtil-isAspectRatioLocked-member)
|
|
- [type](#VideoShapeUtil-type-member)
|
|
- [Methods](#methods)
|
|
- [component](#VideoShapeUtil-component-member-1)
|
|
- [getDefaultProps](#VideoShapeUtil-getDefaultProps-member-1)
|
|
- [indicator](#VideoShapeUtil-indicator-member-1)
|
|
- [toSvg](#VideoShapeUtil-toSvg-member-1)
|
|
</details>
|
|
|
|
|
|
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
class VideoShapeUtil extends BaseBoxShapeUtil<TLVideoShape> {}
|
|
```
|
|
|
|
##### References
|
|
|
|
[BaseBoxShapeUtil](/gen/editor/BaseBoxShapeUtil-class), [TLVideoShape](/gen/tlschema/TLVideoShape-type)
|
|
|
|
---
|
|
|
|
## Properties
|
|
|
|
### `canEdit` \{#VideoShapeUtil-canEdit-member}
|
|
|
|
<Small>Public Property</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
canEdit: () => boolean
|
|
```
|
|
|
|
---
|
|
|
|
### `isAspectRatioLocked` \{#VideoShapeUtil-isAspectRatioLocked-member}
|
|
|
|
<Small>Public Property</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
isAspectRatioLocked: () => boolean
|
|
```
|
|
|
|
---
|
|
|
|
### `type` \{#VideoShapeUtil-type-member}
|
|
|
|
<Small>Public Static Property</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
static type: 'video'
|
|
```
|
|
|
|
---
|
|
|
|
## Methods
|
|
|
|
### `component()` \{#VideoShapeUtil-component-member-1}
|
|
|
|
<Small>Public Method</Small>
|
|
|
|
##### Parameters
|
|
|
|
|
|
<ParametersTable>
|
|
|
|
<ParametersTableRow>
|
|
<ParametersTableName>
|
|
|
|
`shape`
|
|
|
|
</ParametersTableName>
|
|
<ParametersTableDescription>
|
|
|
|
```ts
|
|
TLVideoShape
|
|
```
|
|
|
|
|
|
|
|
</ParametersTableDescription>
|
|
</ParametersTableRow>
|
|
</ParametersTable>
|
|
|
|
##### Returns
|
|
|
|
|
|
```ts
|
|
JSX.Element
|
|
```
|
|
|
|
##### References
|
|
|
|
[TLVideoShape](/gen/tlschema/TLVideoShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
|
|
---
|
|
|
|
### `getDefaultProps()` \{#VideoShapeUtil-getDefaultProps-member-1}
|
|
|
|
<Small>Public Method</Small>
|
|
|
|
##### Parameters
|
|
|
|
|
|
None
|
|
|
|
##### Returns
|
|
|
|
|
|
```ts
|
|
TLVideoShape['props']
|
|
```
|
|
|
|
##### References
|
|
|
|
[TLVideoShape](/gen/tlschema/TLVideoShape-type)
|
|
|
|
---
|
|
|
|
### `indicator()` \{#VideoShapeUtil-indicator-member-1}
|
|
|
|
<Small>Public Method</Small>
|
|
|
|
##### Parameters
|
|
|
|
|
|
<ParametersTable>
|
|
|
|
<ParametersTableRow>
|
|
<ParametersTableName>
|
|
|
|
`shape`
|
|
|
|
</ParametersTableName>
|
|
<ParametersTableDescription>
|
|
|
|
```ts
|
|
TLVideoShape
|
|
```
|
|
|
|
|
|
|
|
</ParametersTableDescription>
|
|
</ParametersTableRow>
|
|
</ParametersTable>
|
|
|
|
##### Returns
|
|
|
|
|
|
```ts
|
|
JSX.Element
|
|
```
|
|
|
|
##### References
|
|
|
|
[TLVideoShape](/gen/tlschema/TLVideoShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
|
|
---
|
|
|
|
### `toSvg()` \{#VideoShapeUtil-toSvg-member-1}
|
|
|
|
<Small>Public Method</Small>
|
|
|
|
##### Parameters
|
|
|
|
|
|
<ParametersTable>
|
|
|
|
<ParametersTableRow>
|
|
<ParametersTableName>
|
|
|
|
`shape`
|
|
|
|
</ParametersTableName>
|
|
<ParametersTableDescription>
|
|
|
|
```ts
|
|
TLVideoShape
|
|
```
|
|
|
|
|
|
|
|
</ParametersTableDescription>
|
|
</ParametersTableRow>
|
|
</ParametersTable>
|
|
|
|
##### Returns
|
|
|
|
|
|
```ts
|
|
SVGGElement
|
|
```
|
|
|
|
##### References
|
|
|
|
[TLVideoShape](/gen/tlschema/TLVideoShape-type), [SVGGElement](/gen/SVGGElement-interface)
|
|
|
|
---
|
|
|