BlockSuite API Documentation / @blocksuite/affine-model / BookmarkBlockModel

Class: BookmarkBlockModel

Extends

• EdgelessBlockModel<BookmarkBlockProps, this>

Implements

• GfxElementGeometry

Constructors

new BookmarkBlockModel()

new BookmarkBlockModel(): BookmarkBlockModel

Returns

BookmarkBlockModel

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).constructor

Defined in

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

Properties

[modelLabel]

[modelLabel]: BookmarkBlockProps

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).[modelLabel]

Defined in

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

---

caption

caption: null | string

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).caption

Defined in

packages/affine/model/src/blocks/bookmark/bookmark-model.ts:21

---

caption$

caption$: Signal<null | string>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).caption$

---

childMap

childMap: ReadonlySignal<Map<string, number>>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).childMap

Defined in

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

---

connectable

connectable: boolean

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).connectable

Defined in

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

---

created

created: Slot<void>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).created

Defined in

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

---

deleted

deleted: Slot<void>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).deleted

Defined in

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

---

description

description: null | string

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).description

Defined in

packages/affine/model/src/utils/types.ts:15

---

description$

description$: Signal<null | string>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).description$

---

flavour

flavour: string

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).flavour

Defined in

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

---

icon

icon: null | string

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).icon

Defined in

packages/affine/model/src/utils/types.ts:16

---

icon$

icon$: Signal<null | string>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).icon$

---

id

id: string

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).id

Defined in

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

---

image

image: null | string

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).image

Defined in

packages/affine/model/src/utils/types.ts:17

---

image$

image$: Signal<null | string>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).image$

---

index

index: string

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).index

Defined in

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

---

index$

index$: Signal<string>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).index$

---

isEmpty

isEmpty: ReadonlySignal<boolean>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).isEmpty

Defined in

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

---

keys

keys: string[]

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).keys

Defined in

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

---

lockedBySelf?

optional lockedBySelf: boolean

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).lockedBySelf

Defined in

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

---

lockedBySelf$

lockedBySelf$: Signal<undefined | boolean>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).lockedBySelf$

---

page

page: Doc

Deprecated

use doc instead

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).page

Defined in

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

---

pop()

pop: (prop) => void

Parameters

prop

"xywh" | "index" | "lockedBySelf" | "description" | "rotate" | "caption" | "style" | "icon" | "image" | "title" | "url"

Returns

void

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).pop

Defined in

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

---

propsUpdated

propsUpdated: Slot<{ key: string; }>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).propsUpdated

Defined in

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

---

role

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

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).role

Defined in

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

---

rotate

rotate: number

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).rotate

Defined in

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

---

rotate$

rotate$: Signal<number>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).rotate$

---

stash()

stash: (prop) => void

Parameters

prop

"xywh" | "index" | "lockedBySelf" | "description" | "rotate" | "caption" | "style" | "icon" | "image" | "title" | "url"

Returns

void

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).stash

Defined in

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

---

style

style: EmbedCardStyle

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).style

Defined in

packages/affine/model/src/blocks/bookmark/bookmark-model.ts:19

---

style$

style$: Signal<EmbedCardStyle>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).style$

---

text?

optional text: Text

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).text

Defined in

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

---

title

title: null | string

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).title

Defined in

packages/affine/model/src/utils/types.ts:18

---

title$

title$: Signal<null | string>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).title$

---

url

url: string

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).url

Defined in

packages/affine/model/src/blocks/bookmark/bookmark-model.ts:20

---

url$

url$: Signal<string>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).url$

---

version

version: number

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).version

Defined in

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

---

xywh

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

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).xywh

Defined in

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

---

xywh$

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

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).xywh$

---

yBlock

yBlock: YBlock

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).yBlock

Defined in

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

Accessors

children

Get Signature

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

Returns

BlockModel<object, SignaledProps<object>>[]

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).children

Defined in

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

---

deserializedXYWH

