Skip to content

BlockSuite API Documentation / @blocksuite/blocks / ConnectorElementModel

Class: ConnectorElementModel

Extends

Constructors

new ConnectorElementModel()

new ConnectorElementModel(options): ConnectorElementModel

Parameters

options

options.id: string

options.model: SurfaceBlockModel

options.onChange

options.stashedStore: Map<unknown, unknown>

options.yMap: YMap<unknown>

Returns

ConnectorElementModel

Inherited from

SurfaceElementModel.constructor

Defined in

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

Properties

_disposable

protected _disposable: DisposableGroup

Inherited from

SurfaceElementModel._disposable

Defined in

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


_id

protected _id: string

Inherited from

SurfaceElementModel._id

Defined in

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


_local

protected _local: Map<string | symbol, unknown>

Inherited from

SurfaceElementModel._local

Defined in

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


_onChange()

protected _onChange: (payload) => void

Parameters

payload

payload.local: boolean

payload.oldValues: Record<string, unknown>

payload.props: Record<string, unknown>

Returns

void

Inherited from

SurfaceElementModel._onChange

Defined in

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


_preserved

protected _preserved: Map<string, unknown>

Used to store a copy of data in the yMap.

Inherited from

SurfaceElementModel._preserved

Defined in

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


_stashed

protected _stashed: Map<string, unknown>

Inherited from

SurfaceElementModel._stashed

Defined in

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


surface

surface: SurfaceBlockModel

Inherited from

SurfaceElementModel.surface

Defined in

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


updatingPath

updatingPath: boolean

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:50


yMap

yMap: YMap<unknown>

Inherited from

SurfaceElementModel.yMap

Defined in

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

Accessors

absolutePath

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:86


connectable

get connectable(): false

Returns

false

Overrides

SurfaceElementModel.connectable

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:51


connected

get connected(): boolean

Returns

boolean

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:52


container

get container(): null | GfxModel & GfxContainerElement

Returns

null | GfxModel & GfxContainerElement

Inherited from

SurfaceElementModel.container

Defined in

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


deserializedXYWH

get deserializedXYWH(): XYWH

Returns

XYWH

Inherited from

SurfaceElementModel.deserializedXYWH

Defined in

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


display

Inherited from

SurfaceElementModel.display

Defined in

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


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

Overrides

SurfaceElementModel.elementBound

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:53


externalBound

get externalBound(): null | Bound

Returns

null | Bound

Inherited from

SurfaceElementModel.externalBound

Defined in

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


externalXYWH

Inherited from

SurfaceElementModel.externalXYWH

Defined in

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


frontEndpointStyle

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:87


group

get group(): null | SurfaceGroupLikeModel<BaseElementProps>

Returns

null | SurfaceGroupLikeModel<BaseElementProps>

Inherited from

SurfaceElementModel.group

Defined in

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


groups

get groups(): SurfaceGroupLikeModel<BaseElementProps>[]

Returns

SurfaceGroupLikeModel<BaseElementProps>[]

Inherited from

SurfaceElementModel.groups

Defined in

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


h

get h(): number

Returns

number

Inherited from

SurfaceElementModel.h

Defined in

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


id

get id(): string

Returns

string

Inherited from

SurfaceElementModel.id

Defined in

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


index

Inherited from

SurfaceElementModel.index

Defined in

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


isConnected

get isConnected(): boolean

Returns

boolean

Inherited from

SurfaceElementModel.isConnected

Defined in

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


labelConstraints

Defines the size constraints of the label.

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:91


labelDisplay

Control display and hide.

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:95


labelOffset

The offset property specifies the label along the connector path.

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:99


labelStyle

Defines the style of the label.

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:103


labelXYWH

Returns a XYWH array providing information about the size of a label and its position relative to the viewport.

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:108


lableEditing

Local control display and hide, mainly used in editing scenarios.

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:112


mode

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:113


opacity

Inherited from

SurfaceElementModel.opacity

Defined in

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


path

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:114


rearEndpointStyle

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:115


rotate

