Class Link

Базовый класс, от которого все наследуются.

Стабильный ID типа для сериализации (className в JSON) и ключа в elementsLib — static readonly typeName. Не зависит от минификации. Объявляйте на каждом конкретном cell-классе; на GraphicElement значение не задаётся. При наследовании обязательно переопределите — иначе assertCellTypeName выбросит ошибку. См. ../../guide/typeName и сериализация cell-классов.md.

Hierarchy (View Summary)

BaseLinear
- Link
  - LineParametric
  - Connector

Index

Constructors

constructor

Constructors

constructor

new Link(options?: LinkOptions, testBboxStyle?: TestBboxStyle): Link
Parameters
- options: LinkOptions = {}
- OptionaltestBboxStyle: TestBboxStyle
Returns Link
Overrides BaseLinear.constructor
- Defined in entities/cell/Link.ts:205

Properties

_activeLabelIndex

_activeLabelIndex: number = 0

_angle

_angle: number = 0

угол в градусах

_height

_height: number = 1

Высота

`Protected`_isBlocked

_isBlocked: boolean = false

`Protected`_isPrintable

_isPrintable: boolean = true

`Protected`_isVisible

_isVisible: boolean = true

`Protected`_magnetPoints

_magnetPoints: Point[] = []

_parent

_parent: string | null = null

Родительская ячейка. Может быть только одна. Наличие его означает, что элемент в группе

_position

_position: Point = ...

Позиция всегда верхний левый угол

_radius

_radius: number = 0

_type

_type: LinkType = LinkType.LINE

Тип линии

_width

_width: number = 100

Ширина

allowAddTextLabel

allowAddTextLabel: boolean = true

разрешаем добавление новых label по dblclick.

angleRad

angleRad: number = 0

угол в радианах

arrowSource

arrowSource: ConnectorArrow | null = null

Стрелка в начале коннектора

arrowTarget

arrowTarget: ConnectorArrow | null = null

Стрелка в конце коннектора

bbox

bbox: Rect = ...

bezierParams

bezierParams: BezierParams = []

children

children: GraphicElement[] = []

Дочерние ячейки. Если массив не пуст, значит ячейка является группой

cursorName

cursorName: string = "DRAG_CELL_SVG"

Название курсора, который задан в cursorCollection, который будет показываться при наведении на фигуру. Если пустая строка, будет показан станадартный, указанный в cursorName, если задан, standardCursor нужно выставить 'none'

cursorTrasform

cursorTrasform: string = "translate(-50%, -50%) "

Смещение кастомного курсора

customAttrs

customAttrs: CustomAttrs = ...

Предназначен для расширения атрибутами

dragFantomPosition

dragFantomPosition: Point | null = null

Применяется при драге с привязкой. Сначала изменяется это значение, и если выполняется условие привязки - меняется положение ячейки

drawingScale

drawingScale: number = 1

Масштаб чертежа

drawPaths

drawPaths: DrawPath[] = []

firstPoint

firstPoint: Point = ...

Начальная точка

firstPointFixed

firstPointFixed: boolean = false

firstPointLocal

firstPointLocal: Point = ...

id

id: string

Уникальный идентификатор

isCell

isCell: boolean = true

isTextEditable

isTextEditable: boolean = true

Фигура с таким флагом будет редактироваться в TextEditor

lastPoint

lastPoint: Point = ...

Конечная точка

lastPointFixed

lastPointFixed: boolean = false

lastPointLocal

lastPointLocal: Point = ...

libName

libName: string | null = null

Имя библиотеки, которая породила этот элемент.

lineColor

lineColor: string = "#000000"

Цвет линии

`Protected`magnetPointsPath

magnetPointsPath: Path2D = ...

margins

margins: TextMargins = ...

name

name: string = "Graphic Element"

Имя. Отображается пользователю

points

points: Point[] = []

Точки, по которым строится линия

relativeTextPosition

relativeTextPosition: RelativeTextPosition = ...

Относительное положение текстового поля

scene

scene: Scene2D | null = null

Сцена, которой принадлежит

standardCursor

standardCursor: CursorStandard = "none"

