BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/blocks / ConnectorElementModel

Class: ConnectorElementModel ​

Extends ​

Constructors ​

new ConnectorElementModel(options) ​

new ConnectorElementModel(options): ConnectorElementModel

Parameters ​

• options

• options.model: SurfaceBlockModel

• options.onChange

• options.stashedStore: Map<unknown, unknown>

• options.yMap: Map<unknown>

Returns ​

ConnectorElementModel

Inherited from ​

ElementModel.constructor

Source ​

packages/blocks/src/surface-block/element-model/base.ts:113

Properties ​

_disposable ​

protected _disposable: DisposableGroup

Inherited from ​

ElementModel._disposable

Source ​

packages/blocks/src/surface-block/element-model/base.ts:72

_local ​

protected _local: Map<string | symbol, unknown>

Inherited from ​

ElementModel._local

Source ​

packages/blocks/src/surface-block/element-model/base.ts:67

_onChange ​

protected _onChange: (payload) => void

Parameters ​

• payload

• payload.oldValues: Record<string, unknown>

• payload.props: Record<string, unknown>

Returns ​

void

Inherited from ​

ElementModel._onChange

Source ​

packages/blocks/src/surface-block/element-model/base.ts:68

_preserved ​

protected _preserved: Map<string, unknown>

When the ymap is not connected to the doc, its value cannot be read. But we need to use those value during the creation, so the yfied decorated field's value will be stored in this map too during the creation.

After the ymap is connected to the doc, this map will be cleared.

Inherited from ​

ElementModel._preserved

Source ​

packages/blocks/src/surface-block/element-model/base.ts:65

_stashed ​

protected _stashed: Map<string, unknown>

Inherited from ​

ElementModel._stashed

Source ​

packages/blocks/src/surface-block/element-model/base.ts:66

absolutePath ​

absolutePath: PointLocation[] = []

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:67

display ​

display: boolean = true

Inherited from ​

ElementModel.display

Source ​

packages/blocks/src/surface-block/element-model/base.ts:90

externalXYWH ​

externalXYWH: undefined | `[${number},${number},${number},${number}]` = undefined

Inherited from ​

ElementModel.externalXYWH

Source ​

packages/blocks/src/surface-block/element-model/base.ts:99

frontEndpointStyle ​

frontEndpointStyle: PointStyle

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:104

index ​

index: string

Inherited from ​

ElementModel.index

Source ​

packages/blocks/src/surface-block/element-model/base.ts:84

mode ​

mode: ConnectorMode = ConnectorMode.Orthogonal

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:76

opacity ​

opacity: number = 1

Inherited from ​

ElementModel.opacity

Source ​

packages/blocks/src/surface-block/element-model/base.ts:93

path ​

path: PointLocation[] = []

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:64

rearEndpointStyle ​

rearEndpointStyle: PointStyle

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:107

rotate ​

rotate: number = 0

Overrides ​

ElementModel.rotate

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:73

rough? ​

optional rough: boolean

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:91

roughness ​

roughness: number = DEFAULT_ROUGHNESS

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:88

seed ​

seed: number

Inherited from ​

ElementModel.seed

Source ​

packages/blocks/src/surface-block/element-model/base.ts:87

source ​

source: Connection

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:94

stroke ​

stroke: string = '#000000'

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:82

strokeStyle ​

strokeStyle: StrokeStyle = 'solid'

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:85

strokeWidth ​

strokeWidth: number = 4

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:79

surface ​

surface: SurfaceBlockModel

Inherited from ​

ElementModel.surface

Source ​

packages/blocks/src/surface-block/element-model/base.ts:75

target ​

target: Connection

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:99

updatingPath ​

updatingPath: boolean = false

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:45

xywh ​

xywh: `[${number},${number},${number},${number}]` = '[0,0,0,0]'

Overrides ​

ElementModel.xywh

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:70

yMap ​

yMap: Map<unknown>

Inherited from ​

