Class EulerGraph

Точка входа. Создает экземпляр движка.

Hierarchy

EventEmitter<EngineEvents>
- EulerGraph

Index

Constructors

constructor

new EulerGraph(dom: EngineDom, options?: EngineOptions): EulerGraph
Parameters
- dom: EngineDom
- options: EngineOptions = {}
  настройки движка
Returns EulerGraph
Requires
dom.container - div, в который будет встроен элемент с канвасами

Desc
dom.drawCanvas Основной канвас

Desc
dom.interactiveCanvas Динамический канвас. для отрисовки выделения, манипуляций и т.п.

Desc
dom.overlayCanvas канвас для отрисовки общих эффектов

Desc
dom.gridCanvas канвас для отрисовки листов и сетки
Overrides EventEmitter<EngineEvents>.constructor
- Defined in EulerGraph.ts:249

Properties

canvas

canvas: HTMLCanvasElement | null

Основной канвас, на котором происходит отрисовка всей сцены

`Readonly`canvasControls

canvasControls: CanvasControls

События мыши и тач, переводятся в пространство схемы

`Readonly`coordsLabel

coordsLabel: CoordsLabel

ctx

ctx: CanvasRenderingContext2D | null

Основной контекст рисования, на котором происходит отрисовка всей сцены

`Readonly`customCursor

customCursor: CustomCursor

debouncedDraw

debouncedDraw: DebouncedFuncLeading<(renderOptions?: RenderOptions) => void> = ...

Основная функция отрисовки debounce с нулевой задержкой, то есть по сути setTimeout

draggingControl

draggingControl: Control | null = null

dynamicCtx

dynamicCtx: CanvasRenderingContext2D | null

Контекст рисования, на котором проихсодит отрисовка динамических элементов при редактировании

`Readonly`elementsLib

elementsLib: Record<string, unknown> = {}

Зарегистрированные элементы. Если элемент не зарегистрирован, то при распаковке из JSON он будет обычным Cell и потеряет все свои дополнительные свойства и методы

gridCanvas

gridCanvas: HTMLCanvasElement | null

Самый нижний канвас, используется для отрисовки сетки

hoveredElement

hoveredElement: GraphicElement | null = null

interactiveCanvas

interactiveCanvas: HTMLCanvasElement | null

Канвас, на котором проихсодит отрисовка динамических элементов при редактировании

isDragging

isDragging: boolean = false

Флаг, указывающий, что в данный момент какой-то элемент перемещают

`Readonly`keyboardService

keyboardService: KeyboardService

overlayCanvas

overlayCanvas: HTMLCanvasElement | null

Верхний канвас, который может использоваться для отрисовки каких-то эффектов поверх всей сцены

projectsManager

projectsManager: ProjectsManager

Открытие и управление проектами

scheduleRender

scheduleRender: DebouncedFuncLeading<(renderOptions?: RenderOptions) => void> = ...

`Readonly`settings

settings: SystemSettings = ...

`Readonly`skiaWasmService

skiaWasmService: SkiaWasmService

Сервис по работе с библиотекой skia. Используется как вспомогательная тулза

Link

https://skia.org/docs/user/modules/canvaskit/

snapPoint

snapPoint: CellIntersection | null = null

Точка привязки

Accessors

appState

get appState(): AppState
Returns AppState
- Defined in EulerGraph.ts:826

currentScene

get currentScene(): Scene2D | null
Returns Scene2D | null
- Defined in EulerGraph.ts:1454

interactive

get interactive(): boolean
Returns boolean
- Defined in EulerGraph.ts:830
set interactive(interactive: boolean): void
Если установить в false, канвас не будет реагировать на события мыши
Parameters
- interactive: boolean
Returns void
- Defined in EulerGraph.ts:837

mode

get mode(): Mode
Returns Mode
- Defined in EulerGraph.ts:1389
set mode(mode: Mode): void
Parameters
- mode: Mode
Returns void
- Defined in EulerGraph.ts:1380

services

get services(): Services
Returns Services
- Defined in EulerGraph.ts:653

version

get version(): string
Версия файла, которая поддерживается данной версией движка

Returns string
- Defined in EulerGraph.ts:1867

Methods

addProject

addProject(projectName?: string): void
Parameters
- OptionalprojectName: string
Returns void
- Defined in EulerGraph.ts:1227

addScene