Стандартный курсор, который будет показываться при наведении на фигуру. Если задан cursorName, то нужно выставить в 'none'

strokeWidth

strokeWidth: number = 1

Толщина линии

testBboxStyle

testBboxStyle: TestBboxStyle

textLabels

textLabels: LinkTextLabel[] = []

transform

transform: DOMMatrix = ...

txtHeight

txtHeight: number = 0

txtWidth

txtWidth: number = 0

userData

userData: UserData = []

Для любых данных пользователя

withBbox

withBbox: boolean = false

zIndex

zIndex: number = 0

`Static` `Readonly`typeName

typeName: string = "Link"

Стабильный ID типа для сериализации (className в JSON) и ключа в elementsLib. Не зависит от минификации. При наследовании обязательно переопределите — иначе assertCellTypeName выбросит ошибку при регистрации.

Accessors

absoluteTextPosition

get absoluteTextPosition(): Point | null
Returns Point | null
- Defined in entities/cell/Link.ts:176
set absoluteTextPosition(value: Point | null): void
Parameters
- value: Point | null
Returns void
- Defined in entities/cell/Link.ts:180

angle

get angle(): number
Returns number
Overrides BaseLinear.angle
- Defined in entities/cell/Link.ts:262

annotatedText

get annotatedText(): AnnotatedText[]
Returns AnnotatedText[]
- Defined in entities/cell/Link.ts:141
set annotatedText(value: AnnotatedText[]): void
Parameters
- value: AnnotatedText[]
Returns void
- Defined in entities/cell/Link.ts:145

height

get height(): number
Returns number
Overrides BaseLinear.height
- Defined in entities/cell/Link.ts:258

isBlocked

get isBlocked(): boolean
Returns boolean
Inherited from Clock.isBlocked
- Defined in entities/cell/GraphicElement.ts:208
set isBlocked(isBlocked: boolean): void
Parameters
- isBlocked: boolean
Returns void
Inherited from Clock.isBlocked
- Defined in entities/cell/GraphicElement.ts:204

isBlockedInRender

get isBlockedInRender(): boolean
Returns boolean
Inherited from BaseLinear.isBlockedInRender
- Defined in entities/cell/GraphicElement.ts:212

isPrintable

get isPrintable(): boolean
Returns boolean
Inherited from Clock.isPrintable
- Defined in entities/cell/GraphicElement.ts:225
set isPrintable(isPrintable: boolean): void
Parameters
- isPrintable: boolean
Returns void
Inherited from Clock.isPrintable
- Defined in entities/cell/GraphicElement.ts:221

isVisible

get isVisible(): boolean
Returns boolean
Inherited from Clock.isVisible
- Defined in entities/cell/GraphicElement.ts:191
set isVisible(visible: boolean): void
Parameters
- visible: boolean
Returns void
Inherited from Clock.isVisible
- Defined in entities/cell/GraphicElement.ts:175

lib

get lib(): Library<typeof BaseCell | typeof BaseLinear> | null
Возвращает библиотеку, которая породила этот элемент. Для этого у элемента должен быть задан libName, элемент должен быть в сцене и подключен сервис Stencil

Returns Library<typeof BaseCell | typeof BaseLinear> | null
Inherited from BaseLinear.lib
- Defined in entities/cell/GraphicElement.ts:243

magnetPoints

get magnetPoints(): Point[]
Returns Point[]
Inherited from BaseLinear.magnetPoints
- Defined in entities/cell/BaseLinear.ts:108
set magnetPoints(magnetPoints: Point[]): void
Parameters
- magnetPoints: Point[]
Returns void
Inherited from BaseLinear.magnetPoints
- Defined in entities/cell/BaseLinear.ts:104

parent

get parent(): GraphicElement | null
Returns GraphicElement | null
Inherited from TextShape.parent
- Defined in entities/cell/GraphicElement.ts:179
set parent(elem: GraphicElement | null): void
Parameters
- elem: GraphicElement | null
Returns void
Inherited from TextShape.parent
- Defined in entities/cell/GraphicElement.ts:187

position

get position(): Point
Returns Point
Overrides BaseLinear.position
- Defined in entities/cell/Link.ts:250

