Class DiagrmLibrary

Библиотека Stencil из классов shapes и/или JSON-описаний.

Hierarchy (View Summary)

Library<ShapesType>
- DiagrmLibrary

Constructors

constructor

new DiagrmLibrary(
    ...args: [
        name: string,
        shapes: (typeof DiagramElement | typeof Connector)[],
    ],
): DiagrmLibrary
Parameters
- ...args: [name: string, shapes: (typeof DiagramElement | typeof Connector)[]]
Returns DiagrmLibrary
Overrides Library.constructor
- Defined in services/Stencil/libs/diagram/DiagramLib.ts:24

Properties

aStarPathFinder

aStarPathFinder: AStarPathFinder | null = null

eulerGraph

eulerGraph: EulerGraph | null = null

items

items: StencilItem<typeof DiagramElement | typeof Connector>[] = []

`Readonly`itemsMap

itemsMap: Map<string, StencilItem<typeof DiagramElement | typeof Connector>> = ...

Все шейпы, загруженные в библиотеку

jsonObjects

jsonObjects: StencilLibItem[] = []

name

name: string

shapes

shapes: (typeof DiagramElement | typeof Connector)[] = []

shapesHiddenInStencil

shapesHiddenInStencil: unknown[] = []

Не будут отображаться в панели Stencil

sortNumber

sortNumber: number = 1

Methods

addJsonObjects

addJsonObjects(jsonObjects: StencilLibItem[]): void
Parameters
- jsonObjects: StencilLibItem[]
Returns void
Inherited from Library.addJsonObjects
- Defined in services/Stencil/libs/Library.ts:46

addShapes

addShapes(shapes: (typeof DiagramElement | typeof Connector)[]): void
Parameters
- shapes: (typeof DiagramElement | typeof Connector)[]
Returns void
Inherited from Library.addShapes
- Defined in services/Stencil/libs/Library.ts:42

createElement

createElement(
name: string,
options?: GraphicElementOptions & Record<string, unknown>,
): Connector | DiagramElement | null
Создает элемент, заданный в функции создания StencilItem.createLibElement. Перед началом работы с элементами библиотеки, их предварительно нужно загрузить методом Stencil.loadItemsByName()
Parameters
- name: string
- Optionaloptions: GraphicElementOptions & Record<string, unknown>
Returns Connector | DiagramElement | null
Inherited from Library.createElement
- Defined in services/Stencil/libs/Library.ts:229

dispose

dispose(): void
Returns void
Overrides Library.dispose
- Defined in services/Stencil/libs/diagram/DiagramLib.ts:220

findPath

findPath(start: Point, end: Point): Point[]
Parameters
- start: Point
- end: Point
Returns Point[]
- Defined in services/Stencil/libs/diagram/DiagramLib.ts:212

getAllItemsNames

getAllItemsNames(): string[]
Возвращает имена всех элементов библиотеки. Перед началом работы с элементами библиотеки, их предварительно нужно загрузить методом Stencil.loadItemsByName()

Returns string[]
Inherited from Library.getAllItemsNames
- Defined in services/Stencil/libs/Library.ts:208

getCellsUnderCursor

getCellsUnderCursor(point: PointLike): DiagramEntity[]
Мы работаем только с ячейками диаграмм
Parameters
- point: PointLike
Returns DiagramEntity[]
- Defined in services/Stencil/libs/diagram/DiagramLib.ts:128

getItemByName

getItemByName(
name: string,
): StencilItem<typeof DiagramElement | typeof Connector> | undefined
Возвращает элемент по имени. Перед началом работы с элементами библиотеки, их предварительно нужно загрузить методом Stencil.loadItemsByName()
Parameters
- name: string
Returns StencilItem<typeof DiagramElement | typeof Connector> | undefined
Inherited from Library.getItemByName
- Defined in services/Stencil/libs/Library.ts:218

getItems

getItems(): StencilItem<typeof DiagramElement | typeof Connector>[]
При переопределении функции необходимо предусмотреть кэширование

if (this.items.length) {

return this.items

}

...
```
 this.items = items
```
return items
Returns StencilItem<typeof DiagramElement | typeof Connector>[]
Inherited from Library.getItems
- Defined in services/Stencil/libs/Library.ts:75

load

load(): Promise<void>
Если нужна предварительная обработка данных для формирования библиотеки, этот метод переопределяется.

Returns Promise<void>
Inherited from Library.load
- Defined in services/Stencil/libs/Library.ts:186

looksConstructable

looksConstructable(value: unknown): boolean
Parameters
- value: unknown
Returns boolean
Inherited from Library.looksConstructable
- Defined in services/Stencil/libs/Library.ts:50

register

register(eulerGraph: EulerGraph): void
Регистрация библиотеки в движке. Библиотка начинает знать о движке и может слушать его события, а так же регистрируются элементы библиотеки в движке
Parameters
- eulerGraph: EulerGraph
Returns void
Overrides Library.register
- Defined in services/Stencil/libs/diagram/DiagramLib.ts:51

updateGraph

updateGraph(): void
Returns void
- Defined in services/Stencil/libs/diagram/DiagramLib.ts:109

Class DiagrmLibrary

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DiagrmLibrary

Properties

aStarPathFinder

eulerGraph

items

ReadonlyitemsMap

jsonObjects

name

shapes

shapesHiddenInStencil

sortNumber

Methods

addJsonObjects

Parameters

Returns void

addShapes

Parameters

Returns void

createElement

Parameters

Returns Connector | DiagramElement | null

dispose

Returns void

findPath

Parameters

Returns Point[]

getAllItemsNames

Returns string[]

getCellsUnderCursor

Parameters

Returns DiagramEntity[]

getItemByName

Parameters

Returns StencilItem<typeof DiagramElement | typeof Connector> | undefined

getItems

Returns StencilItem<typeof DiagramElement | typeof Connector>[]

load

Returns Promise<void>

looksConstructable

Parameters

Returns boolean

register

Parameters

Returns void

updateGraph

Returns void

Settings

On This Page

`Readonly`itemsMap