Class GraphicElement`Abstract`

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

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

Hierarchy (View Summary)

EventEmitter<BaseCellEvents>
- GraphicElement
  - BaseCell
  - BaseLinear

Implements

IBaseCell

Constructors

constructor

new GraphicElement(options?: GraphicElementOptions): GraphicElement
Parameters
- options: GraphicElementOptions = {}
Returns GraphicElement
Overrides EventEmitter<BaseCellEvents>.constructor
- Defined in entities/cell/GraphicElement.ts:127

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[] = []

id

id: string

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

isCell

isCell: boolean = true

isTextEditable

isTextEditable: boolean = false

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

libName

libName: string | null = null

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

`Protected`magnetPointsPath

magnetPointsPath: Path2D = ...

name

name: string = "Graphic Element"

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

scene

scene: Scene2D | null = null

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

standardCursor

standardCursor: CursorStandard = "none"

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

transform

transform: DOMMatrix = ...

userData

userData: UserData = []

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

zIndex

zIndex: number = 0

Accessors

angle

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

height

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

isBlocked

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

isBlockedInRender

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

isPrintable

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

isVisible

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

magnetPoints

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

parent

get parent(): GraphicElement | null
Returns GraphicElement | null
Implementation of IBaseCell.parent
- Defined in entities/cell/GraphicElement.ts:179
set parent(elem: GraphicElement | null): void
Parameters
- elem: GraphicElement | null
Returns void
Implementation of IBaseCell.parent
- Defined in entities/cell/GraphicElement.ts:187

position

get position(): Point
Returns Point
- Defined in entities/cell/GraphicElement.ts:165
set position(_point: Point): void
Parameters
- _point: Point
Returns void
- Defined in entities/cell/GraphicElement.ts:173

visibleInRender

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

width

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

Methods

clone

clone(): GraphicElement
Returns GraphicElement
- Defined in entities/cell/GraphicElement.ts:387

`Abstract`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
- Defined in entities/cell/GraphicElement.ts:410

dispose

dispose(): void
Returns void
Implementation of IBaseCell.dispose
- Defined in entities/cell/GraphicElement.ts:489

drawMagnetPoints

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

embed

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

fromJSON

fromJSON(json: Record<string, unknown>): GraphicElement
Parameters
- json: Record<string, unknown>
Returns GraphicElement
Implementation of IBaseCell.fromJSON
- Defined in entities/cell/GraphicElement.ts:467

`Abstract`getBBox

getBBox(): Rect
Returns Rect
Implementation of IBaseCell.getBBox
- Defined in entities/cell/GraphicElement.ts:299

`Abstract`getControls

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

getHoveredControls

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

getIcon

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

getTopParent

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

`Abstract`isPointInDrawing

isPointInDrawing(
    point: Point,
    ctx: CanvasRenderingContext2D,
    drawingScale: number,
): boolean
Parameters
- point: Point
- ctx: CanvasRenderingContext2D
- drawingScale: number
Returns boolean
Implementation of IBaseCell.isPointInDrawing
- Defined in entities/cell/GraphicElement.ts:377

`Abstract`makeTransformations

makeTransformations(
    offset: PointLike,
    control: Control,
    canvasPosition: PointLike,
    isShiftPressed?: boolean,
): void
Parameters
- offset: PointLike
- control: Control
- canvasPosition: PointLike
- OptionalisShiftPressed: boolean
Returns void
- Defined in entities/cell/GraphicElement.ts:251

`Abstract`move

move(_deltaX: number, _deltaY: number, _update?: boolean): void
Parameters
- _deltaX: number
- _deltaY: number
- Optional_update: boolean
Returns void
Implementation of IBaseCell.move
- Defined in entities/cell/GraphicElement.ts:301

`Abstract`onHover

onHover(ctx: CanvasRenderingContext2D, zoom: number): void
Parameters
- ctx: CanvasRenderingContext2D
- zoom: number
Returns void
- Defined in entities/cell/GraphicElement.ts:433

`Abstract`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
- Defined in entities/cell/GraphicElement.ts:428

`Abstract`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
- Defined in entities/cell/GraphicElement.ts:423

render

render(
    ctx: CanvasRenderingContext2D,
    _zoom: number,
    _options?: RenderOptions,
): void
Parameters
- ctx: CanvasRenderingContext2D
- _zoom: number
- Optional_options: RenderOptions
Returns void
Implementation of IBaseCell.render
- Defined in entities/cell/GraphicElement.ts:258

toJSON

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

Returns GraphicElementJSON
Implementation of IBaseCell.toJSON
- Defined in entities/cell/GraphicElement.ts:439

unembed

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

`Abstract`update

update(): void
Returns void
- Defined in entities/cell/GraphicElement.ts:399

updateMagnetPoints

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

updateRelationships

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

Class GraphicElementAbstract

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GraphicElement

Properties

Protected_isBlocked

Protected_isPrintable

Protected_isVisible

Protected_magnetPoints

_parent

bbox

children

cursorName

cursorTrasform

customAttrs

dragFantomPosition

drawingScale

drawPaths

id

isCell

isTextEditable

libName

ProtectedmagnetPointsPath

name

scene

standardCursor

transform

userData

zIndex

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

Returns boolean

width

Returns number

Methods

clone

Returns GraphicElement

AbstractcontainsPoint

Parameters

Returns boolean

Class GraphicElement`Abstract`

`Protected`_isBlocked

`Protected`_isPrintable

`Protected`_isVisible

`Protected`_magnetPoints

`Protected`magnetPointsPath

`Abstract`containsPoint

`Abstract`getBBox

`Abstract`getControls

`Abstract`isPointInDrawing

`Abstract`makeTransformations

`Abstract`move

`Abstract`onHover

`Abstract`onPointerDown

`Abstract`onPointerUp

`Abstract`update