Class Segment

Hierarchy (view full)

LineParametric
- Segment

Index

Constructors

Accessors

absoluteTextPosition annotatedText isBlocked isBlockedInRender isPrintable isVisible magnetPoints paramData radius source target textBbox textLabel textPosition textTransform type visibleInRender

Constructors

constructor

new Segment(options?): Segment
Parameters
- options: LinkOptions = {}
Returns Segment
Overrides LineParametric.constructor
- Defined in src/engine/entities/cell/primitives/Segment.ts:30

Properties

_activeLabelIndex

_activeLabelIndex: number = 0

_paramData

_paramData: ParamData[] = []

_radius

_radius: number = 0

_type

_type: LinkType = LinkType.LINE

Тип линии

allowAddTextLabel

allowAddTextLabel: boolean = true

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

angle

angle: number = 0

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

angleRad

angleRad: number = 0

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

arrowSource

arrowSource: null | ConnectorArrow = null

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

arrowTarget

arrowTarget: null | ConnectorArrow = null

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

autoRouting

autoRouting: boolean = true

backgroundColor

backgroundColor: string = "#00000000"

bbox

bbox: Rect = ...

bezierParams

bezierParams: BezierParams = []

cornerPoints

cornerPoints: Point[] = []

cursorName

cursorName: string = "DRAG_CELL_SVG"

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

customAttrs

customAttrs: CustomAttrs = ...

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

dragFantomPosition

dragFantomPosition: null | Point = null

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

drawingScale

drawingScale: number = 1

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

drawPaths

drawPaths: DrawPath[] = []

firstPoint

firstPoint: Point = ...

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

firstPointFixed

firstPointFixed: boolean = false

firstPointLocal

firstPointLocal: Point = ...

hatch

hatch: null | HatchFill = null

height

height: number = 1

Высота

id

id: string

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

isCell

isCell: boolean = false

isConnectedLine

isConnectedLine: boolean = false

isConnector

isConnector: boolean = true

isLine

isLine: boolean = false

isTextEditable

isTextEditable: boolean = true

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

lastPoint

lastPoint: Point = ...

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

lastPointFixed

lastPointFixed: boolean = false

lastPointLocal

lastPointLocal: Point = ...

lineColor

lineColor: string = "#000000"

Цвет линии

links

links: Link[] = []

margins

margins: TextMargins = ...

name

name: string = "Соединительня линия"

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

parent

parent: null | Cell = null

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

points

points: Point[] = []

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

position

position: Point = ...

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

relativeTextPosition

relativeTextPosition: RelativeTextPosition = ...

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

scene

scene: null | Scene2D = 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 = []

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

width

width: number = 100

Ширина

withBbox

withBbox: boolean = false

zIndex

zIndex: number = 0

`Static`prefixed

prefixed: string | boolean

Accessors

absoluteTextPosition

get absoluteTextPosition(): null | Point
Returns null | Point
Inherited from LineParametric.absoluteTextPosition
- Defined in src/engine/entities/cell/Link.ts:230
set absoluteTextPosition(value): void
Parameters
- value: null | Point
Returns void
Inherited from LineParametric.absoluteTextPosition
- Defined in src/engine/entities/cell/Link.ts:234

annotatedText

get annotatedText(): AnnotatedText[]
Returns AnnotatedText[]
Inherited from LineParametric.annotatedText
- Defined in src/engine/entities/cell/Link.ts:195
set annotatedText(value): void
Parameters
- value: AnnotatedText[]
Returns void
Inherited from LineParametric.annotatedText
- Defined in src/engine/entities/cell/Link.ts:199

isBlocked

get isBlocked(): boolean
Returns boolean
Inherited from LineParametric.isBlocked
- Defined in src/engine/entities/cell/Link.ts:681
set isBlocked(isBlocked): void
Parameters
- isBlocked: boolean
Returns void
Inherited from LineParametric.isBlocked
- Defined in src/engine/entities/cell/Link.ts:677

isBlockedInRender

get isBlockedInRender(): boolean
Returns boolean
Inherited from LineParametric.isBlockedInRender
- Defined in src/engine/entities/cell/Link.ts:685

isPrintable

