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

Class: ShapeElementModel

Defined in: packages/affine/model/src/elements/shape/shape.ts:60

Extends

SurfaceElementModel<ShapeProps>

Constructors

new ShapeElementModel()

new ShapeElementModel(options): ShapeElementModel

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

Parameters

options

id

string

model

SurfaceBlockModel

onChange

(payload) => void

stashedStore

Map<unknown, unknown>

yMap

YMap<unknown>

Returns

ShapeElementModel

Inherited from

SurfaceElementModel.constructor

Properties

_disposable

protected _disposable: DisposableGroup

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:25

Inherited from

SurfaceElementModel._disposable

_id

protected _id: string

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:26

Inherited from

SurfaceElementModel._id

_local

protected _local: Map<string | symbol, unknown>

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:27

Inherited from

SurfaceElementModel._local

_onChange()

protected _onChange: (payload) => void

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:28

Parameters

payload

local

boolean

oldValues

Record<string, unknown>

props

Record<string, unknown>

Returns

void

Inherited from

SurfaceElementModel._onChange

_preserved

protected _preserved: Map<string, unknown>

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:36

Used to store a copy of data in the yMap.

Inherited from

SurfaceElementModel._preserved

_stashed

protected _stashed: Map<string, unknown>

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:37

Inherited from

SurfaceElementModel._stashed

propsUpdated

propsUpdated: Subject<{ key: string; }>

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:38

Inherited from

SurfaceElementModel.propsUpdated

surface

surface: SurfaceBlockModel

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:42

Inherited from

SurfaceElementModel.surface

textBound

textBound: null | IBound = null

Defined in: packages/affine/model/src/elements/shape/shape.ts:64

The bound of the text content.

yMap

yMap: YMap<unknown>

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:44

Inherited from

SurfaceElementModel.yMap

Accessors

color

Defined in: packages/affine/model/src/elements/shape/shape.ts:102

connectable

Get Signature

get connectable(): boolean

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:45

Returns

boolean

Inherited from

SurfaceElementModel.connectable

deserializedXYWH

Get Signature

get deserializedXYWH(): XYWH

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:46

Returns

XYWH

Inherited from

SurfaceElementModel.deserializedXYWH

display

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:93

Inherited from

SurfaceElementModel.display

elementBound

Get Signature

get elementBound(): Bound

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:51

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

Returns

Bound

Inherited from

SurfaceElementModel.elementBound

externalBound

Get Signature

get externalBound(): null | Bound

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

Returns

null | Bound

Inherited from

SurfaceElementModel.externalBound

externalXYWH

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

In some cases, you need to draw something related to the element, but it does not belong to the element itself. And it is also interactive, you can select element by clicking on it. E.g. the title of the group element. In this case, we need to store this kind of external xywh in order to do hit test. This property should not be synced to the doc. This property should be updated every time it gets rendered.

Inherited from

SurfaceElementModel.externalXYWH

fillColor

Defined in: packages/affine/model/src/elements/shape/shape.ts:105

filled

Defined in: packages/affine/model/src/elements/shape/shape.ts:108

fontFamily

Defined in: packages/affine/model/src/elements/shape/shape.ts:111

fontStyle

Defined in: packages/affine/model/src/elements/shape/shape.ts:117

fontWeight

Defined in: packages/affine/model/src/elements/shape/shape.ts:120

group

Get Signature

get group(): null | GfxGroupModel

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

Returns

null | GfxGroupModel

Inherited from

SurfaceElementModel.group

groups

Get Signature

get groups(): GfxGroupModel[]

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:57

Return the ancestor elements in order from the most recent to the earliest.

Returns

GfxGroupModel[]

Inherited from

SurfaceElementModel.groups

h

Get Signature

get h(): number

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:58

Returns

number

Inherited from

SurfaceElementModel.h

hidden

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

Inherited from

SurfaceElementModel.hidden

id

Get Signature

get id(): string

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:59

Returns

string

Inherited from

SurfaceElementModel.id

index

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

Inherited from

SurfaceElementModel.index

isConnected

Get Signature

get isConnected(): boolean

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:60

Returns

boolean

Inherited from

SurfaceElementModel.isConnected

lockedBySelf

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

