Class EulerGraph

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

После инициализации, нужно создать сцену

const scene = eulerEngine.addScene()

и установить ее текущей

 eulerEngine.setCurrentScene(scene.pageName)

Hierarchy

EventEmitter<EngineEvents>
- EulerGraph

Index

Constructors

constructor

Accessors

appState currentScene interactive mode services version

Constructors

constructor

new EulerGraph(dom, options?): 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 src/engine/EulerGraph.ts:228

Properties

canvas

canvas: null | HTMLCanvasElement

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

`Readonly`canvasControls

canvasControls: CanvasControls

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

`Readonly`coordsLabel

coordsLabel: CoordsLabel

ctx

ctx: null | CanvasRenderingContext2D

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

`Readonly`customCursor

customCursor: CustomCursor

debouncedDraw

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

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

draggingControl

draggingControl: null | Control = null

dynamicCtx

dynamicCtx: null | CanvasRenderingContext2D

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

`Readonly`elementsLib

elementsLib: Record<string, unknown> = {}

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

gridCanvas

gridCanvas: null | HTMLCanvasElement

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

interactiveCanvas

interactiveCanvas: null | HTMLCanvasElement

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

isDragging

isDragging: boolean = false

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

`Readonly`keyboardService

keyboardService: KeyboardService

overlayCanvas

overlayCanvas: null | HTMLCanvasElement

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

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: null | CellIntersection = null

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

`Static`prefixed

prefixed: string | boolean

Accessors

appState

get appState(): AppState
Returns AppState
- Defined in src/engine/EulerGraph.ts:759

currentScene

get currentScene(): null | Scene2D
Returns null | Scene2D
- Defined in src/engine/EulerGraph.ts:1290

interactive

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

mode

get mode(): Mode
Returns Mode
- Defined in src/engine/EulerGraph.ts:1225
set mode(mode): void
Parameters
- mode: Mode
Returns void
- Defined in src/engine/EulerGraph.ts:1216

services

get services(): Services
Returns Services
- Defined in src/engine/EulerGraph.ts:620

version

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

Returns string
- Defined in src/engine/EulerGraph.ts:1438

Methods

addListener

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

addProject

addProject(projectName?): void
Parameters
- OptionalprojectName: string
Returns void
- Defined in src/engine/EulerGraph.ts:1038

addScene

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

addToSelection

addToSelection(cell): void
Parameters
- cell: Cell | Link | (Cell | Link)[]
Returns void
- Defined in src/engine/EulerGraph.ts:1318

clearCurrentScene

clearCurrentScene(): void
Returns void
- Defined in src/engine/EulerGraph.ts:1337

clearDynamicCanvas

clearDynamicCanvas(): void
Returns void
- Defined in src/engine/EulerGraph.ts:801

clearSelection

clearSelection(): void
Returns void
- Defined in src/engine/EulerGraph.ts:1332

createEmptyProject

createEmptyProject(): void
Returns void
- Defined in src/engine/EulerGraph.ts:1148

disableServices

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

disableServicesInteractive

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

dispose

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

Returns void
- Defined in src/engine/EulerGraph.ts:1453

emit

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

enableServices

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

enableServicesInteractive

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

eventNames

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

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

fitToHeight

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

fitToPage

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

fitToView

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

fitToWidth

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

fitViewToSelection

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

getActiveServices

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

getCellById

getCellById(id): undefined | Cell | Link
Parameters
- id: string
Returns undefined | Cell | Link
- Defined in src/engine/EulerGraph.ts:1349

getSelected

getSelected(): (Cell | Link)[]
Returns (Cell | Link)[]
- Defined in src/engine/EulerGraph.ts:1345

getZoom

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

Returns number
- Defined in src/engine/EulerGraph.ts:1431

isEditable

isEditable(): boolean
Returns boolean
- Defined in src/engine/EulerGraph.ts:1442

isInSelection

isInSelection(id): boolean
Parameters
- id: string
Returns boolean
- Defined in src/engine/EulerGraph.ts:1341

listenerCount

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

listeners

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

lockActiveLabelContext

lockActiveLabelContext(owner): void
Parameters
- owner: ITextFormatService
Returns void
- Defined in src/engine/EulerGraph.ts:638