ElementModel.yMap

Source ​

packages/blocks/src/surface-block/element-model/base.ts:74

Accessors ​

connectable ​

get connectable(): false

Returns ​

false

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:52

deserializedXYWH ​

get deserializedXYWH(): XYWH

Returns ​

XYWH

Source ​

packages/blocks/src/surface-block/element-model/base.ts:141

elementBound ​

get elementBound(): Bound

Returns ​

Bound

Source ​

packages/blocks/src/surface-block/element-model/base.ts:179

externalBound ​

get externalBound(): null | Bound

Returns ​

null | Bound

Source ​

packages/blocks/src/surface-block/element-model/base.ts:101

group ​

get group(): null | GroupElementModel

Returns ​

null | GroupElementModel

Source ​

packages/blocks/src/surface-block/element-model/base.ts:167

groups ​

get groups(): GroupElementModel[]

Returns ​

GroupElementModel[]

Source ​

packages/blocks/src/surface-block/element-model/base.ts:171

h ​

get h(): number

Returns ​

number

Source ​

packages/blocks/src/surface-block/element-model/base.ts:163

id ​

get id(): string

Returns ​

string

Source ​

packages/blocks/src/surface-block/element-model/base.ts:175

type ​

get type(): string

Returns ​

string

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:47

w ​

get w(): number

Returns ​

number

Source ​

packages/blocks/src/surface-block/element-model/base.ts:159

x ​

get x(): number

Returns ​

number

Source ​

packages/blocks/src/surface-block/element-model/base.ts:151

y ​

get y(): number

Returns ​

number

Source ​

packages/blocks/src/surface-block/element-model/base.ts:155

Methods ​

boxSelect() ​

boxSelect(bound): boolean

Parameters ​

• bound: Bound

Returns ​

boolean

Inherited from ​

ElementModel.boxSelect

Source ​

packages/blocks/src/surface-block/element-model/base.ts:275

containedByBounds() ​

containedByBounds(bounds): boolean

Parameters ​

• bounds: Bound

Returns ​

boolean

Overrides ​

ElementModel.containedByBounds

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:142

getNearestPoint() ​

getNearestPoint(point): IVec2

Parameters ​

• point: IVec2

Returns ​

IVec2

Overrides ​

ElementModel.getNearestPoint

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:146

getRelativePointLocation() ​

getRelativePointLocation(point): PointLocation

Parameters ​

• point: IVec2

Returns ​

PointLocation

Overrides ​

ElementModel.getRelativePointLocation

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:154

hitTest() ​

hitTest(x, y, options?): boolean

Parameters ​

• x: number

• y: number

• options?: HitTestOptions

Returns ​

boolean

Overrides ​

ElementModel.hitTest

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:127

intersectWithLine() ​

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

Parameters ​

• start: IVec2

• end: IVec2

Returns ​

null | PointLocation[]

Overrides ​

ElementModel.intersectWithLine

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:150

moveTo() ​

moveTo(bound): void

Parameters ​

• bound: Bound

Returns ​

void

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:109

pop() ​

pop(prop): void

Parameters ​

• prop: string

Returns ​

void

Inherited from ​

ElementModel.pop

Source ​

packages/blocks/src/surface-block/element-model/base.ts:226

serialize() ​

serialize(): Object

Returns ​

Object

Overrides ​

ElementModel.serialize

Source ​

packages/blocks/src/surface-block/element-model/connector.ts:160

stash() ​

stash(prop): void

Parameters ​

• prop: string

Returns ​

void

Inherited from ​

ElementModel.stash

Source ​

packages/blocks/src/surface-block/element-model/base.ts:187

propsToY() ​

static propsToY(props): Record<string, unknown>

Parameters ​

• props: Record<string, unknown>

Returns ​

Record<string, unknown>

Inherited from ​

ElementModel.propsToY

Source ​

packages/blocks/src/surface-block/element-model/base.ts:54

Copyright © 2022-present Toeverything