BlockSuite

Appearance

BlockSuite API Documentation / @blocksuite/blocks / ConnectorElement

Class: ConnectorElement ​

Contents ​

Extends ​

Constructors ​

new ConnectorElement(yMap, options, data) ​

new ConnectorElement(yMap, options, data): ConnectorElement

Parameters ​

• yMap: Map<unknown>

• options: Object

• options.getGroupParent: (element) => GroupElement

• options.getLocalRecord: (id) => undefined | CanvasElementLocalRecordValues

• options.onElementUpdated: (update) => void

• options.pickById: (id) => null | EdgelessElement

• options.removeElement: (id) => void

• options.selectionManager?: EdgelessSelectionManager

• options.setGroupParent: (element, group) => void

• options.updateElementLocalRecord: (id, record) => void

• data: Partial<IConnector>= {}

Returns ​

ConnectorElement

Inherited from ​

SurfaceElement<IConnector>.constructor

Source ​

packages/blocks/src/surface-block/elements/surface-element.ts:95

Properties ​

_connectable ​

protected _connectable: boolean = false

Overrides ​

SurfaceElement._connectable

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:36

_path ​

private _path: PointLocation[] = []

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:34

_xywh ​

private _xywh: `[${number},${number},${number},${number}]`

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:35

computedValue ​

computedValue: ComputedValue

Inherited from ​

SurfaceElement.computedValue

Source ​

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

options ​

protected options: Object

Type declaration ​

getGroupParent ​

getGroupParent: (element) => GroupElement

Parameters ​

• element: string | EdgelessElement

Returns ​

GroupElement

getLocalRecord ​

getLocalRecord: (id) => undefined | CanvasElementLocalRecordValues

Parameters ​

• id: string

Returns ​

undefined | CanvasElementLocalRecordValues

onElementUpdated ​

onElementUpdated: (update) => void

Parameters ​

• update: Object

• update.id: string

• update.props: Record<string, unknown>

Returns ​

void

pickById ​

pickById: (id) => null | EdgelessElement

Parameters ​

• id: string

Returns ​

null | EdgelessElement

removeElement ​

removeElement: (id) => void

Parameters ​

• id: string

Returns ​

void

selectionManager? ​

selectionManager?: EdgelessSelectionManager

setGroupParent ​

setGroupParent: (element, group) => void

Parameters ​

• element: string

• group: GroupElement

Returns ​

void

updateElementLocalRecord ​

updateElementLocalRecord: (id, record) => void

Parameters ​

• id: string

• record: Record<string, unknown>

Returns ​

void

Inherited from ​

SurfaceElement.options

Source ​

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

renderer ​

protected renderer: null | Renderer = null

Inherited from ​

SurfaceElement.renderer

Source ​

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

yMap ​

yMap: Map<unknown>

Inherited from ​

SurfaceElement.yMap

Source ​

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

Accessors ​

absolutePath ​

get absolutePath(): PointLocation[]

Returns ​

PointLocation[]

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:111

batch ​

get batch(): null | NonNullable<T["batch"]>

Returns ​

null | NonNullable<T["batch"]>

Source ​

packages/blocks/src/surface-block/elements/surface-element.ts:144

bezierParameters ​

get bezierParameters(): BezierCurveParameters

Returns ​

BezierCurveParameters

Source ​

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

connectable ​

get connectable(): boolean

Returns ​

boolean

Source ​

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

controllers ​

get controllers(): Controller[]

Returns ​

Controller[]

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:92

elementBound ​

get elementBound(): Bound

Returns ​

Bound

Source ​

packages/blocks/src/surface-block/elements/surface-element.ts:148

frontEndpointStyle ​

get frontEndpointStyle(): ConnectorEndpointStyle

Returns ​

ConnectorEndpointStyle

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:96

h ​

get h(): number

Returns ​

number

Source ​

packages/blocks/src/surface-block/elements/surface-element.ts:170

id ​

get id(): T["id"]

Returns ​

T["id"]

Source ​

packages/blocks/src/surface-block/elements/surface-element.ts:114

index ​

get index(): T["index"]

Returns ​

T["index"]

Source ​

packages/blocks/src/surface-block/elements/surface-element.ts:119

localRecord ​

get localRecord(): undefined | CanvasElementLocalRecordValues

Returns ​

undefined | CanvasElementLocalRecordValues

Source ​

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

mode ​

get mode(): ConnectorMode

Returns ​

ConnectorMode

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:57

path ​

get path(): PointLocation[]

set path(p): void

Parameters ​

• p: PointLocation[]

Returns ​

PointLocation[]

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:39

rearEndpointStyle ​

get rearEndpointStyle(): ConnectorEndpointStyle

Returns ​

ConnectorEndpointStyle

Source ​

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

rotate ​

get rotate(): T["rotate"]

Returns ​

T["rotate"]

Source ​

packages/blocks/src/surface-block/elements/surface-element.ts:139

rough ​

get rough(): boolean

Returns ​

boolean

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:80

roughness ​

get roughness(): number

Returns ​

number

Source ​

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

