BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/blocks / EmbedFigmaModel

Class: EmbedFigmaModel ​

Extends ​

  • EmbedFigmaModel_base

Constructors ​

new EmbedFigmaModel() ​

new EmbedFigmaModel(): EmbedFigmaModel

Returns ​

EmbedFigmaModel

Inherited from ​

EmbedFigmaModel_base.constructor

Defined in ​

packages/affine/model/dist/blocks/embed/figma/figma-model.d.ts:13

Properties ​

[modelLabel] ​

[modelLabel]: object & EmbedFigmaBlockUrlData & GfxCompatibleProps

Type declaration ​

caption ​

caption: null | string

style ​

style: EmbedCardStyle

url ​

url: string

Inherited from ​

EmbedFigmaModel_base.[modelLabel]

Defined in ​

packages/framework/store/dist/schema/base.d.ts:116

caption ​

caption: null | string

Inherited from ​

EmbedFigmaModel_base.caption

Defined in ​

packages/affine/model/dist/blocks/embed/figma/figma-model.d.ts:16

caption$ ​

caption$: Signal<null | string>

Inherited from ​

EmbedFigmaModel_base.caption$

childMap ​

childMap: ReadonlySignal<Map<string, number>>

Inherited from ​

EmbedFigmaModel_base.childMap

Defined in ​

packages/framework/store/dist/schema/base.d.ts:109

connectable ​

connectable: boolean

Inherited from ​

EmbedFigmaModel_base.connectable

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:8

created ​

created: Slot<void>

Inherited from ​

EmbedFigmaModel_base.created

Defined in ​

packages/framework/store/dist/schema/base.d.ts:110

deleted ​

deleted: Slot<void>

Inherited from ​

EmbedFigmaModel_base.deleted

Defined in ​

packages/framework/store/dist/schema/base.d.ts:111

description ​

description: null | string

Inherited from ​

EmbedFigmaModel_base.description

Defined in ​

packages/affine/model/dist/blocks/embed/figma/figma-model.d.ts:4

description$ ​

description$: Signal<null | string>

Inherited from ​

EmbedFigmaModel_base.description$

flavour ​

flavour: string

Inherited from ​

EmbedFigmaModel_base.flavour

Defined in ​

packages/framework/store/dist/schema/base.d.ts:112

id ​

id: string

Inherited from ​

EmbedFigmaModel_base.id

Defined in ​

packages/framework/store/dist/schema/base.d.ts:113

index ​

index: string

Inherited from ​

EmbedFigmaModel_base.index

Defined in ​

packages/affine/model/dist/utils/gfx-compatible.d.ts:6

index$ ​

index$: Signal<string>

Inherited from ​

EmbedFigmaModel_base.index$

isEmpty ​

isEmpty: ReadonlySignal<boolean>

Inherited from ​

EmbedFigmaModel_base.isEmpty

Defined in ​

packages/framework/store/dist/schema/base.d.ts:114

keys ​

keys: string[]

Inherited from ​

EmbedFigmaModel_base.keys

Defined in ​

packages/framework/store/dist/schema/base.d.ts:115

page ​

page: Doc

Deprecated ​

use doc instead

Inherited from ​

EmbedFigmaModel_base.page

Defined in ​

packages/framework/store/dist/schema/base.d.ts:120

pop() ​

pop: (prop) => void

Parameters ​

• prop: "xywh" | "index" | "title" | "caption" | "style" | "description" | "url"

Returns ​

void

Inherited from ​

EmbedFigmaModel_base.pop

Defined in ​

packages/framework/store/dist/schema/base.d.ts:121

propsUpdated ​

propsUpdated: Slot<object>

Type declaration ​

key ​

key: string

Inherited from ​

EmbedFigmaModel_base.propsUpdated

Defined in ​

packages/framework/store/dist/schema/base.d.ts:122

role ​

role: "root" | "hub" | "content"

Inherited from ​

EmbedFigmaModel_base.role

Defined in ​

packages/framework/store/dist/schema/base.d.ts:125

rotate ​

rotate: number

Inherited from ​

EmbedFigmaModel_base.rotate

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:9

stash() ​

stash: (prop) => void

Parameters ​

• prop: "xywh" | "index" | "title" | "caption" | "style" | "description" | "url"

Returns ​

void

Inherited from ​

EmbedFigmaModel_base.stash

Defined in ​

packages/framework/store/dist/schema/base.d.ts:126

style ​

style: EmbedCardStyle

Inherited from ​

EmbedFigmaModel_base.style

Defined in ​

packages/affine/model/dist/blocks/embed/figma/figma-model.d.ts:14

style$ ​

style$: Signal<EmbedCardStyle>

Inherited from ​

EmbedFigmaModel_base.style$

text? ​

optional text: Text

Inherited from ​

EmbedFigmaModel_base.text

Defined in ​

packages/framework/store/dist/schema/base.d.ts:127

title ​

title: null | string

Inherited from ​

EmbedFigmaModel_base.title

Defined in ​

packages/affine/model/dist/blocks/embed/figma/figma-model.d.ts:3

title$ ​

title$: Signal<null | string>

Inherited from ​

EmbedFigmaModel_base.title$

url ​

url: string

Inherited from ​

EmbedFigmaModel_base.url

Defined in ​

packages/affine/model/dist/blocks/embed/figma/figma-model.d.ts:15