radius

get radius(): number
Returns number
- Defined in entities/cell/Link.ts:308
set radius(radius: number): void
Parameters
- radius: number
Returns void
- Defined in entities/cell/Link.ts:303

source

get source(): GraphicElement | null
Returns GraphicElement | null
- Defined in entities/cell/Link.ts:761

target

get target(): GraphicElement | null
Returns GraphicElement | null
- Defined in entities/cell/Link.ts:789

textBbox

get textBbox(): Rect | null
Returns Rect | null
- Defined in entities/cell/Link.ts:152
set textBbox(value: Rect | null): void
Parameters
- value: Rect | null
Returns void
- Defined in entities/cell/Link.ts:156

textLabel

get textLabel(): Label | null
Returns Label | null
- Defined in entities/cell/Link.ts:532
set textLabel(label: Label | null): void
Parameters
- label: Label | null
Returns void
- Defined in entities/cell/Link.ts:508

textPosition

get textPosition(): Point | null
Returns Point | null
- Defined in entities/cell/Link.ts:188
set textPosition(value: Point | null): void
Parameters
- value: Point | null
Returns void
- Defined in entities/cell/Link.ts:192

textTransform

get textTransform(): DOMMatrix
Returns DOMMatrix
- Defined in entities/cell/Link.ts:163
set textTransform(value: DOMMatrix): void
Parameters
- value: DOMMatrix
Returns void
- Defined in entities/cell/Link.ts:169

type

get type(): LinkType
Returns LinkType
- Defined in entities/cell/Link.ts:318
set type(type: LinkType): void
Parameters
- type: LinkType
Returns void
- Defined in entities/cell/Link.ts:312

visibleInRender

get visibleInRender(): boolean
Returns boolean
Inherited from BaseLinear.visibleInRender
- Defined in entities/cell/GraphicElement.ts:195

width

get width(): number
Returns number
Overrides BaseLinear.width
- Defined in entities/cell/Link.ts:254

Methods

addTextLabel

addTextLabel(position: Point): number
Parameters
- position: Point
Returns number
- Defined in entities/cell/Link.ts:651

calcDrawPath

calcDrawPath(): void
Returns void
Overrides BaseLinear.calcDrawPath
- Defined in entities/cell/Link.ts:274

calcMidPoint

calcMidPoint(customPoints?: Point[]): Point
Parameters
- OptionalcustomPoints: Point[]
Returns Point
- Defined in entities/cell/Link.ts:395

clone

clone(): Link
Returns Link
Inherited from BaseLinear.clone
- Defined in entities/cell/GraphicElement.ts:387

containsPoint

containsPoint(
    point: PointLike,
    ctx: CanvasRenderingContext2D,
    drawingScale: number,
    accurately: boolean,
): boolean
Попадает ли точка в фигуру.

Если accurately = false то будет найдено пересечение с повернутым bbox
Parameters
- point: PointLike
- ctx: CanvasRenderingContext2D
- drawingScale: number
- accurately: boolean
Returns boolean
Inherited from BaseLinear.containsPoint
- Defined in entities/cell/BaseLinear.ts:247

dispose

dispose(): void
Returns void
Overrides BaseLinear.dispose
- Defined in entities/cell/Link.ts:924

drawMagnetPoints

drawMagnetPoints(ctx: CanvasRenderingContext2D): void
Parameters
- ctx: CanvasRenderingContext2D
Returns void
Inherited from BaseLinear.drawMagnetPoints
- Defined in entities/cell/GraphicElement.ts:371

drawTexts

drawTexts(ctx: CanvasRenderingContext2D): void
Parameters
- ctx: CanvasRenderingContext2D
Returns void
- Defined in entities/cell/Link.ts:536

embed

embed(cell: GraphicElement | GraphicElement[]): void
Parameters
- cell: GraphicElement | GraphicElement[]
Returns void
Inherited from BaseLinear.embed
- Defined in entities/cell/GraphicElement.ts:320

fromJSON

fromJSON(json: Record<string, unknown>): Link
Parameters
- json: Record<string, unknown>
Returns Link
Overrides BaseLinear.fromJSON
- Defined in entities/cell/Link.ts:865