Get Signature

get deserializedXYWH(): XYWH

Returns

XYWH

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).deserializedXYWH

Defined in

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

---

doc

Get Signature

get doc(): Doc

Returns

Doc

Set Signature

set doc(doc): void

Parameters

doc

Doc

Returns

void

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).doc

Defined in

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

---

elementBound

Get Signature

get elementBound(): Bound

Returns

Bound

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).elementBound

Defined in

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

---

externalBound

Get Signature

get externalBound(): null | Bound

Returns

null | Bound

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).externalBound

Defined in

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

---

externalXYWH

Get Signature

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

Returns

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

Set Signature

set externalXYWH(xywh): void

Parameters

xywh

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

Returns

void

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).externalXYWH

Defined in

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

---

group

Get Signature

get group(): null | GfxGroupModel

Returns

null | GfxGroupModel

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).group

Defined in

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

---

groups

Get Signature

get groups(): GfxGroupModel[]

Returns

GfxGroupModel[]

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).groups

Defined in

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

---

h

Get Signature

get h(): number

Returns

number

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).h

Defined in

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

---

parent

Get Signature

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

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).parent

Defined in

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

---

surface

Get Signature

get surface(): null | SurfaceBlockModel

Returns

null | SurfaceBlockModel

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).surface

Defined in

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

---

w

Get Signature

get w(): number

Returns

number

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).w

Defined in

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

---

x

Get Signature

get x(): number

Returns

number

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).x

Defined in

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

---

y

Get Signature

get y(): number

Returns

number

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).y

Defined in

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

Methods

[dispose]()

[dispose](): void

Returns

void

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).[dispose]

Defined in

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

---

containsBound()

containsBound(bounds): boolean

Parameters

bounds

Bound

Returns

boolean

Implementation of

GfxElementGeometry.containsBound

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).containsBound

Defined in

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

---

dispose()

dispose(): void

Returns

void

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).dispose

Defined in

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

---

firstChild()

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

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).firstChild

Defined in

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

---

getLineIntersections()

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

Parameters

start

IVec

end

IVec

Returns

null | PointLocation[]

Implementation of

GfxElementGeometry.getLineIntersections

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).getLineIntersections

Defined in

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

---

getNearestPoint()

getNearestPoint(point): IVec

Parameters

point

IVec

Returns

IVec

Implementation of

GfxElementGeometry.getNearestPoint

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).getNearestPoint

Defined in

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

---

getRelativePointLocation()

getRelativePointLocation(relativePoint): PointLocation

Parameters

relativePoint

IVec

Returns

PointLocation

Implementation of

GfxElementGeometry.getRelativePointLocation

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).getRelativePointLocation

Defined in

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

---

includesPoint()

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

Parameters

x

number

y

number

_

PointTestOptions

__

EditorHost

Returns

boolean

Implementation of

GfxElementGeometry.includesPoint

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).includesPoint

Defined in

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

---

intersectsBound()

intersectsBound(bound): boolean

Parameters

bound

Bound

Returns

boolean

Implementation of

GfxElementGeometry.intersectsBound

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).intersectsBound

Defined in

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

---

isLocked()

isLocked(): boolean

Check if the element is locked. It will check the lock status of the element and its ancestors.

Returns

boolean

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).isLocked

Defined in

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

---

isLockedByAncestor()

isLockedByAncestor(): boolean

Returns

boolean

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).isLockedByAncestor

Defined in

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

---

isLockedBySelf()

isLockedBySelf(): boolean

Returns

boolean

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).isLockedBySelf

Defined in

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

---

lastChild()

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

Returns

null | BlockModel<object, SignaledProps<object>>

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).lastChild

Defined in

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

---

lock()

lock(): void

Returns

void

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).lock

Defined in

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

---

unlock()

unlock(): void

Returns

void

Inherited from

GfxCompatible<BookmarkBlockProps>(BlockModel).unlock

Defined in

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