get isPrintable(): boolean
Returns boolean
Inherited from LineParametric.isPrintable
- Defined in src/engine/entities/cell/Link.ts:698
set isPrintable(isPrintable): void
Parameters
- isPrintable: boolean
Returns void
Inherited from LineParametric.isPrintable
- Defined in src/engine/entities/cell/Link.ts:694

isVisible

get isVisible(): boolean
Returns boolean
Inherited from LineParametric.isVisible
- Defined in src/engine/entities/cell/Link.ts:664
set isVisible(visible): void
Parameters
- visible: boolean
Returns void
Inherited from LineParametric.isVisible
- Defined in src/engine/entities/cell/Link.ts:660

magnetPoints

get magnetPoints(): Point[]
Returns Point[]
Inherited from LineParametric.magnetPoints
- Defined in src/engine/entities/cell/Link.ts:1060
set magnetPoints(magnetPoints): void
Parameters
- magnetPoints: Point[]
Returns void
Inherited from LineParametric.magnetPoints
- Defined in src/engine/entities/cell/Link.ts:1056

paramData

get paramData(): ParamData[]
Returns ParamData[]
Inherited from LineParametric.paramData
- Defined in src/engine/entities/cell/LineParametric.ts:20

radius

get radius(): number
Returns number
Inherited from LineParametric.radius
- Defined in src/engine/entities/cell/Link.ts:442
set radius(radius): void
Parameters
- radius: number
Returns void
Inherited from LineParametric.radius
- Defined in src/engine/entities/cell/Link.ts:437

source

get source(): null | Cell | LineParametric
Returns null | Cell | LineParametric
Inherited from LineParametric.source
- Defined in src/engine/entities/cell/Link.ts:1021

target

get target(): null | Cell | LineParametric
Returns null | Cell | LineParametric
Inherited from LineParametric.target
- Defined in src/engine/entities/cell/Link.ts:1043

textBbox

get textBbox(): null | Rect
Returns null | Rect
Inherited from LineParametric.textBbox
- Defined in src/engine/entities/cell/Link.ts:206
set textBbox(value): void
Parameters
- value: null | Rect
Returns void
Inherited from LineParametric.textBbox
- Defined in src/engine/entities/cell/Link.ts:210

textLabel

get textLabel(): null | Label
Returns null | Label
Inherited from LineParametric.textLabel
- Defined in src/engine/entities/cell/Link.ts:771
set textLabel(label): void
Parameters
- label: null | Label
Returns void
Inherited from LineParametric.textLabel
- Defined in src/engine/entities/cell/Link.ts:747

textPosition

get textPosition(): null | Point
Returns null | Point
Inherited from LineParametric.textPosition
- Defined in src/engine/entities/cell/Link.ts:242
set textPosition(value): void
Parameters
- value: null | Point
Returns void
Inherited from LineParametric.textPosition
- Defined in src/engine/entities/cell/Link.ts:246

textTransform

get textTransform(): DOMMatrix
Returns DOMMatrix
Inherited from LineParametric.textTransform
- Defined in src/engine/entities/cell/Link.ts:217
set textTransform(value): void
Parameters
- value: DOMMatrix
Returns void
Inherited from LineParametric.textTransform
- Defined in src/engine/entities/cell/Link.ts:223

type

get type(): LinkType
Returns LinkType
Inherited from LineParametric.type
- Defined in src/engine/entities/cell/LineParametric.ts:34
set type(type): void
Parameters
- type: LinkType
Returns void
Inherited from LineParametric.type
- Defined in src/engine/entities/cell/LineParametric.ts:29

visibleInRender

get visibleInRender(): boolean
Returns boolean
Inherited from LineParametric.visibleInRender
- Defined in src/engine/entities/cell/Link.ts:668

Methods

addListener

addListener<T>(event, fn, context?): this
Type Parameters
- T extends keyof BaseCellEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<BaseCellEvents>[Extract<T, keyof BaseCellEvents>]) => void)
  - - (...args): void
    - Parameters
      Rest...args: ArgumentMap<BaseCellEvents>[Extract<T, keyof BaseCellEvents>]
      Returns void
- Optionalcontext: any
Returns this
Inherited from LineParametric.addListener
- Defined in node_modules/eventemitter3/index.d.ts:45

addTextLabel

addTextLabel(position): number
Parameters
- position: Point
Returns number
Inherited from LineParametric.addTextLabel
- Defined in src/engine/entities/cell/Link.ts:901

calcDrawPath

calcDrawPath(): void
Returns void
Overrides LineParametric.calcDrawPath
- Defined in src/engine/entities/cell/primitives/Segment.ts:83

calcMidPoint

calcMidPoint(customPoints?): Point
Parameters
- OptionalcustomPoints: Point[]
Returns Point
Inherited from LineParametric.calcMidPoint
- Defined in src/engine/entities/cell/Link.ts:547

clone

clone(): Segment
Returns Segment
Inherited from LineParametric.clone
- Defined in src/engine/entities/cell/Link.ts:1195

copy

copy(link): Link
Parameters
- link: Link
Returns Link
Inherited from LineParametric.copy
- Defined in src/engine/entities/cell/Link.ts:1181

dispose

dispose(): void
Returns void
Inherited from LineParametric.dispose
- Defined in src/engine/entities/cell/Link.ts:1203

drawMagnetPoints

drawMagnetPoints(ctx): void
Parameters
- ctx: CanvasRenderingContext2D
Returns void
Inherited from LineParametric.drawMagnetPoints
- Defined in src/engine/entities/cell/Link.ts:1064

drawTexts

drawTexts(ctx): void
Parameters
- ctx: CanvasRenderingContext2D
Returns void
Inherited from LineParametric.drawTexts
- Defined in src/engine/entities/cell/Link.ts:786

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof BaseCellEvents
Parameters
- event: T
- Rest...args: ArgumentMap<BaseCellEvents>[Extract<T, keyof BaseCellEvents>]
Returns boolean
Inherited from LineParametric.emit
- Defined in node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof BaseCellEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof BaseCellEvents)[]
Inherited from LineParametric.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:15

fromJSON

fromJSON(json): Segment
Parameters
- json: Record<string, unknown>
Returns Segment
Inherited from LineParametric.fromJSON
- Defined in src/engine/entities/cell/Link.ts:1115

getAbsoluteTextBbox

getAbsoluteTextBbox(index): null | Rect
Parameters
- index: number
Returns null | Rect
Inherited from LineParametric.getAbsoluteTextBbox
- Defined in src/engine/entities/cell/Link.ts:871

getAnnotatedText

getAnnotatedText(ctx, index?): void
Parameters
- ctx: CanvasRenderingContext2D
- Optionalindex: number
Returns void
Inherited from LineParametric.getAnnotatedText
- Defined in src/engine/entities/cell/Link.ts:956

getBBox

getBBox(): Rect
Returns Rect
Inherited from LineParametric.getBBox
- Defined in src/engine/entities/cell/Link.ts:389

getControls

getControls(): Control[]
Returns Control[]
Overrides LineParametric.getControls
- Defined in src/engine/entities/cell/primitives/Segment.ts:342

getCornerPoints

getCornerPoints(): void
Returns void
Inherited from LineParametric.getCornerPoints
- Defined in src/engine/entities/cell/Link.ts:774

getIcon

getIcon(): string
Returns string
Inherited from LineParametric.getIcon
- Defined in src/engine/entities/cell/Link.ts:1191

getMarkers

getMarkers(): void
Returns void
Inherited from LineParametric.getMarkers
- Defined in src/engine/entities/cell/Link.ts:824

getParamData

getParamData(): ParamData[]
Returns ParamData[]
Overrides LineParametric.getParamData
- Defined in src/engine/entities/cell/primitives/Segment.ts:34

getTextLabelAtPoint

getTextLabelAtPoint(point): number
Parameters
- point: PointLike
Returns number
Inherited from LineParametric.getTextLabelAtPoint
- Defined in src/engine/entities/cell/Link.ts:884

getTextTransform

getTextTransform(index?): DOMMatrix
Parameters
- Optionalindex: number
Returns DOMMatrix
Inherited from LineParametric.getTextTransform
- Defined in src/engine/entities/cell/Link.ts:979

getTopParent

getTopParent(): Cell | Link
Returns Cell | Link
Inherited from LineParametric.getTopParent
- Defined in src/engine/entities/cell/Link.ts:1177

insertPoint

