BlockSuite API Documentation / @blocksuite/blocks / BookmarkBlockModel
Class: BookmarkBlockModel ​
Contents ​
Extends ​
BaseBlockModel<BookmarkBlockProps,this> &IEdgelessElement
Constructors ​
new BookmarkBlockModel(args) ​
new BookmarkBlockModel(...
args):BookmarkBlockModel
Parameters ​
• ...args: any[]
Returns ​
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).constructor
Source ​
packages/global/dist/utils/types.d.ts:1
Properties ​
batch ​
batch:
null|string
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).batch
Source ​
packages/blocks/src/surface-block/elements/edgeless-element.ts:37
caption ​
caption:
null|string
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).caption
Source ​
packages/blocks/src/bookmark-block/bookmark-model.ts:35
childrenUpdated ​
childrenUpdated:
Slot<void>
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).childrenUpdated
Source ​
packages/store/dist/schema/base.d.ts:116
connectable ​
connectable:
boolean
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).connectable
Source ​
packages/blocks/src/surface-block/elements/edgeless-element.ts:35
created ​
created:
Slot<void>
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).created
Source ​
packages/store/dist/schema/base.d.ts:111
deleted ​
deleted:
Slot<void>
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).deleted
Source ​
packages/store/dist/schema/base.d.ts:112
description ​
description:
null|string
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).description
Source ​
packages/blocks/src/bookmark-block/bookmark-model.ts:9
elementBound ​
elementBound:
Bound
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).elementBound
Source ​
packages/blocks/src/surface-block/elements/edgeless-element.ts:38
flavour ​
flavour:
string
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).flavour
Source ​
packages/store/dist/schema/base.d.ts:102
icon ​
icon:
null|string
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).icon
Source ​
packages/blocks/src/bookmark-block/bookmark-model.ts:10
id ​
id:
string
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).id
Source ​
packages/store/dist/schema/base.d.ts:105
image ​
image:
null|string
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).image
Source ​
packages/blocks/src/bookmark-block/bookmark-model.ts:11
index ​
index:
string
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).index
Source ​
packages/blocks/src/bookmark-block/bookmark-model.ts:27
keys ​
keys:
string[]
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).keys
Source ​
packages/store/dist/schema/base.d.ts:107
page ​
page:
Page
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).page
Source ​
packages/store/dist/schema/base.d.ts:104
pop ​
pop: (
prop) =>void
Parameters ​
• prop: "url" | "style" | "description" | "icon" | "image" | "title" | "index" | "xywh" | "rotate" | "caption"
Returns ​
void
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).pop
Source ​
packages/store/dist/schema/base.d.ts:109
propsUpdated ​
propsUpdated:
Slot<Object>
Type declaration ​
key ​
key:
string
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).propsUpdated
Source ​
packages/store/dist/schema/base.d.ts:113
role ​
role:
"root"|"hub"|"content"
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).role
Source ​
packages/store/dist/schema/base.d.ts:103
rotate ​
rotate:
number
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).rotate
Source ​
packages/blocks/src/bookmark-block/bookmark-model.ts:29
stash ​
stash: (
prop) =>void
Parameters ​
• prop: "url" | "style" | "description" | "icon" | "image" | "title" | "index" | "xywh" | "rotate" | "caption"
Returns ​
void
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).stash
Source ​
packages/store/dist/schema/base.d.ts:108
style ​
style:
BookmarkBlockType
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).style
Source ​
packages/blocks/src/bookmark-block/bookmark-model.ts:33
text? ​
text?:
Text
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).text
Source ​
packages/store/dist/schema/base.d.ts:110
title ​
title:
null|string
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).title
Source ​
packages/blocks/src/bookmark-block/bookmark-model.ts:12
url ​
url:
string
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).url
Source ​
packages/blocks/src/bookmark-block/bookmark-model.ts:34
xywh ​
xywh: `[${number},${number},${number},${number}]`
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).xywh
Source ​
packages/blocks/src/bookmark-block/bookmark-model.ts:28
yBlock ​
yBlock:
YBlock
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).yBlock
Source ​
packages/store/dist/schema/base.d.ts:106
Accessors ​
childMap ​
getchildMap():Map<string,number>
Returns ​
Map<string, number>
Source ​
packages/store/dist/schema/base.d.ts:117
children ​
getchildren():BaseBlockModel<object>[]
Returns ​
BaseBlockModel<object>[]
Source ​
packages/store/dist/schema/base.d.ts:118
Methods ​
boxSelect() ​
boxSelect(
bound):boolean
Parameters ​
• bound: Bound
Returns ​
boolean
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).boxSelect
Source ​
packages/blocks/src/surface-block/elements/edgeless-element.ts:50
clone() ​
clone():
BookmarkBlockModel
Returns ​
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).clone
Source ​
packages/store/dist/schema/base.d.ts:124
containedByBounds() ​
containedByBounds(
bounds):boolean
Parameters ​
• bounds: Bound
Returns ​
boolean
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).containedByBounds
Source ​
packages/blocks/src/surface-block/elements/edgeless-element.ts:39
dispose() ​
dispose():
void
Returns ​
void
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).dispose
Source ​
packages/store/dist/schema/base.d.ts:123
firstChild() ​
firstChild():
null|BaseBlockModel<object>
Returns ​
null | BaseBlockModel<object>
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).firstChild
Source ​
packages/store/dist/schema/base.d.ts:120
getNearestPoint() ​
getNearestPoint(
point):IVec
Parameters ​
• point: IVec
Returns ​
IVec
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).getNearestPoint
Source ​
packages/blocks/src/surface-block/elements/edgeless-element.ts:40
getRelativePointLocation() ​
getRelativePointLocation(
point):PointLocation
Parameters ​
• point: IVec
Returns ​
PointLocation
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).getRelativePointLocation
Source ​
packages/blocks/src/surface-block/elements/edgeless-element.ts:42
hitTest() ​
hitTest(
x,y,options,editorHost,surface?):boolean
Parameters ​
• x: number
• y: number
• options: HitTestOptions
• editorHost: EditorHost
• surface?: SurfaceBlockComponent
Returns ​
boolean
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).hitTest
Source ​
packages/blocks/src/surface-block/elements/edgeless-element.ts:43
intersectWithLine() ​
intersectWithLine(
start,end):null|PointLocation[]
Parameters ​
• start: IVec
• end: IVec
Returns ​
null | PointLocation[]
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).intersectWithLine
Source ​
packages/blocks/src/surface-block/elements/edgeless-element.ts:41
isEmpty() ​
isEmpty():
boolean
Returns ​
boolean
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).isEmpty
Source ​
packages/store/dist/schema/base.d.ts:119
lastChild() ​
lastChild():
null|BaseBlockModel<object>
Returns ​
null | BaseBlockModel<object>
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).lastChild
Source ​
packages/store/dist/schema/base.d.ts:121
lastItem() ​
lastItem():
null|BaseBlockModel<object>
Returns ​
null | BaseBlockModel<object>
Inherited from ​
selectable<BookmarkBlockProps>( BaseBlockModel ).lastItem
Source ​
packages/store/dist/schema/base.d.ts:122
Generated using typedoc-plugin-markdown and TypeDoc