getAbsoluteTextBbox

getAbsoluteTextBbox(index: number): Rect | null
Parameters
- index: number
Returns Rect | null
- Defined in entities/cell/Link.ts:621

getAnnotatedText

getAnnotatedText(ctx: CanvasRenderingContext2D, index?: number): void
Parameters
- ctx: CanvasRenderingContext2D
- Optionalindex: number
Returns void
- Defined in entities/cell/Link.ts:691

getBBox

getBBox(): Rect
Returns Rect
Overrides BaseLinear.getBBox
- Defined in entities/cell/Link.ts:266

getControls

getControls(): Control[]
Returns Control[]
Overrides BaseLinear.getControls
- Defined in entities/cell/Link.ts:815

getHoveredControls

getHoveredControls(): Control[]
Returns Control[]
Inherited from BaseLinear.getHoveredControls
- Defined in entities/cell/GraphicElement.ts:419

getIcon

getIcon(): string
Returns string
Inherited from BaseLinear.getIcon
- Defined in entities/cell/BaseLinear.ts:288

getMarkers

getMarkers(): void
Returns void
- Defined in entities/cell/Link.ts:574

getTextLabelAtPoint

getTextLabelAtPoint(point: PointLike): number
Parameters
- point: PointLike
Returns number
- Defined in entities/cell/Link.ts:634

getTextTransform

getTextTransform(index?: number): DOMMatrix
Parameters
- Optionalindex: number
Returns DOMMatrix
- Defined in entities/cell/Link.ts:715

getTopParent

getTopParent(): GraphicElement
Returns GraphicElement
Inherited from BaseLinear.getTopParent
- Defined in entities/cell/GraphicElement.ts:395

insertPoint

insertPoint(
    point: PointLike,
    ctx: CanvasRenderingContext2D,
    drawingScale: number,
): void
Parameters
- point: PointLike
- ctx: CanvasRenderingContext2D
- drawingScale: number
Returns void
Overrides BaseLinear.insertPoint
- Defined in entities/cell/Link.ts:578

isPointInDrawing

isPointInDrawing(
    point: PointLike,
    ctx: CanvasRenderingContext2D,
    drawingScale: number,
): boolean
Parameters
- point: PointLike
- ctx: CanvasRenderingContext2D
- drawingScale: number
Returns boolean
Overrides BaseLinear.isPointInDrawing
- Defined in entities/cell/Link.ts:676

makeTransformations

makeTransformations(
    offset: PointLike,
    control: Control,
    canvasPosition: PointLike,
    _isShiftPressed?: boolean,
): void
Parameters
- offset: PointLike
- control: Control
- canvasPosition: PointLike
- _isShiftPressed: boolean = false
Returns void
Overrides BaseLinear.makeTransformations
- Defined in entities/cell/Link.ts:333

move

move(deltaX: number, deltaY: number, update?: boolean): void
Parameters
- deltaX: number
- deltaY: number
- update: boolean = true
Returns void
Overrides BaseLinear.move
- Defined in entities/cell/Link.ts:437

onHover

onHover(ctx: CanvasRenderingContext2D, zoom: number): void
Parameters
- ctx: CanvasRenderingContext2D
- zoom: number
Returns void
Inherited from BaseLinear.onHover
- Defined in entities/cell/BaseLinear.ts:354

onPointerDown

onPointerDown(
    _evt: {
        canvasPosition: { x: number; y: number };
        clickPoint: Point | { x: number; y: number };
        x: number;
        y: number;
    },
    _args: unknown,
): void
Parameters
- _evt: {
      canvasPosition: { x: number; y: number };
      clickPoint: Point | { x: number; y: number };
      x: number;
      y: number;
  }
- _args: unknown
Returns void
Inherited from BaseLinear.onPointerDown
- Defined in entities/cell/BaseLinear.ts:346

onPointerUp

onPointerUp(
    _evt: {
        canvasPosition: { x: number; y: number };
        isCtrl: boolean;
        isOutside: boolean;
        x: number;
        y: number;
    },
    draggingControl: Control,
    snapPoint?: CellIntersection | null,
): void
Parameters
- _evt: {
      canvasPosition: { x: number; y: number };
      isCtrl: boolean;
      isOutside: boolean;
      x: number;
      y: number;
  }
