untrack generated files (#1646)
This PR untracks generated docs files. It does some minor repo cleanup. ### Change Type - [x] `internal`
This commit is contained in:
parent
51406d2d81
commit
44387eb363
549 changed files with 13 additions and 63712 deletions
|
@ -17,7 +17,6 @@
|
||||||
**/next.config.js
|
**/next.config.js
|
||||||
**/setupTests.js
|
**/setupTests.js
|
||||||
**/setupJest.js
|
**/setupJest.js
|
||||||
apps/webdriver/www
|
|
||||||
apps/vscode/extension/editor
|
apps/vscode/extension/editor
|
||||||
apps/examples/www
|
apps/examples/www
|
||||||
apps/docs/api-content.json
|
apps/docs/api-content.json
|
||||||
|
|
5
.gitignore
vendored
5
.gitignore
vendored
|
@ -56,7 +56,6 @@ packages/assets/embed-icons
|
||||||
packages/assets/fonts
|
packages/assets/fonts
|
||||||
packages/assets/icons
|
packages/assets/icons
|
||||||
packages/assets/translations
|
packages/assets/translations
|
||||||
apps/webdriver/www/
|
|
||||||
apps/examples/www/embed-icons
|
apps/examples/www/embed-icons
|
||||||
apps/examples/www/fonts
|
apps/examples/www/fonts
|
||||||
apps/examples/www/icons
|
apps/examples/www/icons
|
||||||
|
@ -79,4 +78,6 @@ apps/examples/www/index.js
|
||||||
apps/examples/build.esbuild.json
|
apps/examples/build.esbuild.json
|
||||||
|
|
||||||
apps/examples/e2e/test-results
|
apps/examples/e2e/test-results
|
||||||
apps/examples/playwright-report
|
apps/examples/playwright-report
|
||||||
|
|
||||||
|
docs/gen
|
3
.ignore
3
.ignore
|
@ -17,5 +17,4 @@ apps/example/www/index.css
|
||||||
**/dist/*
|
**/dist/*
|
||||||
*.cjs
|
*.cjs
|
||||||
|
|
||||||
bublic/packages/tldraw/ui.css
|
packages/tldraw/tldraw.css
|
||||||
bublic/packages/tldraw/editor.css
|
|
|
@ -11,6 +11,5 @@
|
||||||
**/_archive/*
|
**/_archive/*
|
||||||
apps/docs/api-content.json
|
apps/docs/api-content.json
|
||||||
apps/docs/content.json
|
apps/docs/content.json
|
||||||
apps/webdriver/www/index.js
|
|
||||||
apps/vscode/extension/editor/*
|
apps/vscode/extension/editor/*
|
||||||
apps/examples/www
|
apps/examples/www
|
|
@ -1,20 +0,0 @@
|
||||||
---
|
|
||||||
title: ACCEPTED_ASSET_TYPE
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 0
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
ACCEPTED_ASSET_TYPE: string
|
|
||||||
```
|
|
||||||
|
|
|
@ -1,20 +0,0 @@
|
||||||
---
|
|
||||||
title: ACCEPTED_IMG_TYPE
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 1
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
ACCEPTED_IMG_TYPE: string[]
|
|
||||||
```
|
|
||||||
|
|
|
@ -1,20 +0,0 @@
|
||||||
---
|
|
||||||
title: ACCEPTED_VID_TYPE
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 2
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
ACCEPTED_VID_TYPE: string[]
|
|
||||||
```
|
|
||||||
|
|
|
@ -1,24 +0,0 @@
|
||||||
---
|
|
||||||
title: AllRecords
|
|
||||||
status: published
|
|
||||||
category: store
|
|
||||||
group: TypeAlias
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 0
|
|
||||||
---<Small>Public TypeAlias</Small>
|
|
||||||
|
|
||||||
Get the type of all records in a record store.
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
type AllRecords<T extends Store<any>> = ExtractR<ExtractRecordType<T>>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Store](/gen/store/Store-class), [ExtractR](/gen/store/~ExtractR-type), [ExtractRecordType](/gen/store/~ExtractRecordType-type)
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: ArrowShape
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 3
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
ArrowShape: import('../../../config/defineShape').TLShapeInfo<
|
|
||||||
import('@tldraw/tlschema').TLArrowShape
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type)
|
|
||||||
|
|
|
@ -1,34 +0,0 @@
|
||||||
---
|
|
||||||
title: ArrowShapeArrowheadEndStyle
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 0
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
ArrowShapeArrowheadEndStyle: import('../styles/StyleProp').EnumStyleProp<
|
|
||||||
| 'arrow'
|
|
||||||
| 'bar'
|
|
||||||
| 'diamond'
|
|
||||||
| 'dot'
|
|
||||||
| 'inverted'
|
|
||||||
| 'none'
|
|
||||||
| 'pipe'
|
|
||||||
| 'square'
|
|
||||||
| 'triangle'
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[EnumStyleProp](/gen/tlschema/EnumStyleProp-class)
|
|
||||||
|
|
|
@ -1,34 +0,0 @@
|
||||||
---
|
|
||||||
title: ArrowShapeArrowheadStartStyle
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 1
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
ArrowShapeArrowheadStartStyle: import('../styles/StyleProp').EnumStyleProp<
|
|
||||||
| 'arrow'
|
|
||||||
| 'bar'
|
|
||||||
| 'diamond'
|
|
||||||
| 'dot'
|
|
||||||
| 'inverted'
|
|
||||||
| 'none'
|
|
||||||
| 'pipe'
|
|
||||||
| 'square'
|
|
||||||
| 'triangle'
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[EnumStyleProp](/gen/tlschema/EnumStyleProp-class)
|
|
||||||
|
|
|
@ -1,925 +0,0 @@
|
||||||
---
|
|
||||||
title: ArrowShapeUtil
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 4
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [canBind](#ArrowShapeUtil-canBind-member)
|
|
||||||
- [canEdit](#ArrowShapeUtil-canEdit-member)
|
|
||||||
- [canSnap](#ArrowShapeUtil-canSnap-member)
|
|
||||||
- [hideResizeHandles](#ArrowShapeUtil-hideResizeHandles-member)
|
|
||||||
- [hideRotateHandle](#ArrowShapeUtil-hideRotateHandle-member)
|
|
||||||
- [hideSelectionBoundsBg](#ArrowShapeUtil-hideSelectionBoundsBg-member)
|
|
||||||
- [hideSelectionBoundsFg](#ArrowShapeUtil-hideSelectionBoundsFg-member)
|
|
||||||
- [isClosed](#ArrowShapeUtil-isClosed-member)
|
|
||||||
- [labelBoundsCache](#ArrowShapeUtil-labelBoundsCache-member)
|
|
||||||
- [onDoubleClickHandle](#ArrowShapeUtil-onDoubleClickHandle-member)
|
|
||||||
- [onEditEnd](#ArrowShapeUtil-onEditEnd-member)
|
|
||||||
- [onHandleChange](#ArrowShapeUtil-onHandleChange-member)
|
|
||||||
- [onResize](#ArrowShapeUtil-onResize-member)
|
|
||||||
- [onTranslateStart](#ArrowShapeUtil-onTranslateStart-member)
|
|
||||||
- [type](#ArrowShapeUtil-type-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [component](#ArrowShapeUtil-component-member-1)
|
|
||||||
- [getArrowInfo](#ArrowShapeUtil-getArrowInfo-member-1)
|
|
||||||
- [getBounds](#ArrowShapeUtil-getBounds-member-1)
|
|
||||||
- [getCenter](#ArrowShapeUtil-getCenter-member-1)
|
|
||||||
- [getDefaultProps](#ArrowShapeUtil-getDefaultProps-member-1)
|
|
||||||
- [getHandles](#ArrowShapeUtil-getHandles-member-1)
|
|
||||||
- [getLabelBounds](#ArrowShapeUtil-getLabelBounds-member-1)
|
|
||||||
- [getOutline](#ArrowShapeUtil-getOutline-member-1)
|
|
||||||
- [getOutlineWithoutLabel](#ArrowShapeUtil-getOutlineWithoutLabel-member-1)
|
|
||||||
- [hitTestLineSegment](#ArrowShapeUtil-hitTestLineSegment-member-1)
|
|
||||||
- [hitTestPoint](#ArrowShapeUtil-hitTestPoint-member-1)
|
|
||||||
- [indicator](#ArrowShapeUtil-indicator-member-1)
|
|
||||||
- [snapPoints](#ArrowShapeUtil-snapPoints-member-1)
|
|
||||||
- [toSvg](#ArrowShapeUtil-toSvg-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class ArrowShapeUtil extends ShapeUtil<TLArrowShape> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[ShapeUtil](/gen/editor/ShapeUtil-class), [TLArrowShape](/gen/tlschema/TLArrowShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `canBind` \{#ArrowShapeUtil-canBind-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
canBind: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `canEdit` \{#ArrowShapeUtil-canEdit-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
canEdit: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `canSnap` \{#ArrowShapeUtil-canSnap-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
canSnap: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideResizeHandles` \{#ArrowShapeUtil-hideResizeHandles-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideResizeHandles: TLShapeUtilFlag<TLArrowShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideRotateHandle` \{#ArrowShapeUtil-hideRotateHandle-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideRotateHandle: TLShapeUtilFlag<TLArrowShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideSelectionBoundsBg` \{#ArrowShapeUtil-hideSelectionBoundsBg-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideSelectionBoundsBg: TLShapeUtilFlag<TLArrowShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideSelectionBoundsFg` \{#ArrowShapeUtil-hideSelectionBoundsFg-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideSelectionBoundsFg: TLShapeUtilFlag<TLArrowShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `isClosed` \{#ArrowShapeUtil-isClosed-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
isClosed: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `labelBoundsCache` \{#ArrowShapeUtil-labelBoundsCache-member}
|
|
||||||
|
|
||||||
<Small>Public Readonly Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
get labelBoundsCache(): ComputedCache<Box2d | null, TLArrowShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[ComputedCache](/gen/store/ComputedCache-type), [Box2d](/gen/primitives/Box2d-class), [TLArrowShape](/gen/tlschema/TLArrowShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onDoubleClickHandle` \{#ArrowShapeUtil-onDoubleClickHandle-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onDoubleClickHandle: (
|
|
||||||
shape: TLArrowShape,
|
|
||||||
handle: TLHandle
|
|
||||||
) => TLShapePartial<TLArrowShape> | void
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLArrowShape](/gen/tlschema/TLArrowShape-type), [TLHandle](/gen/tlschema/TLHandle-interface), [TLShapePartial](/gen/tlschema/TLShapePartial-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onEditEnd` \{#ArrowShapeUtil-onEditEnd-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onEditEnd: TLOnEditEndHandler<TLArrowShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnEditEndHandler](/gen/editor/TLOnEditEndHandler-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onHandleChange` \{#ArrowShapeUtil-onHandleChange-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onHandleChange: TLOnHandleChangeHandler<TLArrowShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnHandleChangeHandler](/gen/editor/TLOnHandleChangeHandler-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onResize` \{#ArrowShapeUtil-onResize-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onResize: TLOnResizeHandler<TLArrowShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnResizeHandler](/gen/editor/TLOnResizeHandler-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onTranslateStart` \{#ArrowShapeUtil-onTranslateStart-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onTranslateStart: TLOnTranslateStartHandler<TLArrowShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnTranslateStartHandler](/gen/editor/TLOnTranslateStartHandler-type), [TLArrowShape](/gen/tlschema/TLArrowShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `type` \{#ArrowShapeUtil-type-member}
|
|
||||||
|
|
||||||
<Small>Public Static Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
static type: 'arrow'
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `component()` \{#ArrowShapeUtil-component-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLArrowShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element | null
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLArrowShape](/gen/tlschema/TLArrowShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getArrowInfo()` \{#ArrowShapeUtil-getArrowInfo-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLArrowShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
ArrowInfo | undefined
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLArrowShape](/gen/tlschema/TLArrowShape-type), [ArrowInfo](/gen/editor/~ArrowInfo-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getBounds()` \{#ArrowShapeUtil-getBounds-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLArrowShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Box2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLArrowShape](/gen/tlschema/TLArrowShape-type), [Box2d](/gen/primitives/Box2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getCenter()` \{#ArrowShapeUtil-getCenter-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLArrowShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLArrowShape](/gen/tlschema/TLArrowShape-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getDefaultProps()` \{#ArrowShapeUtil-getDefaultProps-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLArrowShape['props']
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLArrowShape](/gen/tlschema/TLArrowShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getHandles()` \{#ArrowShapeUtil-getHandles-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLArrowShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLHandle[]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLArrowShape](/gen/tlschema/TLArrowShape-type), [TLHandle](/gen/tlschema/TLHandle-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getLabelBounds()` \{#ArrowShapeUtil-getLabelBounds-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLArrowShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Box2d | null
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLArrowShape](/gen/tlschema/TLArrowShape-type), [Box2d](/gen/primitives/Box2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getOutline()` \{#ArrowShapeUtil-getOutline-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLArrowShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d[]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLArrowShape](/gen/tlschema/TLArrowShape-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getOutlineWithoutLabel()` \{#ArrowShapeUtil-getOutlineWithoutLabel-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLArrowShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d[]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLArrowShape](/gen/tlschema/TLArrowShape-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hitTestLineSegment()` \{#ArrowShapeUtil-hitTestLineSegment-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLArrowShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`A`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`B`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLArrowShape](/gen/tlschema/TLArrowShape-type), [VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hitTestPoint()` \{#ArrowShapeUtil-hitTestPoint-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLArrowShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`point`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLArrowShape](/gen/tlschema/TLArrowShape-type), [VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `indicator()` \{#ArrowShapeUtil-indicator-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLArrowShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element | null
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLArrowShape](/gen/tlschema/TLArrowShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `snapPoints()` \{#ArrowShapeUtil-snapPoints-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`_shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLArrowShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d[]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLArrowShape](/gen/tlschema/TLArrowShape-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `toSvg()` \{#ArrowShapeUtil-toSvg-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLArrowShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`font`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`colors`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLExportColors
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
SVGGElement
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLArrowShape](/gen/tlschema/TLArrowShape-type), [TLExportColors](/gen/editor/~TLExportColors-type), [SVGGElement](/gen/SVGGElement-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,24 +0,0 @@
|
||||||
---
|
|
||||||
title: AssetRecordType
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 4
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
AssetRecordType: import('@tldraw/store').RecordType<TLAsset, 'props' | 'type'>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[RecordType](/gen/store/RecordType-class), [TLAsset](/gen/tlschema/TLAsset-type)
|
|
||||||
|
|
|
@ -1,97 +0,0 @@
|
||||||
---
|
|
||||||
title: BaseBoxShapeTool
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 5
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [children](#BaseBoxShapeTool-children-member)
|
|
||||||
- [id](#BaseBoxShapeTool-id-member)
|
|
||||||
- [initial](#BaseBoxShapeTool-initial-member)
|
|
||||||
- [shapeType](#BaseBoxShapeTool-shapeType-member)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
abstract class BaseBoxShapeTool extends StateNode {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[StateNode](/gen/editor/StateNode-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `children` \{#BaseBoxShapeTool-children-member}
|
|
||||||
|
|
||||||
<Small>Public Static Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
static children: () => (typeof Idle | typeof Pointing)[]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Idle](/gen/editor/~Idle_4-class), [Pointing](/gen/editor/~Pointing_2-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `id` \{#BaseBoxShapeTool-id-member}
|
|
||||||
|
|
||||||
<Small>Public Static Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
static id: string
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `initial` \{#BaseBoxShapeTool-initial-member}
|
|
||||||
|
|
||||||
<Small>Public Static Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
static initial: string
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `shapeType` \{#BaseBoxShapeTool-shapeType-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
abstract shapeType: TLShapeUtilConstructor<any>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeUtilConstructor](/gen/editor/TLShapeUtilConstructor-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,309 +0,0 @@
|
||||||
---
|
|
||||||
title: BaseBoxShapeUtil
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 6
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [onResize](#BaseBoxShapeUtil-onResize-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [getBounds](#BaseBoxShapeUtil-getBounds-member-1)
|
|
||||||
- [getCenter](#BaseBoxShapeUtil-getCenter-member-1)
|
|
||||||
- [getOutline](#BaseBoxShapeUtil-getOutline-member-1)
|
|
||||||
- [hitTestLineSegment](#BaseBoxShapeUtil-hitTestLineSegment-member-1)
|
|
||||||
- [hitTestPoint](#BaseBoxShapeUtil-hitTestPoint-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
abstract class BaseBoxShapeUtil<
|
|
||||||
Shape extends TLBaseBoxShape
|
|
||||||
> extends ShapeUtil<Shape> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLBaseBoxShape](/gen/editor/TLBaseBoxShape-type), [ShapeUtil](/gen/editor/ShapeUtil-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `onResize` \{#BaseBoxShapeUtil-onResize-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onResize: TLOnResizeHandler<any>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnResizeHandler](/gen/editor/TLOnResizeHandler-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `getBounds()` \{#BaseBoxShapeUtil-getBounds-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Shape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Box2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Box2d](/gen/primitives/Box2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getCenter()` \{#BaseBoxShapeUtil-getCenter-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Shape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getOutline()` \{#BaseBoxShapeUtil-getOutline-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Shape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d[]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hitTestLineSegment()` \{#BaseBoxShapeUtil-hitTestLineSegment-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Shape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`A`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`B`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hitTestPoint()` \{#BaseBoxShapeUtil-hitTestPoint-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Shape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`point`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,64 +0,0 @@
|
||||||
---
|
|
||||||
title: BaseRecord
|
|
||||||
status: published
|
|
||||||
category: store
|
|
||||||
group: Interface
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 2
|
|
||||||
---<Small>Public Interface</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [id](#BaseRecord-id-member)
|
|
||||||
- [typeName](#BaseRecord-typeName-member)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
The base record that all records must extend.
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
interface BaseRecord<
|
|
||||||
TypeName extends string,
|
|
||||||
Id extends RecordId<UnknownRecord>
|
|
||||||
> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[RecordId](/gen/store/RecordId-type), [UnknownRecord](/gen/store/UnknownRecord-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `id` \{#BaseRecord-id-member}
|
|
||||||
|
|
||||||
<Small>Public Readonly PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
readonly id: Id
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `typeName` \{#BaseRecord-typeName-member}
|
|
||||||
|
|
||||||
<Small>Public Readonly PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
readonly typeName: TypeName
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: BookmarkShape
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 8
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
BookmarkShape: import('../../../config/defineShape').TLShapeInfo<
|
|
||||||
import('@tldraw/tlschema').TLBookmarkShape
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLBookmarkShape](/gen/tlschema/TLBookmarkShape-type)
|
|
||||||
|
|
|
@ -1,233 +0,0 @@
|
||||||
---
|
|
||||||
title: BookmarkShapeUtil
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 9
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [canResize](#BookmarkShapeUtil-canResize-member)
|
|
||||||
- [hideSelectionBoundsBg](#BookmarkShapeUtil-hideSelectionBoundsBg-member)
|
|
||||||
- [hideSelectionBoundsFg](#BookmarkShapeUtil-hideSelectionBoundsFg-member)
|
|
||||||
- [onBeforeCreate](#BookmarkShapeUtil-onBeforeCreate-member)
|
|
||||||
- [onBeforeUpdate](#BookmarkShapeUtil-onBeforeUpdate-member)
|
|
||||||
- [type](#BookmarkShapeUtil-type-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [component](#BookmarkShapeUtil-component-member-1)
|
|
||||||
- [getDefaultProps](#BookmarkShapeUtil-getDefaultProps-member-1)
|
|
||||||
- [indicator](#BookmarkShapeUtil-indicator-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class BookmarkShapeUtil extends BaseBoxShapeUtil<TLBookmarkShape> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[BaseBoxShapeUtil](/gen/editor/BaseBoxShapeUtil-class), [TLBookmarkShape](/gen/tlschema/TLBookmarkShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `canResize` \{#BookmarkShapeUtil-canResize-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
canResize: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideSelectionBoundsBg` \{#BookmarkShapeUtil-hideSelectionBoundsBg-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideSelectionBoundsBg: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideSelectionBoundsFg` \{#BookmarkShapeUtil-hideSelectionBoundsFg-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideSelectionBoundsFg: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onBeforeCreate` \{#BookmarkShapeUtil-onBeforeCreate-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onBeforeCreate?: TLOnBeforeCreateHandler<TLBookmarkShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnBeforeCreateHandler](/gen/editor/TLOnBeforeCreateHandler-type), [TLBookmarkShape](/gen/tlschema/TLBookmarkShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onBeforeUpdate` \{#BookmarkShapeUtil-onBeforeUpdate-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onBeforeUpdate?: TLOnBeforeUpdateHandler<TLBookmarkShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnBeforeUpdateHandler](/gen/editor/TLOnBeforeUpdateHandler-type), [TLBookmarkShape](/gen/tlschema/TLBookmarkShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `type` \{#BookmarkShapeUtil-type-member}
|
|
||||||
|
|
||||||
<Small>Public Static Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
static type: 'bookmark'
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `component()` \{#BookmarkShapeUtil-component-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLBookmarkShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLBookmarkShape](/gen/tlschema/TLBookmarkShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getDefaultProps()` \{#BookmarkShapeUtil-getDefaultProps-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLBookmarkShape['props']
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLBookmarkShape](/gen/tlschema/TLBookmarkShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `indicator()` \{#BookmarkShapeUtil-indicator-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLBookmarkShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLBookmarkShape](/gen/tlschema/TLBookmarkShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
File diff suppressed because it is too large
Load diff
|
@ -1,85 +0,0 @@
|
||||||
---
|
|
||||||
title: Box2dModel
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Interface
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 6
|
|
||||||
---<Small>Public Interface</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [h](#Box2dModel-h-member)
|
|
||||||
- [w](#Box2dModel-w-member)
|
|
||||||
- [x](#Box2dModel-x-member)
|
|
||||||
- [y](#Box2dModel-y-member)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
A serializable model for 2D boxes.
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
interface Box2dModel {}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `h` \{#Box2dModel-h-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
h: number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `w` \{#Box2dModel-w-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
w: number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `x` \{#Box2dModel-x-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
x: number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `y` \{#Box2dModel-y-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
y: number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,49 +0,0 @@
|
||||||
---
|
|
||||||
title: BreakPointProvider
|
|
||||||
status: published
|
|
||||||
category: ui
|
|
||||||
group: Function
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 0
|
|
||||||
---<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ children }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
{
|
|
||||||
children: any
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: Button
|
|
||||||
status: published
|
|
||||||
category: ui
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 1
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Button: React.ForwardRefExoticComponent<
|
|
||||||
TLUiButtonProps & React.RefAttributes<HTMLButtonElement>
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[React.ForwardRefExoticComponent](/gen/@types/react-React-ForwardRefExoticComponent-interface), [TLUiButtonProps](/gen/ui/TLUiButtonProps-interface), [React.RefAttributes](/gen/@types/react-React-RefAttributes-interface), [HTMLButtonElement](/gen/HTMLButtonElement-interface)
|
|
||||||
|
|
|
@ -1,24 +0,0 @@
|
||||||
---
|
|
||||||
title: CameraRecordType
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 8
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
CameraRecordType: import('@tldraw/store').RecordType<TLCamera, never>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[RecordType](/gen/store/RecordType-class), [TLCamera](/gen/tlschema/TLCamera-interface)
|
|
||||||
|
|
|
@ -1,24 +0,0 @@
|
||||||
---
|
|
||||||
title: Canvas
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 10
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Canvas: React.MemoExoticComponent<() => JSX.Element>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[React.MemoExoticComponent](/gen/@types/react-React-MemoExoticComponent-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
|
@ -1,27 +0,0 @@
|
||||||
---
|
|
||||||
title: CollectionDiff
|
|
||||||
status: published
|
|
||||||
category: store
|
|
||||||
group: TypeAlias
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 3
|
|
||||||
---<Small>Public TypeAlias</Small>
|
|
||||||
|
|
||||||
A diff describing the changes to a collection.
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
type CollectionDiff<T> = {
|
|
||||||
added?: Set<T>
|
|
||||||
removed?: Set<T>
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Set](/gen/Set-interface)
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: ComputedCache
|
|
||||||
status: published
|
|
||||||
category: store
|
|
||||||
group: TypeAlias
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 6
|
|
||||||
---<Small>Public TypeAlias</Small>
|
|
||||||
|
|
||||||
A record store is a collection of records of different types.
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
type ComputedCache<Data, R extends UnknownRecord> = {
|
|
||||||
get(id: IdOf<R>): Data | undefined
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[UnknownRecord](/gen/store/UnknownRecord-type), [IdOf](/gen/store/IdOf-type)
|
|
||||||
|
|
|
@ -1,24 +0,0 @@
|
||||||
---
|
|
||||||
title: ContextMenu
|
|
||||||
status: published
|
|
||||||
category: ui
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 3
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
ContextMenu: ({ children }: { children: any }) => JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
|
@ -1,312 +0,0 @@
|
||||||
---
|
|
||||||
title: CubicSegment2d
|
|
||||||
status: published
|
|
||||||
category: primitives
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 8
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [[Symbol.iterator]](#CubicSegment2d-[Symbol-iterator]-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [getPath](#CubicSegment2d-getPath-member-1)
|
|
||||||
- [getPoint](#CubicSegment2d-getPoint-member-1)
|
|
||||||
- [getX](#CubicSegment2d-getX-member-1)
|
|
||||||
- [getY](#CubicSegment2d-getY-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class CubicSegment2d extends BaseSegment2d<CubicSegment2dModel> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[BaseSegment2d](/gen/primitives/~BaseSegment2d-class), [CubicSegment2dModel](/gen/primitives/CubicSegment2dModel-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Constructor`
|
|
||||||
|
|
||||||
<Small>Public Constructor</Small>
|
|
||||||
|
|
||||||
Constructs a new instance of the `CubicSegment2d` class
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`a`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`b`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`c`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`d`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`p`
|
|
||||||
|
|
||||||
<Small>(optional)</Small>
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `[Symbol.iterator]` \{#CubicSegment2d-[Symbol-iterator]-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
[Symbol.iterator]: (
|
|
||||||
this: InstanceType<typeof CubicSegment2d>
|
|
||||||
) => Generator<VecLike, void, undefined>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Symbol.iterator](/gen/SymbolConstructor-iterator), [InstanceType](/gen/InstanceType-type), [CubicSegment2d](/gen/primitives/CubicSegment2d-class), [Generator](/gen/Generator-interface), [VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `getPath()` \{#CubicSegment2d-getPath-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`head`
|
|
||||||
|
|
||||||
<Small>(optional)</Small>
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
string
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getPoint()` \{#CubicSegment2d-getPoint-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`t`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getX()` \{#CubicSegment2d-getX-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`t`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getY()` \{#CubicSegment2d-getY-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`t`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,115 +0,0 @@
|
||||||
---
|
|
||||||
title: CubicSegment2dModel
|
|
||||||
status: published
|
|
||||||
category: primitives
|
|
||||||
group: Interface
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 9
|
|
||||||
---<Small>Public Interface</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [a](#CubicSegment2dModel-a-member)
|
|
||||||
- [b](#CubicSegment2dModel-b-member)
|
|
||||||
- [c](#CubicSegment2dModel-c-member)
|
|
||||||
- [d](#CubicSegment2dModel-d-member)
|
|
||||||
- [p](#CubicSegment2dModel-p-member)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
interface CubicSegment2dModel {}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `a` \{#CubicSegment2dModel-a-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
a: VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `b` \{#CubicSegment2dModel-b-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
b: VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `c` \{#CubicSegment2dModel-c-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
c: VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `d` \{#CubicSegment2dModel-d-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
d: VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `p` \{#CubicSegment2dModel-p-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
p: number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,244 +0,0 @@
|
||||||
---
|
|
||||||
title: CubicSpline2d
|
|
||||||
status: published
|
|
||||||
category: primitives
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 10
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [segments](#CubicSpline2d-segments-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [FromPoints](#CubicSpline2d-FromPoints-member-1)
|
|
||||||
- [getSegmentsFromPoints](#CubicSpline2d-getSegmentsFromPoints-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class CubicSpline2d extends BaseSpline2d<CubicSegment2dModel> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[BaseSpline2d](/gen/primitives/~BaseSpline2d-class), [CubicSegment2dModel](/gen/primitives/CubicSegment2dModel-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Constructor`
|
|
||||||
|
|
||||||
<Small>Public Constructor</Small>
|
|
||||||
|
|
||||||
Constructs a new instance of the `CubicSpline2d` class
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`points`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike[]
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`k`
|
|
||||||
|
|
||||||
<Small>(optional)</Small>
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`p`
|
|
||||||
|
|
||||||
<Small>(optional)</Small>
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `segments` \{#CubicSpline2d-segments-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
segments: CubicSegment2d[]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[CubicSegment2d](/gen/primitives/CubicSegment2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `FromPoints()` \{#CubicSpline2d-FromPoints-member-1}
|
|
||||||
|
|
||||||
<Small>Public Static Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`points`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d[]
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
CubicSpline2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Vec2d](/gen/primitives/Vec2d-class), [CubicSpline2d](/gen/primitives/CubicSpline2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getSegmentsFromPoints()` \{#CubicSpline2d-getSegmentsFromPoints-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`points`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike[]
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`k`
|
|
||||||
|
|
||||||
<Small>(optional)</Small>
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`p`
|
|
||||||
|
|
||||||
<Small>(optional)</Small>
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
CubicSegment2d[]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type), [CubicSegment2d](/gen/primitives/CubicSegment2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,37 +0,0 @@
|
||||||
---
|
|
||||||
title: DefaultColorStyle
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 15
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
DefaultColorStyle: import('./StyleProp').EnumStyleProp<
|
|
||||||
| 'black'
|
|
||||||
| 'blue'
|
|
||||||
| 'green'
|
|
||||||
| 'grey'
|
|
||||||
| 'light-blue'
|
|
||||||
| 'light-green'
|
|
||||||
| 'light-red'
|
|
||||||
| 'light-violet'
|
|
||||||
| 'orange'
|
|
||||||
| 'red'
|
|
||||||
| 'violet'
|
|
||||||
| 'yellow'
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[EnumStyleProp](/gen/tlschema/EnumStyleProp-class)
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: DefaultDashStyle
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 16
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
DefaultDashStyle: import('./StyleProp').EnumStyleProp<
|
|
||||||
'dashed' | 'dotted' | 'draw' | 'solid'
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[EnumStyleProp](/gen/tlschema/EnumStyleProp-class)
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: DefaultFillStyle
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 17
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
DefaultFillStyle: import('./StyleProp').EnumStyleProp<
|
|
||||||
'none' | 'pattern' | 'semi' | 'solid'
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[EnumStyleProp](/gen/tlschema/EnumStyleProp-class)
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: DefaultFontStyle
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 18
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
DefaultFontStyle: import('./StyleProp').EnumStyleProp<
|
|
||||||
'draw' | 'mono' | 'sans' | 'serif'
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[EnumStyleProp](/gen/tlschema/EnumStyleProp-class)
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: DefaultHorizontalAlignStyle
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 19
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
DefaultHorizontalAlignStyle: import('./StyleProp').EnumStyleProp<
|
|
||||||
'end-legacy' | 'end' | 'middle-legacy' | 'middle' | 'start-legacy' | 'start'
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[EnumStyleProp](/gen/tlschema/EnumStyleProp-class)
|
|
||||||
|
|
|
@ -1,24 +0,0 @@
|
||||||
---
|
|
||||||
title: DefaultSizeStyle
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 20
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
DefaultSizeStyle: import('./StyleProp').EnumStyleProp<'l' | 'm' | 's' | 'xl'>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[EnumStyleProp](/gen/tlschema/EnumStyleProp-class)
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: DefaultVerticalAlignStyle
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 21
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
DefaultVerticalAlignStyle: import('./StyleProp').EnumStyleProp<
|
|
||||||
'end' | 'middle' | 'start'
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[EnumStyleProp](/gen/tlschema/EnumStyleProp-class)
|
|
||||||
|
|
|
@ -1,241 +0,0 @@
|
||||||
---
|
|
||||||
title: Dialog
|
|
||||||
status: published
|
|
||||||
category: ui
|
|
||||||
group: Namespace
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 4
|
|
||||||
---<Small>None Namespace</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [Body](#Dialog-Body-function-1)
|
|
||||||
- [CloseButton](#Dialog-CloseButton-function-1)
|
|
||||||
- [Footer](#Dialog-Footer-function-1)
|
|
||||||
- [Header](#Dialog-Header-function-1)
|
|
||||||
- [Title](#Dialog-Title-function-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `Body` \{#Dialog-Body-function-1}
|
|
||||||
|
|
||||||
<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ className, children, style, }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
{
|
|
||||||
className?: string
|
|
||||||
children: any
|
|
||||||
style?: React.CSSProperties
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[React.CSSProperties](/gen/@types/react-React-CSSProperties-interface), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `CloseButton` \{#Dialog-CloseButton-function-1}
|
|
||||||
|
|
||||||
<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Footer` \{#Dialog-Footer-function-1}
|
|
||||||
|
|
||||||
<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ className, children }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
{
|
|
||||||
className?: string
|
|
||||||
children: any
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Header` \{#Dialog-Header-function-1}
|
|
||||||
|
|
||||||
<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ className, children }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
{
|
|
||||||
className?: string
|
|
||||||
children: any
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Title` \{#Dialog-Title-function-1}
|
|
||||||
|
|
||||||
<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ className, children }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
{
|
|
||||||
className?: string
|
|
||||||
children: any
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,24 +0,0 @@
|
||||||
---
|
|
||||||
title: DocumentRecordType
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 22
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
DocumentRecordType: import('@tldraw/store').RecordType<TLDocument, never>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[RecordType](/gen/store/RecordType-class), [TLDocument](/gen/tlschema/TLDocument-interface)
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: DrawShape
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 26
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
DrawShape: import('../../../config/defineShape').TLShapeInfo<
|
|
||||||
import('@tldraw/tlschema').TLDrawShape
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLDrawShape](/gen/tlschema/TLDrawShape-type)
|
|
||||||
|
|
|
@ -1,630 +0,0 @@
|
||||||
---
|
|
||||||
title: DrawShapeUtil
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 27
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [hideResizeHandles](#DrawShapeUtil-hideResizeHandles-member)
|
|
||||||
- [hideRotateHandle](#DrawShapeUtil-hideRotateHandle-member)
|
|
||||||
- [hideSelectionBoundsBg](#DrawShapeUtil-hideSelectionBoundsBg-member)
|
|
||||||
- [hideSelectionBoundsFg](#DrawShapeUtil-hideSelectionBoundsFg-member)
|
|
||||||
- [isClosed](#DrawShapeUtil-isClosed-member)
|
|
||||||
- [onResize](#DrawShapeUtil-onResize-member)
|
|
||||||
- [type](#DrawShapeUtil-type-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [component](#DrawShapeUtil-component-member-1)
|
|
||||||
- [expandSelectionOutlinePx](#DrawShapeUtil-expandSelectionOutlinePx-member-1)
|
|
||||||
- [getBounds](#DrawShapeUtil-getBounds-member-1)
|
|
||||||
- [getCenter](#DrawShapeUtil-getCenter-member-1)
|
|
||||||
- [getDefaultProps](#DrawShapeUtil-getDefaultProps-member-1)
|
|
||||||
- [getOutline](#DrawShapeUtil-getOutline-member-1)
|
|
||||||
- [hitTestLineSegment](#DrawShapeUtil-hitTestLineSegment-member-1)
|
|
||||||
- [hitTestPoint](#DrawShapeUtil-hitTestPoint-member-1)
|
|
||||||
- [indicator](#DrawShapeUtil-indicator-member-1)
|
|
||||||
- [toSvg](#DrawShapeUtil-toSvg-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class DrawShapeUtil extends ShapeUtil<TLDrawShape> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[ShapeUtil](/gen/editor/ShapeUtil-class), [TLDrawShape](/gen/tlschema/TLDrawShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `hideResizeHandles` \{#DrawShapeUtil-hideResizeHandles-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideResizeHandles: (shape: TLDrawShape) => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLDrawShape](/gen/tlschema/TLDrawShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideRotateHandle` \{#DrawShapeUtil-hideRotateHandle-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideRotateHandle: (shape: TLDrawShape) => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLDrawShape](/gen/tlschema/TLDrawShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideSelectionBoundsBg` \{#DrawShapeUtil-hideSelectionBoundsBg-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideSelectionBoundsBg: (shape: TLDrawShape) => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLDrawShape](/gen/tlschema/TLDrawShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideSelectionBoundsFg` \{#DrawShapeUtil-hideSelectionBoundsFg-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideSelectionBoundsFg: (shape: TLDrawShape) => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLDrawShape](/gen/tlschema/TLDrawShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `isClosed` \{#DrawShapeUtil-isClosed-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
isClosed: (shape: TLDrawShape) => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLDrawShape](/gen/tlschema/TLDrawShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onResize` \{#DrawShapeUtil-onResize-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onResize: TLOnResizeHandler<TLDrawShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnResizeHandler](/gen/editor/TLOnResizeHandler-type), [TLDrawShape](/gen/tlschema/TLDrawShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `type` \{#DrawShapeUtil-type-member}
|
|
||||||
|
|
||||||
<Small>Public Static Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
static type: 'draw'
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `component()` \{#DrawShapeUtil-component-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLDrawShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLDrawShape](/gen/tlschema/TLDrawShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `expandSelectionOutlinePx()` \{#DrawShapeUtil-expandSelectionOutlinePx-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLDrawShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLDrawShape](/gen/tlschema/TLDrawShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getBounds()` \{#DrawShapeUtil-getBounds-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLDrawShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Box2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLDrawShape](/gen/tlschema/TLDrawShape-type), [Box2d](/gen/primitives/Box2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getCenter()` \{#DrawShapeUtil-getCenter-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLDrawShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLDrawShape](/gen/tlschema/TLDrawShape-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getDefaultProps()` \{#DrawShapeUtil-getDefaultProps-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLDrawShape['props']
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLDrawShape](/gen/tlschema/TLDrawShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getOutline()` \{#DrawShapeUtil-getOutline-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLDrawShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d[]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLDrawShape](/gen/tlschema/TLDrawShape-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hitTestLineSegment()` \{#DrawShapeUtil-hitTestLineSegment-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLDrawShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`A`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`B`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLDrawShape](/gen/tlschema/TLDrawShape-type), [VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hitTestPoint()` \{#DrawShapeUtil-hitTestPoint-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLDrawShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`point`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLDrawShape](/gen/tlschema/TLDrawShape-type), [VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `indicator()` \{#DrawShapeUtil-indicator-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLDrawShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLDrawShape](/gen/tlschema/TLDrawShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `toSvg()` \{#DrawShapeUtil-toSvg-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLDrawShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`_font`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
string | undefined
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`colors`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLExportColors
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
SVGGElement
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLDrawShape](/gen/tlschema/TLDrawShape-type), [TLExportColors](/gen/editor/~TLExportColors-type), [SVGGElement](/gen/SVGGElement-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,519 +0,0 @@
|
||||||
---
|
|
||||||
title: DropdownMenu
|
|
||||||
status: published
|
|
||||||
category: ui
|
|
||||||
group: Namespace
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 5
|
|
||||||
---<Small>None Namespace</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [CheckboxItem](#DropdownMenu-CheckboxItem-function-1)
|
|
||||||
- [Content](#DropdownMenu-Content-function-1)
|
|
||||||
- [Group](#DropdownMenu-Group-function-1)
|
|
||||||
- [Indicator](#DropdownMenu-Indicator-function-1)
|
|
||||||
- [Item](#DropdownMenu-Item-function-1)
|
|
||||||
- [RadioItem](#DropdownMenu-RadioItem-function-1)
|
|
||||||
- [Root](#DropdownMenu-Root-function-1)
|
|
||||||
- [Sub](#DropdownMenu-Sub-function-1)
|
|
||||||
- [SubContent](#DropdownMenu-SubContent-function-1)
|
|
||||||
- [SubTrigger](#DropdownMenu-SubTrigger-function-1)
|
|
||||||
- [Trigger](#DropdownMenu-Trigger-function-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `CheckboxItem` \{#DropdownMenu-CheckboxItem-function-1}
|
|
||||||
|
|
||||||
<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ children, onSelect, ...rest }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
DropdownMenuCheckboxItemProps
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[DropdownMenuCheckboxItemProps](/gen/ui/DropdownMenu-DropdownMenuCheckboxItemProps-interface), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Content` \{#DropdownMenu-Content-function-1}
|
|
||||||
|
|
||||||
<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ side, align, sideOffset, alignOffset, children, }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
{
|
|
||||||
children: any
|
|
||||||
alignOffset?: number
|
|
||||||
sideOffset?: number
|
|
||||||
align?: 'center' | 'end' | 'start'
|
|
||||||
side?: 'bottom' | 'left' | 'right' | 'top'
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Group` \{#DropdownMenu-Group-function-1}
|
|
||||||
|
|
||||||
<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ children, size, }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
{
|
|
||||||
children: any
|
|
||||||
size?: 'medium' | 'small' | 'tiny' | 'wide'
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Indicator` \{#DropdownMenu-Indicator-function-1}
|
|
||||||
|
|
||||||
<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Item` \{#DropdownMenu-Item-function-1}
|
|
||||||
|
|
||||||
<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ noClose, ...props }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
DropdownMenuItemProps
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[DropdownMenuItemProps](/gen/ui/DropdownMenu-DropdownMenuItemProps-interface), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `RadioItem` \{#DropdownMenu-RadioItem-function-1}
|
|
||||||
|
|
||||||
<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ children, onSelect, ...rest }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
DropdownMenuCheckboxItemProps
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[DropdownMenuCheckboxItemProps](/gen/ui/DropdownMenu-DropdownMenuCheckboxItemProps-interface), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Root` \{#DropdownMenu-Root-function-1}
|
|
||||||
|
|
||||||
<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ id, children, modal, }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
{
|
|
||||||
id: string
|
|
||||||
children: any
|
|
||||||
modal?: boolean
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Sub` \{#DropdownMenu-Sub-function-1}
|
|
||||||
|
|
||||||
<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ id, children }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
{
|
|
||||||
id: string
|
|
||||||
children: any
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `SubContent` \{#DropdownMenu-SubContent-function-1}
|
|
||||||
|
|
||||||
<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ alignOffset, sideOffset, children, }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
{
|
|
||||||
alignOffset?: number
|
|
||||||
sideOffset?: number
|
|
||||||
children: any
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `SubTrigger` \{#DropdownMenu-SubTrigger-function-1}
|
|
||||||
|
|
||||||
<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ label, 'data-testid': testId, 'data-direction': dataDirection, }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
{
|
|
||||||
label: TLUiTranslationKey
|
|
||||||
'data-testid'?: string
|
|
||||||
'data-direction'?: 'left' | 'right'
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLUiTranslationKey](/gen/ui/TLUiTranslationKey-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Trigger` \{#DropdownMenu-Trigger-function-1}
|
|
||||||
|
|
||||||
<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ children, 'data-testid': testId, }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
{
|
|
||||||
children: any
|
|
||||||
'data-testid'?: string
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,40 +0,0 @@
|
||||||
---
|
|
||||||
title: EASINGS
|
|
||||||
status: published
|
|
||||||
category: primitives
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 13
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
EASINGS: {
|
|
||||||
readonly linear: (t: number) => number
|
|
||||||
readonly easeInQuad: (t: number) => number
|
|
||||||
readonly easeOutQuad: (t: number) => number
|
|
||||||
readonly easeInOutQuad: (t: number) => number
|
|
||||||
readonly easeInCubic: (t: number) => number
|
|
||||||
readonly easeOutCubic: (t: number) => number
|
|
||||||
readonly easeInOutCubic: (t: number) => number
|
|
||||||
readonly easeInQuart: (t: number) => number
|
|
||||||
readonly easeOutQuart: (t: number) => number
|
|
||||||
readonly easeInOutQuart: (t: number) => number
|
|
||||||
readonly easeInQuint: (t: number) => number
|
|
||||||
readonly easeOutQuint: (t: number) => number
|
|
||||||
readonly easeInOutQuint: (t: number) => number
|
|
||||||
readonly easeInSine: (t: number) => number
|
|
||||||
readonly easeOutSine: (t: number) => number
|
|
||||||
readonly easeInOutSine: (t: number) => number
|
|
||||||
readonly easeInExpo: (t: number) => number
|
|
||||||
readonly easeOutExpo: (t: number) => number
|
|
||||||
readonly easeInOutExpo: (t: number) => number
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
|
@ -1,222 +0,0 @@
|
||||||
---
|
|
||||||
title: EMBED_DEFINITIONS
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 24
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
EMBED_DEFINITIONS: readonly [
|
|
||||||
{
|
|
||||||
readonly type: 'tldraw'
|
|
||||||
readonly title: 'tldraw'
|
|
||||||
readonly hostnames: readonly [
|
|
||||||
'beta.tldraw.com',
|
|
||||||
'lite.tldraw.com',
|
|
||||||
'www.tldraw.com'
|
|
||||||
]
|
|
||||||
readonly minWidth: 300
|
|
||||||
readonly minHeight: 300
|
|
||||||
readonly width: 720
|
|
||||||
readonly height: 500
|
|
||||||
readonly doesResize: true
|
|
||||||
readonly canUnmount: true
|
|
||||||
readonly toEmbedUrl: (url: string) => string | undefined
|
|
||||||
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly type: 'codesandbox'
|
|
||||||
readonly title: 'CodeSandbox'
|
|
||||||
readonly hostnames: readonly ['codesandbox.io']
|
|
||||||
readonly minWidth: 300
|
|
||||||
readonly minHeight: 300
|
|
||||||
readonly width: 720
|
|
||||||
readonly height: 500
|
|
||||||
readonly doesResize: true
|
|
||||||
readonly canUnmount: false
|
|
||||||
readonly toEmbedUrl: (url: string) => string | undefined
|
|
||||||
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly type: 'codepen'
|
|
||||||
readonly title: 'Codepen'
|
|
||||||
readonly hostnames: readonly ['codepen.io']
|
|
||||||
readonly minWidth: 300
|
|
||||||
readonly minHeight: 300
|
|
||||||
readonly width: 520
|
|
||||||
readonly height: 400
|
|
||||||
readonly doesResize: true
|
|
||||||
readonly canUnmount: false
|
|
||||||
readonly toEmbedUrl: (url: string) => string | undefined
|
|
||||||
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly type: 'scratch'
|
|
||||||
readonly title: 'Scratch'
|
|
||||||
readonly hostnames: readonly ['scratch.mit.edu']
|
|
||||||
readonly width: 520
|
|
||||||
readonly height: 400
|
|
||||||
readonly doesResize: false
|
|
||||||
readonly canUnmount: false
|
|
||||||
readonly toEmbedUrl: (url: string) => string | undefined
|
|
||||||
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly type: 'youtube'
|
|
||||||
readonly title: 'YouTube'
|
|
||||||
readonly hostnames: readonly ['*.youtube.com', 'youtube.com', 'youtu.be']
|
|
||||||
readonly width: 800
|
|
||||||
readonly height: 450
|
|
||||||
readonly doesResize: true
|
|
||||||
readonly canUnmount: false
|
|
||||||
readonly overridePermissions: {
|
|
||||||
readonly 'allow-presentation': true
|
|
||||||
}
|
|
||||||
readonly isAspectRatioLocked: true
|
|
||||||
readonly toEmbedUrl: (url: string) => string | undefined
|
|
||||||
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly type: 'figma'
|
|
||||||
readonly title: 'Figma'
|
|
||||||
readonly hostnames: readonly ['figma.com']
|
|
||||||
readonly width: 720
|
|
||||||
readonly height: 500
|
|
||||||
readonly doesResize: true
|
|
||||||
readonly canUnmount: true
|
|
||||||
readonly toEmbedUrl: (url: string) => string | undefined
|
|
||||||
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly type: 'google_maps'
|
|
||||||
readonly title: 'Google Maps'
|
|
||||||
readonly hostnames: readonly ['google.*']
|
|
||||||
readonly width: 720
|
|
||||||
readonly height: 500
|
|
||||||
readonly doesResize: true
|
|
||||||
readonly canUnmount: false
|
|
||||||
readonly toEmbedUrl: (url: string) => string | undefined
|
|
||||||
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly type: 'google_calendar'
|
|
||||||
readonly title: 'Google Calendar'
|
|
||||||
readonly hostnames: readonly ['calendar.google.*']
|
|
||||||
readonly width: 720
|
|
||||||
readonly height: 500
|
|
||||||
readonly minWidth: 460
|
|
||||||
readonly minHeight: 360
|
|
||||||
readonly doesResize: true
|
|
||||||
readonly canUnmount: false
|
|
||||||
readonly instructionLink: 'https://support.google.com/calendar/answer/41207?hl=en'
|
|
||||||
readonly toEmbedUrl: (url: string) => string | undefined
|
|
||||||
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly type: 'google_slides'
|
|
||||||
readonly title: 'Google Slides'
|
|
||||||
readonly hostnames: readonly ['docs.google.*']
|
|
||||||
readonly width: 720
|
|
||||||
readonly height: 500
|
|
||||||
readonly minWidth: 460
|
|
||||||
readonly minHeight: 360
|
|
||||||
readonly doesResize: true
|
|
||||||
readonly canUnmount: false
|
|
||||||
readonly toEmbedUrl: (url: string) => string | undefined
|
|
||||||
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly type: 'github_gist'
|
|
||||||
readonly title: 'GitHub Gist'
|
|
||||||
readonly hostnames: readonly ['gist.github.com']
|
|
||||||
readonly width: 720
|
|
||||||
readonly height: 500
|
|
||||||
readonly doesResize: true
|
|
||||||
readonly canUnmount: true
|
|
||||||
readonly toEmbedUrl: (url: string) => string | undefined
|
|
||||||
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly type: 'replit'
|
|
||||||
readonly title: 'Replit'
|
|
||||||
readonly hostnames: readonly ['replit.com']
|
|
||||||
readonly width: 720
|
|
||||||
readonly height: 500
|
|
||||||
readonly doesResize: true
|
|
||||||
readonly canUnmount: false
|
|
||||||
readonly toEmbedUrl: (url: string) => string | undefined
|
|
||||||
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly type: 'felt'
|
|
||||||
readonly title: 'Felt'
|
|
||||||
readonly hostnames: readonly ['felt.com']
|
|
||||||
readonly width: 720
|
|
||||||
readonly height: 500
|
|
||||||
readonly doesResize: true
|
|
||||||
readonly canUnmount: false
|
|
||||||
readonly toEmbedUrl: (url: string) => string | undefined
|
|
||||||
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly type: 'spotify'
|
|
||||||
readonly title: 'Spotify'
|
|
||||||
readonly hostnames: readonly ['open.spotify.com']
|
|
||||||
readonly width: 720
|
|
||||||
readonly height: 500
|
|
||||||
readonly minHeight: 500
|
|
||||||
readonly overrideOutlineRadius: 12
|
|
||||||
readonly doesResize: true
|
|
||||||
readonly canUnmount: false
|
|
||||||
readonly toEmbedUrl: (url: string) => string | undefined
|
|
||||||
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly type: 'vimeo'
|
|
||||||
readonly title: 'Vimeo'
|
|
||||||
readonly hostnames: readonly ['vimeo.com', 'player.vimeo.com']
|
|
||||||
readonly width: 640
|
|
||||||
readonly height: 360
|
|
||||||
readonly doesResize: true
|
|
||||||
readonly canUnmount: false
|
|
||||||
readonly isAspectRatioLocked: true
|
|
||||||
readonly toEmbedUrl: (url: string) => string | undefined
|
|
||||||
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly type: 'excalidraw'
|
|
||||||
readonly title: 'Excalidraw'
|
|
||||||
readonly hostnames: readonly ['excalidraw.com']
|
|
||||||
readonly width: 720
|
|
||||||
readonly height: 500
|
|
||||||
readonly doesResize: true
|
|
||||||
readonly canUnmount: false
|
|
||||||
readonly isAspectRatioLocked: true
|
|
||||||
readonly toEmbedUrl: (url: string) => string | undefined
|
|
||||||
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly type: 'observable'
|
|
||||||
readonly title: 'Observable'
|
|
||||||
readonly hostnames: readonly ['observablehq.com']
|
|
||||||
readonly width: 720
|
|
||||||
readonly height: 500
|
|
||||||
readonly doesResize: true
|
|
||||||
readonly canUnmount: false
|
|
||||||
readonly isAspectRatioLocked: false
|
|
||||||
readonly backgroundColor: '#fff'
|
|
||||||
readonly toEmbedUrl: (url: string) => string | undefined
|
|
||||||
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
||||||
}
|
|
||||||
]
|
|
||||||
```
|
|
||||||
|
|
|
@ -1,20 +0,0 @@
|
||||||
---
|
|
||||||
title: EPSILON
|
|
||||||
status: published
|
|
||||||
category: primitives
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 15
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
EPSILON: number
|
|
||||||
```
|
|
||||||
|
|
|
@ -1,27 +0,0 @@
|
||||||
---
|
|
||||||
title: EVENT_NAME_MAP
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 33
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
EVENT_NAME_MAP: Record<
|
|
||||||
Exclude<TLEventName, TLPinchEventName>,
|
|
||||||
keyof TLEventHandlers
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Record](/gen/Record-type), [Exclude](/gen/Exclude-type), [TLEventName](/gen/editor/TLEventName-type), [TLPinchEventName](/gen/editor/TLPinchEventName-type), [TLEventHandlers](/gen/editor/TLEventHandlers-interface)
|
|
||||||
|
|
|
@ -1,24 +0,0 @@
|
||||||
---
|
|
||||||
title: EasingType
|
|
||||||
status: published
|
|
||||||
category: primitives
|
|
||||||
group: TypeAlias
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 14
|
|
||||||
---<Small>Public TypeAlias</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
type EasingType = keyof typeof EASINGS
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[EASINGS](/gen/primitives/EASINGS-var)
|
|
||||||
|
|
File diff suppressed because it is too large
Load diff
|
@ -1,41 +0,0 @@
|
||||||
---
|
|
||||||
title: EmbedDefinition
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: TypeAlias
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 25
|
|
||||||
---<Small>Public TypeAlias</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
type EmbedDefinition = {
|
|
||||||
readonly type: string
|
|
||||||
readonly title: string
|
|
||||||
readonly hostnames: readonly string[]
|
|
||||||
readonly minWidth?: number
|
|
||||||
readonly minHeight?: number
|
|
||||||
readonly width: number
|
|
||||||
readonly height: number
|
|
||||||
readonly doesResize: boolean
|
|
||||||
readonly canUnmount: boolean
|
|
||||||
readonly isAspectRatioLocked?: boolean
|
|
||||||
readonly overridePermissions?: TLEmbedShapePermissions
|
|
||||||
readonly instructionLink?: string
|
|
||||||
readonly backgroundColor?: string
|
|
||||||
readonly overrideOutlineRadius?: number
|
|
||||||
readonly toEmbedUrl: (url: string) => string | undefined
|
|
||||||
readonly fromEmbedUrl: (url: string) => string | undefined
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLEmbedShapePermissions](/gen/tlschema/TLEmbedShapePermissions-type)
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: EmbedShape
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 29
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
EmbedShape: import('../../../config/defineShape').TLShapeInfo<
|
|
||||||
import('@tldraw/tlschema').TLEmbedShape
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type)
|
|
||||||
|
|
|
@ -1,281 +0,0 @@
|
||||||
---
|
|
||||||
title: EmbedShapeUtil
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 30
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [canEdit](#EmbedShapeUtil-canEdit-member)
|
|
||||||
- [canResize](#EmbedShapeUtil-canResize-member)
|
|
||||||
- [canUnmount](#EmbedShapeUtil-canUnmount-member)
|
|
||||||
- [hideSelectionBoundsBg](#EmbedShapeUtil-hideSelectionBoundsBg-member)
|
|
||||||
- [hideSelectionBoundsFg](#EmbedShapeUtil-hideSelectionBoundsFg-member)
|
|
||||||
- [isAspectRatioLocked](#EmbedShapeUtil-isAspectRatioLocked-member)
|
|
||||||
- [onResize](#EmbedShapeUtil-onResize-member)
|
|
||||||
- [type](#EmbedShapeUtil-type-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [component](#EmbedShapeUtil-component-member-1)
|
|
||||||
- [getDefaultProps](#EmbedShapeUtil-getDefaultProps-member-1)
|
|
||||||
- [indicator](#EmbedShapeUtil-indicator-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class EmbedShapeUtil extends BaseBoxShapeUtil<TLEmbedShape> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[BaseBoxShapeUtil](/gen/editor/BaseBoxShapeUtil-class), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `canEdit` \{#EmbedShapeUtil-canEdit-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
canEdit: TLShapeUtilFlag<TLEmbedShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `canResize` \{#EmbedShapeUtil-canResize-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
canResize: (shape: TLEmbedShape) => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLEmbedShape](/gen/tlschema/TLEmbedShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `canUnmount` \{#EmbedShapeUtil-canUnmount-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
canUnmount: TLShapeUtilFlag<TLEmbedShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideSelectionBoundsBg` \{#EmbedShapeUtil-hideSelectionBoundsBg-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideSelectionBoundsBg: TLShapeUtilFlag<TLEmbedShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideSelectionBoundsFg` \{#EmbedShapeUtil-hideSelectionBoundsFg-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideSelectionBoundsFg: TLShapeUtilFlag<TLEmbedShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `isAspectRatioLocked` \{#EmbedShapeUtil-isAspectRatioLocked-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
isAspectRatioLocked: TLShapeUtilFlag<TLEmbedShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeUtilFlag](/gen/editor/TLShapeUtilFlag-type), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onResize` \{#EmbedShapeUtil-onResize-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onResize: TLOnResizeHandler<TLEmbedShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnResizeHandler](/gen/editor/TLOnResizeHandler-type), [TLEmbedShape](/gen/tlschema/TLEmbedShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `type` \{#EmbedShapeUtil-type-member}
|
|
||||||
|
|
||||||
<Small>Public Static Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
static type: 'embed'
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `component()` \{#EmbedShapeUtil-component-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLEmbedShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLEmbedShape](/gen/tlschema/TLEmbedShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getDefaultProps()` \{#EmbedShapeUtil-getDefaultProps-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLEmbedShape['props']
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLEmbedShape](/gen/tlschema/TLEmbedShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `indicator()` \{#EmbedShapeUtil-indicator-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLEmbedShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLEmbedShape](/gen/tlschema/TLEmbedShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,46 +0,0 @@
|
||||||
---
|
|
||||||
title: EnumStyleProp
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 28
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [values](#EnumStyleProp-values-member)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class EnumStyleProp<T> extends StyleProp<T> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[StyleProp](/gen/tlschema/StyleProp-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `values` \{#EnumStyleProp-values-member}
|
|
||||||
|
|
||||||
<Small>Public Readonly Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
readonly values: readonly T[]
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,166 +0,0 @@
|
||||||
---
|
|
||||||
title: ErrorBoundary
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 31
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [state](#ErrorBoundary-state-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [componentDidCatch](#ErrorBoundary-componentDidCatch-member-1)
|
|
||||||
- [getDerivedStateFromError](#ErrorBoundary-getDerivedStateFromError-member-1)
|
|
||||||
- [render](#ErrorBoundary-render-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class ErrorBoundary extends React.Component<
|
|
||||||
React.PropsWithRef<React.PropsWithChildren<TLErrorBoundaryProps>>,
|
|
||||||
TLErrorBoundaryState
|
|
||||||
> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[React.Component](/gen/@types/react-React-Component-class), [React.PropsWithRef](/gen/@types/react-React-PropsWithRef-type), [React.PropsWithChildren](/gen/@types/react-React-PropsWithChildren-type), [TLErrorBoundaryProps](/gen/editor/TLErrorBoundaryProps-interface), [TLErrorBoundaryState](/gen/editor/~TLErrorBoundaryState-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `state` \{#ErrorBoundary-state-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
state: TLErrorBoundaryState
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLErrorBoundaryState](/gen/editor/~TLErrorBoundaryState-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `componentDidCatch()` \{#ErrorBoundary-componentDidCatch-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`error`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
unknown
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
void
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getDerivedStateFromError()` \{#ErrorBoundary-getDerivedStateFromError-member-1}
|
|
||||||
|
|
||||||
<Small>Public Static Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`error`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Error
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
{
|
|
||||||
error: Error
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Error](/gen/Error-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `render()` \{#ErrorBoundary-render-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
| boolean
|
|
||||||
| JSX.Element
|
|
||||||
| null
|
|
||||||
| number
|
|
||||||
| React.ReactFragment
|
|
||||||
| string
|
|
||||||
| undefined
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[JSX.Element](/gen/@types/react-__global-JSX-Element-interface), [React.ReactFragment](/gen/@types/react-React-ReactFragment-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,49 +0,0 @@
|
||||||
---
|
|
||||||
title: ErrorScreen
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Function
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 32
|
|
||||||
---<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ children }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
{
|
|
||||||
children: any
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: FrameShape
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 35
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
FrameShape: import('../../../config/defineShape').TLShapeInfo<
|
|
||||||
import('@tldraw/tlschema').TLFrameShape
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLFrameShape](/gen/tlschema/TLFrameShape-type)
|
|
||||||
|
|
|
@ -1,373 +0,0 @@
|
||||||
---
|
|
||||||
title: FrameShapeUtil
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 36
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [canBind](#FrameShapeUtil-canBind-member)
|
|
||||||
- [canDropShapes](#FrameShapeUtil-canDropShapes-member)
|
|
||||||
- [canEdit](#FrameShapeUtil-canEdit-member)
|
|
||||||
- [canReceiveNewChildrenOfType](#FrameShapeUtil-canReceiveNewChildrenOfType-member)
|
|
||||||
- [onDragShapesOut](#FrameShapeUtil-onDragShapesOut-member)
|
|
||||||
- [onDragShapesOver](#FrameShapeUtil-onDragShapesOver-member)
|
|
||||||
- [onResizeEnd](#FrameShapeUtil-onResizeEnd-member)
|
|
||||||
- [type](#FrameShapeUtil-type-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [component](#FrameShapeUtil-component-member-1)
|
|
||||||
- [getDefaultProps](#FrameShapeUtil-getDefaultProps-member-1)
|
|
||||||
- [indicator](#FrameShapeUtil-indicator-member-1)
|
|
||||||
- [providesBackgroundForChildren](#FrameShapeUtil-providesBackgroundForChildren-member-1)
|
|
||||||
- [toSvg](#FrameShapeUtil-toSvg-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class FrameShapeUtil extends BaseBoxShapeUtil<TLFrameShape> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[BaseBoxShapeUtil](/gen/editor/BaseBoxShapeUtil-class), [TLFrameShape](/gen/tlschema/TLFrameShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `canBind` \{#FrameShapeUtil-canBind-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
canBind: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `canDropShapes` \{#FrameShapeUtil-canDropShapes-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
canDropShapes: (shape: TLFrameShape, _shapes: TLShape[]) => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLFrameShape](/gen/tlschema/TLFrameShape-type), [TLShape](/gen/tlschema/TLShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `canEdit` \{#FrameShapeUtil-canEdit-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
canEdit: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `canReceiveNewChildrenOfType` \{#FrameShapeUtil-canReceiveNewChildrenOfType-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
canReceiveNewChildrenOfType: (
|
|
||||||
shape: TLShape,
|
|
||||||
_type: TLShape['type']
|
|
||||||
) => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShape](/gen/tlschema/TLShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onDragShapesOut` \{#FrameShapeUtil-onDragShapesOut-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onDragShapesOut: (_shape: TLFrameShape, shapes: TLShape[]) => void
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLFrameShape](/gen/tlschema/TLFrameShape-type), [TLShape](/gen/tlschema/TLShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onDragShapesOver` \{#FrameShapeUtil-onDragShapesOver-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onDragShapesOver: (
|
|
||||||
frame: TLFrameShape,
|
|
||||||
shapes: TLShape[]
|
|
||||||
) => {
|
|
||||||
shouldHint: boolean
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLFrameShape](/gen/tlschema/TLFrameShape-type), [TLShape](/gen/tlschema/TLShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onResizeEnd` \{#FrameShapeUtil-onResizeEnd-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onResizeEnd: TLOnResizeEndHandler<TLFrameShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnResizeEndHandler](/gen/editor/TLOnResizeEndHandler-type), [TLFrameShape](/gen/tlschema/TLFrameShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `type` \{#FrameShapeUtil-type-member}
|
|
||||||
|
|
||||||
<Small>Public Static Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
static type: 'frame'
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `component()` \{#FrameShapeUtil-component-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLFrameShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLFrameShape](/gen/tlschema/TLFrameShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getDefaultProps()` \{#FrameShapeUtil-getDefaultProps-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLFrameShape['props']
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLFrameShape](/gen/tlschema/TLFrameShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `indicator()` \{#FrameShapeUtil-indicator-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLFrameShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLFrameShape](/gen/tlschema/TLFrameShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `providesBackgroundForChildren()` \{#FrameShapeUtil-providesBackgroundForChildren-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `toSvg()` \{#FrameShapeUtil-toSvg-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLFrameShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`font`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`colors`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLExportColors
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Promise<SVGElement> | SVGElement
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLFrameShape](/gen/tlschema/TLFrameShape-type), [TLExportColors](/gen/editor/~TLExportColors-type), [Promise](/gen/Promise-interface), [SVGElement](/gen/SVGElement-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,24 +0,0 @@
|
||||||
---
|
|
||||||
title: GRID_STEPS
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 59
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
GRID_STEPS: {
|
|
||||||
min: number
|
|
||||||
mid: number
|
|
||||||
step: number
|
|
||||||
}[]
|
|
||||||
```
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: GeoShape
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 37
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
GeoShape: import('../../../config/defineShape').TLShapeInfo<
|
|
||||||
import('@tldraw/tlschema').TLGeoShape
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLGeoShape](/gen/tlschema/TLGeoShape-type)
|
|
||||||
|
|
|
@ -1,43 +0,0 @@
|
||||||
---
|
|
||||||
title: GeoShapeGeoStyle
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 30
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
GeoShapeGeoStyle: import('../styles/StyleProp').EnumStyleProp<
|
|
||||||
| 'arrow-down'
|
|
||||||
| 'arrow-left'
|
|
||||||
| 'arrow-right'
|
|
||||||
| 'arrow-up'
|
|
||||||
| 'check-box'
|
|
||||||
| 'diamond'
|
|
||||||
| 'ellipse'
|
|
||||||
| 'hexagon'
|
|
||||||
| 'octagon'
|
|
||||||
| 'oval'
|
|
||||||
| 'pentagon'
|
|
||||||
| 'rectangle'
|
|
||||||
| 'rhombus-2'
|
|
||||||
| 'rhombus'
|
|
||||||
| 'star'
|
|
||||||
| 'trapezoid'
|
|
||||||
| 'triangle'
|
|
||||||
| 'x-box'
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[EnumStyleProp](/gen/tlschema/EnumStyleProp-class)
|
|
||||||
|
|
|
@ -1,773 +0,0 @@
|
||||||
---
|
|
||||||
title: GeoShapeUtil
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 38
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [canEdit](#GeoShapeUtil-canEdit-member)
|
|
||||||
- [onBeforeCreate](#GeoShapeUtil-onBeforeCreate-member)
|
|
||||||
- [onBeforeUpdate](#GeoShapeUtil-onBeforeUpdate-member)
|
|
||||||
- [onDoubleClick](#GeoShapeUtil-onDoubleClick-member)
|
|
||||||
- [onEditEnd](#GeoShapeUtil-onEditEnd-member)
|
|
||||||
- [onResize](#GeoShapeUtil-onResize-member)
|
|
||||||
- [type](#GeoShapeUtil-type-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [component](#GeoShapeUtil-component-member-1)
|
|
||||||
- [getBounds](#GeoShapeUtil-getBounds-member-1)
|
|
||||||
- [getCenter](#GeoShapeUtil-getCenter-member-1)
|
|
||||||
- [getDefaultProps](#GeoShapeUtil-getDefaultProps-member-1)
|
|
||||||
- [getOutline](#GeoShapeUtil-getOutline-member-1)
|
|
||||||
- [hitTestLineSegment](#GeoShapeUtil-hitTestLineSegment-member-1)
|
|
||||||
- [hitTestPoint](#GeoShapeUtil-hitTestPoint-member-1)
|
|
||||||
- [indicator](#GeoShapeUtil-indicator-member-1)
|
|
||||||
- [toSvg](#GeoShapeUtil-toSvg-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class GeoShapeUtil extends BaseBoxShapeUtil<TLGeoShape> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[BaseBoxShapeUtil](/gen/editor/BaseBoxShapeUtil-class), [TLGeoShape](/gen/tlschema/TLGeoShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `canEdit` \{#GeoShapeUtil-canEdit-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
canEdit: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onBeforeCreate` \{#GeoShapeUtil-onBeforeCreate-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onBeforeCreate: (shape: TLGeoShape) =>
|
|
||||||
| {
|
|
||||||
props: {
|
|
||||||
growY: number
|
|
||||||
geo:
|
|
||||||
| 'arrow-down'
|
|
||||||
| 'arrow-left'
|
|
||||||
| 'arrow-right'
|
|
||||||
| 'arrow-up'
|
|
||||||
| 'check-box'
|
|
||||||
| 'diamond'
|
|
||||||
| 'ellipse'
|
|
||||||
| 'hexagon'
|
|
||||||
| 'octagon'
|
|
||||||
| 'oval'
|
|
||||||
| 'pentagon'
|
|
||||||
| 'rectangle'
|
|
||||||
| 'rhombus-2'
|
|
||||||
| 'rhombus'
|
|
||||||
| 'star'
|
|
||||||
| 'trapezoid'
|
|
||||||
| 'triangle'
|
|
||||||
| 'x-box'
|
|
||||||
labelColor:
|
|
||||||
| 'black'
|
|
||||||
| 'blue'
|
|
||||||
| 'green'
|
|
||||||
| 'grey'
|
|
||||||
| 'light-blue'
|
|
||||||
| 'light-green'
|
|
||||||
| 'light-red'
|
|
||||||
| 'light-violet'
|
|
||||||
| 'orange'
|
|
||||||
| 'red'
|
|
||||||
| 'violet'
|
|
||||||
| 'yellow'
|
|
||||||
color:
|
|
||||||
| 'black'
|
|
||||||
| 'blue'
|
|
||||||
| 'green'
|
|
||||||
| 'grey'
|
|
||||||
| 'light-blue'
|
|
||||||
| 'light-green'
|
|
||||||
| 'light-red'
|
|
||||||
| 'light-violet'
|
|
||||||
| 'orange'
|
|
||||||
| 'red'
|
|
||||||
| 'violet'
|
|
||||||
| 'yellow'
|
|
||||||
fill: 'none' | 'pattern' | 'semi' | 'solid'
|
|
||||||
dash: 'dashed' | 'dotted' | 'draw' | 'solid'
|
|
||||||
size: 'l' | 'm' | 's' | 'xl'
|
|
||||||
font: 'draw' | 'mono' | 'sans' | 'serif'
|
|
||||||
align:
|
|
||||||
| 'end-legacy'
|
|
||||||
| 'end'
|
|
||||||
| 'middle-legacy'
|
|
||||||
| 'middle'
|
|
||||||
| 'start-legacy'
|
|
||||||
| 'start'
|
|
||||||
verticalAlign: 'end' | 'middle' | 'start'
|
|
||||||
url: string
|
|
||||||
w: number
|
|
||||||
h: number
|
|
||||||
text: string
|
|
||||||
}
|
|
||||||
type: 'geo'
|
|
||||||
x: number
|
|
||||||
y: number
|
|
||||||
rotation: number
|
|
||||||
index: string
|
|
||||||
parentId: import('@tldraw/tlschema').TLParentId
|
|
||||||
isLocked: boolean
|
|
||||||
opacity: number
|
|
||||||
id: import('@tldraw/tlschema').TLShapeId
|
|
||||||
typeName: 'shape'
|
|
||||||
}
|
|
||||||
| undefined
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGeoShape](/gen/tlschema/TLGeoShape-type), [TLParentId](/gen/tlschema/TLParentId-type), [TLShapeId](/gen/tlschema/TLShapeId-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onBeforeUpdate` \{#GeoShapeUtil-onBeforeUpdate-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onBeforeUpdate: (
|
|
||||||
prev: TLGeoShape,
|
|
||||||
next: TLGeoShape
|
|
||||||
) =>
|
|
||||||
| {
|
|
||||||
props: {
|
|
||||||
growY: number
|
|
||||||
geo:
|
|
||||||
| 'arrow-down'
|
|
||||||
| 'arrow-left'
|
|
||||||
| 'arrow-right'
|
|
||||||
| 'arrow-up'
|
|
||||||
| 'check-box'
|
|
||||||
| 'diamond'
|
|
||||||
| 'ellipse'
|
|
||||||
| 'hexagon'
|
|
||||||
| 'octagon'
|
|
||||||
| 'oval'
|
|
||||||
| 'pentagon'
|
|
||||||
| 'rectangle'
|
|
||||||
| 'rhombus-2'
|
|
||||||
| 'rhombus'
|
|
||||||
| 'star'
|
|
||||||
| 'trapezoid'
|
|
||||||
| 'triangle'
|
|
||||||
| 'x-box'
|
|
||||||
labelColor:
|
|
||||||
| 'black'
|
|
||||||
| 'blue'
|
|
||||||
| 'green'
|
|
||||||
| 'grey'
|
|
||||||
| 'light-blue'
|
|
||||||
| 'light-green'
|
|
||||||
| 'light-red'
|
|
||||||
| 'light-violet'
|
|
||||||
| 'orange'
|
|
||||||
| 'red'
|
|
||||||
| 'violet'
|
|
||||||
| 'yellow'
|
|
||||||
color:
|
|
||||||
| 'black'
|
|
||||||
| 'blue'
|
|
||||||
| 'green'
|
|
||||||
| 'grey'
|
|
||||||
| 'light-blue'
|
|
||||||
| 'light-green'
|
|
||||||
| 'light-red'
|
|
||||||
| 'light-violet'
|
|
||||||
| 'orange'
|
|
||||||
| 'red'
|
|
||||||
| 'violet'
|
|
||||||
| 'yellow'
|
|
||||||
fill: 'none' | 'pattern' | 'semi' | 'solid'
|
|
||||||
dash: 'dashed' | 'dotted' | 'draw' | 'solid'
|
|
||||||
size: 'l' | 'm' | 's' | 'xl'
|
|
||||||
font: 'draw' | 'mono' | 'sans' | 'serif'
|
|
||||||
align:
|
|
||||||
| 'end-legacy'
|
|
||||||
| 'end'
|
|
||||||
| 'middle-legacy'
|
|
||||||
| 'middle'
|
|
||||||
| 'start-legacy'
|
|
||||||
| 'start'
|
|
||||||
verticalAlign: 'end' | 'middle' | 'start'
|
|
||||||
url: string
|
|
||||||
w: number
|
|
||||||
h: number
|
|
||||||
text: string
|
|
||||||
}
|
|
||||||
type: 'geo'
|
|
||||||
x: number
|
|
||||||
y: number
|
|
||||||
rotation: number
|
|
||||||
index: string
|
|
||||||
parentId: import('@tldraw/tlschema').TLParentId
|
|
||||||
isLocked: boolean
|
|
||||||
opacity: number
|
|
||||||
id: import('@tldraw/tlschema').TLShapeId
|
|
||||||
typeName: 'shape'
|
|
||||||
}
|
|
||||||
| undefined
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGeoShape](/gen/tlschema/TLGeoShape-type), [TLParentId](/gen/tlschema/TLParentId-type), [TLShapeId](/gen/tlschema/TLShapeId-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onDoubleClick` \{#GeoShapeUtil-onDoubleClick-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onDoubleClick: (shape: TLGeoShape) =>
|
|
||||||
| {
|
|
||||||
props: {
|
|
||||||
geo: 'check-box'
|
|
||||||
}
|
|
||||||
type: 'geo'
|
|
||||||
x: number
|
|
||||||
y: number
|
|
||||||
rotation: number
|
|
||||||
index: string
|
|
||||||
parentId: import('@tldraw/tlschema').TLParentId
|
|
||||||
isLocked: boolean
|
|
||||||
opacity: number
|
|
||||||
id: import('@tldraw/tlschema').TLShapeId
|
|
||||||
typeName: 'shape'
|
|
||||||
}
|
|
||||||
| {
|
|
||||||
props: {
|
|
||||||
geo: 'rectangle'
|
|
||||||
}
|
|
||||||
type: 'geo'
|
|
||||||
x: number
|
|
||||||
y: number
|
|
||||||
rotation: number
|
|
||||||
index: string
|
|
||||||
parentId: import('@tldraw/tlschema').TLParentId
|
|
||||||
isLocked: boolean
|
|
||||||
opacity: number
|
|
||||||
id: import('@tldraw/tlschema').TLShapeId
|
|
||||||
typeName: 'shape'
|
|
||||||
}
|
|
||||||
| undefined
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGeoShape](/gen/tlschema/TLGeoShape-type), [TLParentId](/gen/tlschema/TLParentId-type), [TLShapeId](/gen/tlschema/TLShapeId-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onEditEnd` \{#GeoShapeUtil-onEditEnd-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onEditEnd: TLOnEditEndHandler<TLGeoShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnEditEndHandler](/gen/editor/TLOnEditEndHandler-type), [TLGeoShape](/gen/tlschema/TLGeoShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onResize` \{#GeoShapeUtil-onResize-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onResize: TLOnResizeHandler<TLGeoShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnResizeHandler](/gen/editor/TLOnResizeHandler-type), [TLGeoShape](/gen/tlschema/TLGeoShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `type` \{#GeoShapeUtil-type-member}
|
|
||||||
|
|
||||||
<Small>Public Static Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
static type: 'geo'
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `component()` \{#GeoShapeUtil-component-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLGeoShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGeoShape](/gen/tlschema/TLGeoShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getBounds()` \{#GeoShapeUtil-getBounds-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLGeoShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Box2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGeoShape](/gen/tlschema/TLGeoShape-type), [Box2d](/gen/primitives/Box2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getCenter()` \{#GeoShapeUtil-getCenter-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLGeoShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGeoShape](/gen/tlschema/TLGeoShape-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getDefaultProps()` \{#GeoShapeUtil-getDefaultProps-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLGeoShape['props']
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGeoShape](/gen/tlschema/TLGeoShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getOutline()` \{#GeoShapeUtil-getOutline-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLGeoShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d[]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGeoShape](/gen/tlschema/TLGeoShape-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hitTestLineSegment()` \{#GeoShapeUtil-hitTestLineSegment-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLGeoShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`A`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`B`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGeoShape](/gen/tlschema/TLGeoShape-type), [VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hitTestPoint()` \{#GeoShapeUtil-hitTestPoint-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLGeoShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`point`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGeoShape](/gen/tlschema/TLGeoShape-type), [VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `indicator()` \{#GeoShapeUtil-indicator-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLGeoShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGeoShape](/gen/tlschema/TLGeoShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `toSvg()` \{#GeoShapeUtil-toSvg-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLGeoShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`font`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`colors`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLExportColors
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
SVGElement
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGeoShape](/gen/tlschema/TLGeoShape-type), [TLExportColors](/gen/editor/~TLExportColors-type), [SVGElement](/gen/SVGElement-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: GroupShape
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 60
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
GroupShape: import('../../../config/defineShape').TLShapeInfo<
|
|
||||||
import('@tldraw/tlschema').TLGroupShape
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLGroupShape](/gen/tlschema/TLGroupShape-type)
|
|
||||||
|
|
|
@ -1,352 +0,0 @@
|
||||||
---
|
|
||||||
title: GroupShapeUtil
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 61
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [canBind](#GroupShapeUtil-canBind-member)
|
|
||||||
- [hideSelectionBoundsBg](#GroupShapeUtil-hideSelectionBoundsBg-member)
|
|
||||||
- [hideSelectionBoundsFg](#GroupShapeUtil-hideSelectionBoundsFg-member)
|
|
||||||
- [onChildrenChange](#GroupShapeUtil-onChildrenChange-member)
|
|
||||||
- [type](#GroupShapeUtil-type-member)
|
|
||||||
- [type](#GroupShapeUtil-type-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [component](#GroupShapeUtil-component-member-1)
|
|
||||||
- [getBounds](#GroupShapeUtil-getBounds-member-1)
|
|
||||||
- [getCenter](#GroupShapeUtil-getCenter-member-1)
|
|
||||||
- [getDefaultProps](#GroupShapeUtil-getDefaultProps-member-1)
|
|
||||||
- [getOutline](#GroupShapeUtil-getOutline-member-1)
|
|
||||||
- [indicator](#GroupShapeUtil-indicator-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class GroupShapeUtil extends ShapeUtil<TLGroupShape> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[ShapeUtil](/gen/editor/ShapeUtil-class), [TLGroupShape](/gen/tlschema/TLGroupShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `canBind` \{#GroupShapeUtil-canBind-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
canBind: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideSelectionBoundsBg` \{#GroupShapeUtil-hideSelectionBoundsBg-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideSelectionBoundsBg: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideSelectionBoundsFg` \{#GroupShapeUtil-hideSelectionBoundsFg-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideSelectionBoundsFg: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onChildrenChange` \{#GroupShapeUtil-onChildrenChange-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onChildrenChange: TLOnChildrenChangeHandler<TLGroupShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnChildrenChangeHandler](/gen/editor/TLOnChildrenChangeHandler-type), [TLGroupShape](/gen/tlschema/TLGroupShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `type` \{#GroupShapeUtil-type-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
type: 'group'
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `type` \{#GroupShapeUtil-type-member}
|
|
||||||
|
|
||||||
<Small>Public Static Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
static type: 'group'
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `component()` \{#GroupShapeUtil-component-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLGroupShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element | null
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGroupShape](/gen/tlschema/TLGroupShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getBounds()` \{#GroupShapeUtil-getBounds-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLGroupShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Box2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGroupShape](/gen/tlschema/TLGroupShape-type), [Box2d](/gen/primitives/Box2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getCenter()` \{#GroupShapeUtil-getCenter-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLGroupShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGroupShape](/gen/tlschema/TLGroupShape-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getDefaultProps()` \{#GroupShapeUtil-getDefaultProps-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLGroupShape['props']
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGroupShape](/gen/tlschema/TLGroupShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getOutline()` \{#GroupShapeUtil-getOutline-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLGroupShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d[]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGroupShape](/gen/tlschema/TLGroupShape-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `indicator()` \{#GroupShapeUtil-indicator-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLGroupShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLGroupShape](/gen/tlschema/TLGroupShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,47 +0,0 @@
|
||||||
---
|
|
||||||
title: HTMLContainer
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Function
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 66
|
|
||||||
---<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ children, className, ...rest }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
HTMLContainerProps
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[HTMLContainerProps](/gen/editor/HTMLContainerProps-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
|
@ -1,24 +0,0 @@
|
||||||
---
|
|
||||||
title: HTMLContainerProps
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: TypeAlias
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 67
|
|
||||||
---<Small>Public TypeAlias</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
type HTMLContainerProps = React.HTMLAttributes<HTMLDivElement>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[React.HTMLAttributes](/gen/@types/react-React-HTMLAttributes-interface), [HTMLDivElement](/gen/HTMLDivElement-interface)
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: HighlightShape
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 64
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
HighlightShape: import('../../../config/defineShape').TLShapeInfo<
|
|
||||||
import('@tldraw/tlschema').TLHighlightShape
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLHighlightShape](/gen/tlschema/TLHighlightShape-type)
|
|
||||||
|
|
|
@ -1,726 +0,0 @@
|
||||||
---
|
|
||||||
title: HighlightShapeUtil
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 65
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [hideResizeHandles](#HighlightShapeUtil-hideResizeHandles-member)
|
|
||||||
- [hideRotateHandle](#HighlightShapeUtil-hideRotateHandle-member)
|
|
||||||
- [hideSelectionBoundsBg](#HighlightShapeUtil-hideSelectionBoundsBg-member)
|
|
||||||
- [hideSelectionBoundsFg](#HighlightShapeUtil-hideSelectionBoundsFg-member)
|
|
||||||
- [onResize](#HighlightShapeUtil-onResize-member)
|
|
||||||
- [type](#HighlightShapeUtil-type-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [backgroundComponent](#HighlightShapeUtil-backgroundComponent-member-1)
|
|
||||||
- [component](#HighlightShapeUtil-component-member-1)
|
|
||||||
- [expandSelectionOutlinePx](#HighlightShapeUtil-expandSelectionOutlinePx-member-1)
|
|
||||||
- [getBounds](#HighlightShapeUtil-getBounds-member-1)
|
|
||||||
- [getCenter](#HighlightShapeUtil-getCenter-member-1)
|
|
||||||
- [getDefaultProps](#HighlightShapeUtil-getDefaultProps-member-1)
|
|
||||||
- [getOutline](#HighlightShapeUtil-getOutline-member-1)
|
|
||||||
- [hitTestLineSegment](#HighlightShapeUtil-hitTestLineSegment-member-1)
|
|
||||||
- [hitTestPoint](#HighlightShapeUtil-hitTestPoint-member-1)
|
|
||||||
- [indicator](#HighlightShapeUtil-indicator-member-1)
|
|
||||||
- [toBackgroundSvg](#HighlightShapeUtil-toBackgroundSvg-member-1)
|
|
||||||
- [toSvg](#HighlightShapeUtil-toSvg-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class HighlightShapeUtil extends ShapeUtil<TLHighlightShape> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[ShapeUtil](/gen/editor/ShapeUtil-class), [TLHighlightShape](/gen/tlschema/TLHighlightShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `hideResizeHandles` \{#HighlightShapeUtil-hideResizeHandles-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideResizeHandles: (shape: TLHighlightShape) => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLHighlightShape](/gen/tlschema/TLHighlightShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideRotateHandle` \{#HighlightShapeUtil-hideRotateHandle-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideRotateHandle: (shape: TLHighlightShape) => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLHighlightShape](/gen/tlschema/TLHighlightShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideSelectionBoundsBg` \{#HighlightShapeUtil-hideSelectionBoundsBg-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideSelectionBoundsBg: (shape: TLHighlightShape) => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLHighlightShape](/gen/tlschema/TLHighlightShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideSelectionBoundsFg` \{#HighlightShapeUtil-hideSelectionBoundsFg-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideSelectionBoundsFg: (shape: TLHighlightShape) => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLHighlightShape](/gen/tlschema/TLHighlightShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onResize` \{#HighlightShapeUtil-onResize-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onResize: TLOnResizeHandler<TLHighlightShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnResizeHandler](/gen/editor/TLOnResizeHandler-type), [TLHighlightShape](/gen/tlschema/TLHighlightShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `type` \{#HighlightShapeUtil-type-member}
|
|
||||||
|
|
||||||
<Small>Public Static Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
static type: 'highlight'
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `backgroundComponent()` \{#HighlightShapeUtil-backgroundComponent-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLHighlightShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `component()` \{#HighlightShapeUtil-component-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLHighlightShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `expandSelectionOutlinePx()` \{#HighlightShapeUtil-expandSelectionOutlinePx-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLHighlightShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLHighlightShape](/gen/tlschema/TLHighlightShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getBounds()` \{#HighlightShapeUtil-getBounds-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLHighlightShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Box2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [Box2d](/gen/primitives/Box2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getCenter()` \{#HighlightShapeUtil-getCenter-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLHighlightShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getDefaultProps()` \{#HighlightShapeUtil-getDefaultProps-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLHighlightShape['props']
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLHighlightShape](/gen/tlschema/TLHighlightShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getOutline()` \{#HighlightShapeUtil-getOutline-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLHighlightShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d[]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hitTestLineSegment()` \{#HighlightShapeUtil-hitTestLineSegment-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLHighlightShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`A`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`B`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hitTestPoint()` \{#HighlightShapeUtil-hitTestPoint-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLHighlightShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`point`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `indicator()` \{#HighlightShapeUtil-indicator-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLHighlightShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `toBackgroundSvg()` \{#HighlightShapeUtil-toBackgroundSvg-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLHighlightShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`font`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
string | undefined
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`colors`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLExportColors
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
SVGPathElement
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [TLExportColors](/gen/editor/~TLExportColors-type), [SVGPathElement](/gen/SVGPathElement-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `toSvg()` \{#HighlightShapeUtil-toSvg-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLHighlightShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`_font`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
string | undefined
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`colors`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLExportColors
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
SVGPathElement
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLHighlightShape](/gen/tlschema/TLHighlightShape-type), [TLExportColors](/gen/editor/~TLExportColors-type), [SVGPathElement](/gen/SVGPathElement-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,27 +0,0 @@
|
||||||
---
|
|
||||||
title: HistoryEntry
|
|
||||||
status: published
|
|
||||||
category: store
|
|
||||||
group: TypeAlias
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 11
|
|
||||||
---<Small>Public TypeAlias</Small>
|
|
||||||
|
|
||||||
An entry containing changes that originated either by user actions or remote changes.
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
type HistoryEntry<R extends UnknownRecord = UnknownRecord> = {
|
|
||||||
changes: RecordsDiff<R>
|
|
||||||
source: ChangeSource
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[UnknownRecord](/gen/store/UnknownRecord-type), [RecordsDiff](/gen/store/RecordsDiff-type), [ChangeSource](/gen/store/~ChangeSource-type)
|
|
||||||
|
|
|
@ -1,20 +0,0 @@
|
||||||
---
|
|
||||||
title: INDENT
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 70
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
INDENT = ' '
|
|
||||||
```
|
|
||||||
|
|
|
@ -1,24 +0,0 @@
|
||||||
---
|
|
||||||
title: Icon
|
|
||||||
status: published
|
|
||||||
category: ui
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 7
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Icon: import('react').NamedExoticComponent<TLUiIconProps>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[NamedExoticComponent](/gen/@types/react-React-NamedExoticComponent-interface), [TLUiIconProps](/gen/ui/TLUiIconProps-interface)
|
|
||||||
|
|
|
@ -1,24 +0,0 @@
|
||||||
---
|
|
||||||
title: IdOf
|
|
||||||
status: published
|
|
||||||
category: store
|
|
||||||
group: TypeAlias
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 12
|
|
||||||
---<Small>Public TypeAlias</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
type IdOf<R extends UnknownRecord> = R['id']
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[UnknownRecord](/gen/store/UnknownRecord-type)
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: ImageShape
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 68
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
ImageShape: import('../../../config/defineShape').TLShapeInfo<
|
|
||||||
import('@tldraw/tlschema').TLImageShape
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLImageShape](/gen/tlschema/TLImageShape-type)
|
|
||||||
|
|
|
@ -1,260 +0,0 @@
|
||||||
---
|
|
||||||
title: ImageShapeUtil
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 69
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [canCrop](#ImageShapeUtil-canCrop-member)
|
|
||||||
- [isAspectRatioLocked](#ImageShapeUtil-isAspectRatioLocked-member)
|
|
||||||
- [onDoubleClick](#ImageShapeUtil-onDoubleClick-member)
|
|
||||||
- [onDoubleClickEdge](#ImageShapeUtil-onDoubleClickEdge-member)
|
|
||||||
- [type](#ImageShapeUtil-type-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [component](#ImageShapeUtil-component-member-1)
|
|
||||||
- [getDefaultProps](#ImageShapeUtil-getDefaultProps-member-1)
|
|
||||||
- [indicator](#ImageShapeUtil-indicator-member-1)
|
|
||||||
- [toSvg](#ImageShapeUtil-toSvg-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class ImageShapeUtil extends BaseBoxShapeUtil<TLImageShape> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[BaseBoxShapeUtil](/gen/editor/BaseBoxShapeUtil-class), [TLImageShape](/gen/tlschema/TLImageShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `canCrop` \{#ImageShapeUtil-canCrop-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
canCrop: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `isAspectRatioLocked` \{#ImageShapeUtil-isAspectRatioLocked-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
isAspectRatioLocked: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onDoubleClick` \{#ImageShapeUtil-onDoubleClick-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onDoubleClick: (shape: TLImageShape) => void
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLImageShape](/gen/tlschema/TLImageShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onDoubleClickEdge` \{#ImageShapeUtil-onDoubleClickEdge-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onDoubleClickEdge: TLOnDoubleClickHandler<TLImageShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnDoubleClickHandler](/gen/editor/TLOnDoubleClickHandler-type), [TLImageShape](/gen/tlschema/TLImageShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `type` \{#ImageShapeUtil-type-member}
|
|
||||||
|
|
||||||
<Small>Public Static Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
static type: 'image'
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `component()` \{#ImageShapeUtil-component-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLImageShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLImageShape](/gen/tlschema/TLImageShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getDefaultProps()` \{#ImageShapeUtil-getDefaultProps-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLImageShape['props']
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLImageShape](/gen/tlschema/TLImageShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `indicator()` \{#ImageShapeUtil-indicator-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLImageShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element | null
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLImageShape](/gen/tlschema/TLImageShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `toSvg()` \{#ImageShapeUtil-toSvg-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLImageShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Promise<SVGGElement>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLImageShape](/gen/tlschema/TLImageShape-type), [Promise](/gen/Promise-interface), [SVGGElement](/gen/SVGGElement-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: Input
|
|
||||||
status: published
|
|
||||||
category: ui
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 8
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Input: React.ForwardRefExoticComponent<
|
|
||||||
TLUiInputProps & React.RefAttributes<HTMLInputElement>
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[React.ForwardRefExoticComponent](/gen/@types/react-React-ForwardRefExoticComponent-interface), [TLUiInputProps](/gen/ui/TLUiInputProps-interface), [React.RefAttributes](/gen/@types/react-React-RefAttributes-interface), [HTMLInputElement](/gen/HTMLInputElement-interface)
|
|
||||||
|
|
|
@ -1,27 +0,0 @@
|
||||||
---
|
|
||||||
title: InstancePageStateRecordType
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 35
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
InstancePageStateRecordType: import('@tldraw/store').RecordType<
|
|
||||||
TLInstancePageState,
|
|
||||||
'pageId'
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[RecordType](/gen/store/RecordType-class), [TLInstancePageState](/gen/tlschema/TLInstancePageState-interface)
|
|
||||||
|
|
|
@ -1,27 +0,0 @@
|
||||||
---
|
|
||||||
title: InstancePresenceRecordType
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 36
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
InstancePresenceRecordType: import('@tldraw/store').RecordType<
|
|
||||||
TLInstancePresence,
|
|
||||||
'currentPageId' | 'userId' | 'userName'
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[RecordType](/gen/store/RecordType-class), [TLInstancePresence](/gen/tlschema/TLInstancePresence-interface)
|
|
||||||
|
|
|
@ -1,153 +0,0 @@
|
||||||
---
|
|
||||||
title: LANGUAGES
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 40
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
LANGUAGES: readonly [
|
|
||||||
{
|
|
||||||
readonly locale: 'ar'
|
|
||||||
readonly label: 'عربي'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'ca'
|
|
||||||
readonly label: 'Català'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'da'
|
|
||||||
readonly label: 'Danish'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'de'
|
|
||||||
readonly label: 'Deutsch'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'en'
|
|
||||||
readonly label: 'English'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'es'
|
|
||||||
readonly label: 'Español'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'fa'
|
|
||||||
readonly label: 'فارسی'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'fi'
|
|
||||||
readonly label: 'Suomi'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'fr'
|
|
||||||
readonly label: 'Français'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'gl'
|
|
||||||
readonly label: 'Galego'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'he'
|
|
||||||
readonly label: 'עברית'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'it'
|
|
||||||
readonly label: 'Italiano'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'ja'
|
|
||||||
readonly label: '日本語'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'ko-kr'
|
|
||||||
readonly label: '한국어'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'ku'
|
|
||||||
readonly label: 'کوردی'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'hi-in'
|
|
||||||
readonly label: 'हिन्दी'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'hu'
|
|
||||||
readonly label: 'Magyar'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'my'
|
|
||||||
readonly label: 'မြန်မာစာ'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'ne'
|
|
||||||
readonly label: 'नेपाली'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'no'
|
|
||||||
readonly label: 'Norwegian'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'pl'
|
|
||||||
readonly label: 'Polski'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'pt-br'
|
|
||||||
readonly label: 'Português - Brasil'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'pt-pt'
|
|
||||||
readonly label: 'Português - Europeu'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'ro'
|
|
||||||
readonly label: 'Română'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'ru'
|
|
||||||
readonly label: 'Russian'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'sv'
|
|
||||||
readonly label: 'Svenska'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'te'
|
|
||||||
readonly label: 'తెలుగు'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'th'
|
|
||||||
readonly label: 'ภาษาไทย'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'tr'
|
|
||||||
readonly label: 'Türkçe'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'uk'
|
|
||||||
readonly label: 'Ukrainian'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'vi'
|
|
||||||
readonly label: 'Tiếng Việt'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'zh-cn'
|
|
||||||
readonly label: 'Chinese - Simplified'
|
|
||||||
},
|
|
||||||
{
|
|
||||||
readonly locale: 'zh-tw'
|
|
||||||
readonly label: '繁體中文 (台灣)'
|
|
||||||
}
|
|
||||||
]
|
|
||||||
```
|
|
||||||
|
|
|
@ -1,556 +0,0 @@
|
||||||
---
|
|
||||||
title: LineSegment2d
|
|
||||||
status: published
|
|
||||||
category: primitives
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 50
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [a](#LineSegment2d-a-member)
|
|
||||||
- [angle](#LineSegment2d-angle-member)
|
|
||||||
- [b](#LineSegment2d-b-member)
|
|
||||||
- [bounds](#LineSegment2d-bounds-member)
|
|
||||||
- [length](#LineSegment2d-length-member)
|
|
||||||
- [tangent](#LineSegment2d-tangent-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [Angle](#LineSegment2d-Angle-member-1)
|
|
||||||
- [getClosestPointTo](#LineSegment2d-getClosestPointTo-member-1)
|
|
||||||
- [getNormal](#LineSegment2d-getNormal-member-1)
|
|
||||||
- [getPath](#LineSegment2d-getPath-member-1)
|
|
||||||
- [getPoint](#LineSegment2d-getPoint-member-1)
|
|
||||||
- [getX](#LineSegment2d-getX-member-1)
|
|
||||||
- [getY](#LineSegment2d-getY-member-1)
|
|
||||||
- [Length](#LineSegment2d-Length-member-1)
|
|
||||||
- [Tangent](#LineSegment2d-Tangent-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class LineSegment2d extends BaseSegment2d<LineSegment2dModel> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[BaseSegment2d](/gen/primitives/~BaseSegment2d-class), [LineSegment2dModel](/gen/primitives/LineSegment2dModel-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Constructor`
|
|
||||||
|
|
||||||
<Small>Public Constructor</Small>
|
|
||||||
|
|
||||||
Constructs a new instance of the `LineSegment2d` class
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`a`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`b`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`p`
|
|
||||||
|
|
||||||
<Small>(optional)</Small>
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `a` \{#LineSegment2d-a-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
a: VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `angle` \{#LineSegment2d-angle-member}
|
|
||||||
|
|
||||||
<Small>Public Readonly Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
get angle(): number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `b` \{#LineSegment2d-b-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
b: VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `bounds` \{#LineSegment2d-bounds-member}
|
|
||||||
|
|
||||||
<Small>Public Readonly Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
get bounds(): Box2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Box2d](/gen/primitives/Box2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `length` \{#LineSegment2d-length-member}
|
|
||||||
|
|
||||||
<Small>Public Readonly Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
get length(): number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `tangent` \{#LineSegment2d-tangent-member}
|
|
||||||
|
|
||||||
<Small>Public Readonly Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
get tangent(): Vec2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `Angle()` \{#LineSegment2d-Angle-member-1}
|
|
||||||
|
|
||||||
<Small>Public Static Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`A`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
LineSegment2d
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[LineSegment2d](/gen/primitives/LineSegment2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getClosestPointTo()` \{#LineSegment2d-getClosestPointTo-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
Get the closest point on the segment to an arbitrary point.
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`point`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
The arbitrary point.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
{
|
|
||||||
point: Vec2d
|
|
||||||
distance: number
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getNormal()` \{#LineSegment2d-getNormal-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getPath()` \{#LineSegment2d-getPath-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`head`
|
|
||||||
|
|
||||||
<Small>(optional)</Small>
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
string
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getPoint()` \{#LineSegment2d-getPoint-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`t`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getX()` \{#LineSegment2d-getX-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`t`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getY()` \{#LineSegment2d-getY-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`t`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Length()` \{#LineSegment2d-Length-member-1}
|
|
||||||
|
|
||||||
<Small>Public Static Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`A`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
LineSegment2d
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[LineSegment2d](/gen/primitives/LineSegment2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Tangent()` \{#LineSegment2d-Tangent-member-1}
|
|
||||||
|
|
||||||
<Small>Public Static Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`A`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
LineSegment2d
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[LineSegment2d](/gen/primitives/LineSegment2d-class), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,79 +0,0 @@
|
||||||
---
|
|
||||||
title: LineSegment2dModel
|
|
||||||
status: published
|
|
||||||
category: primitives
|
|
||||||
group: Interface
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 51
|
|
||||||
---<Small>Public Interface</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [a](#LineSegment2dModel-a-member)
|
|
||||||
- [b](#LineSegment2dModel-b-member)
|
|
||||||
- [p](#LineSegment2dModel-p-member)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
interface LineSegment2dModel {}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `a` \{#LineSegment2dModel-a-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
a: VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `b` \{#LineSegment2dModel-b-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
b: VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `p` \{#LineSegment2dModel-p-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
p: number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: LineShape
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 78
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
LineShape: import('../../../config/defineShape').TLShapeInfo<
|
|
||||||
import('@tldraw/tlschema').TLLineShape
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLLineShape](/gen/tlschema/TLLineShape-type)
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: LineShapeSplineStyle
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 42
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
LineShapeSplineStyle: import('../styles/StyleProp').EnumStyleProp<
|
|
||||||
'cubic' | 'line'
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[EnumStyleProp](/gen/tlschema/EnumStyleProp-class)
|
|
||||||
|
|
|
@ -1,628 +0,0 @@
|
||||||
---
|
|
||||||
title: LineShapeUtil
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 79
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [hideResizeHandles](#LineShapeUtil-hideResizeHandles-member)
|
|
||||||
- [hideRotateHandle](#LineShapeUtil-hideRotateHandle-member)
|
|
||||||
- [hideSelectionBoundsBg](#LineShapeUtil-hideSelectionBoundsBg-member)
|
|
||||||
- [hideSelectionBoundsFg](#LineShapeUtil-hideSelectionBoundsFg-member)
|
|
||||||
- [isClosed](#LineShapeUtil-isClosed-member)
|
|
||||||
- [onHandleChange](#LineShapeUtil-onHandleChange-member)
|
|
||||||
- [onResize](#LineShapeUtil-onResize-member)
|
|
||||||
- [type](#LineShapeUtil-type-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [component](#LineShapeUtil-component-member-1)
|
|
||||||
- [getBounds](#LineShapeUtil-getBounds-member-1)
|
|
||||||
- [getDefaultProps](#LineShapeUtil-getDefaultProps-member-1)
|
|
||||||
- [getHandles](#LineShapeUtil-getHandles-member-1)
|
|
||||||
- [getOutline](#LineShapeUtil-getOutline-member-1)
|
|
||||||
- [getOutlineSegments](#LineShapeUtil-getOutlineSegments-member-1)
|
|
||||||
- [hitTestLineSegment](#LineShapeUtil-hitTestLineSegment-member-1)
|
|
||||||
- [hitTestPoint](#LineShapeUtil-hitTestPoint-member-1)
|
|
||||||
- [indicator](#LineShapeUtil-indicator-member-1)
|
|
||||||
- [toSvg](#LineShapeUtil-toSvg-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class LineShapeUtil extends ShapeUtil<TLLineShape> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[ShapeUtil](/gen/editor/ShapeUtil-class), [TLLineShape](/gen/tlschema/TLLineShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `hideResizeHandles` \{#LineShapeUtil-hideResizeHandles-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideResizeHandles: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideRotateHandle` \{#LineShapeUtil-hideRotateHandle-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideRotateHandle: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideSelectionBoundsBg` \{#LineShapeUtil-hideSelectionBoundsBg-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideSelectionBoundsBg: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideSelectionBoundsFg` \{#LineShapeUtil-hideSelectionBoundsFg-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideSelectionBoundsFg: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `isClosed` \{#LineShapeUtil-isClosed-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
isClosed: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onHandleChange` \{#LineShapeUtil-onHandleChange-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onHandleChange: TLOnHandleChangeHandler<TLLineShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnHandleChangeHandler](/gen/editor/TLOnHandleChangeHandler-type), [TLLineShape](/gen/tlschema/TLLineShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onResize` \{#LineShapeUtil-onResize-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onResize: TLOnResizeHandler<TLLineShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnResizeHandler](/gen/editor/TLOnResizeHandler-type), [TLLineShape](/gen/tlschema/TLLineShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `type` \{#LineShapeUtil-type-member}
|
|
||||||
|
|
||||||
<Small>Public Static Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
static type: 'line'
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `component()` \{#LineShapeUtil-component-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLLineShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element | undefined
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLLineShape](/gen/tlschema/TLLineShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getBounds()` \{#LineShapeUtil-getBounds-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLLineShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
import('@tldraw/primitives').Box2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLLineShape](/gen/tlschema/TLLineShape-type), [Box2d](/gen/primitives/Box2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getDefaultProps()` \{#LineShapeUtil-getDefaultProps-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLLineShape['props']
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLLineShape](/gen/tlschema/TLLineShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getHandles()` \{#LineShapeUtil-getHandles-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLLineShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLHandle[]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLLineShape](/gen/tlschema/TLLineShape-type), [TLHandle](/gen/tlschema/TLHandle-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getOutline()` \{#LineShapeUtil-getOutline-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLLineShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d[]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLLineShape](/gen/tlschema/TLLineShape-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getOutlineSegments()` \{#LineShapeUtil-getOutlineSegments-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLLineShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d[][]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLLineShape](/gen/tlschema/TLLineShape-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hitTestLineSegment()` \{#LineShapeUtil-hitTestLineSegment-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLLineShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`A`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`B`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLLineShape](/gen/tlschema/TLLineShape-type), [VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hitTestPoint()` \{#LineShapeUtil-hitTestPoint-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLLineShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`point`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLLineShape](/gen/tlschema/TLLineShape-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `indicator()` \{#LineShapeUtil-indicator-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLLineShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLLineShape](/gen/tlschema/TLLineShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `toSvg()` \{#LineShapeUtil-toSvg-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLLineShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`_font`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`colors`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLExportColors
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
SVGGElement
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLLineShape](/gen/tlschema/TLLineShape-type), [TLExportColors](/gen/editor/~TLExportColors-type), [SVGGElement](/gen/SVGGElement-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,49 +0,0 @@
|
||||||
---
|
|
||||||
title: LoadingScreen
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Function
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 80
|
|
||||||
---<Small>Public Function</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ children }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
{
|
|
||||||
children: any
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
|
@ -1,24 +0,0 @@
|
||||||
---
|
|
||||||
title: MatLike
|
|
||||||
status: published
|
|
||||||
category: primitives
|
|
||||||
group: TypeAlias
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 54
|
|
||||||
---<Small>Public TypeAlias</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
type MatLike = Matrix2d | Matrix2dModel
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Matrix2d](/gen/primitives/Matrix2d-class), [Matrix2dModel](/gen/primitives/Matrix2dModel-interface)
|
|
||||||
|
|
File diff suppressed because it is too large
Load diff
|
@ -1,113 +0,0 @@
|
||||||
---
|
|
||||||
title: Matrix2dModel
|
|
||||||
status: published
|
|
||||||
category: primitives
|
|
||||||
group: Interface
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 56
|
|
||||||
---<Small>Public Interface</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [a](#Matrix2dModel-a-member)
|
|
||||||
- [b](#Matrix2dModel-b-member)
|
|
||||||
- [c](#Matrix2dModel-c-member)
|
|
||||||
- [d](#Matrix2dModel-d-member)
|
|
||||||
- [e](#Matrix2dModel-e-member)
|
|
||||||
- [f](#Matrix2dModel-f-member)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
interface Matrix2dModel {}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `a` \{#Matrix2dModel-a-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
a: number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `b` \{#Matrix2dModel-b-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
b: number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `c` \{#Matrix2dModel-c-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
c: number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `d` \{#Matrix2dModel-d-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
d: number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `e` \{#Matrix2dModel-e-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
e: number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `f` \{#Matrix2dModel-f-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
f: number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,99 +0,0 @@
|
||||||
---
|
|
||||||
title: MatrixInfo
|
|
||||||
status: published
|
|
||||||
category: primitives
|
|
||||||
group: Interface
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 57
|
|
||||||
---<Small>Public Interface</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [rotation](#MatrixInfo-rotation-member)
|
|
||||||
- [scaleX](#MatrixInfo-scaleX-member)
|
|
||||||
- [scaleY](#MatrixInfo-scaleY-member)
|
|
||||||
- [x](#MatrixInfo-x-member)
|
|
||||||
- [y](#MatrixInfo-y-member)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
interface MatrixInfo {}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `rotation` \{#MatrixInfo-rotation-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
rotation: number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `scaleX` \{#MatrixInfo-scaleX-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
scaleX: number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `scaleY` \{#MatrixInfo-scaleY-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
scaleY: number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `x` \{#MatrixInfo-x-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
x: number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `y` \{#MatrixInfo-y-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
y: number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,23 +0,0 @@
|
||||||
---
|
|
||||||
title: Migration
|
|
||||||
status: published
|
|
||||||
category: store
|
|
||||||
group: TypeAlias
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 15
|
|
||||||
---<Small>Public TypeAlias</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
type Migration<Before = any, After = any> = {
|
|
||||||
up: (oldState: Before) => After
|
|
||||||
down: (newState: After) => Before
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
|
@ -1,20 +0,0 @@
|
||||||
---
|
|
||||||
title: MigrationFailureReason
|
|
||||||
status: published
|
|
||||||
category: store
|
|
||||||
group: Enum
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 16
|
|
||||||
---<Small>Public Enum</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
enum MigrationFailureReason {}
|
|
||||||
```
|
|
||||||
|
|
|
@ -1,32 +0,0 @@
|
||||||
---
|
|
||||||
title: MigrationResult
|
|
||||||
status: published
|
|
||||||
category: store
|
|
||||||
group: TypeAlias
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 17
|
|
||||||
---<Small>Public TypeAlias</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
type MigrationResult<T> =
|
|
||||||
| {
|
|
||||||
type: 'error'
|
|
||||||
reason: MigrationFailureReason
|
|
||||||
}
|
|
||||||
| {
|
|
||||||
type: 'success'
|
|
||||||
value: T
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[MigrationFailureReason](/gen/store/MigrationFailureReason-enum)
|
|
||||||
|
|
|
@ -1,65 +0,0 @@
|
||||||
---
|
|
||||||
title: Migrations
|
|
||||||
status: published
|
|
||||||
category: store
|
|
||||||
group: Interface
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 18
|
|
||||||
---<Small>Public Interface</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [subTypeKey](#Migrations-subTypeKey-member)
|
|
||||||
- [subTypeMigrations](#Migrations-subTypeMigrations-member)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
interface Migrations extends BaseMigrationsInfo {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[BaseMigrationsInfo](/gen/store/~BaseMigrationsInfo-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `subTypeKey` \{#Migrations-subTypeKey-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
subTypeKey?: string
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `subTypeMigrations` \{#Migrations-subTypeMigrations-member}
|
|
||||||
|
|
||||||
<Small>Public PropertySignature</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
subTypeMigrations?: Record<string, BaseMigrationsInfo>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Record](/gen/Record-type), [BaseMigrationsInfo](/gen/store/~BaseMigrationsInfo-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: NoteShape
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 86
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
NoteShape: import('../../../config/defineShape').TLShapeInfo<
|
|
||||||
import('@tldraw/tlschema').TLNoteShape
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLShapeInfo](/gen/editor/TLShapeInfo-type), [TLNoteShape](/gen/tlschema/TLNoteShape-type)
|
|
||||||
|
|
|
@ -1,587 +0,0 @@
|
||||||
---
|
|
||||||
title: NoteShapeUtil
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 87
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [canEdit](#NoteShapeUtil-canEdit-member)
|
|
||||||
- [hideResizeHandles](#NoteShapeUtil-hideResizeHandles-member)
|
|
||||||
- [hideSelectionBoundsBg](#NoteShapeUtil-hideSelectionBoundsBg-member)
|
|
||||||
- [hideSelectionBoundsFg](#NoteShapeUtil-hideSelectionBoundsFg-member)
|
|
||||||
- [onBeforeCreate](#NoteShapeUtil-onBeforeCreate-member)
|
|
||||||
- [onBeforeUpdate](#NoteShapeUtil-onBeforeUpdate-member)
|
|
||||||
- [onEditEnd](#NoteShapeUtil-onEditEnd-member)
|
|
||||||
- [type](#NoteShapeUtil-type-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [component](#NoteShapeUtil-component-member-1)
|
|
||||||
- [getBounds](#NoteShapeUtil-getBounds-member-1)
|
|
||||||
- [getCenter](#NoteShapeUtil-getCenter-member-1)
|
|
||||||
- [getDefaultProps](#NoteShapeUtil-getDefaultProps-member-1)
|
|
||||||
- [getHeight](#NoteShapeUtil-getHeight-member-1)
|
|
||||||
- [getOutline](#NoteShapeUtil-getOutline-member-1)
|
|
||||||
- [indicator](#NoteShapeUtil-indicator-member-1)
|
|
||||||
- [toSvg](#NoteShapeUtil-toSvg-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class NoteShapeUtil extends ShapeUtil<TLNoteShape> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[ShapeUtil](/gen/editor/ShapeUtil-class), [TLNoteShape](/gen/tlschema/TLNoteShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `canEdit` \{#NoteShapeUtil-canEdit-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
canEdit: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideResizeHandles` \{#NoteShapeUtil-hideResizeHandles-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideResizeHandles: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideSelectionBoundsBg` \{#NoteShapeUtil-hideSelectionBoundsBg-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideSelectionBoundsBg: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `hideSelectionBoundsFg` \{#NoteShapeUtil-hideSelectionBoundsFg-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
hideSelectionBoundsFg: () => boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onBeforeCreate` \{#NoteShapeUtil-onBeforeCreate-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onBeforeCreate: (next: TLNoteShape) =>
|
|
||||||
| {
|
|
||||||
props: {
|
|
||||||
growY: number
|
|
||||||
color:
|
|
||||||
| 'black'
|
|
||||||
| 'blue'
|
|
||||||
| 'green'
|
|
||||||
| 'grey'
|
|
||||||
| 'light-blue'
|
|
||||||
| 'light-green'
|
|
||||||
| 'light-red'
|
|
||||||
| 'light-violet'
|
|
||||||
| 'orange'
|
|
||||||
| 'red'
|
|
||||||
| 'violet'
|
|
||||||
| 'yellow'
|
|
||||||
size: 'l' | 'm' | 's' | 'xl'
|
|
||||||
font: 'draw' | 'mono' | 'sans' | 'serif'
|
|
||||||
align:
|
|
||||||
| 'end-legacy'
|
|
||||||
| 'end'
|
|
||||||
| 'middle-legacy'
|
|
||||||
| 'middle'
|
|
||||||
| 'start-legacy'
|
|
||||||
| 'start'
|
|
||||||
verticalAlign: 'end' | 'middle' | 'start'
|
|
||||||
url: string
|
|
||||||
text: string
|
|
||||||
}
|
|
||||||
type: 'note'
|
|
||||||
x: number
|
|
||||||
y: number
|
|
||||||
rotation: number
|
|
||||||
index: string
|
|
||||||
parentId: import('@tldraw/tlschema').TLParentId
|
|
||||||
isLocked: boolean
|
|
||||||
opacity: number
|
|
||||||
id: import('@tldraw/tlschema').TLShapeId
|
|
||||||
typeName: 'shape'
|
|
||||||
}
|
|
||||||
| undefined
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLNoteShape](/gen/tlschema/TLNoteShape-type), [TLParentId](/gen/tlschema/TLParentId-type), [TLShapeId](/gen/tlschema/TLShapeId-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onBeforeUpdate` \{#NoteShapeUtil-onBeforeUpdate-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onBeforeUpdate: (
|
|
||||||
prev: TLNoteShape,
|
|
||||||
next: TLNoteShape
|
|
||||||
) =>
|
|
||||||
| {
|
|
||||||
props: {
|
|
||||||
growY: number
|
|
||||||
color:
|
|
||||||
| 'black'
|
|
||||||
| 'blue'
|
|
||||||
| 'green'
|
|
||||||
| 'grey'
|
|
||||||
| 'light-blue'
|
|
||||||
| 'light-green'
|
|
||||||
| 'light-red'
|
|
||||||
| 'light-violet'
|
|
||||||
| 'orange'
|
|
||||||
| 'red'
|
|
||||||
| 'violet'
|
|
||||||
| 'yellow'
|
|
||||||
size: 'l' | 'm' | 's' | 'xl'
|
|
||||||
font: 'draw' | 'mono' | 'sans' | 'serif'
|
|
||||||
align:
|
|
||||||
| 'end-legacy'
|
|
||||||
| 'end'
|
|
||||||
| 'middle-legacy'
|
|
||||||
| 'middle'
|
|
||||||
| 'start-legacy'
|
|
||||||
| 'start'
|
|
||||||
verticalAlign: 'end' | 'middle' | 'start'
|
|
||||||
url: string
|
|
||||||
text: string
|
|
||||||
}
|
|
||||||
type: 'note'
|
|
||||||
x: number
|
|
||||||
y: number
|
|
||||||
rotation: number
|
|
||||||
index: string
|
|
||||||
parentId: import('@tldraw/tlschema').TLParentId
|
|
||||||
isLocked: boolean
|
|
||||||
opacity: number
|
|
||||||
id: import('@tldraw/tlschema').TLShapeId
|
|
||||||
typeName: 'shape'
|
|
||||||
}
|
|
||||||
| undefined
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLNoteShape](/gen/tlschema/TLNoteShape-type), [TLParentId](/gen/tlschema/TLParentId-type), [TLShapeId](/gen/tlschema/TLShapeId-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `onEditEnd` \{#NoteShapeUtil-onEditEnd-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
onEditEnd: TLOnEditEndHandler<TLNoteShape>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLOnEditEndHandler](/gen/editor/TLOnEditEndHandler-type), [TLNoteShape](/gen/tlschema/TLNoteShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `type` \{#NoteShapeUtil-type-member}
|
|
||||||
|
|
||||||
<Small>Public Static Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
static type: 'note'
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `component()` \{#NoteShapeUtil-component-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLNoteShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLNoteShape](/gen/tlschema/TLNoteShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getBounds()` \{#NoteShapeUtil-getBounds-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLNoteShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Box2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLNoteShape](/gen/tlschema/TLNoteShape-type), [Box2d](/gen/primitives/Box2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getCenter()` \{#NoteShapeUtil-getCenter-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`_shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLNoteShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLNoteShape](/gen/tlschema/TLNoteShape-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getDefaultProps()` \{#NoteShapeUtil-getDefaultProps-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLNoteShape['props']
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLNoteShape](/gen/tlschema/TLNoteShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getHeight()` \{#NoteShapeUtil-getHeight-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLNoteShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLNoteShape](/gen/tlschema/TLNoteShape-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getOutline()` \{#NoteShapeUtil-getOutline-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLNoteShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Vec2d[]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLNoteShape](/gen/tlschema/TLNoteShape-type), [Vec2d](/gen/primitives/Vec2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `indicator()` \{#NoteShapeUtil-indicator-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLNoteShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
JSX.Element
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLNoteShape](/gen/tlschema/TLNoteShape-type), [JSX.Element](/gen/@types/react-__global-JSX-Element-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `toSvg()` \{#NoteShapeUtil-toSvg-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`shape`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLNoteShape
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`font`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`colors`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLExportColors
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
SVGGElement
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLNoteShape](/gen/tlschema/TLNoteShape-type), [TLExportColors](/gen/editor/~TLExportColors-type), [SVGGElement](/gen/SVGGElement-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,20 +0,0 @@
|
||||||
---
|
|
||||||
title: PI
|
|
||||||
status: published
|
|
||||||
category: primitives
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 59
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
PI: number
|
|
||||||
```
|
|
||||||
|
|
|
@ -1,20 +0,0 @@
|
||||||
---
|
|
||||||
title: PI2
|
|
||||||
status: published
|
|
||||||
category: primitives
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 60
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
PI2: number
|
|
||||||
```
|
|
||||||
|
|
|
@ -1,24 +0,0 @@
|
||||||
---
|
|
||||||
title: PageRecordType
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 44
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
PageRecordType: import('@tldraw/store').RecordType<TLPage, 'index' | 'name'>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[RecordType](/gen/store/RecordType-class), [TLPage](/gen/tlschema/TLPage-interface)
|
|
||||||
|
|
|
@ -1,704 +0,0 @@
|
||||||
---
|
|
||||||
title: PlopManager
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 89
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [editor](#PlopManager-editor-member)
|
|
||||||
- [handleContent](#PlopManager-handleContent-member)
|
|
||||||
- [handleUrl](#PlopManager-handleUrl-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [createAssetFromFile](#PlopManager-createAssetFromFile-member-1)
|
|
||||||
- [createAssetFromUrl](#PlopManager-createAssetFromUrl-member-1)
|
|
||||||
- [createShapesForAssets](#PlopManager-createShapesForAssets-member-1)
|
|
||||||
- [handleEmbed](#PlopManager-handleEmbed-member-1)
|
|
||||||
- [handleFiles](#PlopManager-handleFiles-member-1)
|
|
||||||
- [handleSvgText](#PlopManager-handleSvgText-member-1)
|
|
||||||
- [handleText](#PlopManager-handleText-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class ExternalContentManager {}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Constructor`
|
|
||||||
|
|
||||||
<Small>Public Constructor</Small>
|
|
||||||
|
|
||||||
Constructs a new instance of the `ExternalContentManager` class
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`editor`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Editor
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Editor](/gen/editor/Editor-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `editor` \{#PlopManager-editor-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
editor: Editor
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Editor](/gen/editor/Editor-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `handleContent` \{#PlopManager-handleContent-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
handleContent: (info: TLExternalContent) => Promise<void>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[TLExternalContent](/gen/editor/TLExternalContent-type), [Promise](/gen/Promise-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `handleUrl` \{#PlopManager-handleUrl-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
Handle urls from an external source. Feeling lucky? Overwrite this at runtime to change the way this type of external content is handled.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Example
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
editor.this.handleUrl = myCustomMethod
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`editor`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
The editor instance
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`info`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
The info object describing the external content.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
handleUrl: (
|
|
||||||
editor: Editor,
|
|
||||||
{
|
|
||||||
point,
|
|
||||||
url,
|
|
||||||
}: Extract<
|
|
||||||
TLExternalContent,
|
|
||||||
{
|
|
||||||
type: 'url'
|
|
||||||
}
|
|
||||||
>
|
|
||||||
) => Promise<void>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Editor](/gen/editor/Editor-class), [Extract](/gen/Extract-type), [TLExternalContent](/gen/editor/TLExternalContent-type), [Promise](/gen/Promise-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `createAssetFromFile()` \{#PlopManager-createAssetFromFile-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
Override this method to change how assets are created from files.
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`_editor`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Editor
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`file`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
File
|
|
||||||
```
|
|
||||||
|
|
||||||
The file to create the asset from.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Promise<TLAsset>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Editor](/gen/editor/Editor-class), [File](/gen/File-interface), [Promise](/gen/Promise-interface), [TLAsset](/gen/tlschema/TLAsset-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `createAssetFromUrl()` \{#PlopManager-createAssetFromUrl-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
Override me to change the way assets are created from urls.
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`_editor`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Editor
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`url`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
string
|
|
||||||
```
|
|
||||||
|
|
||||||
The url to create the asset from
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Promise<TLAsset>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Editor](/gen/editor/Editor-class), [Promise](/gen/Promise-interface), [TLAsset](/gen/tlschema/TLAsset-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `createShapesForAssets()` \{#PlopManager-createShapesForAssets-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`editor`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Editor
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`assets`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
TLAsset[]
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`position`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Promise<void>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Editor](/gen/editor/Editor-class), [TLAsset](/gen/tlschema/TLAsset-type), [VecLike](/gen/primitives/VecLike-type), [Promise](/gen/Promise-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `handleEmbed()` \{#PlopManager-handleEmbed-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
Handle embed info from an external source. Feeling lucky? Overwrite this at runtime to change the way this type of external content is handled.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Example
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
editor.this.handleEmbed = myCustomMethod
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`editor`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Editor
|
|
||||||
```
|
|
||||||
|
|
||||||
The editor instance
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ point, url, embed }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Extract<
|
|
||||||
TLExternalContent,
|
|
||||||
{
|
|
||||||
type: 'embed'
|
|
||||||
}
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Promise<void>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Editor](/gen/editor/Editor-class), [Extract](/gen/Extract-type), [TLExternalContent](/gen/editor/TLExternalContent-type), [Promise](/gen/Promise-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `handleFiles()` \{#PlopManager-handleFiles-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
Handle files from an external source. Feeling lucky? Overwrite this at runtime to change the way this type of external content is handled.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Example
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
editor.this.handleFiles = myCustomMethod
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`editor`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Editor
|
|
||||||
```
|
|
||||||
|
|
||||||
The editor instance
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ point, files }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Extract<
|
|
||||||
TLExternalContent,
|
|
||||||
{
|
|
||||||
type: 'files'
|
|
||||||
}
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Promise<void>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Editor](/gen/editor/Editor-class), [Extract](/gen/Extract-type), [TLExternalContent](/gen/editor/TLExternalContent-type), [Promise](/gen/Promise-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `handleSvgText()` \{#PlopManager-handleSvgText-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
Handle svg text from an external source. Feeling lucky? Overwrite this at runtime to change the way this type of external content is handled.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Example
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
editor.this.handleSvgText = myCustomMethod
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`editor`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Editor
|
|
||||||
```
|
|
||||||
|
|
||||||
The editor instance.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ point, text }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Extract<
|
|
||||||
TLExternalContent,
|
|
||||||
{
|
|
||||||
type: 'svg-text'
|
|
||||||
}
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Promise<void>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Editor](/gen/editor/Editor-class), [Extract](/gen/Extract-type), [TLExternalContent](/gen/editor/TLExternalContent-type), [Promise](/gen/Promise-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `handleText()` \{#PlopManager-handleText-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
Handle plain text from an external source. Feeling lucky? Overwrite this at runtime to change the way this type of external content is handled.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Example
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
editor.this.handleText = myCustomMethod
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`editor`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Editor
|
|
||||||
```
|
|
||||||
|
|
||||||
The editor instance
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`{ point, text }`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Extract<
|
|
||||||
TLExternalContent,
|
|
||||||
{
|
|
||||||
type: 'text'
|
|
||||||
}
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Promise<void>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Editor](/gen/editor/Editor-class), [Extract](/gen/Extract-type), [TLExternalContent](/gen/editor/TLExternalContent-type), [Promise](/gen/Promise-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,24 +0,0 @@
|
||||||
---
|
|
||||||
title: PointerRecordType
|
|
||||||
status: published
|
|
||||||
category: tlschema
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 46
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
PointerRecordType: import('@tldraw/store').RecordType<TLPointer, never>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[RecordType](/gen/store/RecordType-class), [TLPointer](/gen/tlschema/~TLPointer-interface)
|
|
||||||
|
|
|
@ -1,226 +0,0 @@
|
||||||
---
|
|
||||||
title: Polyline2d
|
|
||||||
status: published
|
|
||||||
category: primitives
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 70
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [segments](#Polyline2d-segments-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [FromPoints](#Polyline2d-FromPoints-member-1)
|
|
||||||
- [getSegmentsFromPoints](#Polyline2d-getSegmentsFromPoints-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class Polyline2d extends BaseSpline2d<LineSegment2dModel> {}
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[BaseSpline2d](/gen/primitives/~BaseSpline2d-class), [LineSegment2dModel](/gen/primitives/LineSegment2dModel-interface)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Constructor`
|
|
||||||
|
|
||||||
<Small>Public Constructor</Small>
|
|
||||||
|
|
||||||
Constructs a new instance of the `Polyline2d` class
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`points`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike[]
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`k`
|
|
||||||
|
|
||||||
<Small>(optional)</Small>
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`p`
|
|
||||||
|
|
||||||
<Small>(optional)</Small>
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `segments` \{#Polyline2d-segments-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
segments: LineSegment2d[]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[LineSegment2d](/gen/primitives/LineSegment2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `FromPoints()` \{#Polyline2d-FromPoints-member-1}
|
|
||||||
|
|
||||||
<Small>Public Static Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`points`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike[]
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Polyline2d
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type), [Polyline2d](/gen/primitives/Polyline2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getSegmentsFromPoints()` \{#Polyline2d-getSegmentsFromPoints-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`points`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
VecLike[]
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`p`
|
|
||||||
|
|
||||||
<Small>(optional)</Small>
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
number
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
LineSegment2d[]
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[VecLike](/gen/primitives/VecLike-type), [LineSegment2d](/gen/primitives/LineSegment2d-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
|
@ -1,26 +0,0 @@
|
||||||
---
|
|
||||||
title: ROTATE_CORNER_TO_SELECTION_CORNER
|
|
||||||
status: published
|
|
||||||
category: primitives
|
|
||||||
group: Variable
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 74
|
|
||||||
---<Small>Public Readonly Variable</Small>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
ROTATE_CORNER_TO_SELECTION_CORNER: {
|
|
||||||
readonly top_left_rotate: 'top_left'
|
|
||||||
readonly top_right_rotate: 'top_right'
|
|
||||||
readonly bottom_right_rotate: 'bottom_right'
|
|
||||||
readonly bottom_left_rotate: 'bottom_left'
|
|
||||||
readonly mobile_rotate: 'top_left'
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
|
@ -1,319 +0,0 @@
|
||||||
---
|
|
||||||
title: ReadonlySharedStyleMap
|
|
||||||
status: published
|
|
||||||
category: editor
|
|
||||||
group: Class
|
|
||||||
author: api
|
|
||||||
date: 06/23/2023
|
|
||||||
order: 91
|
|
||||||
---<Small>Public Class</Small>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>Table of Contents</summary>
|
|
||||||
- [Properties](#properties)
|
|
||||||
- [map](#ReadonlySharedStyleMap-map-member)
|
|
||||||
- [size](#ReadonlySharedStyleMap-size-member)
|
|
||||||
- [Methods](#methods)
|
|
||||||
- [[Symbol.iterator]](#ReadonlySharedStyleMap-[Symbol-iterator]-member-1)
|
|
||||||
- [entries](#ReadonlySharedStyleMap-entries-member-1)
|
|
||||||
- [equals](#ReadonlySharedStyleMap-equals-member-1)
|
|
||||||
- [get](#ReadonlySharedStyleMap-get-member-1)
|
|
||||||
- [getAsKnownValue](#ReadonlySharedStyleMap-getAsKnownValue-member-1)
|
|
||||||
- [keys](#ReadonlySharedStyleMap-keys-member-1)
|
|
||||||
- [values](#ReadonlySharedStyleMap-values-member-1)
|
|
||||||
</details>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
class ReadonlySharedStyleMap {}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `Constructor`
|
|
||||||
|
|
||||||
<Small>Public Constructor</Small>
|
|
||||||
|
|
||||||
Constructs a new instance of the `ReadonlySharedStyleMap` class
|
|
||||||
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`entries`
|
|
||||||
|
|
||||||
<Small>(optional)</Small>
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
Iterable<
|
|
||||||
[StyleProp<unknown>, SharedStyle<unknown>]
|
|
||||||
>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Iterable](/gen/Iterable-interface), [StyleProp](/gen/tlschema/StyleProp-class), [SharedStyle](/gen/editor/SharedStyle-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
|
|
||||||
### `map` \{#ReadonlySharedStyleMap-map-member}
|
|
||||||
|
|
||||||
<Small>Public Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
protected map: Map<StyleProp<unknown>, SharedStyle<unknown>>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Map](/gen/Map-interface), [StyleProp](/gen/tlschema/StyleProp-class), [SharedStyle](/gen/editor/SharedStyle-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `size` \{#ReadonlySharedStyleMap-size-member}
|
|
||||||
|
|
||||||
<Small>Public Readonly Property</Small>
|
|
||||||
|
|
||||||
##### Signature
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
get size(): number
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Methods
|
|
||||||
|
|
||||||
### `[Symbol.iterator]()` \{#ReadonlySharedStyleMap-[Symbol-iterator]-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
IterableIterator<[StyleProp<unknown>, SharedStyle<unknown>]>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[Symbol.iterator](/gen/SymbolConstructor-iterator), [IterableIterator](/gen/IterableIterator-interface), [StyleProp](/gen/tlschema/StyleProp-class), [SharedStyle](/gen/editor/SharedStyle-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `entries()` \{#ReadonlySharedStyleMap-entries-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
IterableIterator<[StyleProp<unknown>, SharedStyle<unknown>]>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[IterableIterator](/gen/IterableIterator-interface), [StyleProp](/gen/tlschema/StyleProp-class), [SharedStyle](/gen/editor/SharedStyle-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `equals()` \{#ReadonlySharedStyleMap-equals-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`other`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
ReadonlySharedStyleMap
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
boolean
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[ReadonlySharedStyleMap](/gen/editor/ReadonlySharedStyleMap-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `get()` \{#ReadonlySharedStyleMap-get-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`prop`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
StyleProp<T>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
SharedStyle<T> | undefined
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[StyleProp](/gen/tlschema/StyleProp-class), [SharedStyle](/gen/editor/SharedStyle-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `getAsKnownValue()` \{#ReadonlySharedStyleMap-getAsKnownValue-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
<ParametersTable>
|
|
||||||
|
|
||||||
<ParametersTableRow>
|
|
||||||
<ParametersTableName>
|
|
||||||
|
|
||||||
`prop`
|
|
||||||
|
|
||||||
</ParametersTableName>
|
|
||||||
<ParametersTableDescription>
|
|
||||||
|
|
||||||
```ts
|
|
||||||
StyleProp<T>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</ParametersTableDescription>
|
|
||||||
</ParametersTableRow>
|
|
||||||
</ParametersTable>
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
T | undefined
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[StyleProp](/gen/tlschema/StyleProp-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `keys()` \{#ReadonlySharedStyleMap-keys-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
IterableIterator<StyleProp<unknown>>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[IterableIterator](/gen/IterableIterator-interface), [StyleProp](/gen/tlschema/StyleProp-class)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### `values()` \{#ReadonlySharedStyleMap-values-member-1}
|
|
||||||
|
|
||||||
<Small>Public Method</Small>
|
|
||||||
|
|
||||||
##### Parameters
|
|
||||||
|
|
||||||
|
|
||||||
None
|
|
||||||
|
|
||||||
##### Returns
|
|
||||||
|
|
||||||
|
|
||||||
```ts
|
|
||||||
IterableIterator<SharedStyle<unknown>>
|
|
||||||
```
|
|
||||||
|
|
||||||
##### References
|
|
||||||
|
|
||||||
[IterableIterator](/gen/IterableIterator-interface), [SharedStyle](/gen/editor/SharedStyle-type)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue