Class BaseLinear

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

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

Hierarchy (View Summary)

GraphicElement
- BaseLinear
  - Link

Constructors

constructor

new BaseLinear(options?: LinearOptions): BaseLinear
Parameters
- options: LinearOptions = {}
Returns BaseLinear
Overrides GraphicElement.constructor
- Defined in entities/cell/BaseLinear.ts:76

Properties

`Protected`_isBlocked

_isBlocked: boolean = false

`Protected`_isPrintable

_isPrintable: boolean = true

`Protected`_isVisible

_isVisible: boolean = true

`Protected`_magnetPoints

_magnetPoints: Point[] = []

_parent

_parent: string | null = null

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

bbox

bbox: Rect = ...

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 = false

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

lastPoint

lastPoint: Point = ...

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

lastPointFixed

lastPointFixed: boolean = false

lastPointLocal

lastPointLocal: Point = ...

libName

libName: string | null = null

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

lineColor

lineColor: string = "#000000"

Цвет линии

`Protected`magnetPointsPath

magnetPointsPath: Path2D = ...

name

name: string = "Graphic Element"

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

points

points: Point[] = []

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

scene

scene: Scene2D | null = null

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

standardCursor

standardCursor: CursorStandard = "none"

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

strokeWidth

strokeWidth: number = 1

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

transform

transform: DOMMatrix = ...

userData

userData: UserData = []

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

zIndex

zIndex: number = 0

`Static` `Readonly`typeName

typeName: string = "BaseLinear"

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

Accessors

angle

get angle(): number
Returns number
Inherited from GraphicElement.angle
- Defined in entities/cell/GraphicElement.ts:169

height

get height(): number
Returns number
Inherited from GraphicElement.height
- Defined in entities/cell/GraphicElement.ts:161

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 GraphicElement.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 GraphicElement.lib
- Defined in entities/cell/GraphicElement.ts:243

magnetPoints

get magnetPoints(): Point[]
Returns Point[]
Overrides Clock.magnetPoints
- Defined in entities/cell/BaseLinear.ts:108
set magnetPoints(magnetPoints: Point[]): void
Parameters
- magnetPoints: Point[]
Returns void
Overrides Clock.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
Inherited from GraphicElement.position
- Defined in entities/cell/GraphicElement.ts:165
set position(_point: Point): void
Parameters
- _point: Point
Returns void
Inherited from GraphicElement.position
- Defined in entities/cell/GraphicElement.ts:173

visibleInRender

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

width

get width(): number
Returns number
Inherited from GraphicElement.width
- Defined in entities/cell/GraphicElement.ts:157

Methods

calcDrawPath

calcDrawPath(): void
Returns void
- Defined in entities/cell/BaseLinear.ts:112

clone

clone(): BaseLinear
Returns BaseLinear
Inherited from GraphicElement.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
Overrides GraphicElement.containsPoint
- Defined in entities/cell/BaseLinear.ts:247

dispose

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

drawMagnetPoints

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

embed

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

fromJSON

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

getBBox

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

getControls

getControls(_options: Record<string, boolean>): Control[]
Parameters
- _options: Record<string, boolean>
Returns Control[]
Overrides GraphicElement.getControls
- Defined in entities/cell/BaseLinear.ts:207

getHoveredControls

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

getIcon

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

getTopParent

getTopParent(): GraphicElement
Returns GraphicElement
Inherited from GraphicElement.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
- Defined in entities/cell/BaseLinear.ts:296

isPointInDrawing

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

makeTransformations

makeTransformations(
    _offset: PointLike,
    _control: Control,
    _canvasPosition: PointLike,
    _isShiftPressed?: boolean,
): void
Parameters
- _offset: PointLike
- _control: Control
- _canvasPosition: PointLike
- Optional_isShiftPressed: boolean
Returns void
Overrides GraphicElement.makeTransformations
- Defined in entities/cell/BaseLinear.ts:198

move

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

onHover

onHover(ctx: CanvasRenderingContext2D, zoom: number): void
Parameters
- ctx: CanvasRenderingContext2D
- zoom: number
Returns void
Overrides GraphicElement.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
Overrides GraphicElement.onPointerDown
- Defined in entities/cell/BaseLinear.ts:346

onPointerUp

onPointerUp(
    _evt: {
        canvasPosition: { x: number; y: number };
        isCtrl: boolean;
        isOutside: boolean;
        x: number;
        y: number;
    },
    _args: unknown,
): void
Parameters
- _evt: {
      canvasPosition: { x: number; y: number };
      isCtrl: boolean;
      isOutside: boolean;
      x: number;
      y: number;
  }
- _args: unknown
Returns void
Overrides GraphicElement.onPointerUp
- Defined in entities/cell/BaseLinear.ts:338

render

render(
    ctx: CanvasRenderingContext2D,
    _zoom?: number,
    _options?: RenderOptions,
): void
Parameters
- ctx: CanvasRenderingContext2D
- Optional_zoom: number
- Optional_options: RenderOptions
Returns void
Overrides GraphicElement.render
- Defined in entities/cell/BaseLinear.ts:116

toJSON

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

Returns LinearJSON
Overrides GraphicElement.toJSON
- Defined in entities/cell/BaseLinear.ts:377

unembed

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

update

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

updateMagnetPoints

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

updateRelationships

updateRelationships(): void
Returns void
Inherited from GraphicElement.updateRelationships
- Defined in entities/cell/GraphicElement.ts:362

Class BaseLinear

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BaseLinear

Properties

Protected_isBlocked

Protected_isPrintable

Protected_isVisible

Protected_magnetPoints

_parent

bbox

children

cursorName

cursorTrasform

customAttrs

dragFantomPosition

drawingScale

drawPaths

firstPoint

firstPointFixed

firstPointLocal

id

isCell

isTextEditable

lastPoint

lastPointFixed

lastPointLocal

libName

lineColor

ProtectedmagnetPointsPath

name

points

scene

standardCursor

strokeWidth

transform

userData

zIndex

Static ReadonlytypeName

Accessors

angle

Returns number

height

Returns number

isBlocked

Returns boolean

Parameters

Returns void

isBlockedInRender

Returns boolean

isPrintable

Returns boolean

Parameters

Returns void

isVisible

Returns boolean

Parameters

Returns void

lib

Returns Library<typeof BaseCell | typeof BaseLinear> | null

magnetPoints

Returns Point[]

Parameters

Returns void

parent

Returns GraphicElement | null

Parameters

Returns void

position

Returns Point

Parameters

Returns void

visibleInRender

`Protected`_isBlocked

`Protected`_isPrintable

`Protected`_isVisible

`Protected`_magnetPoints

`Protected`magnetPointsPath

`Static` `Readonly`typeName