- draggingControl: Control
- OptionalsnapPoint: CellIntersection | null
Returns void
Overrides BaseLinear.onPointerUp
- Defined in entities/cell/Link.ts:819

removeTextLabel

removeTextLabel(index: number): void
Parameters
- index: number
Returns void
- Defined in entities/cell/Link.ts:669

render

render(ctx: CanvasRenderingContext2D): void
Parameters
- ctx: CanvasRenderingContext2D
Returns void
Overrides BaseLinear.render
- Defined in entities/cell/Link.ts:461

repositionTextLabels

repositionTextLabels(): void
Returns void
- Defined in entities/cell/Link.ts:414

setFirstPoint

setFirstPoint(point: Point): void
Parameters
- point: Point
Returns void
- Defined in entities/cell/Link.ts:278

setLastPoint

setLastPoint(point: Point): void
Parameters
- point: Point
Returns void
- Defined in entities/cell/Link.ts:288

setPoints

setPoints(points: Point[]): void
Parameters
- points: Point[]
Returns void
- Defined in entities/cell/Link.ts:298

setSource

setSource(cell: GraphicElement | null): void
Parameters
- cell: GraphicElement | null
Returns void
- Defined in entities/cell/Link.ts:738

setTarget

setTarget(cell: Cell | LineParametric | null): void
Parameters
- cell: Cell | LineParametric | null
Returns void
- Defined in entities/cell/Link.ts:769

setText

setText(text: string): void
Parameters
- text: string
Returns void
- Defined in entities/cell/Link.ts:322

toJSON

toJSON(): LinkJSON
При добавлении нового поля если хотите, чтобы оно сохранялось, нужно добавить его в LINK_SAVE_FIELDS

Returns LinkJSON
Overrides BaseLinear.toJSON
- Defined in entities/cell/Link.ts:831

unembed

unembed(deep?: boolean): void
Parameters
- deep: boolean = true
Returns void
Inherited from BaseLinear.unembed
- Defined in entities/cell/GraphicElement.ts:349

update

update(): void
Returns void
Overrides BaseLinear.update
- Defined in entities/cell/Link.ts:405

updateMagnetPoints

updateMagnetPoints(): void
Returns void
Inherited from BaseLinear.updateMagnetPoints
- Defined in entities/cell/BaseLinear.ts:166

updateMarkerTransform

updateMarkerTransform(): void
Returns void
- Defined in entities/cell/Link.ts:443

updateRelationships

updateRelationships(): void
Returns void
Overrides BaseLinear.updateRelationships
- Defined in entities/cell/Link.ts:797

updateTransform

updateTransform(): void
Returns void
- Defined in entities/cell/Link.ts:431

Class Link

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Link

Properties

_activeLabelIndex

_angle

_height

Protected_isBlocked

Protected_isPrintable

Protected_isVisible

Protected_magnetPoints

_parent

_position

_radius

_type

_width

allowAddTextLabel

angleRad

arrowSource

arrowTarget

bbox

bezierParams

children

cursorName

cursorTrasform

customAttrs

dragFantomPosition

drawingScale

drawPaths

firstPoint

firstPointFixed

firstPointLocal

id

isCell

isTextEditable

lastPoint

lastPointFixed

lastPointLocal

libName

lineColor

ProtectedmagnetPointsPath

margins

name

points

relativeTextPosition

scene

standardCursor

strokeWidth

testBboxStyle

textLabels

transform

txtHeight

txtWidth

userData

withBbox

zIndex

Static ReadonlytypeName

Accessors

absoluteTextPosition

Returns Point | null

Parameters

Returns void

angle

Returns number

annotatedText

Returns AnnotatedText[]

Parameters

Returns void

height

Returns number

isBlocked

Returns boolean

`Protected`_isBlocked

`Protected`_isPrintable

`Protected`_isVisible

`Protected`_magnetPoints

`Protected`magnetPointsPath

`Static` `Readonly`typeName