seed ​

get seed(): T["seed"]

Returns ​

T["seed"]

Source ​

packages/blocks/src/surface-block/elements/surface-element.ts:134

source ​

get source(): Connection

Returns ​

Connection

Source ​

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

stroke ​

get stroke(): string

Returns ​

string

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:65

strokeStyle ​

get strokeStyle(): StrokeStyle

Returns ​

StrokeStyle

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:69

strokeWidth ​

get strokeWidth(): number

Returns ​

number

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:61

target ​

get target(): Connection

Returns ​

Connection

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:84

type ​

get type(): T["type"]

Returns ​

T["type"]

Source ​

packages/blocks/src/surface-block/elements/surface-element.ts:124

w ​

get w(): number

Returns ​

number

Source ​

packages/blocks/src/surface-block/elements/surface-element.ts:165

x ​

get x(): number

Returns ​

number

Source ​

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

xywh ​

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

set xywh(xywh): void

Parameters ​

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

Returns ​

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

Source ​

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

y ​

get y(): number

Returns ​

number

Source ​

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

Methods ​

_getArrowOptions() ​

private _getArrowOptions(end): ArrowOptions

Parameters ​

• end: ConnectorEndpoint

Returns ​

ArrowOptions

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:260

_renderEndpoint() ​

private _renderEndpoint(location, ctx, rc, end, style): void

Parameters ​

• location: PointLocation[]

• ctx: CanvasRenderingContext2D

• rc: RoughCanvas

• end: ConnectorEndpoint

• style: ConnectorEndpointStyle

Returns ​

void

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:277

_renderPoints() ​

private _renderPoints(ctx, rc, points, dash, curve): void

Parameters ​

• ctx: CanvasRenderingContext2D

• rc: RoughCanvas

• points: PointLocation[]

• dash: boolean

• curve: boolean

Returns ​

void

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:195

applyUpdate() ​

applyUpdate(updates): void

Parameters ​

• updates: Partial<IConnector>

Returns ​

void

Inherited from ​

SurfaceElement.applyUpdate

Source ​

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

boxSelect() ​

boxSelect(bound): boolean

Parameters ​

• bound: Bound

Returns ​

boolean

Inherited from ​

SurfaceElement.boxSelect

Source ​

packages/blocks/src/surface-block/elements/surface-element.ts:63

containedByBounds() ​

containedByBounds(bounds): boolean

Parameters ​

• bounds: Bound

Returns ​

boolean

Overrides ​

SurfaceElement.containedByBounds

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:130

deserializeXYWH() ​

deserializeXYWH(): XYWH

Returns ​

XYWH

Inherited from ​

SurfaceElement.deserializeXYWH

Source ​

packages/blocks/src/surface-block/elements/surface-element.ts:193

getLocalRecord() ​

getLocalRecord(): ISurfaceElementLocalRecord

Returns ​

ISurfaceElementLocalRecord

Inherited from ​

SurfaceElement.getLocalRecord

Source ​

packages/blocks/src/surface-block/elements/surface-element.ts:183

getNearestPoint() ​

getNearestPoint(point): IVec

Parameters ​

• point: IVec

Returns ​

IVec

Overrides ​

SurfaceElement.getNearestPoint

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:134

getRelativePointLocation() ​

getRelativePointLocation(point): PointLocation

Parameters ​

• point: IVec

Returns ​

PointLocation

Overrides ​

SurfaceElement.getRelativePointLocation

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:301

hitTest() ​

hitTest(x, y, options?): boolean

Parameters ​

• x: number

• y: number

• options?: HitTestOptions

Returns ​

boolean

Overrides ​

SurfaceElement.hitTest

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:116

init() ​

init(): void

Returns ​

void

Inherited from ​

SurfaceElement.init

Source ​

packages/blocks/src/surface-block/elements/surface-element.ts:112

intersectWithLine() ​

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

Parameters ​

• start: IVec

• end: IVec

Returns ​

null | PointLocation[]

Overrides ​

SurfaceElement.intersectWithLine

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:138

mount() ​

mount(renderer): void

Parameters ​

• renderer: Renderer

Returns ​

void

Inherited from ​

SurfaceElement.mount

Source ​

packages/blocks/src/surface-block/elements/surface-element.ts:219

render() ​

render(ctx, matrix, rc): void

Parameters ​

• ctx: CanvasRenderingContext2D

• matrix: DOMMatrix

• rc: RoughCanvas

Returns ​

void

Overrides ​

SurfaceElement.render

Source ​

packages/blocks/src/surface-block/elements/connector/connector-element.ts:147

serialize() ​

serialize(): IConnector

Returns ​

IConnector

Inherited from ​

SurfaceElement.serialize

Source ​

packages/blocks/src/surface-block/elements/surface-element.ts:197

unmount() ​

unmount(): void

Returns ​

void

Inherited from ​

SurfaceElement.unmount

Source ​

packages/blocks/src/surface-block/elements/surface-element.ts:225

Generated using typedoc-plugin-markdown and TypeDoc

Copyright © 2022-present Toeverything