url$ ​

url$: Signal<string>

Inherited from ​

EmbedFigmaModel_base.url$

version ​

version: number

Inherited from ​

EmbedFigmaModel_base.version

Defined in ​

packages/framework/store/dist/schema/base.d.ts:128

xywh ​

xywh: `[${number},${number},${number},${number}]`

Inherited from ​

EmbedFigmaModel_base.xywh

Defined in ​

packages/affine/model/dist/utils/gfx-compatible.d.ts:5

xywh$ ​

xywh$: Signal<`[${number},${number},${number},${number}]`>

Inherited from ​

EmbedFigmaModel_base.xywh$

yBlock ​

yBlock: YBlock

Inherited from ​

EmbedFigmaModel_base.yBlock

Defined in ​

packages/framework/store/dist/schema/base.d.ts:129

Accessors ​

children ​

get children(): BlockModel<object, SignaledProps<object>>[]

Returns ​

BlockModel<object, SignaledProps<object>>[]

Inherited from ​

EmbedFigmaModel_base.children

Defined in ​

packages/framework/store/dist/schema/base.d.ts:130

doc ​

get doc(): Doc

set doc(doc): void

Parameters ​

• doc: Doc

Returns ​

Doc

Inherited from ​

EmbedFigmaModel_base.doc

Defined in ​

packages/framework/store/dist/schema/base.d.ts:131

elementBound ​

get elementBound(): Bound

Returns ​

Bound

Inherited from ​

EmbedFigmaModel_base.elementBound

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:10

externalBound ​

get externalBound(): null | Bound

Returns ​

null | Bound

Inherited from ​

EmbedFigmaModel_base.externalBound

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:11

externalXYWH ​

get externalXYWH(): undefined | `[${number},${number},${number},${number}]`

set externalXYWH(xywh): void

Parameters ​

• xywh: undefined | `[${number},${number},${number},${number}]`

Returns ​

undefined | `[${number},${number},${number},${number}]`

Inherited from ​

EmbedFigmaModel_base.externalXYWH

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:12

group ​

get group(): null | SurfaceGroupLikeModel<BaseElementProps>

Returns ​

null | SurfaceGroupLikeModel<BaseElementProps>

Inherited from ​

EmbedFigmaModel_base.group

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:14

groups ​

get groups(): SurfaceGroupLikeModel<BaseElementProps>[]

Returns ​

SurfaceGroupLikeModel<BaseElementProps>[]

Inherited from ​

EmbedFigmaModel_base.groups

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:15

parent ​

get parent(): null | BlockModel<object, SignaledProps<object>>

Returns ​

null | BlockModel<object, SignaledProps<object>>

Inherited from ​

EmbedFigmaModel_base.parent

Defined in ​

packages/framework/store/dist/schema/base.d.ts:133

Methods ​

[dispose]() ​

[dispose](): void

Returns ​

void

Inherited from ​

EmbedFigmaModel_base.[dispose]

Defined in ​

packages/framework/store/dist/schema/base.d.ts:138

containsBound() ​

containsBound(bounds): boolean

Parameters ​

• bounds: Bound

Returns ​

boolean

Inherited from ​

EmbedFigmaModel_base.containsBound

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:16

dispose() ​

dispose(): void

Returns ​

void

Inherited from ​

EmbedFigmaModel_base.dispose

Defined in ​

packages/framework/store/dist/schema/base.d.ts:135

firstChild() ​

firstChild(): null | BlockModel<object, SignaledProps<object>>

Returns ​

null | BlockModel<object, SignaledProps<object>>

Inherited from ​

EmbedFigmaModel_base.firstChild

Defined in ​

packages/framework/store/dist/schema/base.d.ts:136

getLineIntersections() ​

getLineIntersections(start, end): null | PointLocation[]

Parameters ​

• start: IVec

• end: IVec

Returns ​

null | PointLocation[]

Inherited from ​

EmbedFigmaModel_base.getLineIntersections

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:17

getNearestPoint() ​

getNearestPoint(point): IVec

Parameters ​

• point: IVec

Returns ​

IVec

Inherited from ​

EmbedFigmaModel_base.getNearestPoint

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:18

getRelativePointLocation() ​

getRelativePointLocation(relativePoint): PointLocation

Parameters ​

• relativePoint: IVec

Returns ​

PointLocation

Inherited from ​

EmbedFigmaModel_base.getRelativePointLocation

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:19

includesPoint() ​

includesPoint(x, y, _, __): boolean

Parameters ​

• x: number

• y: number

• _: PointTestOptions

• __: EditorHost

Returns ​

boolean

Inherited from ​

EmbedFigmaModel_base.includesPoint

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:20

intersectsBound() ​

intersectsBound(bound): boolean

Parameters ​

• bound: Bound

Returns ​

boolean

Inherited from ​

EmbedFigmaModel_base.intersectsBound

Defined in ​

packages/framework/block-std/dist/gfx/gfx-block-model.d.ts:21

lastChild() ​

lastChild(): null | BlockModel<object, SignaledProps<object>>

Returns ​

null | BlockModel<object, SignaledProps<object>>

Inherited from ​

EmbedFigmaModel_base.lastChild

Defined in ​

packages/framework/store/dist/schema/base.d.ts:137

Copyright © 2022-present Toeverything