Overrides

SurfaceElementModel.rotate

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:116


rough

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:117


roughness

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:118


seed

Inherited from

SurfaceElementModel.seed

Defined in

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


source

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:119


stroke

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:120


strokeStyle

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:121


strokeWidth

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:122


target

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:123


text

The content of the label.

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:127


type

get type(): string

Returns

string

Overrides

SurfaceElementModel.type

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:54


w

get w(): number

Returns

number

Inherited from

SurfaceElementModel.w

Defined in

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


x

get x(): number

Returns

number

Inherited from

SurfaceElementModel.x

Defined in

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


xywh

Overrides

SurfaceElementModel.xywh

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:128


y

get y(): number

Returns

number

Inherited from

SurfaceElementModel.y

Defined in

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

Methods

containsBound()

containsBound(bounds): boolean

Parameters

bounds: Bound

Returns

boolean

Overrides

SurfaceElementModel.containsBound

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:56


getLineIntersections()

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

Parameters

start: IVec

end: IVec

Returns

null | PointLocation[]

Overrides

SurfaceElementModel.getLineIntersections

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:57


getNearestPoint()

getNearestPoint(point): IVec

Calculate the closest point on the curve via a point.

Parameters

point: IVec

Returns

IVec

Overrides

SurfaceElementModel.getNearestPoint

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:61


getOffsetDistanceByPoint()

getOffsetDistanceByPoint(point, bounds?): number

Calculating the computed distance along a path via a point.

The point is relative to the viewport.

Parameters

point: IVec

bounds?: Bound

Returns

number

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:67


getPointByOffsetDistance()

getPointByOffsetDistance(offsetDistance?, bounds?): IVec

Calculating the computed point along a path via a offset distance.

Returns a point relative to the viewport.

Parameters

offsetDistance?: number

bounds?: Bound

Returns

IVec

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:73


getRelativePointLocation()

getRelativePointLocation(point): PointLocation

Parameters

point: IVec

Returns

PointLocation

Overrides

SurfaceElementModel.getRelativePointLocation

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:74


hasLabel()

hasLabel(): boolean

Returns

boolean

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:75


includesPoint()

includesPoint(x, y, options?): boolean

Parameters

x: number

y: number

options?: PointTestOptions

Returns

boolean

Overrides

SurfaceElementModel.includesPoint

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:76


intersectsBound()

intersectsBound(bound): boolean

Parameters

bound: Bound

Returns

boolean

Inherited from

SurfaceElementModel.intersectsBound

Defined in

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


labelIncludesPoint()

labelIncludesPoint(point): boolean

Parameters

point: IVec

Returns

boolean

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:77


moveTo()

moveTo(bound): void

Parameters

bound: Bound

Returns

void

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:78


onCreated()

onCreated(): void

Returns

void

Inherited from

SurfaceElementModel.onCreated

Defined in

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


pop()

pop(prop): void

Parameters

prop: string

Returns

void

Inherited from

SurfaceElementModel.pop

Defined in

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


resize()

resize(bounds, originalPath, matrix): object

Parameters

bounds: Bound

originalPath: PointLocation[]

matrix: DOMMatrix

Returns

object

labelXYWH?

optional labelXYWH: XYWH

source?

optional source: Connection

target?

optional target: Connection

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:79


resizePath()

resizePath(originalPath, matrix): PointLocation[]

Parameters

originalPath: PointLocation[]

matrix: DOMMatrix

Returns

PointLocation[]

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:84


serialize()

serialize(): SerializedConnectorElement

Returns

SerializedConnectorElement

Overrides

SurfaceElementModel.serialize

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:85


stash()

stash(prop): void

Parameters

prop: string

Returns

void

Inherited from

SurfaceElementModel.stash

Defined in

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


propsToY()

static propsToY(props): ConnectorElementProps

Parameters

props: ConnectorElementProps

Returns

ConnectorElementProps

Overrides

SurfaceElementModel.propsToY

Defined in

packages/affine/model/dist/elements/connector/connector.d.ts:55