Indicates whether the current block is explicitly locked by self. For checking the lock status of the element, use isLocked instead. For (un)locking the element, use (un)lock instead.

Inherited from

SurfaceElementModel.lockedBySelf

maxWidth

Defined in: packages/affine/model/src/elements/shape/shape.ts:123

opacity

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

Inherited from

SurfaceElementModel.opacity

padding

Defined in: packages/affine/model/src/elements/shape/shape.ts:126

radius

Defined in: packages/affine/model/src/elements/shape/shape.ts:132

responseBound

Get Signature

get responseBound(): Bound

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:61

The bound of the element considering the response extension.

Returns

Bound

Inherited from

SurfaceElementModel.responseBound

responseExtension

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

Defines the extension of the response area beyond the element's bounding box. This tuple specifies the horizontal and vertical margins to be added to the element's bound.

The first value represents the horizontal extension (added to both left and right sides), and the second value represents the vertical extension (added to both top and bottom sides).

The response area is computed as: [x - horizontal, y - vertical, w + 2 * horizontal, h + 2 * vertical].

Example:

xywh: [0, 0, 100, 100], responseExtension: [10, 20] Resulting response area: [-10, -20, 120, 140].
responseExtension: [0, 0] keeps the response area equal to the bounding box.

Inherited from

SurfaceElementModel.responseExtension

rotate

Defined in: packages/affine/model/src/elements/shape/shape.ts:135

Overrides

SurfaceElementModel.rotate

roughness

Defined in: packages/affine/model/src/elements/shape/shape.ts:138

seed

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

Inherited from

SurfaceElementModel.seed

shadow

Defined in: packages/affine/model/src/elements/shape/shape.ts:141

shapeStyle

Defined in: packages/affine/model/src/elements/shape/shape.ts:155

shapeType

Defined in: packages/affine/model/src/elements/shape/shape.ts:158

strokeColor

Defined in: packages/affine/model/src/elements/shape/shape.ts:161

strokeStyle

Defined in: packages/affine/model/src/elements/shape/shape.ts:164

strokeWidth

Defined in: packages/affine/model/src/elements/shape/shape.ts:167

text

Defined in: packages/affine/model/src/elements/shape/shape.ts:170

textAlign

Defined in: packages/affine/model/src/elements/shape/shape.ts:173

textDisplay

Defined in: packages/affine/model/src/elements/shape/shape.ts:176

textHorizontalAlign

Defined in: packages/affine/model/src/elements/shape/shape.ts:179

textResizing

Defined in: packages/affine/model/src/elements/shape/shape.ts:182

textVerticalAlign

Defined in: packages/affine/model/src/elements/shape/shape.ts:185

type

Get Signature

get type(): string

Defined in: packages/affine/model/src/elements/shape/shape.ts:66

Returns

string

Overrides

SurfaceElementModel.type

w

Get Signature

get w(): number

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:63

Returns

number

Inherited from

SurfaceElementModel.w

x

Get Signature

get x(): number

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

Returns

number

Inherited from

SurfaceElementModel.x

xywh

Defined in: packages/affine/model/src/elements/shape/shape.ts:188

Overrides

SurfaceElementModel.xywh

y

Get Signature

get y(): number

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

Returns

number

Inherited from

SurfaceElementModel.y

Methods

containsBound()

containsBound(bounds): boolean

Defined in: packages/affine/model/src/elements/shape/shape.ts:78

Parameters

bounds

Bound

Returns

boolean

Overrides

SurfaceElementModel.containsBound

getLineIntersections()

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

Defined in: packages/affine/model/src/elements/shape/shape.ts:82

Parameters

start

IVec

end

IVec

Returns

null | PointLocation[]

Overrides

SurfaceElementModel.getLineIntersections

getNearestPoint()

getNearestPoint(point): IVec

Defined in: packages/affine/model/src/elements/shape/shape.ts:86

Parameters

point

IVec

Returns

IVec

Overrides

SurfaceElementModel.getNearestPoint

getRelativePointLocation()

getRelativePointLocation(point): PointLocation

Defined in: packages/affine/model/src/elements/shape/shape.ts:90

Parameters

point

IVec

Returns

PointLocation

Overrides

SurfaceElementModel.getRelativePointLocation

includesPoint()

includesPoint(x, y, options): boolean

