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

Class: LocalShapeElementModel

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

Extends

GfxLocalElementModel

Constructors

new LocalShapeElementModel()

new LocalShapeElementModel(surfaceModel): LocalShapeElementModel

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

Parameters

surfaceModel

SurfaceBlockModel

Returns

LocalShapeElementModel

Inherited from

GfxLocalElementModel.constructor

Properties

_local

protected _local: Map<string | symbol, unknown>

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

Inherited from

GfxLocalElementModel._local

_props

protected _props: Set<string | symbol>

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

Used to store all the name of the properties that have been decorated with the @prop

Inherited from

GfxLocalElementModel._props

_surface

protected _surface: SurfaceBlockModel

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

Inherited from

GfxLocalElementModel._surface

cache

cache: Map<string | symbol, unknown>

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

used to store the properties' cache key when the properties required heavy computation

Inherited from

GfxLocalElementModel.cache

id

id: string

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

Inherited from

GfxLocalElementModel.id

roughness

roughness: number = DEFAULT_ROUGHNESS

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

textBound

textBound: null | Bound = null

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

textDisplay

textDisplay: boolean = true

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

Accessors

color

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

deserializedXYWH

Get Signature

get deserializedXYWH(): XYWH

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

Returns

XYWH

Inherited from

GfxLocalElementModel.deserializedXYWH

elementBound

Get Signature

get elementBound(): Bound

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

The bound of the element without considering the response extension.

Returns

Bound

Inherited from

GfxLocalElementModel.elementBound

fillColor

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

filled

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

fontFamily

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

fontStyle

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

fontWeight

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

group

Get Signature

get group(): null | GfxGroupModel

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

Returns

null | GfxGroupModel

Inherited from

GfxLocalElementModel.group

groupId

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

Inherited from

GfxLocalElementModel.groupId

groups

Get Signature

get groups(): GfxGroupModel[]

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

Returns

GfxGroupModel[]

Inherited from

GfxLocalElementModel.groups

h

Get Signature

get h(): number

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

Returns

number

Inherited from

GfxLocalElementModel.h

hidden

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

Inherited from

GfxLocalElementModel.hidden

index

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

Inherited from

GfxLocalElementModel.index

opacity

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

Inherited from

GfxLocalElementModel.opacity

padding

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

radius

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

responseBound

Get Signature

get responseBound(): Bound

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

The bound of the element considering the response extension.

Returns

Bound

Inherited from

GfxLocalElementModel.responseBound

responseExtension

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

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

GfxLocalElementModel.responseExtension

rotate

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

Inherited from

GfxLocalElementModel.rotate

seed

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

Inherited from

GfxLocalElementModel.seed

shadow

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

shapeStyle

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

shapeType

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

strokeColor

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

strokeStyle

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

strokeWidth

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

surface

Get Signature

get surface(): SurfaceBlockModel

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

Returns

SurfaceBlockModel

Inherited from

GfxLocalElementModel.surface

text

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

textAlign

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

textVerticalAlign

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

type

Get Signature

get type(): string

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

Returns

string

Overrides

GfxLocalElementModel.type

w

Get Signature

get w(): number

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

Returns

number

Inherited from

GfxLocalElementModel.w

x

Get Signature

get x(): number

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

Returns

number

Inherited from

GfxLocalElementModel.x

xywh

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

Inherited from

GfxLocalElementModel.xywh

y

Get Signature

get y(): number

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

Returns

number

Inherited from

GfxLocalElementModel.y

Methods

containsBound()

containsBound(bounds): boolean

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

Parameters

bounds

Bound

Returns

boolean

Inherited from

GfxLocalElementModel.containsBound

getLineIntersections()

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

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

Parameters

start

IVec

end

IVec

Returns

null | PointLocation[]

Inherited from

GfxLocalElementModel.getLineIntersections

getNearestPoint()

getNearestPoint(point): IVec

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

Parameters

point

IVec

Returns

IVec

Inherited from

GfxLocalElementModel.getNearestPoint

getRelativePointLocation()

getRelativePointLocation(relativePoint): PointLocation

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

Parameters

relativePoint

IVec

Returns

PointLocation

Inherited from

GfxLocalElementModel.getRelativePointLocation

includesPoint()

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

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

Parameters

x

number

y

number

opt

PointTestOptions

__

EditorHost

Returns

boolean

Inherited from

GfxLocalElementModel.includesPoint

intersectsBound()

intersectsBound(bound): boolean

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

Parameters

bound

Bound

Returns

boolean

Inherited from

GfxLocalElementModel.intersectsBound

isLocked()

isLocked(): boolean

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

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

Returns

boolean

Inherited from

GfxLocalElementModel.isLocked

isLockedByAncestor()

isLockedByAncestor(): boolean

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

Returns

boolean

Inherited from

GfxLocalElementModel.isLockedByAncestor

isLockedBySelf()

isLockedBySelf(): boolean

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

Returns

boolean

Inherited from

GfxLocalElementModel.isLockedBySelf

lock()

lock(): void

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

Returns

void

Inherited from

GfxLocalElementModel.lock

unlock()

unlock(): void

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

Returns

void

Inherited from

GfxLocalElementModel.unlock

Class: LocalShapeElementModel ​

Extends ​

Constructors ​

new LocalShapeElementModel() ​

Parameters ​

surfaceModel ​

Returns ​

Inherited from ​

Properties ​

_local ​

Inherited from ​

_props ​

Inherited from ​

_surface ​

Inherited from ​

cache ​

Inherited from ​

id ​

Inherited from ​

roughness ​

textBound ​

textDisplay ​

Accessors ​

color ​

deserializedXYWH ​

Get Signature ​

Returns ​

Inherited from ​

elementBound ​

Get Signature ​

Returns ​

Inherited from ​

fillColor ​

filled ​

fontFamily ​

fontSize ​

fontStyle ​

fontWeight ​

group ​

Get Signature ​

Returns ​

Inherited from ​

groupId ​

Inherited from ​

groups ​

Get Signature ​

Returns ​

Inherited from ​

h ​

Get Signature ​

Returns ​

Inherited from ​

hidden ​

Inherited from ​

index ​

Inherited from ​

opacity ​

Inherited from ​

padding ​

radius ​

responseBound ​

Get Signature ​

Returns ​

Inherited from ​

responseExtension ​

Inherited from ​

rotate ​

Inherited from ​

seed ​

Inherited from ​

shadow ​

shapeStyle ​

shapeType ​

strokeColor ​

strokeStyle ​

strokeWidth ​

surface ​

Get Signature ​

Returns ​

Inherited from ​

Class: LocalShapeElementModel

Extends

Constructors

new LocalShapeElementModel()

Parameters

surfaceModel

Returns

Inherited from

Properties

_local

Inherited from

_props

Inherited from

_surface

Inherited from

cache

Inherited from

id

Inherited from

roughness

textBound

textDisplay

Accessors

color

deserializedXYWH

Get Signature

Returns

Inherited from

elementBound

Get Signature

Returns

Inherited from

fillColor

filled

fontFamily

fontSize

fontStyle

fontWeight

group

Get Signature

Returns

Inherited from

groupId

Inherited from

groups

Get Signature

Returns

Inherited from

h

Get Signature

Returns

Inherited from

hidden

Inherited from

index

Inherited from

opacity

Inherited from

padding

radius

responseBound

Get Signature

Returns

Inherited from

responseExtension

Inherited from

rotate

Inherited from

seed

Inherited from

shadow

shapeStyle

shapeType

strokeColor

strokeStyle

strokeWidth

surface

Get Signature

Returns

Inherited from