insertPoint(point, ctx, drawingScale): void
Parameters
- point: PointLike
- ctx: CanvasRenderingContext2D
- drawingScale: number
Returns void
Inherited from LineParametric.insertPoint
- Defined in src/engine/entities/cell/Link.ts:828

isPointInDrawing

isPointInDrawing(point, ctx, drawingScale): boolean
Parameters
- point: PointLike
- ctx: CanvasRenderingContext2D
- drawingScale: number
Returns boolean
Inherited from LineParametric.isPointInDrawing
- Defined in src/engine/entities/cell/Link.ts:926

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof BaseCellEvents
Returns number
Inherited from LineParametric.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args: ArgumentMap<BaseCellEvents>[Extract<T, keyof BaseCellEvents>]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof BaseCellEvents
Parameters
- event: T
Returns ((...args: ArgumentMap<BaseCellEvents>[Extract<T, keyof BaseCellEvents>]) => void)[]
Inherited from LineParametric.listeners
- Defined in node_modules/eventemitter3/index.d.ts:20

makeTransformations

makeTransformations(offset, control, canvasPosition): void
Parameters
- offset: PointLike
- control: Control
- canvasPosition: PointLike
Returns void
Overrides LineParametric.makeTransformations
- Defined in src/engine/entities/cell/primitives/Segment.ts:272

move

move(deltaX, deltaY): void
Parameters
- deltaX: number
- deltaY: number
Returns void
Inherited from LineParametric.move
- Defined in src/engine/entities/cell/LineParametric.ts:54

off

off<T>(event, fn?, context?, once?): this
Type Parameters
- T extends keyof BaseCellEvents
Parameters
- event: T
- Optionalfn: ((...args: ArgumentMap<BaseCellEvents>[Extract<T, keyof BaseCellEvents>]) => void)
  - - (...args): void
    - Parameters
      Rest...args: ArgumentMap<BaseCellEvents>[Extract<T, keyof BaseCellEvents>]
      Returns void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from LineParametric.off
- Defined in node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): this
Add a listener for a given event.
Type Parameters
- T extends keyof BaseCellEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<BaseCellEvents>[Extract<T, keyof BaseCellEvents>]) => void)
  - - (...args): void
    - Parameters
      Rest...args: ArgumentMap<BaseCellEvents>[Extract<T, keyof BaseCellEvents>]
      Returns void
- Optionalcontext: any
Returns this
Inherited from LineParametric.on
- Defined in node_modules/eventemitter3/index.d.ts:40

once

once<T>(event, fn, context?): this
Add a one-time listener for a given event.
Type Parameters
- T extends keyof BaseCellEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<BaseCellEvents>[Extract<T, keyof BaseCellEvents>]) => void)
  - - (...args): void
    - Parameters
      Rest...args: ArgumentMap<BaseCellEvents>[Extract<T, keyof BaseCellEvents>]
      Returns void
- Optionalcontext: any
Returns this
Inherited from LineParametric.once
- Defined in node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optionalevent: keyof BaseCellEvents
Returns this
Inherited from LineParametric.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): this
Remove the listeners of a given event.
Type Parameters
- T extends keyof BaseCellEvents
Parameters
- event: T
- Optionalfn: ((...args: ArgumentMap<BaseCellEvents>[Extract<T, keyof BaseCellEvents>]) => void)
  - - (...args): void
    - Parameters
      Rest...args: ArgumentMap<BaseCellEvents>[Extract<T, keyof BaseCellEvents>]
      Returns void
- Optionalcontext: any
- Optionalonce: boolean
Returns this
Inherited from LineParametric.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:63

removeTextLabel

removeTextLabel(index): void
Parameters
- index: number
Returns void
Inherited from LineParametric.removeTextLabel
- Defined in src/engine/entities/cell/Link.ts:919

render

render(ctx): void
Parameters
- ctx: CanvasRenderingContext2D
Returns void
Inherited from LineParametric.render
- Defined in src/engine/entities/cell/Link.ts:704

repositionTextLabels

repositionTextLabels(): void
Returns void
Inherited from LineParametric.repositionTextLabels
- Defined in src/engine/entities/cell/Link.ts:605

setFirstPoint

setFirstPoint(point): void
Parameters
- point: Point
Returns void
Inherited from LineParametric.setFirstPoint
- Defined in src/engine/entities/cell/Link.ts:414

