BlockSuite API Documentation / @blocksuite/blocks / GroupElementModel

Class: GroupElementModel

Extends

• GfxGroupLikeElementModel<GroupElementProps>

Constructors

new GroupElementModel()

new GroupElementModel(options): GroupElementModel

Parameters

• options

• options.id: string

• options.model: SurfaceBlockModel

• options.onChange

• options.stashedStore: Map<unknown, unknown>

• options.yMap: YMap<unknown>

Returns

GroupElementModel

Inherited from

GfxGroupLikeElementModel<GroupElementProps>.constructor

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:68

Properties

[gfxContainerSymbol]

[gfxContainerSymbol]: true

Inherited from

GfxGroupLikeElementModel.[gfxContainerSymbol]

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:119

---

_disposable

protected _disposable: DisposableGroup

Inherited from

GfxGroupLikeElementModel._disposable

Defined in

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

---

_id

protected _id: string

Inherited from

GfxGroupLikeElementModel._id

Defined in

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

---

_local

protected _local: Map<string | symbol, unknown>

Inherited from

GfxGroupLikeElementModel._local

Defined in

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

---

_onChange()

protected _onChange: (payload) => void

Parameters

• payload

• payload.local: boolean

• payload.oldValues: Record<string, unknown>

• payload.props: Record<string, unknown>

Returns

void

Inherited from

GfxGroupLikeElementModel._onChange

Defined in

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

---

_preserved

protected _preserved: Map<string, unknown>

Used to store a copy of data in the yMap.

Inherited from

GfxGroupLikeElementModel._preserved

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:64

---

_stashed

protected _stashed: Map<string, unknown>

Inherited from

GfxGroupLikeElementModel._stashed

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:65

---

surface

surface: SurfaceBlockModel

Inherited from

GfxGroupLikeElementModel.surface

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:66

---

yMap

yMap: YMap<unknown>

Inherited from

GfxGroupLikeElementModel.yMap

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:67

Accessors

childElements

get childElements(): GfxModel[]

Returns

GfxModel[]

Inherited from

GfxGroupLikeElementModel.childElements

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:141

---

childIds

get childIds(): string[]

The ids of the children. Its role is to provide a unique way to access the children. You should update this field through setChildIds when the children are added or removed.

Returns

string[]

Inherited from

GfxGroupLikeElementModel.childIds

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:146

---

children

Overrides

GfxGroupLikeElementModel.children

Defined in

packages/affine/model/dist/elements/group/group.d.ts:23

---

connectable

get connectable(): boolean

Returns

boolean

Inherited from

GfxGroupLikeElementModel.connectable

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:90

---

deserializedXYWH

get deserializedXYWH(): XYWH

Returns

XYWH

Inherited from

GfxGroupLikeElementModel.deserializedXYWH

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:91

---

display

Inherited from

GfxGroupLikeElementModel.display

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:106

---

elementBound

get elementBound(): Bound

The bound of the element after rotation. The bound without rotation should be created by Bound.deserialize(this.xywh).

Returns

Bound

Inherited from

GfxGroupLikeElementModel.elementBound

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:96

---

externalBound

get externalBound(): null | Bound

Returns

null | Bound

Inherited from

GfxGroupLikeElementModel.externalBound

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:97

---

externalXYWH

Inherited from

GfxGroupLikeElementModel.externalXYWH

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:107

---

group

get group(): null | GfxGroupLikeElementModel<BaseElementProps>

Returns

null | GfxGroupLikeElementModel<BaseElementProps>

Inherited from

GfxGroupLikeElementModel.group

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:98

---

groups

get groups(): GfxGroupLikeElementModel<BaseElementProps>[]

Returns

GfxGroupLikeElementModel<BaseElementProps>[]

Inherited from

GfxGroupLikeElementModel.groups

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:99

---

h

get h(): number

Returns

number

Inherited from

GfxGroupLikeElementModel.h

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:100

---

id

get id(): string

Returns

string

Inherited from

GfxGroupLikeElementModel.id

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:101

---

index

Inherited from

GfxGroupLikeElementModel.index

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:108

---

isConnected

get isConnected(): boolean

Returns

boolean

Inherited from

GfxGroupLikeElementModel.isConnected

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:102

---

opacity

Inherited from

GfxGroupLikeElementModel.opacity

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:109

---

rotate

get rotate(): number

set rotate(_): void

Parameters

• _: number

Returns

number

Overrides

GfxGroupLikeElementModel.rotate

Defined in

packages/affine/model/dist/elements/group/group.d.ts:20

---

seed

Inherited from

GfxGroupLikeElementModel.seed

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:111

---

showTitle

Defined in