navigateToSelection

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

off

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

openProject

openProject(fileContent): void
Parameters
- fileContent: string | Record<string, any>
Returns void
- Defined in src/engine/EulerGraph.ts:1156

prepareDynamicCanvas

prepareDynamicCanvas(): void
Returns void
- Defined in src/engine/EulerGraph.ts:814

registerElement

registerElement(elem): void
При добавлении новых шейпов необходимо их зарегистрировать в движке. Можно это сделать автоматически методом EulerGraph.registerElementsLib
Parameters
- elem: unknown
Returns void
- Defined in src/engine/EulerGraph.ts:751

registerElementsLib

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

Returns void
- Defined in src/engine/EulerGraph.ts:730

removeAllListeners

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

removeFromSelection

removeFromSelection(cell): void
Parameters
- cell: Cell | Link | (Cell | Link)[]
Returns void
- Defined in src/engine/EulerGraph.ts:1327

removeListener

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

removeProject

removeProject(projectName): void
Parameters
- projectName: string
Returns void
- Defined in src/engine/EulerGraph.ts:1188

render

render(renderOptions?): void
Parameters
- renderOptions: RenderOptions = {}
Returns void
- Defined in src/engine/EulerGraph.ts:1294

renderSync

renderSync(renderOptions?): void
Parameters
- renderOptions: RenderOptions = {}
Returns void
- Defined in src/engine/EulerGraph.ts:1308

setActiveLabelContext

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

setCanvasTheme

setCanvasTheme(theme): void
Parameters
- theme: CanvasTheme
Returns void
- Defined in src/engine/EulerGraph.ts:1282

setCurrentProject

setCurrentProject(projectName): void
Parameters
- projectName: string
Returns void
- Defined in src/engine/EulerGraph.ts:1134

setCurrentScene

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

setGridColors

setGridColors(smallGridColor, lineColor): void
Parameters
- smallGridColor: string
- lineColor: string
Returns void
- Defined in src/engine/EulerGraph.ts:1270

unlockActiveLabelContext

unlockActiveLabelContext(owner): void
Parameters
- owner: ITextFormatService
Returns void
- Defined in src/engine/EulerGraph.ts:642

updateCanvasesSize

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

updateCustomCursorLabel

updateCustomCursorLabel(canvasPosition, mousePosition): void
Parameters
- canvasPosition: PointLike
- mousePosition: PointLike
Returns void
- Defined in src/engine/EulerGraph.ts:1446

updatePageSize

updatePageSize(pageSize, orientation): void
Parameters
- pageSize: Size
- orientation: PaperOrientation
Returns void
- Defined in src/engine/EulerGraph.ts:1253

updateSceneSettings

updateSceneSettings(sceneSettings): void
Parameters
- sceneSettings: SceneSettings
Returns void
- Defined in src/engine/EulerGraph.ts:1229

updateSystemSettings

updateSystemSettings(systemSettings): void
Parameters
- systemSettings: Partial<SystemSettings>
Returns void
- Defined in src/engine/EulerGraph.ts:1247

viewToShape

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

Class EulerGraph

Hierarchy

Index

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

interactiveCanvas

isDragging

ReadonlykeyboardService

overlayCanvas

projectsManager

scheduleRender

Readonlysettings

ReadonlyskiaWasmService

Link

snapPoint

Staticprefixed

Accessors

appState

Returns AppState

currentScene

Returns null | Scene2D

interactive

Returns boolean

Parameters

Returns void

mode

Returns Mode

Parameters

Returns void

services

Returns Services

version

Returns string

Methods

addListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

addProject

Parameters

Returns void

addScene

Parameters

Optionalscene?: Scene2D

OptionalsceneParams?: SceneParams

Optionalsilent?: boolean

Returns Scene2D

addToSelection

Parameters

Returns void

clearCurrentScene

Returns void

clearDynamicCanvas

Returns void

clearSelection

Returns void

`Readonly`canvasControls

`Readonly`coordsLabel

`Readonly`customCursor

`Readonly`elementsLib

`Readonly`keyboardService

`Readonly`settings

`Readonly`skiaWasmService

`Static`prefixed

`Optional`scene?: Scene2D

`Optional`sceneParams?: SceneParams

`Optional`silent?: boolean