Class BlockShape

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

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

Hierarchy (View Summary)

Cell
- BlockShape

Index

Constructors

constructor

Constructors

constructor

new BlockShape(options?: CellOptions): BlockShape
Parameters
- options: CellOptions = {}
Returns BlockShape
Overrides Cell.constructor
- Defined in services/Stencil/shapes/commonShapes/BlockShape.ts:6

Properties

`Protected`_angle

_angle: number = 0

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

`Protected`_centerOfRotation

_centerOfRotation: CenterOfRotation

`Protected`_height

_height: number = 100

Высота

`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 = ...

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

`Protected`_width

_width: number = 100

Ширина

angleRad

angleRad: number = 0

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

annotatedText

annotatedText: AnnotatedText[] = []

bbox

bbox: Rect = ...

bboxEdges

bboxEdges: BboxEdges = ...

cashCanvas

cashCanvas: OffscreenCanvas | null = null

children

children: GraphicElement[] = []

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

compassPoints

compassPoints: CompassPoints | null = null

cornerPoints

cornerPoints: Point[] = []

Угловые точки от левого нижнего угла по часовой стрелке, с учетом поворота, в глобальных координатах

cursorName

cursorName: string = "DRAG_CELL_SVG"

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

cursorTrasform

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

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

customAttrs

customAttrs: CustomAttrs = ...

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

customRender

customRender: ((ctx: CanvasRenderingContext2D, zoom: number) => void) | null = null

Выполняется после основного рендера ячейки в её координатах

Param: ctx

CanvasRenderingContext2D

Param: zoom

number

dragFantomPosition

dragFantomPosition: Point | null = null

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

drawingScale

drawingScale: number = 1

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

drawPaths

drawPaths: DrawPath[] = []

effectCanvas

effectCanvas: OffscreenCanvas | null = null

`Optional`foreign

foreign?: any = null

id

id: string

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

isCell

isCell: boolean = true

isMultiTextMode

isMultiTextMode: boolean = false

Булеан флаг - включён ли режим мультитекста

isTextBlock

isTextBlock: boolean = false

Булеан флаг - является ли ячейка текстовым блоком (TextShape)

isTextEditable

isTextEditable: boolean = true

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

labels

labels: Label[] = []

libName

libName: string | null = null

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

links

links: Link[] = []

Линии, которые связаны с ячейкой

`Protected`magnetPointsPath

magnetPointsPath: Path2D = ...

margins

margins: TextMargins = ...

name

name: string = "Fugure"

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

prevZoom

prevZoom: number | null = null

realCellSize

realCellSize: { height: number; offset: Point; width: number } | null = null

Deprecated

сейчас никак не рассчитывается

relativeTextPosition

relativeTextPosition: RelativeTextPosition = ...

rotatedBboxEdges

rotatedBboxEdges: BboxEdges = ...

scale

scale: PointLike = ...

Скейл по оси x и по оси y

scene

scene: Scene2D | null = null

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

shapeGhost

shapeGhost: OffscreenCanvas | null = null

standardCursor

standardCursor: CursorStandard = "none"

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

startHeight

startHeight: number

Высота, которая была изначально до определения реальной высоты

startWidth

startWidth: number

Ширина, которая была изначально до определения реальной ширины

testBboxStyle

testBboxStyle: TestBboxStyle

Стиль текстового поля

textBbox

textBbox: Rect | null = null

textPosition

textPosition: Point | null = null

textTransform

textTransform: DOMMatrix = ...

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 = "BlockShape"

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

Accessors

angle

get angle(): number
Returns number
Inherited from Cell.angle
- Defined in entities/cell/BaseCell.ts:634
set angle(angle: number): void
Повернет фигуру относительно центра
Parameters
- angle: number
Returns void
Inherited from Cell.angle
- Defined in entities/cell/BaseCell.ts:629

center

get center(): Point
центр bbox в абсолютных координатах

Returns Point
Inherited from Cell.center
- Defined in entities/cell/BaseCell.ts:550

centerOfRotation

get centerOfRotation(): Point
Returns Point
Inherited from Cell.centerOfRotation
- Defined in entities/cell/BaseCell.ts:309
set centerOfRotation(point: CenterOfRotation): void
Parameters
- point: CenterOfRotation
Returns void
Inherited from Cell.centerOfRotation
- Defined in entities/cell/BaseCell.ts:319

drawCommands

get drawCommands(): CellPaths[]
Returns CellPaths[]
Inherited from Cell.drawCommands
- Defined in entities/cell/BaseCell.ts:345
set drawCommands(drawCommands: CellPaths[]): void
setter

Необходимо присваивать новый массив, а не мутировать старый, тогда пути рисования обновятся
Parameters
- drawCommands: CellPaths[]
Returns void
Inherited from Cell.drawCommands
- Defined in entities/cell/BaseCell.ts:341

geometricCenter

get geometricCenter(): Point
Геометрический центр ячейки . В отличие от bbox.center, не смещается метками мультитекста.

Returns Point
Inherited from Cell.geometricCenter
- Defined in entities/cell/BaseCell.ts:561

globalCenterOfRotation

get globalCenterOfRotation(): Point
Returns Point
Inherited from Cell.globalCenterOfRotation
- Defined in entities/cell/BaseCell.ts:569

height

get height(): number
Высота ячейки в пойнтах (ед измерения отрисовки)

Returns number
Inherited from Cell.height
- Defined in entities/cell/BaseCell.ts:1216
set height(newHeight: number): void
Устанавливает высоту ячейки в пойнтах (ед измерения отрисовки) и пересчитывает bbox и трансформации
Parameters
- newHeight: number
Returns void
Inherited from Cell.height
- Defined in entities/cell/BaseCell.ts:1223

heightMM

get heightMM(): number
Значение высоты в мм

Returns number
Inherited from Cell.heightMM
- Defined in entities/cell/BaseCell.ts:1263
set heightMM(height: number): void
Переводит введённое значение высоты из мм в пойнты
Parameters
- height: number
Returns void
Inherited from Cell.heightMM
- Defined in entities/cell/BaseCell.ts:1269

isBlocked

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

isBlockedInRender

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

isPrintable

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

isVisible

get isVisible(): boolean
Returns boolean
Inherited from Cell.isVisible
- Defined in entities/cell/GraphicElement.ts:191
set isVisible(visible: boolean): void
Parameters
- visible: boolean
Returns void
Inherited from Cell.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 Cell.lib
- Defined in entities/cell/GraphicElement.ts:243

magnetPoints

get magnetPoints(): Point[]
Returns Point[]
Inherited from Cell.magnetPoints
- Defined in entities/cell/GraphicElement.ts:236
set magnetPoints(magnetPoints: Point[]): void
Parameters
- magnetPoints: Point[]
Returns void
Inherited from Cell.magnetPoints
- Defined in entities/cell/GraphicElement.ts:232

parent

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

position

get position(): Point
Returns Point
Inherited from Cell.position
- Defined in entities/cell/BaseCell.ts:287
set position(point: Point): void
Parameters
- point: Point
Returns void
Inherited from Cell.position
- Defined in entities/cell/BaseCell.ts:291

positionMM

get positionMM(): Point
get Позиция в мм

Returns Point
Inherited from Cell.positionMM
- Defined in entities/cell/BaseCell.ts:1280
set positionMM(position: Point): void
set Переводит введённое значение положения из мм в пойнты
Parameters
- position: Point
Returns void
Inherited from Cell.positionMM
- Defined in entities/cell/BaseCell.ts:1290

startSize

get startSize(): { height: number; width: number }
Returns { height: number; width: number }
Inherited from Cell.startSize
- Defined in entities/cell/BaseCell.ts:509

textLabel

get textLabel(): Label | null
Returns Label | null
Inherited from Cell.textLabel
- Defined in entities/cell/BaseCell.ts:305
set textLabel(label: Label | null): void
Parameters
- label: Label | null
Returns void
Inherited from Cell.textLabel
- Defined in entities/cell/BaseCell.ts:296

visibleInRender

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

width

get width(): number
Ширина ячейки в пойнтах (ед измерения отрисовки)

Returns number
Inherited from Cell.width
- Defined in entities/cell/BaseCell.ts:1199
set width(newWidth: number): void
Устанавливает ширину ячейки в пойнтах (ед измерения отрисовки) и пересчитывает bbox и трансформации
Parameters
- newWidth: number
Returns void
Inherited from Cell.width
- Defined in entities/cell/BaseCell.ts:1206

widthMM

get widthMM(): number
Значение ширины в мм

Returns number
Inherited from Cell.widthMM
- Defined in entities/cell/BaseCell.ts:1245
set widthMM(width: number): void
Устанавливает значение ширины из мм
Parameters
- width: number
Returns void
Inherited from Cell.widthMM
- Defined in entities/cell/BaseCell.ts:1252

Methods

calcTextPosition

calcTextPosition(): void
Returns void
Inherited from Cell.calcTextPosition
- Defined in entities/cell/BaseCell.ts:1462

clone

clone(): BlockShape
Returns BlockShape
Inherited from Cell.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 = true
Returns boolean
Inherited from Cell.containsPoint
- Defined in entities/cell/BaseCell.ts:1091

dispose

dispose(): void
Returns void
Inherited from Cell.dispose
- Defined in entities/cell/BaseCell.ts:1497

drawForeign

drawForeign(ctx: CanvasRenderingContext2D): void
Parameters
- ctx: CanvasRenderingContext2D
Returns void
Inherited from Cell.drawForeign
- Defined in entities/cell/BaseCell.ts:872

drawMagnetPoints

drawMagnetPoints(ctx: CanvasRenderingContext2D): void
Parameters
- ctx: CanvasRenderingContext2D
Returns void
Inherited from Cell.drawMagnetPoints
- Defined in entities/cell/BaseCell.ts:882

drawTexts

drawTexts(ctx: CanvasRenderingContext2D): void
Parameters
- ctx: CanvasRenderingContext2D
Returns void
Inherited from Cell.drawTexts
- Defined in entities/cell/BaseCell.ts:927

embed

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

findConnectionPoints

findConnectionPoints(_drawingScale?: number): void
Parameters
- Optional_drawingScale: number
Returns void
Deprecated
Ищет крайние точки на фигуре по восьми направлениям от центра: к центрам сторон bbox и к углам. Сработает только один раз. Если нужно пересчитывать при изменении скейла элемента, нужна убрать проверку. На больших элементах работает медленно. если элемент очень большой надо уменьшать
Inherited from Cell.findConnectionPoints
- Defined in entities/cell/BaseCell.ts:1079

fromJSON

fromJSON(json: Record<keyof CellJSON, CellJSON[keyof CellJSON]>): BlockShape
Parameters
- json: Record<keyof CellJSON, CellJSON[keyof CellJSON]>
Returns BlockShape
Inherited from Cell.fromJSON
- Defined in entities/cell/BaseCell.ts:1400

getAnnotatedText

getAnnotatedText(ctx: CanvasRenderingContext2D): void
Parameters
- ctx: CanvasRenderingContext2D
Returns void
Inherited from Cell.getAnnotatedText
- Defined in entities/cell/BaseCell.ts:909

getBBox

getBBox(): Rect
Returns Rect
Inherited from Cell.getBBox
- Defined in entities/cell/BaseCell.ts:414

getControls

getControls(options?: CellControlsActve): ControlCell[]
Parameters
- options: CellControlsActve = ...
Returns ControlCell[]
Inherited from Cell.getControls
- Defined in entities/cell/Cell.ts:18

getCornerPoints

getCornerPoints(): void
Returns void
Inherited from Cell.getCornerPoints
- Defined in entities/cell/BaseCell.ts:889

getCtxTransform

getCtxTransform(): CtxTransform
Returns CtxTransform
Inherited from Cell.getCtxTransform
- Defined in entities/cell/BaseCell.ts:638

getHoveredControls

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

getIcon

getIcon(): string
Returns string
Inherited from Cell.getIcon
- Defined in entities/cell/GraphicElement.ts:383

getTextTransform

getTextTransform(): DOMMatrix
Returns DOMMatrix
Inherited from Cell.getTextTransform
- Defined in entities/cell/BaseCell.ts:382

getTopParent

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

isPointInDrawing

isPointInDrawing(
    point: PointLike,
    ctx: CanvasRenderingContext2D,
    drawingScale: number,
): boolean
Parameters
- point: PointLike
- ctx: CanvasRenderingContext2D
- drawingScale: number
Returns boolean
Inherited from Cell.isPointInDrawing
- Defined in entities/cell/BaseCell.ts:1138

makeTransformations

makeTransformations(
    offset: PointLike,
    control: Control,
    canvasPosition: PointLike,
    isShiftPressed?: boolean,
): void
Parameters
- offset: PointLike
- control: Control
- canvasPosition: PointLike
- isShiftPressed: boolean = false
Returns void
Inherited from Cell.makeTransformations
- Defined in entities/cell/BaseCell.ts:513

move

move(deltaX: number, deltaY: number, update?: boolean): void
Parameters
- deltaX: number
- deltaY: number
- update: boolean = true
Returns void
Inherited from Cell.move
- Defined in entities/cell/BaseCell.ts:496

moveCenterOfRotation

moveCenterOfRotation(offset: PointLike): void
Parameters
- offset: PointLike
Returns void
Inherited from Cell.moveCenterOfRotation
- Defined in entities/cell/BaseCell.ts:327

onHover

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

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 Cell.onPointerDown
- Defined in entities/cell/BaseCell.ts:1317

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
Inherited from Cell.onPointerUp
- Defined in entities/cell/BaseCell.ts:1309

render

render(
    ctx: CanvasRenderingContext2D,
    zoom: number,
    options?: RenderOptions,
): void
Parameters
- ctx: CanvasRenderingContext2D
- zoom: number
- Optionaloptions: RenderOptions
Returns void
Inherited from Cell.render
- Defined in entities/cell/BaseCell.ts:648

reWriteSize

reWriteSize(size: Size, update?: boolean): void
Parameters
- size: Size
- update: boolean = true
Returns void
Inherited from Cell.reWriteSize
- Defined in entities/cell/BaseCell.ts:1229

rotateAroundCenter

rotateAroundCenter(angle: number, snap?: number): void
Parameters
- angle: number
  угол в градусах
- Optionalsnap: number
  угловая привязка в градусах
Returns void
Inherited from Cell.rotateAroundCenter
- Defined in entities/cell/BaseCell.ts:578

rotateAroundPoint

rotateAroundPoint(
    point: Point | PointLike,
    angle: number,
    snap?: number,
    update?: boolean,
): void
Parameters
- point: Point | PointLike
- angle: number
  угол в градусах
- Optionalsnap: number
  угловая привязка в градусах
- update: boolean = true
Returns void
Inherited from Cell.rotateAroundPoint
- Defined in entities/cell/BaseCell.ts:587

setPosition

setPosition(x: number, y: number, update?: boolean): void
Parameters
- x: number
- y: number
- update: boolean = true
Returns void
Inherited from Cell.setPosition
- Defined in entities/cell/BaseCell.ts:490

setText

setText(text: string): void
Parameters
- text: string
Returns void
Inherited from Cell.setText
- Defined in entities/cell/BaseCell.ts:1453

toJSON

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

Returns CellJSON
Inherited from Cell.toJSON
- Defined in entities/cell/BaseCell.ts:1373

unembed

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

update

update(): void
Returns void
Inherited from Cell.update
- Defined in entities/cell/BaseCell.ts:1301

updateDrawPaths

updateDrawPaths(): void
Returns void
Inherited from Cell.updateDrawPaths
- Defined in entities/cell/BaseCell.ts:349

updateGhost

updateGhost(): void
обновляет реальные размеры с учетом толщин линий и перерисовывает упрощенное отображение для быстрого рендера

Returns void
Inherited from Cell.updateGhost
- Defined in entities/cell/BaseCell.ts:358

updateLinks

updateLinks(): void
Returns void
Inherited from Cell.updateLinks
- Defined in entities/cell/BaseCell.ts:524

updateMagnetPoints

updateMagnetPoints(): void
Returns void
Inherited from Cell.updateMagnetPoints
- Defined in entities/cell/GraphicElement.ts:303

updateRelationships

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

updateTransform

updateTransform(): void
Returns void
Inherited from Cell.updateTransform
- Defined in entities/cell/BaseCell.ts:540

Class BlockShape

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BlockShape

Properties

Protected_angle

Protected_centerOfRotation

Protected_height

Protected_isBlocked

Protected_isPrintable

Protected_isVisible

Protected_magnetPoints

_parent

_position

Protected_width

angleRad

annotatedText

bbox

bboxEdges

cashCanvas

children

compassPoints

cornerPoints

cursorName

cursorTrasform

customAttrs

customRender

Param: ctx

Param: zoom

dragFantomPosition

drawingScale

drawPaths

effectCanvas

Optionalforeign

id

isCell

isMultiTextMode

isTextBlock

isTextEditable

labels

libName

links

ProtectedmagnetPointsPath

margins

name

prevZoom

realCellSize

Deprecated

relativeTextPosition

rotatedBboxEdges

scale

scene

shapeGhost

standardCursor

startHeight

startWidth

testBboxStyle

textBbox

textPosition

textTransform

transform

txtHeight

txtWidth

userData

withBbox

zIndex

Static ReadonlytypeName

Accessors

angle

Returns number

Parameters

Returns void

center

`Protected`_angle

`Protected`_centerOfRotation

`Protected`_height

`Protected`_isBlocked

`Protected`_isPrintable

`Protected`_isVisible

`Protected`_magnetPoints

`Protected`_width

`Optional`foreign

`Protected`magnetPointsPath

`Static` `Readonly`typeName