addScene(
    options?: {
        scene?: Scene2D;
        sceneParams?: SceneParams;
        silent?: boolean;
    },
): Scene2D
Добавление сцены (листа)
Parameters
- options: { scene?: Scene2D; sceneParams?: SceneParams; silent?: boolean } = {}
Returns Scene2D
- Defined in EulerGraph.ts:1145

addTextShapeToCell

addTextShapeToCell(cell: Cell, canvasPosition: PointLike): void
Добавить новый TextShape в ячейку в позиции canvasPosition
Parameters
- cell: Cell
- canvasPosition: PointLike
Returns void
- Defined in EulerGraph.ts:1735

addToSelection

addToSelection(cell: GraphicElement | GraphicElement[]): void
Parameters
- cell: GraphicElement | GraphicElement[]
Returns void
- Defined in EulerGraph.ts:1482

clearCurrentScene

clearCurrentScene(): void
Returns void
- Defined in EulerGraph.ts:1751

clearDynamicCanvas

clearDynamicCanvas(): void
Returns void
- Defined in EulerGraph.ts:933

clearSelection

clearSelection(): void
Returns void
- Defined in EulerGraph.ts:1495

collapseMultiText

collapseMultiText(cell: Cell): void
Свернуть TextShape дочерние ячейки обратно в labels[]
Parameters
- cell: Cell
Returns void
- Defined in EulerGraph.ts:1627

createEmptyProject

createEmptyProject(): void
Returns void
- Defined in EulerGraph.ts:1308

disableServices

disableServices(
    services: (
        | "Charts"
        | "CommentManager"
        | "CopyPasteService"
        | "DrawService"
        | "Editor"
        | "Effects"
        | "ExportService"
        | "ExtPluginsManager"
        | "ImportService"
        | "LayersManager"
        | "Layout"
        | "PrintPreview"
        | "SaveService"
        | "SnapService"
        | "Stencil"
        | "TextEditor"
        | "ThemeService"
        | "TableEditService"
        | "CommandManager"
        | "AnimationService"
    )[],
): void
Полное отключение и удаление сервисов, при этом вызывается их dispose() и они могут быть далее использованы. Чтобы временно отключить сервис используйте EulerGraph.disableServicesInteractive
Parameters
- services: (
      | "Charts"
      | "CommentManager"
      | "CopyPasteService"
      | "DrawService"
      | "Editor"
      | "Effects"
      | "ExportService"
      | "ExtPluginsManager"
      | "ImportService"
      | "LayersManager"
      | "Layout"
      | "PrintPreview"
      | "SaveService"
      | "SnapService"
      | "Stencil"
      | "TextEditor"
      | "ThemeService"
      | "TableEditService"
      | "CommandManager"
      | "AnimationService"
  )[]
Returns void
- Defined in EulerGraph.ts:739

disableServicesInteractive

disableServicesInteractive(
    except?: (
        | "Charts"
        | "CommentManager"
        | "CopyPasteService"
        | "DrawService"
        | "Editor"
        | "Effects"
        | "ExportService"
        | "ExtPluginsManager"
        | "ImportService"
        | "LayersManager"
        | "Layout"
        | "PrintPreview"
        | "SaveService"
        | "SnapService"
        | "Stencil"
        | "TextEditor"
        | "ThemeService"
        | "TableEditService"
        | "CommandManager"
        | "AnimationService"
    )[],
): void
Делает все сервисы неактивными (в основном отключает подписки на события), за исключением переданных
Parameters
- except: (
      | "Charts"
      | "CommentManager"
      | "CopyPasteService"
      | "DrawService"
      | "Editor"
      | "Effects"
      | "ExportService"
      | "ExtPluginsManager"
      | "ImportService"
      | "LayersManager"
      | "Layout"
      | "PrintPreview"
      | "SaveService"
      | "SnapService"
      | "Stencil"
      | "TextEditor"
      | "ThemeService"
      | "TableEditService"
      | "CommandManager"
      | "AnimationService"
  )[] = []
Returns void
- Defined in EulerGraph.ts:913

dispose

dispose(): void
Очистка ресурсов

Returns void
- Defined in EulerGraph.ts:1914

duplicateScene

duplicateScene(pageName: string): void
Parameters
- pageName: string
Returns void
- Defined in EulerGraph.ts:1205

enableServices

enableServices(services?: AvailableServices): void
Инициализация сервисов, поставляемых вместе с движком. Список поддерживаемых сервисов можно получить getActiveServices()
Parameters
- Optionalservices: AvailableServices
Returns void
- Defined in EulerGraph.ts:685

enableServicesInteractive