setLastPoint

setLastPoint(point): void
Parameters
- point: Point
Returns void
Inherited from LineParametric.setLastPoint
- Defined in src/engine/entities/cell/Link.ts:423

setPoints

setPoints(points): void
Parameters
- points: Point[]
Returns void
Inherited from LineParametric.setPoints
- Defined in src/engine/entities/cell/Link.ts:432

setPosition

setPosition(x, y): void
Parameters
- x: number
- y: number
Returns void
Inherited from LineParametric.setPosition
- Defined in src/engine/entities/cell/Link.ts:949

setSource

setSource(cell): void
Parameters
- cell: null | Cell | LineParametric
Returns void
Inherited from LineParametric.setSource
- Defined in src/engine/entities/cell/Link.ts:1002

setTarget

setTarget(cell): void
Parameters
- cell: null | Cell | LineParametric
Returns void
Inherited from LineParametric.setTarget
- Defined in src/engine/entities/cell/Link.ts:1025

setText

setText(text): void
Parameters
- text: string
Returns void
Inherited from LineParametric.setText
- Defined in src/engine/entities/cell/Link.ts:459

switchParam

switchParam(name, val): void
Parameters
- name: string
- val: string
Returns void
Inherited from LineParametric.switchParam
- Defined in src/engine/entities/cell/LineParametric.ts:61

toJSON

toJSON(): LinkJSON & {
    _paramData?: ParamData[];
} & {
    _equidistant: number;
    _isClosed?: boolean;
    _isClosedEquidistant: boolean;
    backgroundColor: string;
    hatch: null | HatchFill;
}
При добавлении нового поля если хотите, чтобы оно сохранялось, нужно добавить его в LINK_SAVE_FIELDS

Returns LinkJSON & {
    _paramData?: ParamData[];
} & {
    _equidistant: number;
    _isClosed?: boolean;
    _isClosedEquidistant: boolean;
    backgroundColor: string;
    hatch: null | HatchFill;
}
Overrides LineParametric.toJSON
- Defined in src/engine/entities/cell/primitives/Segment.ts:387

unembed

unembed(): void
Returns void
Inherited from LineParametric.unembed
- Defined in src/engine/entities/cell/Link.ts:1047

update

update(): void
Returns void
Inherited from LineParametric.update
- Defined in src/engine/entities/cell/LineParametric.ts:42

updateLinks

updateLinks(): void
Returns void
Inherited from LineParametric.updateLinks
- Defined in src/engine/entities/cell/LineParametric.ts:68

updateMagnetPoints

updateMagnetPoints(): void
Returns void
Inherited from LineParametric.updateMagnetPoints
- Defined in src/engine/entities/cell/Link.ts:397

updateMarkerTransform

updateMarkerTransform(): void
Returns void
Inherited from LineParametric.updateMarkerTransform
- Defined in src/engine/entities/cell/Link.ts:642

updateParamData

updateParamData(): void
Returns void
Inherited from LineParametric.updateParamData
- Defined in src/engine/entities/cell/LineParametric.ts:38

updateTransform

updateTransform(): void
Returns void
Inherited from LineParametric.updateTransform
- Defined in src/engine/entities/cell/Link.ts:622

Class Segment

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Segment

Properties

_activeLabelIndex

_paramData

_radius

_type

allowAddTextLabel

angle

angleRad

arrowSource

arrowTarget

autoRouting

backgroundColor

bbox

bezierParams

cornerPoints

cursorName

customAttrs

dragFantomPosition

drawingScale

drawPaths

firstPoint

firstPointFixed

firstPointLocal

hatch

height

id

isCell

isConnectedLine

isConnector

isLine

isTextEditable

lastPoint

lastPointFixed

lastPointLocal

lineColor

links

margins

name

parent

points

position

relativeTextPosition

scene

standardCursor

strokeWidth

testBboxStyle

textLabels

transform

txtHeight

txtWidth

userData

width

withBbox

zIndex

Staticprefixed

Accessors

absoluteTextPosition

Returns null | Point

Parameters

Returns void

annotatedText

Returns AnnotatedText[]

Parameters

Returns void

isBlocked

Returns boolean

Parameters

Returns void

isBlockedInRender

`Static`prefixed