c893a02878
Highlighter is autolocked, so we shouldn't show the lock icon ### Change Type - [x] `patch` — Bug fix [^1]: publishes a `patch` release, for devDependencies use `internal` [^2]: will not publish a new version ### Test Plan 1. Add a step-by-step description of how to test your PR here. 2. - [ ] Unit Tests - [ ] End to end tests ### Release Notes - We no longer show the tool lock option for highlighter - it didn't do anything anyway
168 lines
2.1 KiB
Text
168 lines
2.1 KiB
Text
---
|
|
title: TLBaseShape
|
|
status: published
|
|
category: tlschema
|
|
group: Interface
|
|
author: api
|
|
date: 06/23/2023
|
|
order: 65
|
|
---<Small>Public Interface</Small>
|
|
|
|
<details>
|
|
<summary>Table of Contents</summary>
|
|
- [Properties](#properties)
|
|
- [index](#TLBaseShape-index-member)
|
|
- [isLocked](#TLBaseShape-isLocked-member)
|
|
- [opacity](#TLBaseShape-opacity-member)
|
|
- [parentId](#TLBaseShape-parentId-member)
|
|
- [props](#TLBaseShape-props-member)
|
|
- [rotation](#TLBaseShape-rotation-member)
|
|
- [type](#TLBaseShape-type-member)
|
|
- [x](#TLBaseShape-x-member)
|
|
- [y](#TLBaseShape-y-member)
|
|
</details>
|
|
|
|
|
|
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
interface TLBaseShape<Type extends string, Props extends object>
|
|
extends BaseRecord<'shape', TLShapeId> {}
|
|
```
|
|
|
|
##### References
|
|
|
|
[BaseRecord](/gen/store/BaseRecord-interface), [TLShapeId](/gen/tlschema/TLShapeId-type)
|
|
|
|
---
|
|
|
|
## Properties
|
|
|
|
### `index` \{#TLBaseShape-index-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
index: string
|
|
```
|
|
|
|
---
|
|
|
|
### `isLocked` \{#TLBaseShape-isLocked-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
isLocked: boolean
|
|
```
|
|
|
|
---
|
|
|
|
### `opacity` \{#TLBaseShape-opacity-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
opacity: TLOpacityType
|
|
```
|
|
|
|
##### References
|
|
|
|
[TLOpacityType](/gen/tlschema/TLOpacityType-type)
|
|
|
|
---
|
|
|
|
### `parentId` \{#TLBaseShape-parentId-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
parentId: TLParentId
|
|
```
|
|
|
|
##### References
|
|
|
|
[TLParentId](/gen/tlschema/TLParentId-type)
|
|
|
|
---
|
|
|
|
### `props` \{#TLBaseShape-props-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
props: Props
|
|
```
|
|
|
|
---
|
|
|
|
### `rotation` \{#TLBaseShape-rotation-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
rotation: number
|
|
```
|
|
|
|
---
|
|
|
|
### `type` \{#TLBaseShape-type-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
type: Type
|
|
```
|
|
|
|
---
|
|
|
|
### `x` \{#TLBaseShape-x-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
x: number
|
|
```
|
|
|
|
---
|
|
|
|
### `y` \{#TLBaseShape-y-member}
|
|
|
|
<Small>Public PropertySignature</Small>
|
|
|
|
##### Signature
|
|
|
|
|
|
```ts
|
|
y: number
|
|
```
|
|
|
|
---
|
|
|