Defined in: packages/affine/model/src/elements/shape/shape.ts:94

Parameters

x

number

y

number

options

PointTestOptions

Returns

boolean

Overrides

SurfaceElementModel.includesPoint

intersectsBound()

intersectsBound(bound): boolean

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

Parameters

bound

Bound

Returns

boolean

Inherited from

SurfaceElementModel.intersectsBound

isLocked()

isLocked(): boolean

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

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

Returns

boolean

Inherited from

SurfaceElementModel.isLocked

isLockedByAncestor()

isLockedByAncestor(): boolean

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

Returns

boolean

Inherited from

SurfaceElementModel.isLockedByAncestor

isLockedBySelf()

isLockedBySelf(): boolean

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

Returns

boolean

Inherited from

SurfaceElementModel.isLockedBySelf

lock()

lock(): void

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

Returns

void

Inherited from

SurfaceElementModel.lock

onCreated()

onCreated(): void

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

Returns

void

Inherited from

SurfaceElementModel.onCreated

onDestroyed()

onDestroyed(): void

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:88

Returns

void

Inherited from

SurfaceElementModel.onDestroyed

pop()

pop(prop): void

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

Parameters

prop

string

Returns

void

Inherited from

SurfaceElementModel.pop

serialize()

serialize(): SerializedElement

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

Returns

SerializedElement

Inherited from

SurfaceElementModel.serialize

stash()

stash(prop): void

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

Parameters

prop

string

Returns

void

Inherited from

SurfaceElementModel.stash

unlock()

unlock(): void

Defined in: packages/framework/block-std/dist/gfx/model/surface/element-model.d.ts:92

Returns

void

Inherited from

SurfaceElementModel.unlock

propsToY()

static propsToY(props): ShapeProps

Defined in: packages/affine/model/src/elements/shape/shape.ts:70

Parameters

props

ShapeProps

Returns

ShapeProps

Class: ShapeElementModel ​

Extends ​

Constructors ​

new ShapeElementModel() ​

Parameters ​

options ​

id ​

model ​

onChange ​

stashedStore ​

yMap ​

Returns ​

Inherited from ​

Properties ​

_disposable ​

Inherited from ​

_id ​

Inherited from ​

_local ​

Inherited from ​

_onChange() ​

Parameters ​

payload ​

local ​

oldValues ​

props ​

Returns ​

Inherited from ​

_preserved ​

Inherited from ​

_stashed ​

Inherited from ​

propsUpdated ​

Inherited from ​

surface ​

Inherited from ​

textBound ​

yMap ​

Inherited from ​

Accessors ​

color ​

connectable ​

Get Signature ​

Returns ​

Inherited from ​

deserializedXYWH ​

Get Signature ​

Returns ​

Inherited from ​

display ​

Inherited from ​

elementBound ​

Get Signature ​

Returns ​

Inherited from ​

externalBound ​

Get Signature ​

Returns ​

Inherited from ​

externalXYWH ​

Inherited from ​

fillColor ​

filled ​

fontFamily ​

fontSize ​

fontStyle ​

fontWeight ​

group ​

Get Signature ​

Returns ​

Inherited from ​

groups ​

Get Signature ​

Returns ​

Inherited from ​

h ​

Get Signature ​

Returns ​

Inherited from ​

hidden ​

Class: ShapeElementModel

Extends

Constructors

new ShapeElementModel()

Parameters

options

id

model

onChange

stashedStore

yMap

Returns

Inherited from

Properties

_disposable

Inherited from

_id

Inherited from

_local

Inherited from

_onChange()

Parameters

payload

local

oldValues

props

Returns

Inherited from

_preserved

Inherited from

_stashed

Inherited from

propsUpdated

Inherited from

surface

Inherited from

textBound

yMap

Inherited from

Accessors

color

connectable

Get Signature

Returns

Inherited from

deserializedXYWH

Get Signature

Returns

Inherited from

display

Inherited from

elementBound

Get Signature

Returns

Inherited from

externalBound

Get Signature

Returns

Inherited from

externalXYWH

Inherited from

fillColor

filled

fontFamily

fontSize

fontStyle

fontWeight

group

Get Signature

Returns

Inherited from

groups

Get Signature

Returns

Inherited from

h

Get Signature

Returns

Inherited from

hidden