enableServicesInteractive(
    except?: (
        | "Charts"
        | "CommentManager"
        | "CopyPasteService"
        | "DrawService"
        | "Editor"
        | "Effects"
        | "ExportService"
        | "ExtPluginsManager"
        | "ImportService"
        | "LayersManager"
        | "Layout"
        | "PrintPreview"
        | "SaveService"
        | "SnapService"
        | "Stencil"
        | "TextEditor"
        | "ThemeService"
        | "TableEditService"
        | "CommandManager"
        | "AnimationService"
    )[],
): void
Делает сервисы активными (в основном включает подписки на события), за исключением переданных.
Parameters
- except: (
      | "Charts"
      | "CommentManager"
      | "CopyPasteService"
      | "DrawService"
      | "Editor"
      | "Effects"
      | "ExportService"
      | "ExtPluginsManager"
      | "ImportService"
      | "LayersManager"
      | "Layout"
      | "PrintPreview"
      | "SaveService"
      | "SnapService"
      | "Stencil"
      | "TextEditor"
      | "ThemeService"
      | "TableEditService"
      | "CommandManager"
      | "AnimationService"
  )[] = []
Returns void
- Defined in EulerGraph.ts:925

expandMultiText

expandMultiText(cell: Cell): void
Разворачивает labels[] в TextShape ячейки
Parameters
- cell: Cell
Returns void
- Defined in EulerGraph.ts:1560

fitToHeight

fitToHeight(animationTime?: number): void
Вписывает лист во вьюпорт по высоте листа
Parameters
- animationTime: number = ...
  количество итераций анимации
Returns void
void
- Defined in EulerGraph.ts:1030

fitToPage

fitToPage(animationTime?: number): void
Вписывает лист во вьюпорт по размеру листа по наибольшей стороне
Parameters
- animationTime: number = ...
  количество итераций анимации
Returns void
void
- Defined in EulerGraph.ts:984

fitToView

fitToView(animationTime?: number): void
Вписывает лист во вьюпорт по bbоx всех ячеек
Parameters
- animationTime: number = ...
  количество итераций анимации
Returns void
void
- Defined in EulerGraph.ts:968

fitToWidth

fitToWidth(animationTime?: number): void
Вписывает лист во вьюпорт по ширине листа
Parameters
- animationTime: number = ...
  количество итераций анимации
Returns void
void
- Defined in EulerGraph.ts:1006

fitViewToSelection

fitViewToSelection(animationTime?: number): void
Вписывает выделение во вьюпорт
Parameters
- animationTime: number = ...
  количество итераций анимации
Returns void
- Defined in EulerGraph.ts:1073

getActiveServices

getActiveServices(): (
    | "Charts"
    | "CommentManager"
    | "CopyPasteService"
    | "DrawService"
    | "Editor"
    | "Effects"
    | "ExportService"
    | "ExtPluginsManager"
    | "ImportService"
    | "LayersManager"
    | "Layout"
    | "PrintPreview"
    | "SaveService"
    | "SnapService"
    | "Stencil"
    | "TextEditor"
    | "ThemeService"
    | "TableEditService"
    | "CommandManager"
    | "AnimationService"
)[]
Returns (
    | "Charts"
    | "CommentManager"
    | "CopyPasteService"
    | "DrawService"
    | "Editor"
    | "Effects"
    | "ExportService"
    | "ExtPluginsManager"
    | "ImportService"
    | "LayersManager"
    | "Layout"
    | "PrintPreview"
    | "SaveService"
    | "SnapService"
    | "Stencil"
    | "TextEditor"
    | "ThemeService"
    | "TableEditService"
    | "CommandManager"
    | "AnimationService"
)[]
- Defined in EulerGraph.ts:756

getCellById

getCellById(id: string): GraphicElement | undefined
Parameters
- id: string
Returns GraphicElement | undefined
- Defined in EulerGraph.ts:1763

getSelected

getSelected(): GraphicElement[]
Returns GraphicElement[]
- Defined in EulerGraph.ts:1759

getZoom

getZoom(): number
zoom текущей сцены

Returns number
- Defined in EulerGraph.ts:1860

isEditable

isEditable(): boolean
Returns boolean
- Defined in EulerGraph.ts:1871

isInSelection