packages/affine/model/dist/elements/group/group.d.ts:24

---

title

Defined in

packages/affine/model/dist/elements/group/group.d.ts:25

---

type

get type(): string

Returns

string

Overrides

GfxGroupLikeElementModel.type

Defined in

packages/affine/model/dist/elements/group/group.d.ts:22

---

w

get w(): number

Returns

number

Inherited from

GfxGroupLikeElementModel.w

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:103

---

x

get x(): number

Returns

number

Inherited from

GfxGroupLikeElementModel.x

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:104

---

xywh

get xywh(): `[${number},${number},${number},${number}]`

set xywh(_): void

Parameters

• _: `[${number},${number},${number},${number}]`

Returns

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

Inherited from

GfxGroupLikeElementModel.xywh

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:147

---

y

get y(): number

Returns

number

Inherited from

GfxGroupLikeElementModel.y

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:105

Methods

addChild()

addChild(element): void

Parameters

• element: string | GfxModel

Returns

void

Defined in

packages/affine/model/dist/elements/group/group.d.ts:15

---

containsBound()

containsBound(bound): boolean

Parameters

• bound: Bound

Returns

boolean

Overrides

GfxGroupLikeElementModel.containsBound

Defined in

packages/affine/model/dist/elements/group/group.d.ts:16

---

descendants()

descendants(withoutGroup?): GfxModel[]

Get all descendants of this group

Parameters

• withoutGroup?: boolean

if true, will not include group element

Returns

GfxModel[]

Inherited from

GfxGroupLikeElementModel.descendants

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:125

---

getLineIntersections()

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

Parameters

• start: IVec

• end: IVec

Returns

null | PointLocation[]

Overrides

GfxGroupLikeElementModel.getLineIntersections

Defined in

packages/affine/model/dist/elements/group/group.d.ts:17

---

getNearestPoint()

getNearestPoint(point): IVec

Parameters

• point: IVec

Returns

IVec

Inherited from

GfxGroupLikeElementModel.getNearestPoint

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:82

---

getRelativePointLocation()

getRelativePointLocation(relativePoint): PointLocation

Parameters

• relativePoint: IVec

Returns

PointLocation

Inherited from

GfxGroupLikeElementModel.getRelativePointLocation

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:83

---

hasChild()

hasChild(element): boolean

The actual field that stores the children of the group. It should be a ymap decorated with @field.

Parameters

• element: string | GfxModel

Returns

boolean

Inherited from

GfxGroupLikeElementModel.hasChild

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:130

---

hasDescendant()

hasDescendant(element): boolean

Check if the group has the given descendant.

Parameters

• element: string | GfxModel

Returns

boolean

Inherited from

GfxGroupLikeElementModel.hasDescendant

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:134

---

includesPoint()

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

Parameters

• x: number

• y: number

• _: PointTestOptions

• __: EditorHost

Returns

boolean

Inherited from

GfxGroupLikeElementModel.includesPoint

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:84

---

intersectsBound()

intersectsBound(bound): boolean

Parameters

• bound: Bound

Returns

boolean

Inherited from

GfxGroupLikeElementModel.intersectsBound

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:85

---

onCreated()

onCreated(): void

Returns

void

Inherited from

GfxGroupLikeElementModel.onCreated

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:86

---

pop()

pop(prop): void

Parameters

• prop: string

Returns

void

Inherited from

GfxGroupLikeElementModel.pop

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:87

---

removeChild()

removeChild(element): void

Remove the child from the group

Parameters

• element: string | GfxModel

Returns

void

Overrides

GfxGroupLikeElementModel.removeChild

Defined in

packages/affine/model/dist/elements/group/group.d.ts:18

---

serialize()

serialize(): SerializedGroupElement

Returns

SerializedGroupElement

Overrides

GfxGroupLikeElementModel.serialize

Defined in

packages/affine/model/dist/elements/group/group.d.ts:19

---

setChildIds()

setChildIds(value, fromLocal): void

Set the new value of the childIds

Parameters

• value: string[]

the new value of the childIds

• fromLocal: boolean

if true, the change is happened in the local

Returns

void

Inherited from

GfxGroupLikeElementModel.setChildIds

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:140

---

stash()

stash(prop): void

Parameters

• prop: string

Returns

void

Inherited from

GfxGroupLikeElementModel.stash

Defined in

packages/framework/block-std/dist/gfx/surface/element-model.d.ts:89

---

propsToY()

static propsToY(props): GroupElementProps

Parameters

• props: Record<string, unknown>

Returns

GroupElementProps

Overrides

GfxGroupLikeElementModel.propsToY

Defined in

packages/affine/model/dist/elements/group/group.d.ts:14