isInSelection(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in EulerGraph.ts:1755

lockActiveLabelContext

lockActiveLabelContext(owner: ITextFormatService): void
Parameters
- owner: ITextFormatService
Returns void
- Defined in EulerGraph.ts:671

navigateToSelection

navigateToSelection(animationTime?: number): void
Смещает вид так, что выделение становится посередине вида. Зум при этом не меняется
Parameters
- animationTime: number = ...
Returns void
- Defined in EulerGraph.ts:1101

openProject

openProject(
    fileContent: string | Record<string, any>,
    _fileName: string,
    _extention?: string,
): void
Parameters
- fileContent: string | Record<string, any>
- _fileName: string
- Optional_extention: string
Returns void
- Defined in EulerGraph.ts:1316

pasteToViewportCenter

pasteToViewportCenter(element: GraphicElement): void
Вставляет элемент в сцену в центр вьюпорта.

Если элемент уже в какой-то сцене, но не в текущей - элемент склонируется
Parameters
- element: GraphicElement
Returns void
- Defined in EulerGraph.ts:1886

prepareDynamicCanvas

prepareDynamicCanvas(): void
Returns void
- Defined in EulerGraph.ts:946

registerElement

registerElement(elem: unknown): void
При добавлении новых шейпов необходимо их зарегистрировать в движке. Класс должен объявить уникальный static readonly typeName (assertCellTypeName). См. ../../guide/typeName и сериализация cell-классов.md. Можно это сделать автоматически методом EulerGraph.registerElementsLib
Parameters
- elem: unknown
Returns void
- Defined in EulerGraph.ts:811

registerElementsLib

registerElementsLib(): void
При добавлении новых шейпов необходимо их зарегистрировать в движке Для этого в \engine\features\Stencil\shapes нужно правильно прописывать экспорты, либо вручную методом EulerGraph.registerElement

Returns void
- Defined in EulerGraph.ts:784

registerStandardLibs

registerStandardLibs(): void
Returns void
- Defined in EulerGraph.ts:715

removeFromSelection

removeFromSelection(cell: GraphicElement | GraphicElement[]): void
Parameters
- cell: GraphicElement | GraphicElement[]
Returns void
- Defined in EulerGraph.ts:1490

removeProject

removeProject(projectName: string): void
Parameters
- projectName: string
Returns void
- Defined in EulerGraph.ts:1352

removeScene

removeScene(pageName: string): void
Parameters
- pageName: string
Returns void
- Defined in EulerGraph.ts:1183

removeTextShapeFromCell

removeTextShapeFromCell(textShape: Cell): void
Удалить одну TextShape-ячейку из expanded multitext родителя
Parameters
- textShape: Cell
Returns void
- Defined in EulerGraph.ts:1689

renameScene

renameScene(oldName: string, newName: string): void
Parameters
- oldName: string
- newName: string
Returns void
- Defined in EulerGraph.ts:1176

render

render(renderOptions?: RenderOptions): void
Parameters
- renderOptions: RenderOptions = {}
Returns void
- Defined in EulerGraph.ts:1458

renderSync

renderSync(renderOptions?: RenderOptions): void
Parameters
- renderOptions: RenderOptions = {}
Returns void
- Defined in EulerGraph.ts:1472

setActiveLabelContext

setActiveLabelContext(
ctx: ActiveLabelContext | null,
source?: ITextFormatService,
): void
Инициализация активного текстового контекста для UI.
Parameters
- ctx: ActiveLabelContext | null
- Optionalsource: ITextFormatService
Returns void
- Defined in EulerGraph.ts:660

setCanvasTheme

setCanvasTheme(theme: CanvasTheme): void
Parameters
- theme: CanvasTheme
Returns void
- Defined in EulerGraph.ts:1446

setCurrentProject

setCurrentProject(projectName: string): void
Parameters
- projectName: string
Returns void
- Defined in EulerGraph.ts:1294

setCurrentScene

setCurrentScene(pageName: string): void
Установить текущую сцену. Нужно устанавливать вручную при загрузке.
Parameters
- pageName: string
Returns void
- Defined in EulerGraph.ts:1237

setGridColors

setGridColors(smallGridColor: string, lineColor: string): void
Parameters
- smallGridColor: string
- lineColor: string
Returns void
- Defined in EulerGraph.ts:1434

toggleMultiTextMode

toggleMultiTextMode(cell: Cell): void
Переключить режим мультитекста у ячейки
Parameters
- cell: Cell
Returns void
- Defined in EulerGraph.ts:1678

unlockActiveLabelContext

unlockActiveLabelContext(owner: ITextFormatService): void
Parameters
- owner: ITextFormatService
Returns void
- Defined in EulerGraph.ts:675

updateCanvasesSize

updateCanvasesSize(scaler?: number): void
Устанавливает размеры канвасов по реальным размерам
Parameters
- Optionalscaler: number
Returns void
- Defined in EulerGraph.ts:1128

updateCustomCursorLabel

updateCustomCursorLabel(
canvasPosition: PointLike,
mousePosition: PointLike,
): void
Parameters
- canvasPosition: PointLike
- mousePosition: PointLike
Returns void
- Defined in EulerGraph.ts:1875

updatePageSize

updatePageSize(pageSize: Size, orientation: PaperOrientation): void
Parameters
- pageSize: Size
- orientation: PaperOrientation
Returns void
- Defined in EulerGraph.ts:1417

updateSceneSettings

updateSceneSettings(sceneSettings: SceneSettings): void
Parameters
- sceneSettings: SceneSettings
Returns void
- Defined in EulerGraph.ts:1393

updateSystemSettings

updateSystemSettings(systemSettings: Partial<SystemSettings>): void
Parameters
- systemSettings: Partial<SystemSettings>
Returns void
- Defined in EulerGraph.ts:1411

viewToShape

viewToShape(cell: Rect | GraphicElement, animationTime?: number): void
Смещает вид так, что объект становится посередине вида. Зум при этом не меняется
Parameters
- cell: Rect | GraphicElement
- animationTime: number = ...
  количество итераций анимации
Returns void
- Defined in EulerGraph.ts:1054

`Static`registerExternalModules

registerExternalModules<T extends { [key: string]: EngineExtensionConstructor }>(
moduleConstructors: T,
): ExtensionsService<T>
Регистрирует внешние модули в глобальном контексте движка.
Type Parameters
- T extends { [key: string]: EngineExtensionConstructor }
  Структура регистрируемых модулей, где ключи — названия, а значения — EngineExtensionConstructor.
Parameters
- moduleConstructors: T
  Объект, содержащий конструкторы модулей расширения (например, результат import * as Modules).
Returns ExtensionsService<T>
Строго типизированный экземпляр сервиса ExtensionsService<T>, предоставляющий доступ только к модулям текущей регистрации.
Remarks
Архитектурная особенность (Разделение контекстов): Под капотом все модули регистрируются в рамках одного общего синглтон-сервиса ExtensionsService. Однако на уровне типов TypeScript этот метод возвращает изолированное представление (View), ограниченное исключительно типом T из текущей сессии регистрации.

Это позволяет пользователю логически разграничивать контексты:
```
// Идеальное автодополнение: mockService «знает» только про моки,
// а engineExtensionService — только про боевые модули.
const mockService = EulerGraph.registerExternalModules<typeof MockClasses>(MockClasses);
const engineExtensionService = EulerGraph.registerExternalModules<typeof ExtensionClasses>(ExtensionClasses);
```
Example
```
const extensionService = EulerGraph.registerExternalModules<typeof ExtensionClasses>(ExtensionClasses);
const myModule = extensionService.getModule("MyModule");
```
Warn
Если регистрируемый модуль содержит ключи, которые уже были зарегистрированы ранее, будет выброшена ошибка.
- Defined in EulerGraph.ts:873

Class EulerGraph

Hierarchy

Index

Documents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns EulerGraph

Requires

Desc

Desc

Desc

Desc

Properties

canvas

ReadonlycanvasControls

ReadonlycoordsLabel

ctx

ReadonlycustomCursor

debouncedDraw

draggingControl

dynamicCtx

ReadonlyelementsLib

gridCanvas

hoveredElement

interactiveCanvas

isDragging

ReadonlykeyboardService

overlayCanvas

projectsManager

scheduleRender

Readonlysettings

ReadonlyskiaWasmService

Link

snapPoint

Accessors

appState

Returns AppState

currentScene

Returns Scene2D | null

interactive

Returns boolean

Parameters

Returns void

mode

Returns Mode

Parameters

Returns void

services

Returns Services

version

Returns string

Methods

addProject

Parameters

Returns void

addScene

Parameters

Returns Scene2D

addTextShapeToCell

Parameters

Returns void

addToSelection

Parameters

Returns void

clearCurrentScene

Returns void

clearDynamicCanvas

Returns void

clearSelection

Returns void

collapseMultiText

Parameters

Returns void

createEmptyProject

Returns void

`Readonly`canvasControls

`Readonly`coordsLabel

`Readonly`customCursor

`Readonly`elementsLib

`Readonly`keyboardService

`Readonly`settings

`Readonly`skiaWasmService